@dittolive/ditto 4.5.0 → 4.5.1

package/DittoReactNative.podspec

@@ -15,13 +15,14 @@ Pod::Spec.new do |s|
 
   s.platforms    = { :ios => "14.0" }
 
-  s.source = { :http => 'https://software.ditto.live/react-native/ditto/4.5.0/ios/DittoReactNative.xcframework.tar.gz' }
-  s.vendored_frameworks = "DittoReactNative.xcframework"
+  s.source = { :http => 'https://software.ditto.live/react-native/ditto/4.5.1/ios/DittoReactNative.xcframework.tar.gz' }
 
   include_local_boost(s)
 
-  s.source_files = "react-native/ios/**/*.{h,m,mm}", "react-native/cpp/**/*.{h,cpp,hpp}"
+  s.source_files = "react-native/ios/**/*.{h,m,mm}", "react-native/cpp/**/*.{h,cpp,hpp}",
   s.public_header_files = 'react-native/dittoffi/dittoffi.h', 'react-native/dittoffi/ifaddrs.h'
 
   s.dependency "React-Core"
+  s.dependency 'DittoReactNativeIOS'
+
 end

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.5.0**
+Version: **4.5.1**
 
 For more information please visit [ditto.live](https://ditto.live), as well as the
-[API Reference](https://software.ditto.live/js/Ditto/4.5.0/api-reference/) for this particular version.
+[API Reference](https://software.ditto.live/js/Ditto/4.5.1/api-reference/) for this particular version.
 
 ---
 

package/node/ditto.cjs.js

@@ -439,6 +439,8 @@ function websocket_client_free_handle(...args) { return ditto.websocket_client_f
 function withOutBoxCBytes(...args) { return ditto.withOutBoxCBytes(...args) }
 function withOutPtr$1(...args) { return ditto.withOutPtr(...args) }
 
+const isWebBuild = false;
+
 //
 // Copyright © 2023 DittoLive Incorporated. All rights reserved.
 //
@@ -1785,7 +1787,7 @@ class AttachmentToken {
 
 // 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.5.0-transports-behind-core';
+const fullBuildVersionString = '4.5.1-transports-behind-core';
 
 //
 // Copyright © 2021 DittoLive Incorporated. All rights reserved.
@@ -7819,7 +7821,7 @@ class Sync {
     // ---------------------------------------------------------- Internal ------
     /** @internal */
     get parameters() {
-        return this._parameters;
+        return this.state.underlyingSyncParameters;
     }
     /** @internal */
     constructor(ditto) {
@@ -7842,7 +7844,6 @@ class Sync {
         const transportConfig = new TransportConfig();
         const parameters = { identity, transportConfig, ditto, isWebValid: false, isX509Valid: false, isSyncActive: false };
         this.ditto = ditto;
-        this._parameters = parameters;
         this.state = stateFrom(parameters);
         transportsInit();
     }
@@ -7886,15 +7887,14 @@ class Sync {
     }
     /** @internal */
     update(parameters) {
-        this._parameters = { ...parameters };
         // NOTE: updating is a two-step process. Given all parameters, we
         // first compute the final "state" we want the transports stuff to
         // be in via the `stateFrom()` function. We then take that "desired" state
         // and feed it into the various update methods, which essentially perform
-        // a diff on the state before and after, and update the low-lever transports
+        // a diff on the state before and after, and update the low-level transports
         // machinery accordingly.
         const stateOld = this.state;
-        const stateNew = stateFrom(this.parameters);
+        const stateNew = stateFrom(parameters);
         this.updatePeerToPeerBluetoothLE(stateOld, stateNew);
         this.updatePeerToPeerAWDL(stateOld, stateNew);
         this.updatePeerToPeerLAN(stateOld, stateNew);
@@ -8107,31 +8107,78 @@ class Sync {
     }
 }
 /**
+ * Computes the effective transport config given a desired transport config and
+ * some additional state.
+ *
+ * Disables all transports that are unavailable due to the runtime environment
+ * or authentication requirements. Adds websocket URL for Ditto Cloud if
+ * enabled.
+ *
+ * Throws if the target transport config enables sync but contains transports
+ * that are not available in the current environment. Does not throw when
+ * transports are enabled but not available due to authentication requirements.
+ *
  * @private
  */
 function stateFrom(parameters) {
-    const ditto = parameters.ditto;
+    // IMPORTANT: this function maps a set of sync parameters to an effective
+    // transport config plus some extra state where need be. Make sure
+    // to keep this function free of side-effects.
+    var _a, _b;
+    const identity = parameters.identity;
+    const isSyncActive = parameters.isSyncActive;
+    const isX509Valid = parameters.isX509Valid;
+    const isWebValid = parameters.isWebValid;
+    let appID;
+    let customDittoCloudURL;
+    let isDittoCloudSyncEnabled = false;
+    if (identity.type === 'onlinePlayground' || identity.type === 'onlineWithAuthentication') {
+        // NOTE: enableDittoCloudSync is true by default for any online identity.
+        appID = identity.appID;
+        customDittoCloudURL = (_a = identity.customDittoCloudURL) !== null && _a !== void 0 ? _a : null;
+        isDittoCloudSyncEnabled = (_b = identity.enableDittoCloudSync) !== null && _b !== void 0 ? _b : true;
+    }
+    validateEnabledTransportsAvailable(parameters.ditto, parameters.transportConfig);
+    const transportConfig = parameters.transportConfig.copy();
+    if (!isSyncActive || !isX509Valid) {
+        transportConfig.peerToPeer.bluetoothLE.isEnabled = false;
+        transportConfig.peerToPeer.awdl.isEnabled = false;
+        transportConfig.peerToPeer.lan.isEnabled = false;
+        transportConfig.listen.tcp.isEnabled = false;
+        transportConfig.connect.tcpServers = [];
+    }
+    if (!isSyncActive || !isWebValid) {
+        transportConfig.connect.websocketURLs = [];
+    }
+    if (!isSyncActive) {
+        transportConfig.listen.http.isEnabled = false;
+    }
+    // NOTE: we have to smuggle in an additional Ditto Cloud websocket URL to
+    // connect to if cloud sync is enabled.
+    if (isSyncActive && isWebValid && isDittoCloudSyncEnabled) {
+        // @ts-ignore To fix this type error, refactor using a switch
+        // statement, c.f.
+        // https://github.com/getditto/ditto/blob/d35b6c1cb280cdd6368d14137c97609b9b9b9296/js/sources/sync.ts#L488
+        const dittoCloudURL = customDittoCloudURL !== null && customDittoCloudURL !== void 0 ? customDittoCloudURL : defaultDittoCloudURL(appID);
+        transportConfig.connect.websocketURLs.push(dittoCloudURL);
+    }
+    return {
+        underlyingSyncParameters: parameters,
+        effectiveTransportConfig: transportConfig.freeze(),
+    };
+}
+/**
+ * Validate that all enabled transports are available in the current environment
+ * and throw an error if not.
+ *
+ * @private
+ */
+function validateEnabledTransportsAvailable(ditto, transportConfig) {
     const dittoHandle = Bridge.ditto.handleFor(ditto);
     return ditto.deferClose(() => {
-        // IMPORTANT: this function maps a set of sync parameters to an effective
-        // transport config plus some extra state where need be. Make sure
-        // to keep this function free of side-effects.
-        var _a, _b;
-        const transportConfig = parameters.transportConfig.copy();
-        const identity = parameters.identity;
-        const isSyncActive = parameters.isSyncActive;
-        const isX509Valid = parameters.isX509Valid;
-        const isWebValid = parameters.isWebValid;
-        let appID;
-        let customDittoCloudURL;
-        let isDittoCloudSyncEnabled = false;
-        if (identity.type === 'onlinePlayground' || identity.type === 'onlineWithAuthentication') {
-            // NOTE: enableDittoCloudSync is true by default for any online identity.
-            appID = identity.appID;
-            customDittoCloudURL = (_a = identity.customDittoCloudURL) !== null && _a !== void 0 ? _a : null;
-            isDittoCloudSyncEnabled = (_b = identity.enableDittoCloudSync) !== null && _b !== void 0 ? _b : true;
-        }
-        // Not all P2P transports are always supported.
+        // - BLE
+        // - AWDL
+        // - LAN / mDNS
         const unavailableButEnabledP2PTransports = [];
         const isBLEAvailable = transportsBLEIsAvailable(dittoHandle.deref());
         const isAWDLAvailable = transportsAWDLIsAvailable(dittoHandle.deref());
@@ -8148,29 +8195,17 @@ function stateFrom(parameters) {
         if (unavailableButEnabledP2PTransports.length > 0) {
             throw new Error(`The following P2P transports are enabled in the transport config but are not supported in the current environment: ${unavailableButEnabledP2PTransports.join(', ')}`);
         }
-        if (!isSyncActive || !isX509Valid) {
-            transportConfig.peerToPeer.bluetoothLE.isEnabled = false;
-            transportConfig.peerToPeer.awdl.isEnabled = false;
-            transportConfig.peerToPeer.lan.isEnabled = false;
-            transportConfig.listen.tcp.isEnabled = false;
-            transportConfig.connect.tcpServers = [];
-        }
-        if (!isSyncActive || !isWebValid) {
-            transportConfig.connect.websocketURLs = [];
+        // - Websocket / HTTP
+        // - TCP
+        if (transportConfig.connect.tcpServers.length > 0 && isWebBuild) {
+            throw new Error(`The transport config contains TCP servers, but this transport is not supported in web environments`);
         }
-        if (!isSyncActive) {
-            transportConfig.listen.http.isEnabled = false;
+        if (transportConfig.listen.http.isEnabled && isWebBuild) {
+            throw new Error(`The transport config contains an HTTP listener, which is not supported in web environments`);
         }
-        // NOTE: we have to smuggle in an additional Ditto Cloud websocket URL to
-        // connect to if cloud sync is enabled.
-        if (isSyncActive && isWebValid && isDittoCloudSyncEnabled) {
-            const dittoCloudURL = customDittoCloudURL !== null && customDittoCloudURL !== void 0 ? customDittoCloudURL : defaultDittoCloudURL(appID);
-            transportConfig.connect.websocketURLs.push(dittoCloudURL);
+        if (transportConfig.listen.tcp.isEnabled && isWebBuild) {
+            throw new Error(`The transport config contains a TCP listener, which is not supported in web environments`);
         }
-        return {
-            underlyingSyncParameters: parameters,
-            effectiveTransportConfig: transportConfig.freeze(),
-        };
     });
 }
 
@@ -8790,13 +8825,12 @@ class Ditto {
         else {
             this.auth = new NotAvailableAuthenticator(this.keepAlive);
         }
-        const transportConfig = this.makeDefaultTransportConfig();
+        const transportConfig = this.makeDefaultTransportConfig().freeze();
         //
         // Assign instance properties.
         //
         this.appID = appID;
         this.siteID = siteID;
-        this._transportConfig = transportConfig.copy().freeze();
         this.isX509Valid = isX509Valid;
         this.isWebValid = isWebValid;
         this.sync = new Sync(this);
@@ -8997,7 +9031,7 @@ class Ditto {
      * @see {@link updateTransportConfig | updateTransportConfig()}
      */
     get transportConfig() {
-        return this._transportConfig;
+        return this.sync.parameters.transportConfig;
     }
     /**
      * Assigns a new transports configuration. By default peer-to-peer transports
@@ -9009,8 +9043,7 @@ class Ditto {
      * @see {@link updateTransportConfig | updateTransportConfig()}
      */
     setTransportConfig(transportConfig) {
-        this._transportConfig = transportConfig.copy().freeze();
-        const transportConfigNew = this.transportConfig;
+        const transportConfigNew = transportConfig.copy().freeze();
         const identity = this.identity;
         const isWebValid = this.isWebValid;
         const isX509Valid = this.isX509Valid;

package/package.json

@@ -1,29 +1,29 @@
 {
-  "author" : {
-    "email" : "contact@ditto.live",
-    "name" : "DittoLive Incorporated.",
-    "url" : "https://ditto.live"
+  "author": {
+    "email": "contact@ditto.live",
+    "name": "DittoLive Incorporated.",
+    "url": "https://ditto.live"
   },
-  "browser" : "web/ditto.es6.js",
-  "browser/umd" : "web/ditto.umd.js",
-  "browserslist" : [
+  "browser": "web/ditto.es6.js",
+  "browser/umd": "web/ditto.umd.js",
+  "browserslist": [
     "defaults"
   ],
-  "dependencies" : {
-    "@ungap/weakrefs" : "^0.2.0",
-    "cbor-js" : "^0.1.0",
-    "cbor-redux" : "^1.0.0",
-    "fastestsmallesttextencoderdecoder" : "^1.0.22"
+  "dependencies": {
+    "@ungap/weakrefs": "^0.2.0",
+    "cbor-js": "^0.1.0",
+    "cbor-redux": "^1.0.0",
+    "fastestsmallesttextencoderdecoder": "^1.0.22"
   },
-  "description" : "Ditto is a cross-platform embeddable NoSQL database that can sync with or without an internet connection.",
-  "devDependencies" : {
-    "serve" : "^14.2.0"
+  "description": "Ditto is a cross-platform embeddable NoSQL database that can sync with or without an internet connection.",
+  "devDependencies": {
+    "serve": "^14.2.0"
   },
-  "engines" : {
-    "node" : ">=14"
+  "engines": {
+    "node": ">=14"
   },
-  "homepage" : "https://ditto.live",
-  "keywords" : [
+  "homepage": "https://ditto.live",
+  "keywords": [
     "ditto",
     "dittolive",
     "webassembly",
@@ -33,14 +33,14 @@
     "sync",
     "p2p"
   ],
-  "license" : "SEE LICENSE IN LICENSE.md",
-  "main" : "node/ditto.cjs.js",
-  "name" : "@dittolive/ditto",
-  "react-native" : "react-native/src/index.ts",
-  "scripts" : {
-    "play:node" : "node --experimental-repl-await --unhandled-rejections=strict playground.cjs",
-    "play:web" : "npx serve --listen 5285"
+  "license": "SEE LICENSE IN LICENSE.md",
+  "main": "node/ditto.cjs.js",
+  "name": "@dittolive/ditto",
+  "react-native": "react-native/src/index.ts",
+  "scripts": {
+    "play:node": "node --experimental-repl-await --unhandled-rejections=strict playground.cjs",
+    "play:web": "npx serve --listen 5285"
   },
-  "types" : "types/ditto.d.ts",
-  "version" : "4.5.0"
-}
+  "types": "types/ditto.d.ts",
+  "version": "4.5.1"
+}