@dittolive/ditto 4.7.4-rc.2 → 4.7.4

package/react-native/lib/module/ditto.rn.js.map

@@ -0,0 +1 @@
+{"version":3,"names":["NativeModules","Platform","FinalizationGroup","dittoCore","global","isLoaded","ditto_sdk_transports_init","_NativeModules$DittoR","result","DittoRNSDK","install","Error","setInterval","ditto_tick","FinalizationRegistry","platformName","select","ios","android","default","ditto_init_sdk_version","Object","keys","filter","key","forEach","exports","transportsErrorPointer","OS","res","ditto_sdk_transports_set_android_context","getMissingAndroidPermissions","ditto_sdk_transports_android_missing_permissions","boxCStringIntoString","something","boxCBytesIntoBuffer","cborBytes","bytes","sliceBoxedToUInt8Array","Uint8Array","getDeadlockTimeout","setDeadlockTimeout"],"sourceRoot":"../../src","sources":["ditto.rn.ts"],"mappings":"AAAA,SAASA,aAAa,EAAEC,QAAQ,QAAyB,cAAc;AACvE;;AAEA;AACA;AACA;AACA,SAASC,iBAAiB,QAAQ,iBAAiB;AACnD,OAAO,mCAAmC;;AAE1C;;AAEA;AACA;AACA;AAoBA,MAAMC,SAAS,GAAGC,MAAkC;AAEpD,MAAMC,QAAQ,GAAG,OAAOF,SAAS,CAACG,yBAAyB,KAAK,UAAU;AAC1E,IAAI,CAACD,QAAQ,EAAE;EAAA,IAAAE,qBAAA;EACb,MAAMC,MAAM,IAAAD,qBAAA,GAAGP,aAAa,CAACS,UAAU,cAAAF,qBAAA,uBAAxBA,qBAAA,CAA0BG,OAAO,CAAC,CAAC;EAElD,IAAI,CAACF,MAAM,EAAE;IACX,MAAM,IAAIG,KAAK,CAAC,wDAAwD,CAAC;EAC3E;;EAEA;EACA;EACA;EACAC,WAAW,CAAC,MAAM;IAChBT,SAAS,CAACU,UAAU,CAAC,CAAC;EACxB,CAAC,EAAE,EAAE,CAAC;;EAEN;EACA;EACA,IACE,OAAOT,MAAM,CAACU,oBAAoB,KAAK,WAAW,IAClD,OAAOZ,iBAAiB,KAAK,WAAW,EACxC;IACAE,MAAM,CAACU,oBAAoB,GAAGZ,iBAAiB;EACjD;EAEA,MAAMa,YAAiB,GAAGd,QAAQ,CAACe,MAAM,CAAC;IACxCC,GAAG,EAAE,KAAK;IACVC,OAAO,EAAE,SAAS;IAClBC,OAAO,EAAE;EACX,CAAC,CAAC;EAEFhB,SAAS,CAACiB,sBAAsB,CAACL,YAAY,EAAE,YAAY,EAAE,OAAO,CAAC;AACvE;;AAEA;AACAM,MAAM,CAACC,IAAI,CAACnB,SAAS;AACnB;AAAA,CACCoB,MAAM,CAAEC,GAAG,IAAKA,GAAG,KAAK,2BAA2B,CAAC,CACpDC,OAAO,CAAED,GAAG,IAAK;EAChBE,OAAO,CAACF,GAAG,CAAC,GAAGrB,SAAS,CAACqB,GAAG,CAAwB;AACtD,CAAC,CAAC;;AAEJ;AACA;AACA,OAAO,SAASlB,yBAAyBA,CACvCqB,sBAA2B,EAClB;EACT,IAAI1B,QAAQ,CAAC2B,EAAE,KAAK,SAAS,EAAE;IAC7B,MAAMC,GAAG,GAAG1B,SAAS,CAAC2B,wCAAwC,CAAC,CAAC;IAChE,IAAI,CAACD,GAAG,EAAE;MACR,MAAM,IAAIlB,KAAK,CACb,0FACF,CAAC;IACH;EACF;EACA,OAAOR,SAAS,CAACG,yBAAyB,CAACqB,sBAAsB,CAAC;AACpE;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASI,4BAA4BA,CAAA,EAAiB;EAC3D,IAAI9B,QAAQ,CAAC2B,EAAE,KAAK,SAAS,EAAE;IAC7B,OAAO,EAAE;EACX;EACA,OAAOzB,SAAS,CAAC6B,gDAAgD,CAAC,CAAC;AACrE;;AAEA;AACA;AACA;;AAEA,OAAO,SAASC,oBAAoBA,CAACC,SAAc,EAAE;EACnD,OAAOA,SAAS;AAClB;AAEA,OAAO,SAASC,mBAAmBA,CAACC,SAAc,EAAE;EAClD,MAAMC,KAAK,GAAGlC,SAAS,CAACmC,sBAAsB,CAACF,SAAS,CAAC;EACzD,OAAOC,KAAK,GAAG,IAAIE,UAAU,CAACF,KAAK,CAAC,GAAG,IAAI;AAC7C;AAEA,OAAO,SAASG,kBAAkBA,CAAA,EAAW;EAC3C,OAAO,CAAC;AACV;AAEA,OAAO,SAASC,kBAAkBA,CAACP,SAAc,EAAE;EACjD,OAAOA,SAAS;AAClB"}

package/react-native/lib/module/index.js

@@ -0,0 +1,27 @@
+// RN API
+
+export { getMissingAndroidPermissions } from './ditto.rn';
+
+// JS API
+
+export * from '../../sources/essentials';
+export * from '../../sources/logger';
+export * from '../../sources/document-id';
+export * from '../../sources/observer';
+export * from '../../sources/authenticator';
+export * from '../../sources/identity';
+export * from '../../sources/ditto';
+export * from '../../sources/store-observer';
+export * from '../../sources/sync';
+export * from '../../sources/sync-subscription';
+export * from '../../sources/error';
+export * from '../../sources/error-codes';
+export * from '../../sources/query-result-item';
+export * from '../../sources/query-result';
+export * from '../../sources/small-peer-info';
+export * from '../../sources/store';
+export * from '../../sources/presence';
+export * from '../../sources/transport-config';
+export * from '../../sources/epilogue';
+
+# sourceMappingURL=index.js.map

package/react-native/lib/module/index.js.map

@@ -0,0 +1 @@
+{"version":3,"names":[],"sourceRoot":"../../src","sources":["index.ts"],"mappings":"AAAA;;AAEA;;AAEA;;AAEA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA"}

package/react-native/lib/typescript/ditto.rn.d.ts

@@ -0,0 +1,15 @@
+import { type Permission } from 'react-native';
+import 'fastestsmallesttextencoderdecoder';
+export declare function ditto_sdk_transports_init(transportsErrorPointer: any): boolean;
+/**
+ * Get the list of missing Android permissions for syncing. The returned value
+ * can be passed directly to `PermissionsAndroid.requestMultiple()`.
+ *
+ * Returns an empty array on other platforms.
+ */
+export declare function getMissingAndroidPermissions(): Permission[];
+export declare function boxCStringIntoString(something: any): any;
+export declare function boxCBytesIntoBuffer(cborBytes: any): Uint8Array | null;
+export declare function getDeadlockTimeout(): number;
+export declare function setDeadlockTimeout(something: any): any;
+//# sourceMappingURL=ditto.rn.d.ts.map

package/react-native/lib/typescript/ditto.rn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ditto.rn.d.ts","sourceRoot":"","sources":["../../src/ditto.rn.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAOxE,OAAO,mCAAmC,CAAC;AAuE3C,wBAAgB,yBAAyB,CACvC,sBAAsB,EAAE,GAAG,GAC1B,OAAO,CAUT;AAED;;;;;GAKG;AACH,wBAAgB,4BAA4B,IAAI,UAAU,EAAE,CAK3D;AAMD,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,GAAG,OAElD;AAED,wBAAgB,mBAAmB,CAAC,SAAS,EAAE,GAAG,qBAGjD;AAED,wBAAgB,kBAAkB,IAAI,MAAM,CAE3C;AAED,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,GAAG,OAEhD"}

package/react-native/lib/typescript/index.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=index.d.ts.map

package/react-native/lib/typescript/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":""}

package/react-native/src/ditto.rn.ts

@@ -0,0 +1,123 @@
+import { NativeModules, Platform, type Permission } from 'react-native';
+
+import { FinalizationGroup } from '@ungap/weakrefs';
+import 'fastestsmallesttextencoderdecoder';
+
+import { type Language, type Platform as SDKPlatform } from './sources/ffi';
+
+interface JSSDKAPI {
+  /* C++ methods */
+  ditto_sdk_transports_init(transportsErrorPointer: any): boolean;
+  ditto_init_sdk_version(
+    platform: SDKPlatform,
+    language: Language,
+    semVer: string
+  ): number;
+  sliceBoxedToUInt8Array(cborBytes: any): Uint8Array | null;
+  sliceRefToUInt8Array(cborBytes: any): Uint8Array | null;
+}
+interface PlatformSpecificAPI {
+  getRandomValues<T extends ArrayBufferView>(array: T): T;
+  ditto_tick(): void;
+  createDirectory(path: string): string;
+  readFile(path: string): string;
+  copyFile(source: string, destination: string, dittoPath: string): string;
+  checkDirectoryExists(path: string): string;
+  defaultDeviceName(): string;
+
+  // Android only
+  ditto_sdk_transports_set_android_context(): boolean;
+  ditto_sdk_transports_android_missing_permissions(): string[];
+}
+
+type DittoCoreType = JSSDKAPI & PlatformSpecificAPI;
+const dittoCore = global as unknown as DittoCoreType;
+
+const isLoaded = typeof dittoCore.ditto_sdk_transports_init === 'function';
+if (!isLoaded) {
+  const result = NativeModules.DittoRNSDK?.install();
+
+  if (!result) {
+    throw new Error('JSI bindings were not installed for: DittoRNSDK Module');
+  }
+
+  setInterval(() => {
+    dittoCore.ditto_tick();
+  }, 50);
+
+  if (
+    typeof global.FinalizationRegistry === 'undefined' &&
+    typeof FinalizationGroup !== 'undefined'
+  ) {
+    global.FinalizationRegistry = FinalizationGroup;
+  }
+
+  const platformName: SDKPlatform = Platform.select({
+    ios: 'Ios',
+    android: 'Android',
+    default: 'Unknown',
+  });
+
+  dittoCore.ditto_init_sdk_version(
+    platformName,
+    'JavaScript',
+    '4.7.0-rc.1'
+  );
+}
+
+// Export JSI methods.
+Object.keys(dittoCore)
+  // we will provide our own decorated implementation.
+  .filter((key) => key !== 'ditto_sdk_transports_init')
+  .forEach((key) => {
+    exports[key] = dittoCore[key as keyof DittoCoreType];
+  });
+
+export function ditto_sdk_transports_init(
+  transportsErrorPointer: any
+): boolean {
+  if (Platform.OS === 'android') {
+    const res = dittoCore.ditto_sdk_transports_set_android_context();
+    if (!res) {
+      throw new Error(
+        "Couldn't manage to set Android context with `ditto_sdk_transports_set_android_context()`"
+      );
+    }
+  }
+  return dittoCore.ditto_sdk_transports_init(transportsErrorPointer);
+}
+
+/**
+ * Get the list of missing Android permissions for syncing. The returned value
+ * can be passed directly to `PermissionsAndroid.requestMultiple()`.
+ *
+ * Returns an empty array on other platforms.
+ */
+export function getMissingAndroidPermissions(): Permission[] {
+  if (Platform.OS !== 'android') {
+    return [];
+  }
+  return dittoCore.ditto_sdk_transports_android_missing_permissions() as Permission[];
+}
+
+//
+// Needed as for JS SDK API's.
+//
+
+export function boxCBytesIntoBuffer(cborBytes: any): Uint8Array | null {
+  const bytes = dittoCore.sliceBoxedToUInt8Array(cborBytes);
+  return bytes ? new Uint8Array(bytes) : null;
+}
+
+export function refCBytesIntoBuffer(cborBytes: any): Uint8Array | null {
+  const bytes = dittoCore.sliceRefToUInt8Array(cborBytes);
+  return bytes ? new Uint8Array(bytes) : null;
+}
+
+export function getDeadlockTimeout(): number {
+  return 0;
+}
+
+export function setDeadlockTimeout(something: any) {
+  return something;
+}

package/react-native/src/environment/environment.fallback.ts

@@ -0,0 +1,4 @@
+export const isReactNativeBuild = true
+export const isNodeBuild = false
+export const isWebBuild = false
+

package/react-native/src/index.ts

@@ -0,0 +1,29 @@
+export { getMissingAndroidPermissions } from './ditto.rn';
+
+export * from './sources/essentials';
+
+export * from './sources/attachment-token';
+export * from './sources/attachment';
+export * from './sources/attachment-fetcher';
+export * from './sources/attachment-fetch-event';
+export * from './sources/init';
+export * from './sources/logger';
+export * from './sources/document-id';
+export * from './sources/observer';
+
+export * from './sources/authenticator';
+export * from './sources/identity';
+export * from './sources/ditto';
+export * from './sources/store-observer';
+export * from './sources/sync';
+export * from './sources/sync-subscription';
+export * from './sources/error';
+export * from './sources/error-codes';
+export * from './sources/query-result-item';
+export * from './sources/query-result';
+export * from './sources/small-peer-info';
+export * from './sources/store';
+export * from './sources/presence';
+export * from './sources/transport-config';
+export * from './sources/epilogue';
+export * from './sources/connection-request';

package/react-native/src/sources/@cbor-redux.ts

@@ -0,0 +1,2 @@
+import * as CBOR from 'cbor-redux';
+export {CBOR};

package/react-native/src/sources/@ditto.core.ts

@@ -0,0 +1 @@
+export * from '@dittolive/ditto/react-native/src/ditto.rn';

package/react-native/src/sources/@environment.ts

@@ -0,0 +1 @@
+export * from '@dittolive/ditto/react-native/src/environment/environment.fallback';

package/react-native/src/sources/attachment-fetch-event.ts

@@ -0,0 +1,54 @@
+//
+// Copyright © 2021 DittoLive Incorporated. All rights reserved.
+//
+
+import type { Attachment } from './attachment'
+import type { Store } from './store'
+
+/**
+ * The types of attachment fetch events that can be delivered to an attachment
+ * fetcher's `callback`.
+ */
+export type AttachmentFetchEventType = 'Completed' | 'Progress' | 'Deleted'
+
+/**
+ * An attachment fetch event used when the attachment's download has completed.
+ */
+export type AttachmentFetchEventCompleted = {
+  type: 'Completed'
+  attachment: Attachment
+}
+
+/**
+ * An attachment fetch event used when the attachment's download progressed but
+ * is not yet complete.
+ */
+export type AttachmentFetchEventProgress = {
+  type: 'Progress'
+  totalBytes: number | BigInt
+  downloadedBytes: number | BigInt
+}
+
+/**
+ * An attachment fetch event used when the attachment is deleted.
+ */
+export type AttachmentFetchEventDeleted = {
+  type: 'Deleted'
+}
+
+/**
+ * A representation of the events that can occur in relation to an attachment
+ * fetch.
+ *
+ * There are three different attachment fetch events: `Completed`, `Progress`,
+ * or `Deleted`.
+ *
+ * There will be at most one `Completed` or `Deleted` event per attachment
+ * fetch. There can be many `Progress` events delivered for each attachment
+ * fetch.
+ *
+ * Updates relating to an attachment fetch are delivered by registering an
+ * {@link AttachmentFetcher} through a call to
+ * {@link Store["fetchAttachment"] | ditto.store.fetchAttachment()}.
+ */
+export type AttachmentFetchEvent = AttachmentFetchEventCompleted | AttachmentFetchEventProgress | AttachmentFetchEventDeleted

package/react-native/src/sources/attachment-fetcher-manager.ts

@@ -0,0 +1,145 @@
+//
+// Copyright © 2023 DittoLive Incorporated. All rights reserved.
+//
+
+import * as FFI from './ffi'
+
+import { AttachmentFetcher } from './attachment-fetcher'
+import { AttachmentToken } from './attachment-token'
+import { Bridge } from './bridge'
+
+import type { AttachmentFetchEvent } from './attachment-fetch-event'
+import type { Ditto } from './ditto'
+
+/** @internal */
+type AttachmentFetcherContextInfo = {
+  attachmentFetcher: WeakRef<AttachmentFetcher>
+  // Attachment token is unique per attachment.
+  attachmentTokenID: Uint8Array
+  // This id is unique per attachment fetcher.
+  id: string
+  // Promise for a token that can be used to cancel the fetch. If `null`, the
+  // fetch has already completed, errored, or been canceled.
+  cancelTokenPromise: Promise<number | BigInt | null> | null
+}
+
+/**
+ * Manages attachment fetchers to make sure we free all resources when the
+ * fetcher is garbage collected and to allow us to wait for freeing of
+ * ressources to be finished before the ditto instance is closed.
+ *
+ * @internal
+ */
+export class AttachmentFetcherManager {
+  readonly ditto: Ditto
+
+  /** @internal */
+  constructor(ditto: Ditto) {
+    this.ditto = ditto
+  }
+
+  /**
+   * Start an attachment fetcher.
+   *
+   * @internal */
+  startAttachmentFetcher(token: AttachmentToken, eventHandler?: (attachmentFetchEvent: AttachmentFetchEvent) => void): AttachmentFetcher {
+    return this.ditto.deferClose(() => {
+      const attachmentFetcher = new AttachmentFetcher(this.ditto, token, this, eventHandler)
+
+      // Register in finalization registry.
+      const contextInfo: AttachmentFetcherContextInfo = {
+        id: attachmentFetcher.id,
+        attachmentTokenID: token.idBytes,
+        cancelTokenPromise: attachmentFetcher.cancelTokenPromise,
+        attachmentFetcher: new WeakRef(attachmentFetcher),
+      }
+      this.finalizationRegistry.register(attachmentFetcher, contextInfo, attachmentFetcher)
+
+      // Keep a reference to the context info so that we can stop the fetcher.
+      this.contextInfoByID[attachmentFetcher.id] = contextInfo
+
+      // Prevent cancellation of the fetch once it was fulfilled or rejected.
+      const resetCancelToken = () => {
+        if (this.contextInfoByID[attachmentFetcher.id] != null) {
+          this.contextInfoByID[attachmentFetcher.id].cancelTokenPromise = null
+        }
+      }
+      attachmentFetcher.attachment.then(
+        (value) => {
+          resetCancelToken()
+          return value
+        },
+        (reason) => {
+          resetCancelToken()
+          return reason
+        },
+      )
+
+      // Keep the attachment fetcher alive until it is stopped.
+      this.ditto.keepAlive.retain(`AttachmentFetcher.${attachmentFetcher.id})`)
+
+      return attachmentFetcher
+    })
+  }
+
+  /**
+   * Stop an attachment fetcher and wait for it to be stopped.
+   *
+   * @internal */
+  async stopAttachmentFetcher(attachmentFetcher: AttachmentFetcher): Promise<void> {
+    this.finalizationRegistry.unregister(attachmentFetcher)
+    const contextInfo = this.contextInfoByID[attachmentFetcher.id]
+    if (contextInfo == null) {
+      throw new Error(`Internal inconsistency: cannot stop attachment fetcher ${attachmentFetcher.id}, which is not registered.`)
+    }
+    await this.stopWithContextInfo(contextInfo)
+  }
+
+  /**
+   * Closing the manager will cancel all attachment fetchers.
+   *
+   * @internal
+   */
+  close() {
+    void this.ditto.deferCloseAsync(async () => {
+      const contextInfos = Object.values(this.contextInfoByID)
+      const stopped = contextInfos.map(async (contextInfo) => {
+        const attachmentFetcher = contextInfo.attachmentFetcher.deref()
+        if (attachmentFetcher != null) {
+          await this.stopAttachmentFetcher(attachmentFetcher)
+        }
+      })
+      await Promise.all(stopped)
+    })
+  }
+
+  // --- Private ---
+
+  private contextInfoByID: { [attachmentFetcherID: string]: AttachmentFetcherContextInfo } = {}
+
+  private finalizationRegistry: FinalizationRegistry<AttachmentFetcherContextInfo> = new FinalizationRegistry(this.stopWithContextInfo)
+
+  /**
+   * Stop the attachment fetcher without unregistering it from the finalization
+   * registry.
+   */
+  private stopWithContextInfo(contextInfo: AttachmentFetcherContextInfo): Promise<void> {
+    const dittoHandle = Bridge.ditto.handleFor(this.ditto)
+    return this.ditto.deferCloseAsync(async () => {
+      // Remove the manager's own record of the context info.
+      if (this.contextInfoByID[contextInfo.id] == null) {
+        throw new Error(`Internal inconsistency: attachment fetcher ${contextInfo.id} not found in active attachment fetchers.`)
+      }
+      delete this.contextInfoByID[contextInfo.id]
+
+      // Release the keep-alive.
+      this.ditto.keepAlive.release(`AttachmentFetcher.${contextInfo.id})`)
+
+      // Cancel the fetcher if it is still running.
+      const cancelToken = await contextInfo.cancelTokenPromise
+      if (cancelToken) {
+        FFI.dittoCancelResolveAttachment(dittoHandle.deref(), contextInfo.attachmentTokenID, cancelToken)
+      }
+    })
+  }
+}