Skip to content

Latest commit

 

History

History
2284 lines (1513 loc) · 96.6 KB

CHANGELOG.md

File metadata and controls

2284 lines (1513 loc) · 96.6 KB
Raw

RxDB Changelog

15.36.1 (16 October 2024)

  • ADD SQLite RxStorage support for Expo SDK 51 with the async API getSQLiteBasicsExpoSQLiteAsync()

15.36.0 (16 October 2024)

  • ADD option to define the RxDB Premium token in an .env file

15.35.0 (15 October 2024)

15.34.1 (2 October 2024)

  • ADD proper error message if people miss out the usesRxDatabaseInWorker settings in OPFS.

15.34.0 (1 October 2024)

  • FIX OPFS Storage based RxDatabase cannot be created inside of worker via discord
  • IMPROVE performance of nested property access #6406
  • FIX firestore replication of multiple document with the same serverTimestamp #6436

15.33.0 (10 September 2024)

  • ADD tutorial for a local-first Vector Database
  • FIX RxPipeline tries to store metadata that does not match the json schema.
  • ADD utilities function for vector search.

15.32.0 (26 August 2024)

  • ADD Fulltext Search Plugin
  • FIX RangeError: Invalid count value error in the OPFS and filesystem storage on cleanups.

15.31.4 (22 August 2024)

15.31.3 (21 August 2024)

15.31.2 (21 August 2024)

  • FIX postCleanup hook not running

15.31.1 (19 August 2024)

  • ADD postCleanup hook.

15.31.0 (14 August 2024)

15.30.2 (5 August 2024)

  • FIX node:sqlite couldn't be found in react native #6291

15.30.1 (3 August 2024)

  • FIX node:sqlite couldn't be found in react native #6291

15.30.0 (2 August 2024)

  • FIX quotes problem on windows with the scripts of the package.json
  • CHANGE getSQLiteBasicsNodeNative() requires the constructor as param
  • FIX key-compression broken with boolean indexes on dexie #6267
  • FIX type of RxQuery.$ must be Observable #6285

15.29.0 (29 July 2024)

  • ADD support for the node:sqlite module to the SQLite RxStorage
  • FIX several problem with the memory-mapped RxStorage in ReactNative

15.28.1 (19 July 2024)

  • ADD storage bucket support to the IndexedDB RxStorage.
  • FIX error when calling bulkUpsert() with multiple docs where one fails and one suceeds.

15.28.0 (9 July 2024)

  • CHANGE RxStorage interface: For better performance on remote storages, RxStorageInstance.bulkWrite() must only return errors, not the written documents data.

15.27.0 (7 July 2024)

  • FIX Wrong Reactivity generics passed by RxCollection extending RxCollectionBase #6188
  • IMPROVE performance of ChangeEventBuffer by processing events in bulks.
  • IMPROVE performance of DocCache by processing events in bulks.
  • IMPROVE performance of ChangeEventBuffer and DocCache by lazily processing tasks.

15.26.0 (3 July 2024)

  • IMPROVE performance of .appendToArray()
  • IMPROVE performance of writes to the memory RxStorage
  • ADD iframe tracking to dev-mode plugin.

15.25.0 (28 June 2024)

  • FIX RxState sometimes does writes to the storage that do not match the schema.
  • FIX Query Builder does not work on queries created by .findByIds() #6148
  • FIX (IndexedDB RxStorage) When used with Sharding and Workers, it sometimes errors on the first query after db creation.

15.24.0 (9 June 2024)

15.23.0 (29 May 2024)

  • FIX type resolving in webpack #6051

15.22.0 (23 May 2024)

  • Add missing extensions error field to errorToPlainJson #6029
  • ADD dedicated errors page
  • FIX randomly failing replication test
  • ADD non-premium console.log on the LokiJS RxStorage

15.21.3 (20 May 2024)

15.21.0 (18 May 2024)

  • FIX collection.remove() must end up with the correct RxCollection state across tabs. 5721
  • ADD RxCollection.onRemove hooks to detect the removing of a RxCollection across tabs.
  • IMPROVE performance of insert to IndexedDB
  • ADD non-premium console.log on the Dexie.js RxStorage

15.20.0 (12 May 2024)

  • ADD RxQuery.patch() RxQuery.incrementalPatch() RxQuery.modify() RxQuery.incrementalModify() and RxQuery.incrementalRemove().
  • FIX RxDocument.update() must return the latest revision of the RxDocument.
  • ADD(GraphQL replication) change GraphQL query builder functions to generate output fields for nested queries #5976
  • ADD queryModifier to SQLite RxStorage
  • IMPROVE performance of insert-many to the memory RxStorage by 40%.
  • IMPROVE performance of getHeightOfRevision().
  • ADD check to throw helpfull error message when a Date() object is passed instead of plain json data.

15.19.0 (29 April 2024)

15.18.6 (29 April 2024)

15.18.5 (29 April 2024)

15.18.4 (27 April 2024)

15.18.3 (25 April 2024)

15.18.2 (25 April 2024)

  • Memory RxStorage: Add categorizedByWriteInput property that can be used by other plugins.

15.18.1 (18 April 2024)

  • FIX CouchDB replication error Cannot read properties of undefined (reading '_attachments')

15.18.0 (17 April 2024)

  • FIX memory-synced storage must be able to query encrypted fields on the in-memory side.
  • RxServer: updatedAt must be lwt #61
  • RxServer: Fix using parseFloat instead of parseInt #5883

15.17.0 (8 April 2024)

  • ADD RxReplicationState.remove() to delete the metadata of a specific replication.
  • FIX IndexedDB RxStorage: Rerun database creation when IndexedDB database was closed by safari bug
  • FIX vite bundling error with WebRTC replication #5841
  • ADD replication-webrtc: allow passing config to simple-peer #5838

15.16.0 (28 March 2024)

  • Update dexie.js to version 4.0.1
  • Deprecate LokiJS RxStorage

15.15.1 (27 March 2024)

15.15.0 (27 March 2024)

  • ADD PreactSignalsRxReactivityFactory to use custom reactivity with preact signals instead of observables.
  • ADD VueRxReactivityFactory to use custom reactivity with vue shallow refs instead of observables.
  • ADD(reactivity) pass reference to RxDatabase to fromObservable()

15.14.0 (25 March 2024)

15.13.4 (24 March 2024)

15.13.3 (24 March 2024)

15.13.2 (24 March 2024)

15.13.1 (24 March 2024)

15.13.0 (24 March 2024)

  • REFACTOR RxServer package. (Includes breaking changes of the beta RxServer!)

15.12.0 (16 March 2024)

  • SQLite RxStorage add support to use Webassembly SQLite in the browser
  • FIX(Lokisjs RxStorage) always use slice() for applying offset and limit #5757
  • FIX randomly failing lokijs and denokv test #5765

15.11.1 (10 March 2024)

15.11.0 (10 March 2024)

  • ADD RxState: A convenient state library to store, fetch and observe complex json data that is persisted into RxDB.
  • ADD automatically extend the RxDocument type so it knows about the RxDocument.myField$ observables.
  • ADD check to ensure Infinity is not used when defining index sizes in the RxJsonSchema
  • FIX do not automatically set multiInstance: false for shared worker storage databases.

15.10.0 (27 February 2024)

  • IMPROVE OPFS RxStorage performance.
  • ADD usesRxDatabaseInWorker option to the OPFS RxStorage.
  • ADD getRxStorageOPFSMainThread() to run OPFS from the main thread instead of a worker for less latency.

15.9.1 (21 February 2024)

  • FIX creating two databases with the same name but different storage must work.

15.9.0 (21 February 2024)

  • ADD awaitWritePersistence option to memory-synced storage.

15.8.1 (14 February 2024)

  • FIX #5624 Maximum call stack size exceeded during encryptString

15.8.0 (10 February 2024)

15.7.0 (7 February 2024)

  • FIX key-compression broken on keys with brackets #5605

15.6.2 (7 February 2024)

  • FIX using encryption plugins inside of worker was broken
  • FIX(premium) missing type SharedWorker

15.6.1 (1 February 2024)

  • FIX(lokijs) $in operator not working on arrays.

15.6.0 (1 February 2024)

  • FIX firestore replication not working with schema validation #5572
  • FIX Replication observation mode ignored when push handler is waiting #5571
  • FIX migration from v14 -> v15 is broken when IndexedDB is used inside of worker. 5565

15.5.0 (30 January 2024)

  • ADD RxServer 🎉
  • ADD Optionally supress dev mode Warning #5556

15.4.3 (28 January 2024)

15.4.2 (24 January 2024)

  • ADD(worker storage) support for directly imported Worker and SharedWorker functions as workerInput.

15.4.1 (24 January 2024)

  • ADD export test utilities so other projects can use them

15.4.0 (22 January 2024)

  • ADD helpers for the new server plugin
  • ADD RxJsonSchema.internalIndexes
  • ADD(opfs-storage) allow to set jsonPositionSize to increase the maxium database size to be bigger than 100 MegaByte.

15.3.0 (15 January 2024)

15.2.0 (5 January 2024)

  • FIX(dexie.js) migration from v14 to v15 not working.
  • ADD initialCheckpoint for Couchdb #5461

15.1.0 (2 January 2024)

  • Add operationName to graphQL requests #5418
  • Custom fetch to support axios for the graphQL replication #5421
  • FIX CRDT not working with undefined fields #5423

15.0.0 (20 December 2023)

🚀 RxDB v15 is released

  • A list of changes for RxDB v15 can be found here

14.17.1 (24 September 2023)

14.17.0 (18 September 2023)

14.16.0 (21 August 2023)

  • FIX primaryKey with value "constructor", breaks findOne()
  • FIX Queries with $lt selector on primaryKey broken #4751
  • UPDATE mingo to 6.4.4

14.15.1 (27 July 2023)

  • FIX using .count() with allowSlowCount: true can return wrong results.

14.15.0 (18 July 2023)

  • FIX count() is incorrect #4755

14.14.2 (10 July 2023)

  • FIX #4804 requestIdlePromise broken in react-native (#4813)
  • FIX #4781 GraphQL Replication Cancel With Database Destroy

14.14.1 (23 June 2023)

  • Fix returning deleted items in find queries #4773

14.14.0 (7 June 2023)

14.13.0 (2 June 2023)

14.12.1 (30 May 2023)

  • Fix prevent delete _rev from row.doc #4752
  • IMPROVE landingpage hero section #4753

14.12.0 (23 May 2023)

  • FIX(couchdb replication) Retries must respect retryTime to not cause the UI to stuck related #4612
  • FIX(OPFS RxStorage) various bugs with umlauts
  • REMOVE outdated tests related #4741
  • FIX checkSchema for anyOf and items array #4741

14.11.5 (19 May 2023)

14.11.4 (17 May 2023)

14.11.3 (16 May 2023)

14.11.2 (15 May 2023)

14.11.1 (4 May 2023)

  • FIX remove pouchdb-selector-core dependency #4722

14.11.0 (26 April 2023)

14.10.0 (25 April 2023)

14.9.0 (20 April 2023)

14.8.3 (16 April 2023)

  • FIX(data-migrator) use count() instead of query() to count documents.
  • FIX(data-migrator) send correct writeRow.previous to old storage for deletion.

14.8.2 (15 April 2023)

14.8.1 (15 April 2023)

14.8.0 (15 April 2023)

  • FIX(docs) eventReduce: false is the default. #4614 You have to manually enable eventReduce.
  • ADD(storage-opfs) attachments support.
  • CHANGE RxStorageInstance.getAttachmentData() add digest parameter.

14.7.2 (11 April 2023)

14.7.0 (11 April 2023)

  • ADD OPFS RxStorage for browsers (premium).
  • ADD Check to ensure that the primaryKey does not contain a double-quote.

14.6.5 (10 April 2023)

14.6.4 (8 April 2023)

14.6.3 (8 April 2023)

14.6.2 (7 April 2023)

  • FIX(remote-storage) mode: 'one' option must reuse the RemoteMessageChannel
  • IMPROVE performance of index creation on some storages.

14.6.1 (6 April 2023)

  • FIX requestIdlePromise() must run in a queue.
  • ADD Export ReplicationOptions type #4606
  • ADD mode option to remote storage

14.6.0 (31 March 2023)

  • FIX wrong index generation on some number fields that do not have decimals.

14.5.2 (30 March 2023)

  • ADD method getPrimaryKeyFromIndexableString()
  • REFACTOR utils for Map and WeakMap caching
  • FIX: lost RxDocument in preSave from v14.0.0 #4581

14.5.1 (28 March 2023)

  • ADD getIndexStringLength() helper method

14.5.0 (27 March 2023)

  • ADD (dev-mode) ensure it throws on malformated primary keys
  • UPDATE typescript to version 5
  • ADD(replication-firestore): add filtered replication #4590
  • FIX(typescript) schema type not working with readonly array #4579

14.4.0 (24 March 2023)

  • FIX multiple problems in the query planner
  • ADD 'includeWsHeaders' property for GraphQL replication #4533
  • UPDATE broadcast-channel to version 5.0.0
  • FIX query-builder copies RxQuery's other param #4587

14.3.7 (18 March 2023)

14.3.6 (15 March 2023)

14.3.5 (15 March 2023)

14.3.4 (15 March 2023)

14.3.3 (14 March 2023)

14.3.2 (13 March 2023)

14.3.1 (13 March 2023)

14.3.0 (13 March 2023)

  • FIX RxDocument getter should return the same object on property paths #4548
  • OPTIMIZE use findDocumentsById() on queries that do only do an $in operator on the primary key.
  • FIX $or query with other operator on dexie.js

14.2.3 (10 March 2023)

14.2.1 (9 March 2023)

  • ADD docs for remote storage customRequestHandler

14.2.0 (8 March 2023)

  • CHANGE increase the default batch size of the migration plugin from 10 to 200.
  • FIX awaitInitialReplication() must not resolve on error-only replication handlers.

14.1.9 (4 March 2023)

14.1.8 (2 March 2023)

14.1.6 (2 March 2023)

14.1.5 (2 March 2023)

14.1.3 (1 March 2023)

14.1.2 (26 February 2023)

  • FIX ensure writing many documents at once works with every RxStorage.

14.1.1 (24 February 2023)

  • REMOVE broken dev dependency wrtc
  • FIX(SQLite) broken pragma calls on iOS

14.1.0 (23 February 2023)

  • CHANGE premium plugin users can still use the code after the license has expired.
  • ADD(utils) export RXDB_VERSION variable.
  • REFACTOR(RxStorageStatics) use the same query matcher and sort function everywhere, not dependend by storage implementation.

14.0.5 (22 February 2023)

  • SQLite: Added logger function
  • ADD capacitor build to angular example

14.0.4 (19 February 2023)

  • websocket-replication: pass all websocket options to constructor #4449
  • FIX Firebase Replication Issues #4405

14.0.3 (15 February 2023)

14.0.2 (15 February 2023)

14.0.1 (13 February 2023)

  • FIX(websocket remote storage) custom request not working with multiple clients

14.0.0 (8 February 2023) BREAKING read the announcement

  • Remove the deprecated PouchDB RxStorage.

  • REMOVE old replication-couchdb plugin. Rename replication-couchdb-new to replication-couchdb.

  • Remove depricated skipIfSame from putAttachment()

  • CHANGE use plain json errors inside of RxError parameters to make debugging easier.

  • CHANGE Make RxDocuments immutable

  • ADD RxDocument.getLatest()

  • CHANGE RxCollection.findByIds() now returns a RxQuery.

  • REMOVED RxCollection.findByIds$, use RxCollection.findByIds().$ instead.

  • CHANGE Prefix storage plugins with storage- like rxdb/plugins/storage-dexie.

  • RENAME atomicUpdate() to incrementalModify()

  • RENAME atomicPatch() to incrementalPatch()

  • RENAME atomicUpsert() to incrementalUpsert()

  • ADD RxDocument().incrementalUpdate()

  • ADD RxDocument.incrementalRemove()

  • ADD non-incremental RxDocument methods patch() and modify()

  • ADD typings to the query selector

  • CHANGE start replication via pure functions instead of RxCollection methods.

  • CHANGE RxDocument.$ emits RxDocument instances instead of the plain document data.

  • ADD push.initialCheckpoint to start a replication from a given checkpoint.

  • CHANGE Do not use hash for revisions but use database instance token instead.

  • CHANGE crunch multiple incremental (aka 'atomic') operations into a single database write. Also batch writes to multiple documents into a single write.

  • REMOVE deprecated babel-plugin-transform-async-to-promises plugin.

  • CHANGE to reduce bundle size and improve performance, the following JavaScript features will no longer be transpiled:

Bugfixes:

  • CHANGE (memory RxStorage) do not clean up database state on closing of the storage, only on remove().
  • FIX CouchDB replication: Use correct default fetch method.
  • FIX schema hashing should respect the sort order #4005
  • FIX replication does not provide a ._rev to the storage write when a conflict is resolved.
  • FIX(remote storage) ensure caching works properly even on parallel create-calls
  • FIX(replication) Composite Primary Keys broken on replicated collections #4190
  • FIX(sqlite) $in Query not working SQLite #4278
  • FIX CouchDB push is throwing error because of missing revision #4299
  • ADD dev-mode shows a console.warn() to ensure people do not use it in production.
  • Remove the usage of Buffer. We now use Blob everywhere.
  • FIX import of socket.io #4307
  • FIX Id length limit reached with composite key #4315
  • FIX $regex query not working on remote storage.
  • FIX SQLite must store attachments data as Blob instead of base64 string to reduce the database size.
  • FIX CouchDB replication conflict handling
  • CHANGE Encryption plugin was renamed to encryption-crypto-js
  • FIX replication state meta data must also be encrypted.
  • FIX crash with null in selector #4369
  • FIX storage instances MUST NOT mutate the given database- and collection-name.
  • REMOVE deprecated babel-plugin-transform-async-to-promises plugin.
  • ADD Ability to use a responseModifier for GraphQL push replication #4385
  • FIX Add null check for isRxDocument #4406

13.17.1 (30 December 2022)

  • FIX Add missing mingo array operators #4203 Thanks @swnf
  • FIX(sqlite) $elemMatch query did not work correctly on object arrays.
  • CHANGE(sqlite) do not use ORDER BY on count queries for better performance.

13.17.0 (29 December 2022)

  • FIX(lokijs) wrong query result when sorting on a nested field.
  • IMPROVE usage of the mingo query library by only adding the operators to the build that are really needed.
  • CHANGE use faster deep clone method.

13.16.1 (27 December 2022)

13.16.0 (26 December 2022)

13.15.3 (13 December 2022)

13.15.2 (11 December 2022)

  • FIX(SQLite) getSQLiteBasicsQuickSQLite must use executeAsync

13.15.1 (11 December 2022)

13.15.0 (10 December 2022)

13.14.3 (9 December 2022)

  • FIX Ensure equal behavior across all storages on call to .close() after .remove().

13.14.2 (9 December 2022)

13.14.1 (9 December 2022)

13.14.0 (9 December 2022)

13.13.7 (6 December 2022)

  • REFACTOR the electron plugin to improve ipcRenderer communications.
  • REMOVE is-electron dependency.

13.13.6 (5 December 2022)

  • REFACTOR the remote RxStorage for electron ipcRenderer

13.13.5 (2 December 2022)

13.13.4 (2 December 2022)

13.13.3 (2 December 2022)

13.13.2 (30 November 2022)

13.13.1 (30 November 2022)

  • UPDATE isomorphic-ws to 5.0.0

13.13.0 (30 November 2022)

13.12.0 (29 November 2022)

  • ADD electron ipcRenderer plugin which can be used in Electron.js to run the RxStorage in the main process and the RxDatabase in the renderer processes.
  • Removed the electron-remote example because @electron/remote is deprecated.
  • FIX emit false on active$ after replication is done #4136 Thanks @maxnowack
  • Deprecated the PouchDB RxStorage, read this

13.11.1 (23 November 2022)

  • FIX Throw proper error message when a boolean index is used in the Dexie.js RxStorage.

13.11.0 (19 November 2022)

  • ADD replication-webrtc which can be used to replicate data peer-to-peer without a backend server.

13.10.1 (10 November 2022)

13.10.0 (10 November 2022)

13.9.0 (7 November 2022)

  • REFACTOR use faster areRxDocumentArraysEqual instead of doing a deep-equal check.
  • ADD check to easier debug wrongly behaving backend during replication.
  • FIX error dev-mode added multiple times is removed because it is annoying when using react hot-swap. Instead addRxPlugin() will now only throw if a different plugin is added that has the same name as a plugin that was added before.
  • REFACTOR create the digest of an attachment inside of the RxStorage, not in RxDB. This makes the behavior equal to CouchDB and solves a lot of problems caused by different hashing or base64 encoding of the RxStorage implementations. (Fixes #4107) Thanks @Elendiar
  • FIX GraphQL replication: should stop syncing if we receive less docs than pull.batchSize #4110 Thanks @jwallet

13.8.3 (3 November 2022)

  • FIX TS Error in Plugin "Replicate-GraphQL" : GraphQL Websocket on "isomorphic-ws" import #4104 Thanks @jwallet

13.8.2 (1 November 2022)

  • UPDATE fake-indexeddb to version 4.0.0
  • REFACTOR use webpack instead of browserify in karma tests.
  • REMOVE graphql-client dependency #3497

13.8.1 (1 November 2022)

  • FIX wrong query results in some cases with many operators.
  • REMOVE deep-freeze npm dependency because it has no author.

13.8.0 (31 October 2022)

  • Added RxCollection.count() queries. #4096
  • REFACTOR index boundary usage for better performance.
  • FIX critical bug in query correctness. IMPORTANT: If you use the RxStorage IndexedDB or FoundationDB, you have to rebuild the indexes by increasing your schema version and running a migration. #4098
  • FIX Typo in CRDT Plugin: RxDDcrdtPlugin is now RxDBcrdtPlugin #4094 Thanks @jwallet

13.7.0 (24 October 2022)

  • ADD CRDT Plugin
  • FIX calling .remove() on an RxDocument must update the internal data of the document with the deleted state.
  • FIX Stop retries when replication gets canceled #4088 Thanks @Whoops

13.6.0 (19 October 2022)

13.5.1 (15 October 2022)

  • ADD in fastUnsecureHash() use polyfill if TextEncoder is not available

13.5.0 (12 October 2022)

13.4.5 (7 October 2022)

  • REFACTORED the landingpage to have less blinking and no more autoplay audio.

13.4.4 (4 October 2022)

  • ADD new premium plugin RxStorage Localstorage Meta Optimizer

13.4.2 (3 October 2022)

13.4.1 (2 October 2022)

  • REFACTOR stuff for a new optimization plugin

13.4.0 (28 September 2022)

  • FIX image attachments not working correctly in the browser
  • FIX Push batchSize in not respected #3994
  • FIX boolean indexes not working #3994

13.3.0 (26 September 2022)

  • FIX(sqlite) use dollar params instead of named params
  • CHANGE run performance tests without the dev-mode plugin
  • IMPROVE performance of document writes by not using try-catch in a hot path.
  • FIX RxDatabase.remove() must properly remove the collection storage together with the replication states.

13.2.0 (22 September 2022)

  • FIX respect the prefers-reduced-motion media query to not show blinking animations to neurodiverse people at the landingpage.
  • ADD pull.responseModifier to the graphql replication plugin so that you can aggregate the checkpoint from the returned graphql response.

13.1.0 (19 September 2022)

  • FIX saving multiple attachments broke previously stored attachments on some storages.
  • UPDATE graphql websocket dependencies #3980 Thanks @herefishyfish
  • FIX on RxCollection.remove() the related storages like the meta of replications, must also be removed.

13.0.3 (17 September 2022)

  • FIX sorting via event-reduce did not work when key-compression plugin was used.

13.0.2 (16 September 2022)

  • FIX event-reduce did not work when key-compression plugin was used.

13.0.1 (16 September 2022)

13.0.0 (16 September 2022) BREAKING read the announcement

  • FIX graphQLSchemaFromRxSchema() must not create broken schema when there are no headerFields

  • ADD credentials settings to the GraphQL replication plugin #3976 Thanks @marcoklein

  • RENAMED the ajv-validate plugin to validate-ajv to be in equal with the other validation plugins.

  • The is-my-json-valid validation is no longer supported until this bug is fixed.

  • REFACTORED the schema validation plugins, they are no longer plugins but now they get wrapped around any other RxStorage.

    • It allows us to run the validation inside of a Worker RxStorage instead of running it in the main JavaScript process.
    • It allows us to configure which RxDatabase instance must use the validation and which does not. In production it often makes sense to validate user data, but you might not need the validation for data that is only replicated from the backend.

  • REFACTORED the key compression plugin, it is no longer a plugin but now a wrapper around any other RxStorage.

    • It allows to run the key-comresion inside of a Worker RxStorage instead of running it in the main JavaScript process.

  • REFACTORED the encryption plugin, it is no longer a plugin but now a wrapper around any other RxStorage.

    • It allows to run the encryption inside of a Worker RxStorage instead of running it in the main JavaScript process.
    • It allows do use asynchronous crypto function like WebCrypto

  • Store the password hash in the same write request as the database token to improve performance.

  • REMOVED many unused plugin hooks because they decreased the performance.

  • REMOVED support for temporary documents see here

  • REMOVED RxDatabase.broadcastChannel The broadcast channel has been moved out of the RxDatabase and is part of the RxStorage. So it is not longer exposed via RxDatabase.broadcastChannel.

  • In the RxDB internal _meta.lwt field, we now use 2 decimals number of the unix timestamp in milliseconds.

  • REMOVE RxStorageStatics .hash and .hashKey

  • CHANGE removed default usage of md5 as default hashing. Use a faster non-cryptographic hash instead.

    • ADD option to pass a custom hash function when calling createRxDatabase.

  • Removed the liveInterval option of the replication. It was an edge case feature with wrong defaults. If you want to run the pull replication on internval, you can send a RESYNC event manually in a loop.

  • CHANGE use Float instead of Int to represent timestamps in GraphQL.

  • REPLACED RxReplicationPullError and RxReplicationPushError with normal RxError like in the rest of the RxDB code.

  • REMOVED the option to filter out replication documents with the push/pull modifiers #2552 because this does not work with the new replication protocol.

  • CHANGE default of replication live to be set to true. Because most people want to do a live replication, not a one time replication.

  • CHANGED Attachment data is now always handled as Blob because Node.js does support Blob since version 18.0.0 so we no longer have to use a Buffer but instead can use Blob for browsers and Node.js

  • FIXED multiple problems with encoding attachments data. We now use the js-base64 library which properly handles utf-8/binary/ascii transformations.

  • RENAMED the server plugin is now called server-couchdb and RxDatabase.server() is now RxDatabase.serverCouchDB()

  • ADDED the websocket replication plugin

  • ADDED the FoundationDB RxStorage

  • FIX couchdb-server plugin missed out events from the replication.

  • ADD Support JsonSchema for nested additionalProperties #3952 Thanks @swnf

  • REFACTORED the layout of RxChangeEvent to better match the RxDB requirements and to fix the 'deleted-document-is-modified-but-still-deleted' bug.

12.7.16 (18 July 2022)

12.7.15 (18 July 2022)

12.7.14 (18 July 2022)

12.7.13 (18 July 2022)

12.7.12 (17 July 2022)

  • CHANGE use eslint rule require-await to reduce build size.

12.7.11 (17 July 2022)

12.7.10 (17 July 2022)

12.7.9 (17 July 2022)

12.7.8 (15 July 2022)

12.7.7 (15 July 2022)

12.7.6 (15 July 2022)

12.7.5 (15 July 2022)

  • FIX unify checkpoint behavior across all RxStorage implementations.
  • FIX github release bot to only post non-patch releases to discord.

12.7.4 (15 July 2022)

  • ADD export type CategorizeBulkWriteRowsOutput
  • CHANGE RxStorageInstance.getChangedDocumentsSince() only returns the last checkpoint, not one for each document.

12.7.3 (14 July 2022)

  • ADD export type RxStorageDefaultCheckpoint

12.7.2 (14 July 2022)

12.7.1 (14 July 2022)

12.7.0 (14 July 2022)

  • FIX #3839 executing insert -> remove -> insert -> remove does not work. Thanks @nisarpeitang
  • ADD checkpoint to the internal used events that are emitted in the RxStorageInstance.changestream().
  • FIX randomly failing test with dexie.js RxStorage.
  • ADD custom parameter to RxStorageInstance.bulkWrite()

12.6.14 (7 July 2022)

12.6.13 (6 July 2022)

  • ADD getPouchDBOfRxCollection() to easy access the PouchDB instance of a RxCollection.

12.6.11 (5 July 2022)

12.6.10 (5 July 2022)

12.6.9 (4 July 2022)

  • Add conflict handling to RxCollection.

12.6.8 (2 July 2022)

12.6.7 (1 July 2022)

12.6.6 (1 July 2022)

12.6.5 (30 June 2022)

  • ADD isRxDatabaseFirstTimeInstantiated()

12.6.4 (30 June 2022)

12.6.3 (29 June 2022)

12.6.2 (29 June 2022)

12.6.1 (29 June 2022)

  • FIX RxStorageReplication must work with local documents.

12.6.0 (29 June 2022)

  • The worker RxStorage will no longer reuse the worker so that multiple RxDatabase instances can use different workers for better performance.
  • Cross-Tab event propagation is now handled by the RxStorage implementations, not by the RxDatabase. This allows to better combine RxStorages and plugins/wrappers.

12.5.4 (23 June 2022)

  • Only check if final field have been changed in dev-mode.
  • Fix atomicUpsert() broken when document was replicated before. #3856. Thanks @AntonOfTheWoods
  • Refactor revision handling
  • Fix the _rev that is passed to an RxStorage must be respected by the RxStorage.

12.5.3 (15 June 2022)

12.5.1 (15 June 2022)

12.5.0 (15 June 2022)

  • UPDATE Node.js to version 18.3.0
  • FIX: RxStorage should never emit an eventBulk with an empty events array.
  • Update PouchDB to 7.3.0 Thanks @cetsupport.
  • CHANGE (RxStorage) revision hash must not include the _meta field.
  • Added new Stream replication for internal usage in plugins.

12.4.3 (27 May 2022)

  • SQLite RxStorage: Add support for specific query indexes.

12.4.2 (23 May 2022)

  • FIX query planner did not pick the correct index on $eq operations.
  • IMPROVE performance of the memory RxStorage
  • IMPROVE performance of custom index creation

12.4.1 (12 May 2022)

  • ADD query optimizer to premium plugins.

12.4.0 (12 May 2022)

  • REFACTOR if no sort order is set on a query, use a better matching sort order and not just the primary key.

12.3.2 (10 May 2022)

12.3.1 (10 May 2022)

12.3.0 (10 May 2022)

  • OPTIMIZE isFindOneByIdQuery() should be true when only the primary field is queried with an $eq
  • REWRITE query planner to use better indexeses in dexie.js and memory storage.

12.2.0 (9 May 2022)

  • ADD attachment support to SQLite RxStorage
  • ADD attachment support to IndexedDB RxStorage
  • FIX collections with a dash in the name where not properly removed #3785 Thanks @mmouterde
  • FIX data still there despite remove and destroy calls #3788 Thanks @mmouterde

12.1.0 (6 May 2022)

  • ADD notifyAboutRemoteChange() to the GrapQL replication and replication primitives.
  • ADD attachment support to memory RxStorage.
  • FIX default of waitForLeadership in replication primitives must be true

12.0.8 (4 May 2022)

  • IMPROVE memory storage performance.

12.0.7 (3 May 2022)

12.0.6 (3 May 2022)

12.0.5 (3 May 2022)

12.0.4 (3 May 2022)

12.0.3 (3 May 2022)

12.0.2 (2 May 2022)

  • FIX dexie.js storage does not work with keyCompression when having a nested schema.

12.0.1 (28 April 2022)

  • Added autoStart option to the replication plugins #3775 Thanks @mmouterde
  • Fix #778 Storing string array was broken in the dexie storage. Thanks @mmouterde

12.0.0 (26 April 2022) BREAKING read the announcement

  • All indexes that do not contain the primaryKey, get the primary key added.

  • You can now set a custom index when doing a query.

  • Unified the replication primitives and the GraphQL replication plugin.

  • Removed the deprecated in-memory plugin.

  • Added cleanup plugin

  • Refactor local documents plugin to only create a storage instance for local documents when needed.

  • Removed the core plugin. The default export from 'rxdb' now exports only the RxDB core without plugins.

  • The Dexie.js RxStorage is no longer in beta mode.

  • Added the in memory storage plugin.

  • Added RxDocument().toMutableJSON()

  • Added RxCollection().bulkUpsert()

  • Added optional init() function to RxPlugin.

  • dev-mode: Add check to ensure all top-level fields in a query are defined in the schema.

  • Support for array field based indexes like data.[].subfield was removed, as it anyway never really worked.

  • Refactored the usage of RxCollection.storageInstance to ensure all hooks run properly.

  • Refactored the encryption plugin so no more plugin specific code is in the RxDB core.

  • Removed the encrypted export from the json-import-export plugin. This was barely used and made everything more complex. All exports are no non-encrypted. If you need them encrypted, you can still run by encryption after the export is done.

  • RxPlugin hooks now can be defined as running before or after other plugin hooks.

  • Attachments are now internally handled as string instead of Blob or Buffer

  • Fix (replication primitives) only drop pulled documents when a relevant document was changed locally.

  • Fix dexie.js was not able to query over an index when keyCompression: true

Changes to RxStorageInterface:

  • RxStorageInstance must have the RxStorage in the storage property.
  • The _deleted field is now required for each data interaction with RxStorage.
  • Removed RxStorageInstance.getChangedDocuments() and added RxStorageInstance.getChangedDocumentsSince() for better performance.
  • Added doesBroadcastChangestream() to RxStorageStatics
  • Added withDeleted parameter to RxStorageKeyObjectInstance.findLocalDocumentsById()
  • Added internal _meta property to stored document data that contains internal document related data like last-write-time and replication checkpoints.

11.6.0 (4 February 2022)

Bugfixes:

  • #3666 RxDB with lokijs works bad in Safari and FF when using multiple tabs

Other:

  • Replication primitives must throw an error if _deleted field is missing. #3671

11.5.1 (30 January 2022)

Bugfixes:

  • RxStorage.statics.getQueryMatcher() must not match documents with _deleted: true.
  • Fixed multiple problems with RxCollection.findByIds$() #3659 Thanks @Hideman85

11.5.0 (30 January 2022)

Features:

11.4.0 (28 January 2022)

Bugfixes:

  • RxDocument.toJSON() is leaking meta field _deleted. #3645 Thanks @Bessonov

Features:

  • Allow truthy values for the GraphQL replication deletedFlag field. #3644 Thanks @nirvdrum

Other:

  • .findOne(documentId) should use RxStorage().findDocumentsById() instead of RxStorage().query()

11.3.0 (17 January 2022)

Bugfixes:

  • GraphQL replication: Unnecessary local document writes fill up the database #3627 Thanks @hdwatts

11.2.0 (12 January 2022)

Bugfixes:

  • Replication Primitives: Local writes while running the pull must not be lost but send to the remote.
  • Replication Primitives: Should not stack up failed runs and then run many times.
  • Support composite indices in schema literal types #3609 Thanks @nirvdrum

11.1.0 (6 January 2022)

Features:

  • Added toTypedRxJsonSchema and ExtractDocumentTypeFromTypedRxJsonSchema to generate the document types from the schema.

11.0.0 (3 January 2022) BREAKING read the announcement

BREAKING:

  • RxStorage: The non async functions prepareQuery, getSortComparator and getQueryMatcher have been moved out of RxStorageInstance into RxStorage. This was needed to have better WebWorker support. This will not affect you do not use a custom RxStorage implementation.
  • LokiJS: Do not use the IdleQueue of the RxDatabase to handle calls to saveDatabase(), instead wait for CPU idleness of the JavaScript process.
  • RxStorageInterface:
    • Replaced all Map with plain json objects so that they can be JSON.stringify-ed
    • Replaced typings of event stream to use EventBulk and process events in bulks to save performance.
    • Move all static methods into the statics property so we can code-split when using the worker plugin.
    • digest and length of attachment data is now created by RxDB, not by the RxStorage. #3548
    • Added the statics hashKey property to identify the used hash function.
  • Internally all events are handles via bulks, this saves performance when events are transfered over a WebWorker or a BroadcastChannel.
  • Removed the deprecated recieved methods, use received instead. See #3392
  • Removed the no-validate plugin. To use RxDB without schema validation, just do not add a validation plugin to your custom build.

Bugfixes:

  • Do not throw an error when database is destroyed while a GraphQL replication is running.
  • Compound primary key migration throws "Value of primary key(s) cannot be changed" #3546 Thanks @nothingkid
  • Allow _id as primaryKey #3562 Thanks @SuperKirik
  • LokiJS: Remote operations do never resolve when remote instance was leader and died.

Other:

  • LokiJS: All documents are stored with a $lastWriteAt field, so we can implement an auto compaction later.
  • Transpile async/await to promises instead of generators. via babel-plugin-transform-async-to-promises

10.5.4 (30 November 2021)

Bugfixes:

  • LokiJS: Do not call saveDatabase() when no persistence adapter is given.
  • Query returns outdated result in second subscription #3498 Thanks @swnf
  • Spawning a server when full leveldown-module is used must not throw an error.

10.5.3 (19 November 2021)

Bugfixes:

  • PouchDB: getSortComparator() broken on some complex $or query.

10.5.2 (18 November 2021)

Other:

  • GraphQL replication must wait for requestIdlePromise to not slow down more important tasks.

Bugfixes:

  • LokiJS: Directly create local state when instance becomes leader.
  • LokiJS: mustUseLocalState() should not create multiple local states.

10.5.1 (15 November 2021)

Bugfixes:

  • GraphQL replication should affect requestIdlePromise and while replication IO is running, the database must not be idle.
  • Creating a collection that has existed before must not cause a database write.
  • LokiJS: Fixed error log when reloading while having the database open in multiple browser tabs.

10.5.0 (15 November 2021)

Other:

  • Removed useless runtime check of database name, only check in dev-mode.

Changes:

  • LokiJS: Use custom save handler instead of setting autosave: true

10.4.1 (13 November 2021)

Other:

  • Decreased build size by not importing pouchdb-utils
  • Improve build size and performance by replacing deep-equal with fast-deep-equal
  • Remove module random-token and use the same random string generator everywhere.

10.4.0 (11 November 2021)

Bugfixes:

  • LokiJS: Ensure events emit exact the same data as with PouchDB.
  • LokiJS: Queries with limit and skip where broken.
  • LokiJS: Fix all bugs and run the whole test suite with LokiJS Storage
  • Fix PouchDB RxStorage sometimes returned wrong sort comparison results.

Other:

  • Updated event-reduce for more optimizations.
  • Allow dash character - in collection and database names.

10.3.5 (8 November 2021)

Bugfixes:

  • LokiJS findDocumentsById() returned additional $loki property.
  • LokiJS bulkAddRevisions() must not mutate the input.
  • LokiJS deletes on GraphQL replication must work.

10.3.4 (7 November 2021)

Bugfixes:

  • LokiJS: Upserting a deleted document did not work.
  • LokiJS: Storage queries returned additional $loki property.

10.3.3 (6 November 2021)

Bugfixes:

  • LokiJS Storage must have a deterministic sort order.

10.3.2 (5 November 2021)

Bugfixes:

  • Sort queries broken with LokiJS RxStorage.

10.3.1 (5 November 2021)

Bugfixes:

  • Fix endless loop when using GrapQL-replication & LokiJS RxStorage.

10.3.0 (4 November 2021)

Features:

  • Added LokiJS RxStorage plugin.

Bugfixes:

  • Fixed missing closings of RxStorage instances when the database or collection is destroyed.

Other:

  • Improved performance of write operations.
  • Removed unnecessary abstraction layer of LeaderElector

10.2.2 (25 October 2021)

Bugfixes:

  • Migration with attachments removes attachment mime types #3460 Thanks @swnf

Other:

  • Improved performance when many queries are created in a short timespan.
  • Database- and collection names can now contain the minus char -.

10.2.1 (20 October 2021)

Bugfixes:

  • GraphQL replication: push not working with keyCompression.
  • Buffer is not available in browsers #3454 Thanks @swnf

10.2.0 (13 October 2021)

Bugfixes:

Other:

  • We now have set sideEffects: false to the default in the package.json so tree shaking can work.
  • Optimized memory usage in the query cache.

Features:

10.1.0 (27 September 2021)

Other:

  • Refactored the migration plugin for better performance by writing the documents in bulk requests
  • Added svelte example #3287 Thanks @bkeating
  • Improved error messages

Bugfixes:

  • #3319 Graphql replication checkpoint was not deleted after running RxDatabase.remove()
  • Fixed spelling of recieved -> received everywhere. The old getters are still useable but deprecated #3392. Thanks chrisdrackett

10.0.3 (9 August 2021)

Bugfixes:

  • Calling bulk-methods with an empty array must not throw an error.
  • RxCollection.remove() does not delete local documents #3319

10.0.0 (20 July 2021) BREAKING read the announcement

Breaking:

  • Setting a primaryKey for a schema is now required.

  • When using the type RxJsonSchema<DocType> the DocType is now required.

  • A JsonSchema must have the required array at the top level and it must contain the primary key.

  • Outgoing data is now Readonly typed and deep-frozen in dev mode

  • RxDocument.putAttachment() no longer supports string as data, only Blob or Buffer.

  • Changed the default of putAttachment to skipIfSame=true.

  • Removed the deprecated atomicSet(), use atomicPatch() instead.

  • Removed the deprecated RxDatabase.collection() use RxDatabase().addCollections() instead.

  • Moved everything pouchdb related to the pouchdb plugin.

  • Pouchdb plugins are not longer added via addRxPlugin() but addPouchPlugin(). (RxDB plugins are still added via addRxPlugin).

  • Removed plugin hook preCreatePouchDb.

  • Removed the watch-for-changes plugin, this is now directly integrated into the pouchdb RxStorage.

  • Removed the adapter-check plugin. (The function adapterCheck has moved to the pouchdb plugin).

  • Calling RxDatabase.server() now returns a promise that resolves when the server is started up.

  • Changed the defaults of PouchDBExpressServerOptions from the server() method, by default we now store logs in the tmp folder and the config is in memory.

  • Renamed replication-plugin to replication-couchdb to be more consistend in naming like with replication-graphql

    • Renamed RxCollection().sync() to RxCollection().syncCouchDB()

  • Renamed the functions of the json import/export plugin to be less confusing

    • dump() is now exportJSON()
    • importDump() is now importJSON()

  • RxCollection uses a separate pouchdb instance for local documents, so that they can persist during migrations.

Features:

  • Added support for composite primary keys.

Other:

  • Moved all should never happen errors into own error code.

Typings:

  • Improved typings of error codes.

9.21.0 (30 June 2021)

Features:

  • Added dataPath property to GraphQL replication pull options to allow the document JSON lookup path to configured instead of assuming the document data is always the first child of the response #2606 Thanks @joshmcarthur

Types:

  • getLocal() can return undefined. Thanks @chrisdrackett
  • Fixed typings in the dependencies so you can use noUncheckedIndexedAccess. Thanks @seanwu1105

9.20.0 (15 May 2021)

Bugfixes:

  • Auto-cancel one time couchdb replications to not cause a memory leak
  • Fixed another memory leak when calling the couchdb replication many times.

9.19.0 (12 May 2021)

Features:

Other:

  • Updated rxjs to version 7.0.1

9.18.0 (26 April 2021)

Bugfixes:

  • Fixed memory leak in RxCollection().findByIds$()

Other:

  • Added collection name when throwing errors in RxQuery

9.17.1 (21 April 2021)

Other:

  • Added hints abount 2021 user survey.

9.17.0 (14 April 2021)

Features:

  • Added possibility to change, update, remove and add RxAttachments inside of a migration strategy.

9.16.0 (12 April 2021)

Features:

  • Added RxDatabase.migrationStates() which returns an observable to observe the state of all ongoing migrations.
  • Added startupPromise to the returned object of RxDatabase().server()

Bugfixes:

  • Ensure every background task is done when RxDatabase.destroy() resolves. #2938

Other:

  • Added analytics to docs page

9.15.0 (25 February 2021)

Bugfixes:

Other:

  • Determinstic handling of revision keys during data migration
  • Added more information to RxError when data migration fails

9.14.0 (14 February 2021)

Features:

  • Added RxReplicationState.awaitInitialReplication()

Bugfixes:

  • Using the replication plugins must not required to also use leader-election
  • Refactor QueryCache.triggerCacheReplacement() to not spawn setTimeout regulary. This is needed for server side rendering with angular universal.

Other:

9.13.0 (10 February 2021)

Features:

Other:

  • Improved typings of insertLocal() #2850 Thanks @openscript
  • Improved typings of bulkInsert()

9.12.1 (24 January 2021)

Bugfixes:

  • #2785 postInsert hook not working when use bulkInsert to insert doc. Thanks @qinyang912
  • Setted sideEffects: true for main module #2798

Other:

  • (docs) added warning about indexeddb adapter
  • Upgraded typescript to 4.1.3

9.12.0 (3 January 2021)

Features:

  • Allow primary and ref at the same time in a schema. #2747

Bugfixes:

  • #2705 when use bulkInsert to insert doc, the rxDocument property on changeEvent is an object, not a RxDocument instance. Thanks @qinyang912
  • When the mutation function of atomicUpdate() has thrown once, it was not possible to use it again.

9.11.0 (13 December 2020)

Features:

  • Added putAttachment(skipIfSame), if set to true a write will be skipped if the attachment already exists with the same data.

Bugfixes:

  • awaitInitialReplication() resolves on failed replication #2745. Thanks @dome4
  • insertLocal() not emitted the state change across tabs

Other:

  • Added name identifier to RxPlugin
  • Throw error when dev-mode plugin is added multiple times because there is no way that this was done intentional likely the developer has mixed core and default usage of RxDB.
  • Fix reported security problem with the query builders mquery api.

9.10.1 (23 November 2020)

Other:

  • Additional refactorings to improve collection creation speed

9.10.0 (23 November 2020)

Features:

  • Added RxCollection.getLocal$() and RxDatabase.getLocal$() to observe local documents.
  • Added RxDatabase.addCollections() to create multiple collections at once. Is faster and better typed than the now deprecated RxDatabase.collection()

Other:

  • Improved typings for pouchdb.changes()
  • Moved from travisci to github actions

9.9.0 (10 November 2020)

Other:

  • Improved startup performance by doing a index-exist check
  • Added check for properties to dev-mode schema check
  • Add better checks for query input in dev-mode

9.8.0 (2 November 2020)

Features:

Bugfixes:

  • (types) Returned values of syncGraphQL() did not type-match with RxGraphQLReplicationState
  • RxDocument.atomicUpdate() now does a retry on 409 write conflicts

Other:

  • Added authentication to graphql example
  • Deprecated RxDocument.atomicSet(). Used atomicPatch instead, it works better with typescript
  • (docs) added workarounds for 6-connection limit at couchdb replication #2659. Thanks @MuresanSergiu

9.7.1 (22 October 2020)

Bugfixes:

  • Server-Plugin: Replication did not work until there is at least one document.
  • Fix skipping docs in graphql push replication #2627 Thanks @DDoerner

9.7.0 (21 October 2020)

Bugfixes:

  • RxLocalDocument.$ emitted to often on changes #2471
  • Fix typings of RxReplicationState.collection

Features:

  • Allow to skip docs in push/pull modifiers with the graphql-replication. #2552 Thanks @DDoerner
  • Allow to type the data of RxLocalDocument like myDatabase.getLocal<{foo: string}>('bar')

Other:

  • Refactored GraphQL replication to run faster #2524 Thanks @corinv

9.6.0 (7 September 2020)

Features:

  • Add RxReplicationState.setHeaders() #2399 Thanks @DDoerner
  • Added RxCollection.findByIds$() see

Bugfixes:

  • wrong key handling on compound indexes #2456 Thanks @dome4
  • Nested $or queries where broken when they used the primaryKey in the selector

9.5.0 (2 August 2020)

Other:

  • Upgraded pouchdb to 7.2.2
  • Upgraded typescript to 3.9.7

9.4.0 (24 July 2020)

Features:

  • Add cache-replacement-policy for the QueryCache
  • GraphQL replication async modifier function #2367

Bugfixes:

  • GraphQL replication run increasing requests when offline #2336

9.3.0 (26 June 2020)

Features:

  • Added (beta) RxCollection.findByIds() to get many documents by their id with a better performance.

Other:

  • Added typings for pouch.allDocs()

9.2.0 (21 June 2020)

Bugfixes:

  • ref-fields must be nullable #2285 Thanks @kunal15595
  • RxDatabase names can no longer end with a slash #2251 which breaks the server plugin.

Other:

  • Added "sideEffects": false to all plugins

9.1.0 (31 May 2020)

Features:

  • RxDatabase.server() does now accept pouchdbExpressOptions to set the log file and other stuff configured on express-pouchdb

Bugfixes:

Other:

9.0.0 (16 May 2020) BREAKING read the announcement

Features:

  • Added RxQuery.exec(throwIfMissing: true)
  • Added helper functions to GraphQL replication to generate GraphQL Schemas from the RxJsonSchema

Bugfixes:

  • GraphQL replication plugin fires exponentially #2048
  • When a default is set in the schema, the default values are also applied after atomicUpdate() and atomicSet()

Breaking:

  • Indexes are now specified at the top-level of the schema-definition. #1655
  • Encrypted fields are now specified at the top-level of the schema-definition
  • Removed all default exports. Please only import the stuff that you really need.
  • Renamed RxDB.create() to createRxDatabase()
  • Renamed removeDatabase() to removeRxDatabase()
  • Renamed plugin() to addRxPlugin()
  • Replaced plugins error-messages and schema-check with dev-mode
  • Moved data migration from core to migration plugin
  • Replaced key-compression implementation with jsonschema-key-compression
  • Renamed RxDatabase.queryChangeDetection to eventReduce and set default to true (no beta anymore)
  • Change .find() and .findOne() to acccept a full MangoQuery with sort and limit instead of just the selector
  • Chained queries like collection.find().where('x').eq('foo') moved out of the core module into the query-builder plugin
  • The internal hash() function does now use a RxDB specific salt
  • Change default of RxDocument().toJSON(withRevAndAttachments) to false
  • Refactored RxCollection
  • Creating a collection will no longer emit an RxChangeEvent
  • Removed RxCollection.docChanges$() because all events are from the docs
  • Renamed RxSchema.jsonID to RxSchema.jsonSchema
  • Moved remaining stuff of leader-election from core into the plugin
  • Merged multiple internal databases for metadata into one internalStore
  • In dev-mode, the GraphQL-replication will run a schema validation of each document that comes from the server

Other:

  • Removed many runtime type checks that now should be covered by typescript in buildtime
  • The GraphQL replication is now out of beta mode

Docs:

  • Removed examples for require() CommonJS loading

8.9.0 (14 March 2020)

Other:

Features:

  • Added option to replicate revisions with graphql-replication #2000 Thanks @gautambt

8.8.0 (5 March 2020)

Other:

  • Upgraded PouchDB and other dependencies

8.7.5 (6 January 2020)

Other:

  • Added a new example for electron with the remote API. Thanks @SebastienWae
  • Fixed Typing error on database.dump() #1754. Thanks @PVermeer

Bugfixes:

  • Updates to documents fail with GraphQL replication. #1812. Thanks @gautambt
  • RxQuery.doesDocumentDataMatch() was wrong on queries with $and which lead to a wrong result with QueryChangeDetection

8.7.4 (2 December 2019)

Other:

  • Improved performance of QueryChangeDetection by using array-push-at-sort-position instead of re-sorting the whole results of a query
  • Improved performance by removing unnecessary calls to deep-clone

8.7.3 (10 November 2019)

Features:

  • Added RxCollection.bulkInsert()

Bugfixes:

  • Fix replication of migrated schemas in the server plugin

8.7.2 (24 October 2019)

Bugfixes:

  • GraphQL replication sometimes not pushes when a big amount of documents has been pulled before
  • Fixed typings of PouchdbReplicationOptions

Other:

  • Upgrade pouchdb to 7.1.1
  • Refactor some internals

8.7.1 (18 October 2019)

Other:

  • Json-Import now uses bulkDocs for better performance
  • Refactored prototype merging so it can be optimised later
  • Moved some check into the check-plugin to optimize production build size
  • Refactor schema-validation-plugins since sub-path validation is no longer needed

8.7.0 (11 October 2019)

Features:

  • RxDB server can now be used with an existing express-app. #1448 Thanks @dstudzinski
  • Wrapped pouchdb conflict error into RxError

Other:

  • Fixed typings of RxError parameters
  • Fix GraphQL-example to propper use Websocket-Pub-Sub

8.6.0 (4 October 2019)

  • Migrated to typescript.
  • Fixed import of @types/pouchdb-core and @types/pouchdb-find

Bugfixes:

8.5.0 (18 September 2019)

Features:

  • Add ability to use server app as a part of bigger Express app #1448 Thanks @dstudzinski

Bugfixes:

Other:

  • Improved QueryChangeDetection to not run on irrelevant changes

8.4.0 (1 September 2019)

Bugfixes:

  • Fix imports of encryption-plugin to work with rollup #1413 Thanks @kenshyx
  • Removed express-pouchdb from the dependencies #884

8.3.1 (23 August 2019)

Features:

Bugfixes:

  • Attachments not working in electron renderer with IndexedDb adapter #1371 Thanks @rixo
  • json export/import not working when a document has attachments #1396 Thanks @rixo

Other:

  • Improved performance of query-change-detection by reusing the result of massageSelector

8.3.0 (5 August 2019)

Features:

Bugfixes:

  • .populate() returns findOne() on empty string. This results in a random find #1325 Thanks @PVermeer

8.2.1 (5 July 2019)

Features:

Bugfixes:

  • Collection change event was emitted before the actual change happened #1225. Thanks @milanpro

Typings:

  • ADD typings to access the PouchSyncHandler of RxReplicationState

8.2.0 (21 May 2019)

Bugfixes:

  • Vue devtools broke the application #1126

Typings:

  • RxDocument.getAttachment() and RxDocument.allAttachments() did not return promises
  • ADD RxJsonSchema generic for better TypeScript experience

8.1.0 (22 April 2019)

Bugfixes:

  • Server-plugin did not work with absolute paths and leveldb
  • Vue threw get is not a function when a RxDocument was added to a component's state
  • RxDocument.allAttachments() did throw an error when the document has no RxAttachment
  • RxDocument.toJSON(false) does no longer return the _attachments attribute

8.0.7 (6 April 2019)

Bugfixes:

  • Fix creating a collection mutates to arguments object #939
  • Fix not having optional encrypted fields in a document throws an error #917

8.0.6 (20 March 2019)

Features:

  • RxDocument().toJSON() can be called with .toJSON(false) and then returns not _rev attribute

Bugfixes:

  • (typings) Fix additionalProperties: boolean is allowed for nested objects
  • (typings) Fix RxQuery().toJSON()' was missing

8.0.5 (7 February 2019)

Bugfixes:

  • Calling remove() on a deleted RxDocument should return a rejected promise #830
  • Passing auto_compaction to a collection did not work via gitter
  • util missing in react-native #890

8.0.4 (13 November 2018)

Bugfixes:

  • Updated the dependencies with some bugfixes

8.0.3 (29. October 2018)

Bugfixes:

  • Reopening a database after using the wrong password did not work #837

8.0.2 (7. October 2018)

Features:

Bugfixes:

  • RxDB.removeDatabase() did not return a Promise #822. Thanks @will118

8.0.1 (21. September 2018)

Bugfixes:

  • Does not compile in TypeScript with strict flag enabled #448

8.0.0 (18. September 2018) BREAKING read the announcement

Breaking:

  • Upgraded to pouchdb 7.0.0
  • disableKeyCompression is renamed to keyCompression which defaults to false
  • RxDatabase.collection() now only accepts the json-schema as schema-attribute
  • It is no longer allowed to set required fields via required: true, use required: ['myfield'] in compliance with the jsonschema standard
  • QueryChangeDetection is not enabled in the RxDatabase-options queryChangeDetection: true
  • Setters and save() are only callable on temporary documents
  • Removed RxDocument.synced$ and RxDocument.resync()
  • Middleware-Hooks now have plainJson as first parameter and RxDocument-instance as second
  • Typings have been modified, see
  • postCreateRxDocument-hooks will not be awaited if they are async

Features:

  • Added RxDocument.atomicSet()
  • Added RxCollection.awaitPersistence() for in-memory-collections
  • Added RxReplicationState.denied$ #763
  • Added option for CORS to server-plugin
  • this-scope of collection-hooks are bound to the collection itself #788
  • All methods of RxDocument are bound to the instance #791
  • Added RxReplicationState.alive$, see. Thanks @rafamel

Bugfixes:

  • checkAdapter doesn't cleanup test databases #714
  • inMemory collections don't implement static methods #744
  • inMemory collections do not sync up removals #754
  • Ensure final fields cannot be changed on RxDocument.atomicUpdate() and RxDocument.update()
  • Fixed a missing dependency on the server-plugin

Other:

  • cross-instance communication is now done with https://github.com/pubkey/broadcast-channel (way better performance)
  • Upgrade to eslint 5 (no more babel-eslint)
  • Upgrade to babel7
  • Refactored plugins/replication/.watchForChanges() to fix sometimes-breaking-test with RxReplicationState.complete$
  • Split RxCollection.watchForChanges() into own plugin
  • Refactored RxQuery

7.7.1 (August 1, 2018)

Bugfixes:

Other

  • Moved @types/core-js to dev-dependencies #712
  • Added more example the the RxQuery-Docs #740 thanks @Celludriel

7.7.0 (July 6, 2018)

Bugfixes:

  • Indexes do not work in objects named "properties" #697
  • Wrong pouch-location when folderpath used for collection #677
  • Mutating a result-array from RxQuery.exec() or RxQuery.$ does not affect future calls #698#issuecomment-402604237

Other:

  • Updated Angular-Example to 6.0.5 Thanks @fuerst

7.6.1 (May 26, 2018)

Bugfixes:

  • Unhandled promise rejection with DOMException #644
  • Prevent bug with replication of internal pouchdb's #641
  • LocalDocument observe on field not working #661
  • Skip defining getter and setter when property not defined in schema #646
  • (typings) Fix type: 'object' not correctly recognized (via gitter at 2018 Mai 22 19:20)

7.6.0 (May 12, 2018)

Bugfixes:

  • Query cache is not being invalidated by replication #630

Other:

  • Updated to rxjs 6.0.0
  • Added integration tests for couchdb

7.5.1 (May 3, 2018)

Bugfixes:

Other:

  • Fixed typings for additionalProperties in schemas
  • Added performance-tests
  • Removed workarround for pouchdb#6733

Typings:

  • Added optional type for ORM-Methods

7.5.0 (April 24, 2018)

Features:

  • Added RxCollection.insert$, RxCollection.update$, RxCollection.remove$ read the docs

Other:

  • Added dangerousRemoveCollectionInfo() for migrations over rxdb-versions.
  • Improved typings for RxChangeEvent

7.4.4 (April 18, 2018)

Bugfixes:

  • Wrong index used when no sort specified #609

Other:

  • Improved typings of RxChangeEvent thx @hubgit

7.4.3 (April 7,2018)

Bugfixes:

  • Sort by sub object is not working #585
  • Encrypted attachments not working inside of electron-renderer #587
  • Schema fails with sub-sub-index #590
  • Default value not applied when the stored value is undefined #596

7.4.2 (March 22, 2018)

Bugfixes:

  • Wrong typings with custom build #576

Features:

  • Add option to add pouchSettings to all pouchdb-instances #567 Thx @EugeniaM

7.4.1 (March 11, 2018)

Bugfixes:

7.4.0 (March 9, 2018)

Features:

  • Added RxDatabase.server() to quickly spawn couchdb-compatibe endpoint out of RxDB. Read this
  • Use CustomIdleQueue for atomic updates to enable #494

Bugfixes:

7.3.3 (February 4, 2018)

Other:

  • Update to pouchdb version 6.4.3
  • Improve performance by using the profiler
  • Added typings for internal pouchdb-instance

7.3.2 (January 25, 2018)

Features:

Typings:

  • Fix RxCollection.findOne() can return null

Other:

7.3.1 (January 3, 2018)

Bugfixes:

  • Allow number-fields as index #438
  • Ensure typescript strict: true works #448

7.3.0 (December 18, 2017)

Features:

Bugfixes:

  • inMemory() throws error when using primary-key #401

Other:

  • Update to pouchdb 6.4.0
  • Optimize socket-pull by comparing internal last-change-time
  • do not hide fields with value: undefined in error-message #403

7.2.0 (December 7, 2017)

Warning:

  • Removed automatic import of pouchdb-adapter-memory for in-memory-collections. Read this

Features:

Bugfixes:

  • Query-Cache not used when declaring queries without mango-chain

Other:

  • Do not throw errors if the same plugin is added multiple times
  • Allow getting the collection via RxDatabase().collection(name: string)
  • Allow recreating the collection with different schema, if it has no documents
  • Split out error-messages into separate own plugin

7.1.1 (November 27, 2017)

Bugfixes:

  • Error on key-compression when nested value is null
  • Fix typings of RxDocument.putAttachment()

7.1.0 (November 22, 2017)

Other:

7.0.1 (November 14, 2017)

Bugfixes:

  • Include pouchdb-adapter-memory as dependency #365

7.0.0 (November 14, 2017)

Breaking:

  • Renamed ingoreDuplicate to ingoreDuplicate #314
  • Improved typings #329 by @ihadeed

Features:

Bugfixes:

  • Added error-message when you json-import on a non-existing collection #319
  • Allow windows-foldernames (with backslash) as collection-name 343

Other:

  • Split out idle-queue into own npm-module
  • Enfore usage of strict-equality via eslint

6.0.1 (September 20, 2017)

  • Fix core is not defined #296

6.0.0 (September 19, 2017) BREAKING

Breaking:

  • Filenames are now kebab-case
  • pouchdb-replication-plugin is now imported by default, do not import it by your own.
  • RxDB.create() throws if you create the same database twice. (You can use ignoreDuplicate)

Features:

Custom-Build:

  • Custom-build is now out of beta
  • If you use a custom-build, you have to change the import-paths. See custom-build
  • Replication is now its own module see
  • Json import/exportis now its own module see

Bugfixes:

  • Allow null-selector #267
  • RxQuery.exec() throws when out of change-event-buffer-bounds #278
  • Fix deprecated warning that sometimes occurs with indexeddb-adapter db.type()
  • Add fallback to leader-election when unload not works (mostly when you use RxDB inside of an iFrame)

Other:

  • Use RxError-class to throw Custom errors with the parameters-attribute
  • Optimize leader-election to not waste resources when many tabs open
  • Optimize schema-parsing when multiple collections have the same schema
  • Reduced build-size by only using async/await if it makes sense
  • Pre-Parse schema to validator when requestIdleCallback available
  • Optimize socket-cleanup by using requestIdlePromise
  • Added plugin-hook for preCreatePouchDb

5.3.0 (August 25, 2017)

Features:

Bugfixes:

  • RxQuery.or() did not work with KeyCompression #252

5.2.1 (July 17, 2017)

Quickfix because of new pouchdb-import

5.2.0 (July 17, 2017)

Features:

Other:

Bugfixes:

  • Settings values to null did not work on temporaryDocuments #215
  • RxDocument.atomicUpdate() did not run when reusing after a while
  • RxQuery.toString() was sometimes not predictable

WARNING: If you use RxDB with angular2||zone.js, you might have the error _global is not defined. Wait for the next zone.js release before updating RxDB.

5.1.0 (July 10, 2017)

Features:

  • Added instanceOf-checks

Bugfixes:

  • AutoMigrated caused infinity-loop #212
  • Minor bugs on the typings

Other:

  • Use requestIdleCallback on non-prio-tasks for better performance on browsers
  • Optimise socket-pull-intervall to not waste resources on slow devices
  • split out test-util from util to optimize build-size
  • remove lodash completely

5.0.0 (June 20, 2017) BREAKING

Features:

  • Added RxDocument.atomicUpdate() docs
  • Added RxCollection.remove() docs
  • Added RxDatabase.remove() docs
  • Added options for RxCollection.sync(): direction and pouchdb-replication-settings docs
  • Added query-param for RxCollection.sync() to allow selector-based replication docs
  • Added TemporaryDocuments RxCollection.newDocument() docs

Breaking:

  • postCreate-hooks can no longer be async
  • RxCollection.sync() completely changed docs

Other:

  • Added .babelrc to .npmignore
  • Added build-tests to travis

4.1.0 (June 7, 2017)

Features:

Bugfixes:

  • QueryCache returns old RxQuery when .regex() is used #190
  • RxDocument.resync() was broken 174

Other:

  • Throw error if RxQuery.sort() runs on field which is not in the schema #146
  • extract watchForChanges to allow custom sync-operations #197
  • Added travis-ci

4.0.2 (May 17, 2017)

Bugfixes:

  • Ensure es6-build does not contain es7-features
  • Ensure everything works after using UglifyJs

4.0.1 (May 17, 2017)

Bugfixes:

  • jsnext:main and module now point to es6 instead of es7-stage-0 commit issue
  • Sort on primary fails without non-id primary commit
  • QueryChangeDetection breaks on no-resort-optimisation commit

4.0.0 (May 5, 2017) BREAKING

Breaking:

  • RxQuery's are now immutable
  • RxQuery.$ does not emit null when running
  • RxQuery will sort by primary (ASC) as default

Features:

Other:

  • upgraded to pouchdb v6.2.0
  • re-executing queries while nothing happend to the collection, is now fetched

3.0.8 (April 20, 2017)

Bugfixes:

  • findOne().$ did not have limit:1
  • findOne(string).$ streams all documents when _id as primary

3.0.7 (April 10, 2017)

Bugfixes:

  • Fixed es6-imports for webpack-builds

3.0.6 (March 29, 2017)

Features:

Other:

  • improved typings

3.0.5 (March 21, 2017)

Bugfixes:

  • overwrites default selector on RxQuery.sort()

Other:

  • Refactor RxQuery for better performance
  • Refactor mquery for smaller build
  • More tests for RxQuery

3.0.4 (March 12, 2017)

Bugfixes:

  • Vuejs runs populate-getter on changedetection #75
  • isDeepEqual does not work correctly for Arrays #76
  • wrong storageEngine in the typings

3.0.3 (March 6, 2017)

Features:

Bugfixes:

3.0.2 (March 2, 2017)

Bugfixes:

  • compound-index not being created #68

3.0.1 (March 2, 2017)

Bugfixes:

  • new document does not get new state on remove-reinsert #66

3.0.0 (February 27, 2017) BREAKING

Features:

Bugfixes:

  • running RxDocument().save() twice did not work

Breaking:

  • Collection-names must match ^[a-z][a-z0-9]*$ Fixes #45
  • RxDB.create has new api with destructuring see
  • RxDatabase.collection() has new api with destructuring see
  • schema-fieldnames must match the regex: ^[a-zA-Z][[a-zA-Z0-9_]*]?[a-zA-Z0-9]$
  • RxDatabase.collection() only to create collection, use myDatabase.heroes to get existing one
  • RxDB.create() multiInstance is now true by default
  • rxjs and babel-polyfill are now peerDependencies

2.0.5 (February 25, 2017)

Features:

  • possibility to add pouchSettings when creating a collection
  • typings compatible with noImplicitAny Typescript projects

2.0.4 (February 12, 2017)

Bugfixes:

  • top-level array of document not working #50
  • event on document.remove() not fired at query-obserable #52

2.0.3 (January 31, 2017)

Features:

  • save full schema in internal database once

Bugfixes:

  • Throw when .findOne() is called with number or array
  • ADD babel-polyfill to dependencies #40

2.0.2 (January 27, 2017)

Bugfixes:

  • Throw when .regex() is used on primary

2.0.1 (January 26, 2017)

Refactor:

  • Because IE11 does not support the Proxy-Object, defineGetter/Setter is now used
  • Tests now run in all installed browsers

Bugfixes:

  • Fixed tests for IE11

2.0.0 (January 23, 2017) BREAKING

Features:

  • key-compression for better space-usage

Breaking:

  • schema-objects are now normalized (order alphabetic) before hashing
  • RxQuery.select() is removed since it has no better performance than getting the whole document
  • RxChangeEvent on sockets do no longer contain the documents-data for performance-reason
  • RxQuery.$ only emits when the result actually changes #31

Bugfixes:

  • console.dir on RxDocument now works

1.7.7 (January 13, 2017)

Features:

1.6.7 (January 11, 2017)

Features:

1.5.6 (December 22, 2016)

Bugfixes:

  • direct import 'url'-module for react native

1.5.5 (December 20, 2016)

Features:

  • refactor socket to save db-io
  • wrap BroadcastChannel-API
  • added leader-election
  • sync() will only start if db is leader

Bugfixes:

  • cleanup all databases after tests
  • remove broken builds from dist-folder