@dittolive/ditto 4.4.2 → 4.4.4

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: **4.4.2**
+Version: **4.4.4**
 
 Please visit [ditto.live](https://ditto.live) for more info as well as the
-[API Reference](https://software.ditto.live/js/Ditto/4.4.2/api-reference/) for this particular version.
+[API Reference](https://software.ditto.live/js/Ditto/4.4.4/api-reference/) for this particular version.
 
 --------------------------------------------------------------------------------
 

package/node/ditto.cjs.js

@@ -376,6 +376,10 @@ function ditto_set_static_tcp_clients(...args) { return ditto.ditto_set_static_t
 function ditto_set_static_websocket_clients(...args) { return ditto.ditto_set_static_websocket_clients(...args) }
 function ditto_set_sync_group(...args) { return ditto.ditto_set_sync_group(...args) }
 function ditto_shutdown(...args) { return ditto.ditto_shutdown(...args) }
+function ditto_small_peer_info_get_is_enabled(...args) { return ditto.ditto_small_peer_info_get_is_enabled(...args) }
+function ditto_small_peer_info_get_sync_scope(...args) { return ditto.ditto_small_peer_info_get_sync_scope(...args) }
+function ditto_small_peer_info_set_enabled(...args) { return ditto.ditto_small_peer_info_set_enabled(...args) }
+function ditto_small_peer_info_set_sync_scope(...args) { return ditto.ditto_small_peer_info_set_sync_scope(...args) }
 function ditto_small_peer_info_set_transport_config_data(...args) { return ditto.ditto_small_peer_info_set_transport_config_data(...args) }
 function ditto_start_http_server(...args) { return ditto.ditto_start_http_server(...args) }
 function ditto_start_tcp_server(...args) { return ditto.ditto_start_tcp_server(...args) }
@@ -1035,6 +1039,26 @@ async function dittoClearPresenceV3Callback(self) {
     ditto_clear_presence_v3_callback(self);
 }
 /** @internal */
+function dittoSmallPeerInfoGetIsEnabled(dittoPointer) {
+    ensureInitialized();
+    return ditto_small_peer_info_get_is_enabled(dittoPointer);
+}
+/** @internal */
+async function dittoSmallPeerInfoSetEnabled(dittoPointer, isEnabled) {
+    ensureInitialized();
+    ditto_small_peer_info_set_enabled(dittoPointer, isEnabled);
+}
+/** @internal */
+async function dittoSmallPeerInfoGetSyncScope(dittoPointer) {
+    ensureInitialized();
+    return ditto_small_peer_info_get_sync_scope(dittoPointer);
+}
+/** @internal */
+async function dittoSmallPeerInfoSetSyncScope(dittoPointer, syncScope) {
+    ensureInitialized();
+    return ditto_small_peer_info_set_sync_scope(dittoPointer, syncScope);
+}
+/** @internal */
 async function dittoSmallPeerInfoCollectionSetTransportConfigData(self, transportConfigData) {
     ensureInitialized();
     ditto_small_peer_info_set_transport_config_data(self, transportConfigData);
@@ -1521,7 +1545,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 = '4.4.2';
+const fullBuildVersionString = '4.4.4';
 
 //
 // Copyright © 2021 DittoLive Incorporated. All rights reserved.
@@ -7868,6 +7892,81 @@ class AttachmentFetcherManager {
     }
 }
 
+//
+// Copyright © 2023 DittoLive Incorporated. All rights reserved.
+//
+/**
+ * The entrypoint for small peer user info collection. Small peer info consists of information
+ * gathered into a system collection on a regular interval and optionally synced to the Big Peer
+ * for device dashboard and debugging purposes.
+ *
+ * You don't create this class directly, but can access it from a particular `Ditto`
+ * instance via its {@link Ditto.smallPeerInfo | `smallPeerInfo`} property.
+ */
+class SmallPeerInfo {
+    /**
+     * Indicates whether small peer info collection is currently enabled, defaults
+     * to `false`.
+     *
+     * Note: whether the background ingestion process is enabled or not is a
+     * separate decision to whether this information is allowed to sync to other
+     * peers (including the big peer). This is controlled by
+     * {@link getSyncScope | getSyncScope()} and
+     * {@link setSyncScope | setSyncScope()}.
+     */
+    get isEnabled() {
+        const dittoHandle = Bridge.ditto.handleFor(this.ditto);
+        return this.ditto.deferClose(() => {
+            return dittoSmallPeerInfoGetIsEnabled(dittoHandle.deref());
+        });
+    }
+    /**
+     * Set whether small peer info collection is enabled.
+     *
+     * @throws when set to a non-boolean value.
+     */
+    set isEnabled(newValue) {
+        if (typeof newValue !== 'boolean') {
+            throw new TypeError(`Expected boolean, got ${typeof newValue}`);
+        }
+        const dittoHandle = Bridge.ditto.handleFor(this.ditto);
+        this.ditto.deferClose(() => {
+            dittoSmallPeerInfoSetEnabled(dittoHandle.deref(), newValue);
+        });
+    }
+    /**
+     * Determines which "kind" of peers the small peer info will be
+     * replicated to.
+     *
+     * Defaults to `LocalPeerOnly`, which means no replication. Set this to
+     * `BigPeerOnly` to replicate collected info to the Big Peer.
+     */
+    async getSyncScope() {
+        const dittoHandle = Bridge.ditto.handleFor(this.ditto);
+        return this.ditto.deferCloseAsync(async () => {
+            return dittoSmallPeerInfoGetSyncScope(dittoHandle.deref());
+        });
+    }
+    /**
+     * Set the sync scope.
+     *
+     * See {@link getSyncScope} for more information.
+     *
+     * @param syncScope the new sync scope.
+     * @throws when set to a value other than `BigPeerOnly` or `LocalPeerOnly`.
+     */
+    async setSyncScope(syncScope) {
+        const dittoHandle = Bridge.ditto.handleFor(this.ditto);
+        return this.ditto.deferCloseAsync(async () => {
+            return dittoSmallPeerInfoSetSyncScope(dittoHandle.deref(), syncScope);
+        });
+    }
+    /** @internal */
+    constructor(ditto) {
+        this.ditto = ditto;
+    }
+}
+
 //
 // Copyright © 2021 DittoLive Incorporated. All rights reserved.
 //
@@ -8045,6 +8144,7 @@ class Ditto {
         // mark the instance as activated from the get-go in that case.
         this.isActivated = !IdentityTypesRequiringOfflineLicenseToken.includes(validIdentity.type);
         this.store = new Store(this);
+        this.smallPeerInfo = new SmallPeerInfo(this);
         this.presence = new Presence(this);
         this.presenceManager = new PresenceManager(this);
         this.liveQueryManager = new LiveQueryManager(this, this.keepAlive);
@@ -8709,6 +8809,7 @@ exports.PendingIDSpecificOperation = PendingIDSpecificOperation;
 exports.Presence = Presence;
 exports.Register = Register;
 exports.SingleDocumentLiveQueryEvent = SingleDocumentLiveQueryEvent;
+exports.SmallPeerInfo = SmallPeerInfo;
 exports.Store = Store;
 exports.Subscription = Subscription;
 exports.TransportConfig = TransportConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dittolive/ditto",
-  "version": "4.4.2",
+  "version": "4.4.4",
   "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

@@ -1866,6 +1866,63 @@ declare class AttachmentFetcherManager {
     private stopWithContextInfo;
 }
 
+/**
+ * Specifies which peers to replicate the small peer info to when enabled.
+ *
+ * Possible values are:
+ *
+ * - `LocalPeerOnly`: no replication (default)
+ * - `BigPeerOnly`: replicate to the Big Peer
+ */
+type SmallPeerInfoSyncScope = 'LocalPeerOnly' | 'BigPeerOnly';
+/**
+ * The entrypoint for small peer user info collection. Small peer info consists of information
+ * gathered into a system collection on a regular interval and optionally synced to the Big Peer
+ * for device dashboard and debugging purposes.
+ *
+ * You don't create this class directly, but can access it from a particular `Ditto`
+ * instance via its {@link Ditto.smallPeerInfo | `smallPeerInfo`} property.
+ */
+declare class SmallPeerInfo {
+    /**
+     * Indicates whether small peer info collection is currently enabled, defaults
+     * to `false`.
+     *
+     * Note: whether the background ingestion process is enabled or not is a
+     * separate decision to whether this information is allowed to sync to other
+     * peers (including the big peer). This is controlled by
+     * {@link getSyncScope | getSyncScope()} and
+     * {@link setSyncScope | setSyncScope()}.
+     */
+    get isEnabled(): boolean;
+    /**
+     * Set whether small peer info collection is enabled.
+     *
+     * @throws when set to a non-boolean value.
+     */
+    set isEnabled(newValue: boolean);
+    /**
+     * Determines which "kind" of peers the small peer info will be
+     * replicated to.
+     *
+     * Defaults to `LocalPeerOnly`, which means no replication. Set this to
+     * `BigPeerOnly` to replicate collected info to the Big Peer.
+     */
+    getSyncScope(): Promise<SmallPeerInfoSyncScope>;
+    /**
+     * Set the sync scope.
+     *
+     * See {@link getSyncScope} for more information.
+     *
+     * @param syncScope the new sync scope.
+     * @throws when set to a value other than `BigPeerOnly` or `LocalPeerOnly`.
+     */
+    setSyncScope(syncScope: SmallPeerInfoSyncScope): Promise<void>;
+    private ditto;
+    /** @internal */
+    constructor(ditto: Ditto);
+}
+
 /** Types of connections that can be established between two peers. */
 type TransportCondition = 'Unknown' | 'OK' | 'GenericFailure' | 'AppInBackground' | 'MDNSFailure' | 'TCPListenFailure' | 'NoBLECentralPermission' | 'NoBLEPeripheralPermission' | 'CannotEstablishConnection' | 'BLEDisabled' | 'NoBLEHardware' | 'WiFiDisabled' | 'TemporarilyUnavailable';
 /** The source for a transport condition. */
@@ -1937,6 +1994,10 @@ declare class Ditto {
      * The site ID that the instance of `Ditto` is using as part of its identity.
      */
     readonly siteID: number | BigInt;
+    /**
+     * Provides access to the SDK's small peer info functionality.
+     */
+    readonly smallPeerInfo: SmallPeerInfo;
     /**
      * Returns `true` if an offline license token has been set, otherwise returns `false`.
      *
@@ -3421,5 +3482,5 @@ declare class CBOR {
     static decode(data: Uint8Array): any;
 }
 
-export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, BasePendingCursorOperation, BasePendingIDSpecificOperation, CBOR, ChangeHandler, ChangeHandlerWithSignalNext, Collection, CollectionInterface, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, ErrorHandler, ExperimentalChangeListener, ExperimentalChangeListenerManager, ExperimentalChangeListenerStatus, ExperimentalReplicationSubscription, ExperimentalReplicationSubscriptionContextInfo, ExperimentalReplicationSubscriptionManager, ExperimentalStore, 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, WriteTransaction, WriteTransactionCollection, WriteTransactionPendingCursorOperation, WriteTransactionPendingIDSpecificOperation, WriteTransactionResult, addressToString, checkAPIs, disableDeadlockTimeoutWhenDebugging, getBridgeLoad, init, transportConfigFromDeserializable, transportConfigToSerializable, validateDocumentIDCBOR, validateDocumentIDValue };
+export { Address, Attachment, AttachmentFetchEvent, AttachmentFetchEventCompleted, AttachmentFetchEventDeleted, AttachmentFetchEventProgress, AttachmentFetchEventType, AttachmentFetcher, AttachmentToken, AuthenticationHandler, AuthenticationStatus, Authenticator, BasePendingCursorOperation, BasePendingIDSpecificOperation, CBOR, ChangeHandler, ChangeHandlerWithSignalNext, Collection, CollectionInterface, CollectionsEvent, CollectionsEventParams, CollectionsObservationHandler, ConditionSource, Connection, ConnectionType, Counter, CustomLogCallback, Ditto, Document, DocumentID, DocumentIDValue, DocumentPath, DocumentValue, ErrorHandler, ExperimentalChangeListener, ExperimentalChangeListenerManager, ExperimentalChangeListenerStatus, ExperimentalReplicationSubscription, ExperimentalReplicationSubscriptionContextInfo, ExperimentalReplicationSubscriptionManager, ExperimentalStore, 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, SmallPeerInfo, SmallPeerInfoSyncScope, SortDirection, Store, Subscription, TransportCondition, TransportConfig, TransportConfigConnect, TransportConfigGlobal, TransportConfigLan, TransportConfigListen, TransportConfigListenHTTP, TransportConfigListenTCP, TransportConfigPeerToPeer, UpdateResult, UpdateResultType, UpdateResultsMap, UpsertOptions, Value, WebAssemblyModule, WriteStrategy, WriteTransaction, WriteTransactionCollection, WriteTransactionPendingCursorOperation, WriteTransactionPendingIDSpecificOperation, WriteTransactionResult, addressToString, checkAPIs, disableDeadlockTimeoutWhenDebugging, getBridgeLoad, init, transportConfigFromDeserializable, transportConfigToSerializable, validateDocumentIDCBOR, validateDocumentIDValue };
 //# sourceMappingURL=ditto.d.ts.map