@evolu/common 7.3.0 → 7.4.1

package/src/local-first/Evolu.ts

@@ -465,8 +465,9 @@ export type EvoluError =
   | TimestampError
   | TransferableError;
 
-interface InternalEvoluInstance<S extends EvoluSchema = EvoluSchema>
-  extends Evolu<S> {
+interface InternalEvoluInstance<
+  S extends EvoluSchema = EvoluSchema,
+> extends Evolu<S> {
   /**
    * Ensure tables and columns defined in {@link EvoluSchema} exist in the
    * database. This function is for hot reloading.

package/src/local-first/Owner.ts

@@ -28,6 +28,7 @@ import { TimestampBytes } from "./Timestamp.js";
  */
 export interface ReadonlyOwner {
   readonly id: OwnerId;
+  /** TODO: Wrap with `Redacted` in the next major version. */
   readonly encryptionKey: OwnerEncryptionKey;
 }
 
@@ -63,6 +64,7 @@ export interface ReadonlyOwner {
  * @see {@link createSharedReadonlyOwner}
  */
 export interface Owner extends ReadonlyOwner {
+  /** TODO: Wrap with `Redacted` in the next major version. */
   readonly writeKey: OwnerWriteKey;
 }
 
@@ -184,6 +186,8 @@ export interface AppOwner extends Owner {
    * The mnemonic that was used to derive the AppOwner keys. Optional when the
    * AppOwner is created from external keys to avoid sharing the mnemonic with
    * the Evolu app.
+   *
+   * TODO: Wrap with `Redacted` in the next major version.
    */
   readonly mnemonic?: Mnemonic | null;
 }

package/src/local-first/Public.ts

@@ -1,5 +1,10 @@
 /**
- * Local-first code to be imported from "@evolu/common"
+ * Public local-first API exported from "@evolu/common"
+ *
+ * This module provides the supported consumer-facing API for Evolu's
+ * local-first system: prefer importing from `@evolu/common` (this module) when
+ * using Evolu in applications. If you require access to lower level internals,
+ * consider importing from `@evolu/common/local-first`.
  *
  * @module
  */

package/src/local-first/Storage.ts

@@ -273,8 +273,7 @@ export const ValidDbChangeValues = brand(
 );
 export type ValidDbChangeValues = typeof ValidDbChangeValues.Type;
 
-export interface ValidDbChangeValuesError
-  extends TypeError<"ValidDbChangeValues"> {
+export interface ValidDbChangeValuesError extends TypeError<"ValidDbChangeValues"> {
   readonly invalidColumns: ReadonlyArray<string>;
 }
 
@@ -324,16 +323,15 @@ export type DbChange = typeof DbChange.Type;
  * users, and when it goes down, nothing happens, because it will be
  * synchronized later.
  */
-export interface BaseSqliteStorage
-  extends Pick<
-    Storage,
-    | "getSize"
-    | "fingerprint"
-    | "fingerprintRanges"
-    | "findLowerBound"
-    | "iterate"
-    | "deleteOwner"
-  > {
+export interface BaseSqliteStorage extends Pick<
+  Storage,
+  | "getSize"
+  | "fingerprint"
+  | "fingerprintRanges"
+  | "findLowerBound"
+  | "iterate"
+  | "deleteOwner"
+> {
   /** Inserts a timestamp for an owner into the skiplist-based storage. */
   readonly insertTimestamp: (
     ownerId: OwnerIdBytes,

package/src/local-first/Sync.ts

@@ -5,7 +5,7 @@ import {
   NonEmptyArray,
   NonEmptyReadonlyArray,
 } from "../Array.js";
-import { assert, assertNonEmptyReadonlyArray } from "../Assert.js";
+import { assertNonEmptyReadonlyArray } from "../Assert.js";
 import { Brand } from "../Brand.js";
 import { ConsoleDep } from "../Console.js";
 import {
@@ -13,7 +13,6 @@ import {
   SymmetricCryptoDecryptError,
   SymmetricCryptoDep,
 } from "../Crypto.js";
-import { eqArrayNumber } from "../Eq.js";
 import { createTransferableError, TransferableError } from "../Error.js";
 import { constFalse, constTrue } from "../Function.js";
 import { createRecord, getProperty, objectToEntries } from "../Object.js";
@@ -32,7 +31,6 @@ import {
 import { AbortError, createMutex } from "../Task.js";
 import { TimeDep } from "../Time.js";
 import {
-  Boolean,
   DateIso,
   Id,
   IdBytes,
@@ -593,19 +591,14 @@ const createClientStorage =
         }
 
         const { rows } = result.value;
-        assertNonEmptyReadonlyArray(
-          rows,
-          "Every timestamp must have rows in evolu_history or quarantine",
-        );
+        assertNonEmptyReadonlyArray(rows, "Every timestamp must have rows");
+        const firstRow = firstInArray(rows);
 
-        const { table, id } = firstInArray(rows);
         const values = createRecord<string, SqliteValue>();
-        let isInsert;
-        let isDelete: boolean | null = null;
+        let isInsert: DbChange["isInsert"] = false;
+        let isDelete: DbChange["isDelete"] = null;
 
         for (const r of rows) {
-          assert(r.table === table, "All rows must have the same table");
-          assert(eqArrayNumber(r.id, id), "All rows must have the same Id");
           switch (r.column) {
             case "createdAt":
               isInsert = true;
@@ -614,24 +607,20 @@ const createClientStorage =
               isInsert = false;
               break;
             case "isDeleted":
-              assert(
-                SqliteBoolean.is(r.value),
-                "isDeleted column must contain a valid SqliteBoolean",
-              );
-              isDelete = sqliteBooleanToBoolean(r.value);
+              if (SqliteBoolean.is(r.value)) {
+                isDelete = sqliteBooleanToBoolean(r.value);
+              }
               break;
             default:
               values[r.column] = r.value;
           }
         }
 
-        assert(Boolean.is(isInsert), "isInsert must be in evolu_history");
-
         const message: CrdtMessage = {
           timestamp: timestampBytesToTimestamp(timestamp),
           change: DbChange.orThrow({
-            table: rows[0].table,
-            id: idBytesToId(rows[0].id),
+            table: firstRow.table,
+            id: idBytesToId(firstRow.id),
             values,
             isInsert,
             isDelete,

package/src/local-first/index.ts

@@ -1,5 +1,13 @@
 /**
- * Local-first code to be imported from "@evolu/common/local-first"
+ * Internal local-first modules re-exported from "@evolu/common/local-first"
+ *
+ * These exports expose the internal building blocks of Evolu's local-first
+ * implementation (Db, Relay, Sync, Query, Storage, Timestamp, etc.). They are
+ * primarily intended for use within Evolu packages and for advanced use-cases
+ * that require direct access to local-first internals.
+ *
+ * Public consumers should us top-level exports from `@evolu/common` unless you
+ * have a specific need to import these internals.
  *
  * @module
  */