@dittolive/ditto 3.0.3 → 4.0.0-beta1

package/README.md

@@ -3,10 +3,10 @@
 *Ditto is a cross platform SDK that allows mobile, web, and IoT apps to sync
 with and even without connectivity.*
 
-Version: **3.0.3**
+Version: **4.0.0-beta1**
 
 Please visit [ditto.live](https://ditto.live) for more info as well as the
-[API Reference](https://software.ditto.live/js/Ditto/3.0.3/api-reference/) for this particular version.
+[API Reference](https://software.ditto.live/js/Ditto/4.0.0-beta1/api-reference/) for this particular version.
 
 --------------------------------------------------------------------------------
 

package/node/ditto.cjs.js

@@ -368,7 +368,7 @@ function ditto_collection_remove(...args) { return ditto.ditto_collection_remove
 function ditto_collection_remove_query_str(...args) { return ditto.ditto_collection_remove_query_str(...args) }
 function ditto_collection_update(...args) { return ditto.ditto_collection_update(...args) }
 function ditto_collection_update_multiple(...args) { return ditto.ditto_collection_update_multiple(...args) }
-function ditto_disable_sync_with_v2(...args) { return ditto.ditto_disable_sync_with_v2(...args) }
+function ditto_disable_sync_with_v3(...args) { return ditto.ditto_disable_sync_with_v3(...args) }
 function ditto_document_free(...args) { return ditto.ditto_document_free(...args) }
 function ditto_document_get_cbor_with_path_type(...args) { return ditto.ditto_document_get_cbor_with_path_type(...args) }
 function ditto_document_id(...args) { return ditto.ditto_document_id(...args) }
@@ -495,19 +495,19 @@ function mdnsServerFreeHandle(handle) {
 }
 // ------------------------------------------------------------- Document ------
 /** @internal */
-function documentSetCBORWithTimestamp(document, path, cbor, createPath, timestamp) {
+function documentSetCBORWithTimestamp(document, path, cbor, timestamp) {
     ensureInitialized();
     const pathX = bytesFromString(path);
-    const errorCode = ditto_document_set_cbor_with_timestamp(document, pathX, cbor, createPath, timestamp);
+    const errorCode = ditto_document_set_cbor_with_timestamp(document, pathX, cbor, timestamp);
     if (errorCode !== 0)
         throw new Error(errorMessage() || `ditto_document_set_cbor_with_timestamp() failed with error code: ${errorCode}`);
 }
 /** @internal */
-function documentSetCBOR(document, path, cbor, createPath) {
+function documentSetCBOR(document, path, cbor) {
     ensureInitialized();
     // NOTE: not sure if this should be async or not.
     const pathX = bytesFromString(path);
-    const errorCode = ditto_document_set_cbor(document, pathX, cbor, createPath);
+    const errorCode = ditto_document_set_cbor(document, pathX, cbor);
     if (errorCode !== 0)
         throw new Error(errorMessage() || `ditto_document_set_cbor() failed with error code: ${errorCode}`);
 }
@@ -1151,11 +1151,11 @@ function dittoRunGarbageCollection(dittoPointer) {
     return ditto_run_garbage_collection(dittoPointer);
 }
 /** @internal */
-async function dittoDisableSyncWithV2(dittoPointer) {
+async function dittoDisableSyncWithV3(dittoPointer) {
     ensureInitialized();
-    const errorCode = await ditto_disable_sync_with_v2(dittoPointer);
+    const errorCode = await ditto_disable_sync_with_v3(dittoPointer);
     if (errorCode !== 0)
-        throw new Error(errorMessage() || `ditto_disable_sync_with_v2() failed with error code: ${errorCode}`);
+        throw new Error(errorMessage() || `ditto_disable_sync_with_v3() failed with error code: ${errorCode}`);
 }
 // ------------------------------------------------------ Hash & Mnemonic ------
 /** @internal */
@@ -1434,7 +1434,7 @@ function awdlDestroy(awdl) {
 
 // NOTE: this is patched up with the actual build version by Jake task
 // build:package and has to be a valid semantic version as defined here: https://semver.org.
-const fullBuildVersionString = '3.0.3';
+const fullBuildVersionString = '4.0.0-beta1';
 
 //
 /**
@@ -3083,33 +3083,6 @@ class MutableRegister extends Register {
     }
 }
 
-//
-// Copyright © 2022 DittoLive Incorporated. All rights reserved.
-//
-/**
- * Represents a CRDT Replicated Growable Array (RGA).
- *
- * RGAs are deprecated and you should instead use a `Register` containing an
- * array.
- */
-class RGA {
-    /** The array representation of the RGA. */
-    get value() {
-        return this['@ditto.value'];
-    }
-    /** @internal */
-    constructor(array = []) {
-        this['@ditto.value'] = array;
-    }
-    /** @internal */
-    static '@ditto.create'(path, value) {
-        const rga = new RGA(value);
-        rga['@ditto.path'] = path;
-        rga['@ditto.value'] = value;
-        return rga;
-    }
-}
-
 //
 // Copyright © 2021 DittoLive Incorporated. All rights reserved.
 //
@@ -3164,10 +3137,6 @@ function augmentJSONValue(json, mutDoc, workingPath) {
         else if (json[DittoCRDTTypeKey] === DittoCRDTType.register) {
             return Register['@ditto.create'](mutDoc, workingPath, json[DittoCRDTValueKey]);
         }
-        else if (json[DittoCRDTTypeKey] === DittoCRDTType.rga) {
-            const augmentedValue = augmentJSONValue(json[DittoCRDTValueKey], mutDoc, workingPath);
-            return RGA['@ditto.create'](workingPath, augmentedValue);
-        }
         else if (json[DittoCRDTTypeKey] === DittoCRDTType.attachment) {
             return new AttachmentToken(json);
         }
@@ -3202,12 +3171,6 @@ function desugarJSObject(jsObj, atRoot = false) {
             registerJSON[DittoCRDTValueKey] = jsObj.value;
             return registerJSON;
         }
-        else if (jsObj instanceof RGA) {
-            const rgaJSON = {};
-            rgaJSON[DittoCRDTTypeKey] = DittoCRDTType.rga;
-            rgaJSON[DittoCRDTValueKey] = desugarJSObject(jsObj.value);
-            return rgaJSON;
-        }
         else if (jsObj instanceof Attachment) {
             const attachmentJSON = {
                 _id: jsObj.token.id,
@@ -3450,17 +3413,6 @@ class DocumentPath {
         const underlyingValue = this.underlyingValueForPathType('Register');
         return typeof underlyingValue !== 'undefined' ? Register['@ditto.create'](null, this.path, underlyingValue) : null;
     }
-    /**
-     * Returns the value at the previously specified key in the document as an
-     * {@link RGA} if possible, otherwise returns `null`.
-     *
-     * @deprecated RGA usage should be replaced. Use arrays inside Registers
-     * instead.
-     */
-    get rga() {
-        const underlyingValue = this.underlyingValueForPathType('Rga');
-        return typeof underlyingValue !== 'undefined' ? RGA['@ditto.create'](this.path, underlyingValue) : null;
-    }
     /**
      * Returns the value at the previously specified key in the document as an
      * {@link AttachmentToken} if possible, otherwise returns `null`.
@@ -3548,21 +3500,6 @@ class MutableDocumentPath {
         const underlyingValue = this.underlyingValueForPathType('Register');
         return typeof underlyingValue !== 'undefined' ? Register['@ditto.create'](this.mutableDocument, this.path, underlyingValue) : null;
     }
-    /**
-     * Returns the value at the previously specified key in the document as a
-     * {@link RGA} if possible, otherwise returns `null`.
-     *
-     * Note that the returned type, {@link RGA}, is deprecated and does not allow
-     * any mutation. RGAs cannot be created or mutated with this version of the
-     * SDK; they can only be read and this is for backwards compatibility reasons.
-     *
-     * @deprecated RGA usage should be replaced. Use arrays inside Registers
-     * instead.
-     */
-    get rga() {
-        const underlyingValue = this.underlyingValueForPathType('Rga');
-        return typeof underlyingValue !== 'undefined' ? RGA['@ditto.create'](this.path, underlyingValue) : null;
-    }
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link AttachmentToken} if possible, otherwise returns `null`.
@@ -3584,8 +3521,6 @@ class MutableDocumentPath {
     }
     /**
      * Removes a value at the document's key-path defined by the receiver.
-     * If removing an index from an `RGA`, any subsequent indexes will be shifted
-     * left to fill the gap.
      */
     remove() {
         return this['@ditto.remove']();
@@ -3619,10 +3554,10 @@ class MutableDocumentPath {
         const valueJSON = desugarJSObject(value, false);
         const valueCBOR = CBOR.encode(valueJSON);
         if (isDefault) {
-            documentSetCBORWithTimestamp(documentX, this.path, valueCBOR, true, 0);
+            documentSetCBORWithTimestamp(documentX, this.path, valueCBOR, 0);
         }
         else {
-            documentSetCBOR(documentX, this.path, valueCBOR, true);
+            documentSetCBOR(documentX, this.path, valueCBOR);
         }
         // HACK: we need a copy of value because the original value can be mutated
         // later on and an update result needs the state of the value at this
@@ -4957,18 +4892,19 @@ class PendingCollectionsOperation {
     // ----------------------------------------------------------- Internal ------
     /** @internal */
     _observe(handler, createSubscription, waitForNextSignal) {
-        const weakThis = new WeakRef(this);
+        const weakStore = new WeakRef(this.store);
         const collectionsObservationHandler = function (documents, event, nextSignal) {
-            const strongThis = weakThis.deref();
-            if (strongThis === null)
+            const strongStore = weakStore.deref();
+            if (!strongStore) {
                 return;
-            const collections = collectionsFromDocuments(documents, strongThis.store);
+            }
+            const collections = collectionsFromDocuments(documents, strongStore);
             let collEvent;
             if (event.isInitial === true) {
                 collEvent = CollectionsEvent.initial(collections);
             }
             else {
-                const oldCollections = collectionsFromDocuments(event.oldDocuments, strongThis.store);
+                const oldCollections = collectionsFromDocuments(event.oldDocuments, strongStore);
                 collEvent = new CollectionsEvent({
                     isInitial: false,
                     collections,
@@ -5894,16 +5830,16 @@ class Ditto {
     }
     /**
      * Explicitly opt-in to disabling the ability to sync with Ditto peers running
-     * any version of the SDK in the v2 series of releases.
+     * any version of the SDK in the v3 (or lower) series of releases.
      *
      * Assuming this succeeds then this peer will only be able to sync with other
-     * peers using SDKs in the v3 series of releases. Note that this disabling of
-     * sync spreads to peers that sync with a peer that has disabled, or has
-     * (transitively) had disabled, syncing with v2 SDK peers.
+     * peers using SDKs in the v4 (or higher) series of releases. Note that this
+     * disabling of sync spreads to peers that sync with a peer that has disabled,
+     * or has (transitively) had disabled, syncing with v3 SDK peers.
      */
-    disableSyncWithV2() {
+    disableSyncWithV3() {
         const dittoPointer = dittoBridge.pointerFor(this);
-        dittoDisableSyncWithV2(dittoPointer);
+        dittoDisableSyncWithV3(dittoPointer);
     }
     authClientValidityChanged(isWebValid, isX509Valid) {
         const transportConfig = this.transportConfig;
@@ -6048,7 +5984,6 @@ exports.PendingCollectionsOperation = PendingCollectionsOperation;
 exports.PendingCursorOperation = PendingCursorOperation;
 exports.PendingIDSpecificOperation = PendingIDSpecificOperation;
 exports.Presence = Presence;
-exports.RGA = RGA;
 exports.Register = Register;
 exports.SingleDocumentLiveQueryEvent = SingleDocumentLiveQueryEvent;
 exports.Store = Store;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittolive/ditto",
-  "version": "3.0.3",
+  "version": "4.0.0-beta1",
   "description": "Ditto is a cross-platform embeddable NoSQL database that can sync with or without an internet connection.",
   "homepage": "https://ditto.live",
   "license": "SEE LICENSE IN LICENSE.md",

package/types/ditto.d.ts

@@ -637,25 +637,6 @@ declare class MutableRegister extends Register {
     constructor(value: any);
 }
 
-/**
- * Represents a CRDT Replicated Growable Array (RGA).
- *
- * RGAs are deprecated and you should instead use a `Register` containing an
- * array.
- */
-declare class RGA {
-    /** The array representation of the RGA. */
-    get value(): any[];
-    /** @internal */
-    private constructor();
-    /** @internal */
-    static '@ditto.create'(path: any, value: any): RGA;
-    /** @internal */
-    protected '@ditto.path': any;
-    /** @internal */
-    protected '@ditto.value': any;
-}
-
 /**
  * Serves as a token for a specific attachment that you can pass to a call to
  * {@link Collection.fetchAttachment | fetchAttachment()} on a
@@ -723,14 +704,6 @@ declare class DocumentPath {
      * {@link Register} if possible, otherwise returns `null`.
      */
     get register(): Register | null;
-    /**
-     * Returns the value at the previously specified key in the document as an
-     * {@link RGA} if possible, otherwise returns `null`.
-     *
-     * @deprecated RGA usage should be replaced. Use arrays inside Registers
-     * instead.
-     */
-    get rga(): RGA | null;
     /**
      * Returns the value at the previously specified key in the document as an
      * {@link AttachmentToken} if possible, otherwise returns `null`.
@@ -787,18 +760,6 @@ declare class MutableDocumentPath {
      * {@link MutableRegister} if possible, otherwise returns `null`.
      */
     get register(): MutableRegister | null;
-    /**
-     * Returns the value at the previously specified key in the document as a
-     * {@link RGA} if possible, otherwise returns `null`.
-     *
-     * Note that the returned type, {@link RGA}, is deprecated and does not allow
-     * any mutation. RGAs cannot be created or mutated with this version of the
-     * SDK; they can only be read and this is for backwards compatibility reasons.
-     *
-     * @deprecated RGA usage should be replaced. Use arrays inside Registers
-     * instead.
-     */
-    get rga(): RGA | null;
     /**
      * Returns the value at the previously specified key in the document as a
      * {@link AttachmentToken} if possible, otherwise returns `null`.
@@ -815,8 +776,6 @@ declare class MutableDocumentPath {
     set(value: any, isDefault?: boolean): void;
     /**
      * Removes a value at the document's key-path defined by the receiver.
-     * If removing an index from an `RGA`, any subsequent indexes will be shifted
-     * left to fill the gap.
      */
     remove(): void;
     /** @internal */
@@ -2312,14 +2271,14 @@ declare class Ditto {
     runGarbageCollection(): void;
     /**
      * Explicitly opt-in to disabling the ability to sync with Ditto peers running
-     * any version of the SDK in the v2 series of releases.
+     * any version of the SDK in the v3 (or lower) series of releases.
      *
      * Assuming this succeeds then this peer will only be able to sync with other
-     * peers using SDKs in the v3 series of releases. Note that this disabling of
-     * sync spreads to peers that sync with a peer that has disabled, or has
-     * (transitively) had disabled, syncing with v2 SDK peers.
+     * peers using SDKs in the v4 (or higher) series of releases. Note that this
+     * disabling of sync spreads to peers that sync with a peer that has disabled,
+     * or has (transitively) had disabled, syncing with v3 SDK peers.
      */
-    disableSyncWithV2(): void;
+    disableSyncWithV3(): void;
     /** @internal */
     keepAlive: KeepAlive;
     private sync;
@@ -2640,5 +2599,5 @@ declare class CBOR {
     static decode(data: Uint8Array): any;
 }
 
-export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, Peer, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, Presence, PresenceConnectionType, PresenceGraph, QueryArguments, QueryObservationHandler, RGA, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, addressToString, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
+export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, CBOR, Collection, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, Identity, IdentityManual, IdentityOfflinePlayground, IdentityOnlinePlayground, IdentityOnlineWithAuthentication, IdentitySharedKey, IdentityTypesRequiringOfflineLicenseToken, InitOptions, KeepAlive, LiveQuery, LiveQueryEvent, LiveQueryEventInitial, LiveQueryEventUpdate, LiveQueryEventUpdateParams, LiveQueryMove, LogLevel, Logger, MutableCounter, MutableDocument, MutableDocumentPath, MutableRegister, NotAvailableAuthenticator, Observer, ObserverOptions, OnlineAuthenticator, Peer, PendingCollectionsOperation, PendingCursorOperation, PendingIDSpecificOperation, Presence, PresenceConnectionType, PresenceGraph, QueryArguments, QueryObservationHandler, Register, RemotePeer, SingleDocumentLiveQueryEvent, SingleObservationHandler, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, addressToString, attachmentBridge, dittoBridge, documentBridge, init, mutableDocumentBridge, validateDocumentIDCBOR, validateDocumentIDValue };
 //# sourceMappingURL=ditto.d.ts.map