@evolu/react-native 15.0.2 → 16.0.1

package/src/Task.test.ts

@@ -0,0 +1,82 @@
+import {
+  assertEqual,
+  assertLength,
+  assertNonNullable,
+  assertThrows,
+  assertTrue,
+  testStubGlobal,
+} from "@evolu/common";
+import { describe, it, mock } from "node:test";
+import { createRun } from "./Task.ts";
+
+describe("createRun", () => {
+  it("createRun reports defects with ErrorUtils.reportError", async () => {
+    const reportError = mock.fn<(error: unknown) => void>();
+    using _errorUtils = testStubGlobal("ErrorUtils", {
+      getGlobalHandler: () => null,
+      setGlobalHandler:
+        mock.fn<NonNullable<typeof ErrorUtils>["setGlobalHandler"]>(),
+      reportError,
+    });
+    await using run = createRun();
+    const defect = new Error("boom");
+
+    run.panic(defect);
+
+    assertEqual(reportError.mock.callCount(), 1);
+    const reported = reportError.mock.calls[0]?.arguments[0];
+    assertNonNullable(reported);
+    assertTrue(typeof reported === "object");
+    assertEqual(Reflect.get(reported, "reason"), {
+      type: "PanicAbortReason",
+      defect,
+    });
+  });
+
+  it("createRun preserves a custom reportDefect", async () => {
+    const reportError =
+      mock.fn<NonNullable<typeof ErrorUtils>["reportError"]>();
+    const reportDefect = mock.fn();
+    using _errorUtils = testStubGlobal("ErrorUtils", {
+      getGlobalHandler: () => null,
+      setGlobalHandler:
+        mock.fn<NonNullable<typeof ErrorUtils>["setGlobalHandler"]>(),
+      reportError,
+    });
+    await using run = createRun({ reportDefect });
+
+    run.panic(new Error("boom"));
+
+    assertEqual(reportDefect.mock.callCount(), 1);
+    assertEqual(reportError.mock.callCount(), 0);
+  });
+
+  it("createRun falls back when ErrorUtils is unavailable", async (t) => {
+    using _errorUtils = testStubGlobal("ErrorUtils", undefined);
+    assertTrue(Reflect.deleteProperty(globalThis, "ErrorUtils"));
+    const callbacks: Array<() => void> = [];
+    t.mock.method(globalThis, "queueMicrotask", (callback: () => void) => {
+      callbacks.push(callback);
+    });
+    await using run = createRun();
+
+    run.panic(new Error("boom"));
+
+    assertLength(callbacks, 1);
+    assertThrows(callbacks[0], (reported) => {
+      assertNonNullable(reported);
+      assertTrue(typeof reported === "object");
+      const reason = Reflect.get(reported, "reason");
+      assertNonNullable(reason);
+      assertTrue(typeof reason === "object");
+      assertEqual(Reflect.get(reason, "type"), "PanicAbortReason");
+    });
+  });
+
+  it("creates a run", async () => {
+    await using run = createRun();
+
+    assertNonNullable(run);
+    assertNonNullable(run.deps);
+  });
+});

package/src/Task.ts

@@ -23,6 +23,7 @@ import {
  *
  * ```ts
  * import {
+ *   assertSame,
  *   createConsole,
  *   createConsoleFormatter,
  *   ok,
@@ -38,7 +39,7 @@ import {
  * await using run = createRun({ console });
  * const appPromise = run.ok(() => ok("started"));
  *
- * expect(await appPromise).toBe("started");
+ * assertSame(await appPromise, "started");
  * ```
  */
 export function createRun(): DisposableRun;
@@ -51,8 +52,12 @@ export function createRun<D extends object>(
   deps?: RunCustomDeps<D>,
 ): DisposableRun | DisposableRun<D> {
   const reportDefect = (reported: unknown): void => {
-    if (globalThis.ErrorUtils) globalThis.ErrorUtils.reportError(reported);
-    else reportDefectAfterMicrotask(reported);
+    if (globalThis.ErrorUtils) {
+      // oxlint-disable-next-line evolu/no-unnecessary-global-this -- Report through the React Native host API on the global object even if a realm lexical binding shadows it.
+      globalThis.ErrorUtils.reportError(reported);
+    } else {
+      reportDefectAfterMicrotask(reported);
+    }
   };
 
   return deps === undefined

package/src/components/EvoluIdenticon.tsx

@@ -10,7 +10,7 @@ export const EvoluIdenticon: FC<{
   style?: IdenticonStyle;
 }> = ({ id, size = 32, borderRadius = 3, style }) => {
   const svg = useMemo(() => createIdenticon(id, style), [id, style]);
-  return id ? (
+  return (
     <View
       style={{
         width: size,
@@ -21,5 +21,5 @@ export const EvoluIdenticon: FC<{
     >
       <SvgXml xml={svg} width={size} height={size} />
     </View>
-  ) : null;
+  );
 };

package/src/exports/expo-sqlite.ts

@@ -2,7 +2,8 @@
  * Public entry point for Expo SQLite. Exported as
  * "@evolu/react-native/expo-sqlite" in package.json.
  *
- * Use this with Expo projects that use expo-sqlite.
+ * Use this with Expo projects and existing React Native projects configured
+ * with Expo modules.
  */
 
 import type { ConsoleDep } from "@evolu/common";
@@ -20,11 +21,3 @@ export const createEvoluDeps = (deps: Partial<ConsoleDep> = {}): EvoluDeps =>
       void Expo.reloadAppAsync();
     },
   });
-
-// import { createExpoDeps } from "../createExpoDeps.ts";
-// import { createExpoSqliteDriver } from "../sqlite-drivers/createExpoSqliteDriver.ts";
-//
-// // eslint-disable-next-line evolu/require-pure-annotation
-// export const { evoluReactNativeDeps, localAuth } = createExpoDeps({
-//   createSqliteDriver: createExpoSqliteDriver,
-// });

package/src/shared.ts

@@ -56,7 +56,7 @@ export const createEvoluDeps = (
   };
 
   const createDbWorker: CreateDbWorker = (): DbWorker =>
-    createWorker<DbWorkerInit, never>((self) => {
+    createWorker<DbWorkerInit>((self) => {
       const dbWorkerRun = createWorkerRun();
       void dbWorkerRun(startDbWorker(self));
     });
@@ -82,52 +82,3 @@ export const createEvoluDeps = (
     sharedWorker,
   });
 };
-
-// TODO: Reimplement local auth for React Native from scratch.
-// export const createSharedLocalAuth = (
-//   secureStorage: SecureStorage,
-// ): LocalAuth =>
-//   createLocalAuth({
-//     randomBytes,
-//     secureStorage,
-//   });
-
-// import {
-//   createConsole,
-//   createLocalAuth,
-//   createRandomBytes,
-//   type CreateSqliteDriverDep,
-//   type LocalAuth,
-//   type ReloadAppDep,
-//   type SecureStorage,
-// } from "@evolu/common";
-// import type {
-//   // createDbWorkerForPlatform,
-//   // createDbWorkerForPlatform,
-//   EvoluDeps,
-// } from "@evolu/common/local-first";
-//
-// const _console = createConsole();
-// const randomBytes = createRandomBytes();
-//
-// export const createSharedEvoluDeps = (
-//   _deps: CreateSqliteDriverDep & ReloadAppDep,
-// ): EvoluDeps => {
-//   throw new Error("todo");
-// };
-//
-//   ({
-//   ...deps,
-//   console,
-//   sharedWorker: "TODO" as never,
-//   // createDbWorker: () =>
-//   //   createDbWorkerForPlatform({
-//   //     ...deps,
-//   //     console,
-//   //     createWebSocket,
-//   //     random: createRandom(),
-//   //     randomBytes,
-//   //     time: createTime(),
-//   //   }),
-//   randomBytes,
-// });

package/src/sqlite-drivers/createExpoSqliteDriver.ts

@@ -8,6 +8,7 @@ import {
 import {
   deleteDatabaseSync,
   openDatabaseSync,
+  type SQLiteBindValue,
   type SQLiteStatement,
 } from "expo-sqlite";
 
@@ -39,7 +40,10 @@ export const createExpoSqliteDriver: CreateSqliteDriver =
     return ok({
       exec: (query) => {
         const execStatement = (statement: SQLiteStatement) => {
-          const result = statement.executeSync(query.parameters);
+          // Expo only reads the array, but its parameter type is mutable.
+          const result = statement.executeSync(
+            query.parameters as Array<SQLiteBindValue>,
+          );
           try {
             const rows = result.getAllSync();
             const changes = result.changes;

package/dist/src/createExpoDeps.d.ts

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

package/dist/src/createExpoDeps.d.ts.map

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

package/dist/src/createExpoDeps.js

@@ -1,163 +0,0 @@
-"use strict";
-// import type {
-//   AccessControl,
-//   LocalAuthOptions,
-//   SecureStorage,
-//   SensitiveInfoItem,
-//   StorageMetadata,
-// } from "@evolu/common";
-// import {
-//   type CreateSqliteDriverDep,
-//   type LocalAuth,
-//   localAuthDefaultOptions,
-//   type ReloadApp,
-// } from "@evolu/common";
-// import type { EvoluDeps } from "@evolu/common/local-first";
-// import * as Expo from "expo";
-// import * as SecureStore from "expo-secure-store";
-// import KVStore from "expo-sqlite/kv-store";
-// import { createSharedEvoluDeps, createSharedLocalAuth } from "./shared.ts";
-// const reloadApp: ReloadApp = () => {
-//   void Expo.reloadAppAsync();
-// };
-//
-// const createSecureStore = (): SecureStorage => {
-//   const store: SecureStorage = {
-//     setItem: async (key, value, options) => {
-//       const rnsiOpts = convertOptions(options);
-//       const service = options?.service ?? "default";
-//       const metadata = createMetadata(options?.accessControl === "none");
-//       await KVStore.setItem(`${service}-${key}`, "1");
-//       await SecureStore.setItemAsync(
-//         key,
-//         JSON.stringify({ value, metadata }),
-//         rnsiOpts,
-//       );
-//       return { metadata };
-//     },
-//
-//     getItem: async (key, options) => {
-//       const rnsiOpts = convertOptions(options);
-//       const service = options?.service ?? "default";
-//       let data: { value: string; metadata: StorageMetadata };
-//       try {
-//         const result = await SecureStore.getItemAsync(key, rnsiOpts);
-//         if (!result) return null;
-//         data = JSON.parse(result) as {
-//           value: string;
-//           metadata: StorageMetadata;
-//         };
-//       } catch (_error) {
-//         return null;
-//       }
-//       return { key, service, ...data };
-//     },
-//
-//     deleteItem: async (key, options) => {
-//       const rnsiOpts = convertOptions(options);
-//       const service = options?.service ?? "default";
-//       await Promise.all([
-//         KVStore.removeItemAsync(`${service}-${key}`),
-//         SecureStore.deleteItemAsync(key, rnsiOpts),
-//       ]);
-//       return true;
-//     },
-//
-//     getAllItems: async (options) => {
-//       const keys = await KVStore.getAllKeysAsync();
-//       const service = options?.service ?? "default";
-//       const metadata = createMetadata(options?.accessControl === "none");
-//       return keys
-//         .filter((key) => key.startsWith(`${service}-`))
-//         .map((key) => ({
-//           key: key.slice(service.length + 1),
-//           service,
-//           metadata,
-//         }));
-//     },
-//
-//     clearService: async (options) => {
-//       const rnsiOpts = convertOptions(options);
-//       const service = options?.service ?? "default";
-//       const items = await store.getAllItems(options);
-//       await KVStore.multiRemove(items.map((item) => `${service}-${item.key}`));
-//       await Promise.all(
-//         items.map(async (item) => {
-//           await SecureStore.deleteItemAsync(item.key, rnsiOpts);
-//         }),
-//       );
-//     },
-//   };
-//
-//   return store;
-// };
-// /**
-//  * Create default metadata for backwards compatibility with items that don't
-//  * have stored metadata.
-//  */
-// const createMetadata = (isSecure = true): SensitiveInfoItem["metadata"] => ({
-//   backend: "keychain",
-//   accessControl: isSecure ? "biometryCurrentSet" : "none",
-//   securityLevel: isSecure ? "biometry" : "software",
-//   timestamp: Date.now(),
-// });
-//
-// const convertOptions = (
-//   options?: LocalAuthOptions,
-// ): SecureStore.SecureStoreOptions => {
-//   const accessGroup =
-//     options?.keychainGroup ?? localAuthDefaultOptions.keychainGroup ?? "";
-//   const keychainService =
-//     options?.service ?? localAuthDefaultOptions.service ?? "";
-//   const keychainAccessible = convertKeychainAccessible(
-//     options?.accessControl ??
-//       localAuthDefaultOptions.accessControl ??
-//       "biometryCurrentSet",
-//   );
-//   const authenticationPrompt =
-//     options?.authenticationPrompt?.title ??
-//     localAuthDefaultOptions.authenticationPrompt?.title ??
-//     "";
-//   return {
-//     accessGroup,
-//     keychainService,
-//     keychainAccessible,
-//     authenticationPrompt,
-//     requireAuthentication: options?.accessControl !== "none",
-//   };
-// };
-//
-// const convertKeychainAccessible = (
-//   accessControl: AccessControl,
-// ): SecureStore.KeychainAccessibilityConstant => {
-//   switch (accessControl) {
-//     case "none":
-//       // eslint-disable-next-line @typescript-eslint/no-deprecated
-//       return SecureStore.ALWAYS;
-//     case "biometryCurrentSet":
-//       return SecureStore.AFTER_FIRST_UNLOCK;
-//     case "biometryAny":
-//       return SecureStore.AFTER_FIRST_UNLOCK;
-//     case "devicePasscode":
-//       return SecureStore.AFTER_FIRST_UNLOCK;
-//     case "secureEnclaveBiometry":
-//       return SecureStore.AFTER_FIRST_UNLOCK;
-//     // Exhaustive check
-//     default:
-//       accessControl satisfies never;
-//       // Default (for typescript, should never hit)
-//       return SecureStore.AFTER_FIRST_UNLOCK;
-//   }
-// };
-//
-// const localAuth = createSharedLocalAuth(createSecureStore());
-//
-// export const createExpoDeps = (
-//   deps: CreateSqliteDriverDep,
-// ): { evoluReactNativeDeps: EvoluDeps; localAuth: LocalAuth } => ({
-//   evoluReactNativeDeps: createSharedEvoluDeps({
-//     ...deps,
-//     reloadApp,
-//   }),
-//   localAuth,
-// });

package/dist/src/exports/bare-op-sqlite.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=bare-op-sqlite.d.ts.map

package/dist/src/exports/bare-op-sqlite.d.ts.map

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

package/dist/src/exports/bare-op-sqlite.js

@@ -1,31 +0,0 @@
-"use strict";
-// /**
-//  * Public entry point for bare React Native with OP-SQLite. Exported as
-//  * "@evolu/react-native/bare-op-sqlite" in package.json.
-//  *
-//  * Use this with bare React Native projects (not Expo) that use
-//  * `@op-engineering/op-sqlite`.
-//  */
-//
-// import { type ReloadApp } from "@evolu/common";
-// import { DevSettings } from "react-native";
-// import { SensitiveInfo } from "react-native-sensitive-info";
-// import { createSharedEvoluDeps, createSharedLocalAuth } from "../shared.ts";
-// import { createOpSqliteDriver } from "../sqlite-drivers/createOpSqliteDriver.ts";
-//
-// const reloadApp: ReloadApp = () => {
-//   if (process.env.NODE_ENV === "development") {
-//     DevSettings.reload();
-//   } else {
-//     // TODO: reload not implemented for bare rn
-//   }
-// };
-//
-// // eslint-disable-next-line evolu/require-pure-annotation
-// export const evoluReactNativeDeps = createSharedEvoluDeps({
-//   createSqliteDriver: createOpSqliteDriver,
-//   reloadApp,
-// });
-//
-// // eslint-disable-next-line evolu/require-pure-annotation
-// export const localAuth = createSharedLocalAuth(SensitiveInfo);

package/dist/src/exports/expo-op-sqlite.d.ts

@@ -1 +0,0 @@
-//# sourceMappingURL=expo-op-sqlite.d.ts.map

package/dist/src/exports/expo-op-sqlite.d.ts.map

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

package/dist/src/exports/expo-op-sqlite.js

@@ -1,16 +0,0 @@
-"use strict";
-// /**
-//  * Public entry point for Expo with OP-SQLite. Exported as
-//  * "@evolu/react-native/expo-op-sqlite" in package.json.
-//  *
-//  * Use this with Expo projects that use `@op-engineering/op-sqlite` for better
-//  * performance.
-//  */
-//
-// import { createExpoDeps } from "../createExpoDeps.ts";
-// import { createOpSqliteDriver } from "../sqlite-drivers/createOpSqliteDriver.ts";
-//
-// // eslint-disable-next-line evolu/require-pure-annotation
-// export const { evoluReactNativeDeps, localAuth } = createExpoDeps({
-//   createSqliteDriver: createOpSqliteDriver,
-// });

package/dist/src/sqlite-drivers/createOpSqliteDriver.d.ts

@@ -1,3 +0,0 @@
-import { type CreateSqliteDriver } from "@evolu/common";
-export declare const createOpSqliteDriver: CreateSqliteDriver;
-//# sourceMappingURL=createOpSqliteDriver.d.ts.map

package/dist/src/sqlite-drivers/createOpSqliteDriver.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"createOpSqliteDriver.d.ts","sourceRoot":"","sources":["../../../src/sqlite-drivers/createOpSqliteDriver.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,kBAAkB,EAGxB,MAAM,eAAe,CAAC;AAGvB,eAAO,MAAM,oBAAoB,EAAE,kBAiEhC,CAAC"}

package/dist/src/sqlite-drivers/createOpSqliteDriver.js

@@ -1,119 +0,0 @@
-var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
-    if (value !== null && value !== void 0) {
-        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
-        var dispose, inner;
-        if (async) {
-            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
-            dispose = value[Symbol.asyncDispose];
-        }
-        if (dispose === void 0) {
-            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
-            dispose = value[Symbol.dispose];
-            if (async) inner = dispose;
-        }
-        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
-        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
-        env.stack.push({ value: value, dispose: dispose, async: async });
-    }
-    else if (async) {
-        env.stack.push({ async: true });
-    }
-    return value;
-};
-var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
-    return function (env) {
-        function fail(e) {
-            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
-            env.hasError = true;
-        }
-        var r, s = 0;
-        function next() {
-            while (r = env.stack.pop()) {
-                try {
-                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
-                    if (r.dispose) {
-                        var result = r.dispose.call(r.value);
-                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
-                    }
-                    else s |= 1;
-                }
-                catch (e) {
-                    fail(e);
-                }
-            }
-            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
-            if (env.hasError) throw env.error;
-        }
-        return next();
-    };
-})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-});
-import { constVoid, bytesToHex, createPreparedStatementsCache, ok, } from "@evolu/common";
-import { open } from "@op-engineering/op-sqlite";
-export const createOpSqliteDriver = (name, options) => () => {
-    const env_1 = { stack: [], error: void 0, hasError: false };
-    try {
-        // https://op-engineering.github.io/op-sqlite/docs/configuration#in-memory
-        const disposer = __addDisposableResource(env_1, new DisposableStack(), false);
-        const db = disposer.adopt(open(options?.mode === "memory"
-            ? { name: `inMemoryDb`, location: ":memory:" }
-            : {
-                name: `evolu1-${name}.db`,
-                ...(options?.mode === "encrypted" && {
-                    encryptionKey: `x'${bytesToHex(options.encryptionKey)}'`,
-                }),
-            }), (db) => {
-            db.close();
-        });
-        const cache = disposer.use(createPreparedStatementsCache((sql) => db.prepareStatement(sql), 
-        // op-sqlite doesn't have API for that
-        constVoid));
-        const disposables = disposer.move();
-        return ok({
-            exec: (query) => {
-                const prepared = cache.get(query);
-                if (prepared) {
-                    prepared.bindSync(query.parameters);
-                }
-                const { rows, rowsAffected } = db.executeSync(query.sql, query.parameters);
-                return { rows: rows, changes: rowsAffected };
-            },
-            // FIXME: op-sqlite does not expose binary, but a path to the database file
-            // another react native dependency would be needed to implement this
-            export: () => {
-                throw new Error("TODO: Not implemented yet");
-            },
-            deleteDatabase: () => {
-                const env_2 = { stack: [], error: void 0, hasError: false };
-                try {
-                    const deleteDisposer = __addDisposableResource(env_2, new DisposableStack(), false);
-                    if (options?.mode !== "memory") {
-                        deleteDisposer.defer(() => {
-                            db.delete();
-                        });
-                    }
-                    deleteDisposer.use(disposables);
-                }
-                catch (e_2) {
-                    env_2.error = e_2;
-                    env_2.hasError = true;
-                }
-                finally {
-                    __disposeResources(env_2);
-                }
-            },
-            [Symbol.dispose]: () => {
-                disposables.dispose();
-            },
-        });
-    }
-    catch (e_1) {
-        env_1.error = e_1;
-        env_1.hasError = true;
-    }
-    finally {
-        __disposeResources(env_1);
-    }
-};