fix(deps): update dependency dexie to v4 #224
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^3.2.7
->^4.0.0
Release Notes
dexie/Dexie.js (dexie)
v4.0.9
: Dexie v4.0.9Compare Source
Bugfixes
#2011: Dexie returns duplicated object after manually deleting the database and re-populate it
#2064 Failed to execute 'cmp' on 'IDBFactory': The parameter is not a valid key.
#2073 Uses cmp for sortBy
#2078 DexiePromise does not have withResolvers
#2067 useLiveQuery does not update when multiple items are deleted
Note: The Y.js support is released in 4.1.0 in alpha and possible to test but there is still no official release published for it. Also, the API might change from how it is right now. Will need some more testing and documentation before publishing it with release notes
v4.0.8
: Dexie v4.0.8Compare Source
Here's a maintainance release with small things so far.
NOTE: We're also working to release a 4.1 later this summer with CRDT support for rich text editing by providing explicit support for Y.js documents into both Dexie.js and Dexie Cloud (#1926)
Solved issues
PRs:
[email protected]:
v4.0.7
: Dexie v4.0.7Compare Source
v4.0.5
: Dexie v4.0.5Compare Source
Features
New CRDT operations: add() and remove() (#1936)
New operations that works consistently across sync: Mathematical addition/subtraction as well as adding or removing string or numbers from array properties.
Add to set
It is now possible to add items to an array property using a sync consistent operation "add":
Remove from set
Mathematical addition and subtraction (number)
Mathematical addition and subtraction (bigint)
Typings
Bug fixes
[email protected]
v4.0.4
: Dexie v4.0.4Compare Source
Fixes #1955 for real this time (the fix in 4.0.2 wasn't correct enough for npm)
v4.0.3
Compare Source
v4.0.2
: Dexie v4.0.2Compare Source
Patch Release
[email protected]
[email protected]
v4.0.1
: Dexie v4.0.1Compare Source
Dexie 4 Stable
After 3 years is alpha and beta, and a week in RC, Dexie@4 is finally out!
Changed Version Handling (PR #1880)
It's still recommended to increment version number when schema has been updated before publishing new versions of an application since it can make opening the db fractions of ms faster. But it's not required.
(If the native version has diverged from the declared version - which happen when extending schema without incrementing version, dexie need to increment the native version to extend schema - and after a page refresh dexie will detect diverged version by catching VersionError and will redo open with the exact installed version under the hood. When measuring the extra time to open an older version in indexedDB and catch VersionError 10,000 times, it only took 1000 ms - 0.1 ms per try (on a macbook pro), so it should be negligible (https://jsfiddle.net/dfahlander/9tg13fwk/19/))
Cache
Non-transactional live queries utilize memory cache to assist in query resolution. It is possible to opt-out from using the cache using the option
{cache: 'disabled'}
. The cache can greatly improve simple pure range-based live queries and reduce the queries towards IndexedDB by reusing common queries from different components. The cache will be continously developed and optimized further to improve the new paging support in Dexie 5.0.Workarounds for flaky browsers
Dexie 4 catches various issues in the IndexedDB support for Chrome and Safari. Without dexie@4 transactions and write operations can suddenly fail in modern versions of Chrome and Safari but dexie makes sure to protect the end user from experience any issues. It does this by reopening the database or redoing the transaction when these things happen - all without the developer having to worry about it. See issues #543 and #613. (A close upcoming release on the 4.0-track will also address #1660 and #1829).
Supports Dexie Cloud
With Dexie 4.0, you can optionally use dexie-cloud-addon and connect your local database with a cloud based database. Dexie Cloud is a complete solution for authorization and synchronization of personal data with support for sharing data between users.
Improved Typing
Dexie 4 has some improved typing. Specifically, Collection.modify() and Table.update() use template literals to suggest code completion and type checking of keypaths to update.
Distinguish insert- from output types
The type passed to db.table.add() can be different from the type returned from db.table.get() and tb.table.toArray(). This mirrors reality better since some properties may be optional when adding (such as an auto-incremented primary key or dexie-cloud properties
realmId
andowner
).The generic type
Table<T, TKey>
is extended with a 3rd optional parameterTInsertType
making it possible to declare a table as such:A new helper generic
EntityTable<T>
also exists as a "don't repeat yourself" sugar on top of this, and will also omit any method on the type. In case the type is a mapped class with helper methods, you are still able to pass simple POJO objectsto add() and put() with only data properties.
If using Dexie Cloud, there's a
DexieCloudTable<T>
generic that will declare the implicit Dexie Cloud properties on the entity correctly for insert- and output types:A solution to dependency issues with mapped classes
In dexie 3, a mapped class that needs to access the database from its methods, will needs to access the a
db
instance. But it is a bit awkward to tie a method body to the same instance exported from thedb
module. For example, having two instances of db with different constructor parameters would not work as both would use one of the instances from their method bodies.In Dexie 4.0, this is solved using a lightweight dependency injection. There is a generic class
Entity
that your classes may extend from in order to get your database instance injected as a protected propertydb
on every entity instance. Your class methods can then perform queries onto the db without being dependant on thedb
module of your app. This use case will require a subclassed Dexie declaration though. There will still be cyclic import dependencies but only on the type level.Breaking Changes
No IE11 support
No support for Internet Explorer 11, legacy Edge (non-chromium) nor legacy Safari below version 14.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.