@evolu/common 5.4.8 → 6.0.0

package/src/Model.ts

@@ -1,233 +0,0 @@
-import * as S from "@effect/schema/Schema";
-import * as Types from "effect/Types";
-import { Value, maybeJson } from "./Sqlite.js";
-
-/** Branded Id Schema. To create Id Schema for a specific table, use {@link id}. */
-export const Id = S.String.pipe(S.pattern(/^[\w-]{21}$/), S.brand("Id"));
-export type Id = typeof Id.Type;
-
-/**
- * A factory function to create {@link Id} Schema for a specific table.
- *
- * @example
- *   import * as S from "@effect/schema/Schema";
- *   import { id } from "@evolu/react";
- *
- *   const TodoId = id("Todo");
- *   type TodoId = typeof TodoId.Type;
- */
-export const id = <T extends string>(
-  table: T,
-): S.brand<S.brand<S.Schema<string, string, never>, "Id">, T> =>
-  Id.pipe(S.brand(table));
-
-/**
- * SQLite doesn't support the Date type, so Evolu uses SqliteDate instead. Use
- * the {@link cast} helper to cast SqliteDate from Date and back.
- * https://www.sqlite.org/quirks.html#no_separate_datetime_datatype
- */
-export const SqliteDate = S.String.pipe(
-  S.filter((s) => !isNaN(Date.parse(s))),
-  S.brand("SqliteDate"),
-);
-export type SqliteDate = typeof SqliteDate.Type;
-
-/**
- * SQLite doesn't support the boolean type, so Evolu uses SqliteBoolean instead.
- * Use the {@link cast} helper to cast SqliteBoolean from boolean and back.
- * https://www.sqlite.org/quirks.html#no_separate_boolean_datatype
- */
-export const SqliteBoolean = S.Number.pipe(
-  S.int(),
-  S.filter((s) => s === 0 || s === 1),
-  S.brand("SqliteBoolean"),
-);
-export type SqliteBoolean = typeof SqliteBoolean.Type;
-
-/**
- * A helper for casting types not supported by SQLite. SQLite doesn't support
- * Date nor Boolean types, so Evolu emulates them with {@link SqliteBoolean} and
- * {@link SqliteDate}.
- *
- * @example
- *   const allTodosNotDeleted = evolu.createQuery((db) =>
- *     db
- *       .selectFrom("todo")
- *       .selectAll()
- *       // isDeleted is SqliteBoolean
- *       .where("isDeleted", "is not", Evolu.cast(true)),
- *   );
- */
-export function cast(value: boolean): SqliteBoolean;
-export function cast(value: SqliteBoolean): boolean;
-export function cast(value: Date): SqliteDate;
-export function cast(value: SqliteDate): Date;
-export function cast(
-  value: boolean | SqliteBoolean | Date | SqliteDate,
-): boolean | SqliteBoolean | Date | SqliteDate {
-  if (typeof value === "boolean")
-    return (value === true ? 1 : 0) as SqliteBoolean;
-  if (typeof value === "number") return value === 1;
-  if (value instanceof Date) return value.toISOString() as SqliteDate;
-  return new Date(value);
-}
-
-interface EvoluTypeError<E extends string> {
-  readonly __evoluTypeError__: E;
-}
-
-/**
- * Create table schema.
- *
- * Supported types are null, string, number, Uint8Array, JSON Object, and JSON
- * Array. Use SqliteDate for dates and SqliteBoolean for booleans.
- *
- * Reserved columns are createdAt, updatedAt, isDeleted. Those columns are added
- * by default.
- *
- * @example
- *   const TodoId = id("Todo");
- *   type TodoId = typeof TodoId.Type;
- *
- *   const TodoTable = table({
- *     id: TodoId,
- *     title: NonEmptyString1000,
- *     isCompleted: S.nullable(SqliteBoolean),
- *   });
- *   type TodoTable = typeof TodoTable.Type;
- */
-export const table = <Fields extends TableFields>(
-  fields: Fields,
-  // Because Schema is invariant, we have to do validation like this.
-): ValidateFieldsTypes<Fields> extends true
-  ? ValidateFieldsNames<Fields> extends true
-    ? ValidateFieldsHasId<Fields> extends true
-      ? S.Schema<
-          Types.Simplify<S.Struct.Type<Fields> & typeof ReservedColumns.Type>,
-          Types.Simplify<
-            S.Struct.Encoded<Fields> & typeof ReservedColumns.Encoded
-          >
-        >
-      : EvoluTypeError<"table() called without id column.">
-    : EvoluTypeError<"table() called with a reserved column. Reserved columns are createdAt, updatedAt, isDeleted. Those columns are added by default.">
-  : EvoluTypeError<"table() called with unsupported type. Supported types are null, string, number, Uint8Array, JSON Object, and JSON Array. Use SqliteDate for dates and SqliteBoolean for booleans."> =>
-  S.Struct(fields).pipe(S.extend(ReservedColumns)) as never;
-
-const ReservedColumns = S.Struct({
-  createdAt: SqliteDate,
-  updatedAt: SqliteDate,
-  isDeleted: SqliteBoolean,
-});
-
-type TableFields = Record<string, S.Schema<any>>;
-
-type ValidateFieldsTypes<Fields extends TableFields> =
-  keyof Fields extends infer K
-    ? K extends keyof Fields
-      ? Fields[K] extends TableFields
-        ? ValidateFieldsTypes<Fields[K]>
-        : // eslint-disable-next-line @typescript-eslint/no-unused-vars
-          Fields[K] extends S.Schema<infer A, infer _I>
-          ? A extends Value
-            ? true
-            : false
-          : never
-      : never
-    : never;
-
-type ValidateFieldsNames<Fields extends TableFields> =
-  keyof Fields extends infer K
-    ? K extends keyof Fields
-      ? K extends "createdAt" | "updatedAt" | "isDeleted"
-        ? false
-        : true
-      : never
-    : never;
-
-type ValidateFieldsHasId<Fields extends TableFields> = "id" extends keyof Fields
-  ? true
-  : false;
-
-/**
- * Create database schema.
- *
- * Tables with a name prefixed with _ are local-only, which means they are not
- * synced. Local-only tables are useful for device-specific or temporal data.
- *
- * @example
- *   const Database = database({
- *     // A local-only table.
- *     _todo: TodoTable,
- *     todo: TodoTable,
- *     todoCategory: TodoCategoryTable,
- *   });
- *   type Database = typeof Database.Type;
- */
-export const database = S.Struct;
-
-/**
- * String schema represents a string that is not stringified JSON. Using String
- * schema for strings stored in SQLite is crucial to ensure a stored string is
- * not automatically parsed to a JSON object or array when retrieved. Use String
- * schema for all string-based schemas.
- */
-export const String = S.String.pipe(
-  S.filter(
-    (s) => {
-      if (!maybeJson(s)) return true;
-      try {
-        JSON.parse(s);
-      } catch (e) {
-        return true;
-      }
-      return false;
-    },
-    { message: () => "a string that is not stringified JSON" },
-  ),
-  S.brand("String"),
-);
-export type String = typeof String.Type;
-
-/**
- * A string with a maximum length of 1000 characters.
- *
- * @example
- *   import * as S from "@effect/schema/Schema";
- *   import { String1000 } from "@evolu/react";
- *
- *   S.decode(String1000)(value);
- */
-export const String1000 = String.pipe(S.maxLength(1000), S.brand("String1000"));
-export type String1000 = typeof String1000.Type;
-
-/**
- * A nonempty string with a maximum length of 1000 characters.
- *
- * @example
- *   import * as S from "@effect/schema/Schema";
- *   import { NonEmptyString1000 } from "@evolu/react";
- *
- *   S.decode(NonEmptyString1000)(value);
- */
-export const NonEmptyString1000 = String.pipe(
-  S.minLength(1),
-  S.maxLength(1000),
-  S.brand("NonEmptyString1000"),
-);
-export type NonEmptyString1000 = typeof NonEmptyString1000.Type;
-
-/**
- * A positive integer.
- *
- * @example
- *   import * as S from "@effect/schema/Schema";
- *   import { PositiveInt } from "@evolu/react";
- *
- *   S.decode(PositiveInt)(value);
- */
-export const PositiveInt = S.Number.pipe(
-  S.int(),
-  S.positive(),
-  S.brand("PositiveInt"),
-);
-export type PositiveInt = typeof PositiveInt.Type;

package/src/Murmurhash.ts

@@ -1,70 +0,0 @@
-// https://github.com/garycourt/murmurhash-js/blob/master/murmurhash3_gc.js
-export const murmurhash = (key: string, seed = 0): number => {
-  let h1, h1b, k1, i;
-
-  const remainder = key.length & 3; // key.length % 4
-  const bytes = key.length - remainder;
-  h1 = seed;
-  const c1 = 0xcc9e2d51;
-  const c2 = 0x1b873593;
-  i = 0;
-
-  while (i < bytes) {
-    k1 =
-      (key.charCodeAt(i) & 0xff) |
-      ((key.charCodeAt(++i) & 0xff) << 8) |
-      ((key.charCodeAt(++i) & 0xff) << 16) |
-      ((key.charCodeAt(++i) & 0xff) << 24);
-    ++i;
-
-    k1 =
-      ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff;
-    k1 = (k1 << 15) | (k1 >>> 17);
-    k1 =
-      ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) & 0xffffffff;
-
-    h1 ^= k1;
-    h1 = (h1 << 13) | (h1 >>> 19);
-    h1b =
-      ((h1 & 0xffff) * 5 + ((((h1 >>> 16) * 5) & 0xffff) << 16)) & 0xffffffff;
-    h1 = (h1b & 0xffff) + 0x6b64 + ((((h1b >>> 16) + 0xe654) & 0xffff) << 16);
-  }
-
-  k1 = 0;
-
-  switch (remainder) {
-    case 3:
-      k1 ^= (key.charCodeAt(i + 2) & 0xff) << 16;
-    // eslint-disable-next-line no-fallthrough
-    case 2:
-      k1 ^= (key.charCodeAt(i + 1) & 0xff) << 8;
-    // eslint-disable-next-line no-fallthrough
-    case 1:
-      k1 ^= key.charCodeAt(i) & 0xff;
-
-      k1 =
-        ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) &
-        0xffffffff;
-      k1 = (k1 << 15) | (k1 >>> 17);
-      k1 =
-        ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) &
-        0xffffffff;
-      h1 ^= k1;
-  }
-
-  h1 ^= key.length;
-
-  h1 ^= h1 >>> 16;
-  h1 =
-    ((h1 & 0xffff) * 0x85ebca6b +
-      ((((h1 >>> 16) * 0x85ebca6b) & 0xffff) << 16)) &
-    0xffffffff;
-  h1 ^= h1 >>> 13;
-  h1 =
-    ((h1 & 0xffff) * 0xc2b2ae35 +
-      ((((h1 >>> 16) * 0xc2b2ae35) & 0xffff) << 16)) &
-    0xffffffff;
-  h1 ^= h1 >>> 16;
-
-  return h1 >>> 0;
-};

package/src/Owner.ts

@@ -1,69 +0,0 @@
-import * as Brand from "effect/Brand";
-import * as Context from "effect/Context";
-import * as Effect from "effect/Effect";
-import {
-  Mnemonic,
-  createMnemonic,
-  mnemonicToSeed,
-  slip21Derive,
-} from "./Crypto.js";
-import { Id } from "./Model.js";
-
-/**
- * The Owner represents the Evolu database owner, a user. Instead of traditional
- * email with a password, the Owner uses a mnemonic, also known as a "seed
- * phrase," which is a set of 12 words in a specific order chosen from a
- * predefined list.
- *
- * The purpose of the BIP39 mnemonic is to provide a human-readable way of
- * storing a private key.
- *
- * Mnemonic is generated safely in the user's device and must not be shared with
- * anyone.
- */
-export interface Owner {
-  /** The {@link Mnemonic} associated with {@link Owner}. */
-  readonly mnemonic: Mnemonic;
-
-  /** The unique identifier safely derived from {@link Mnemonic}. */
-  readonly id: OwnerId;
-
-  /** The encryption key safely derived from {@link Mnemonic}. */
-  readonly encryptionKey: Uint8Array;
-}
-
-export const Owner = Context.GenericTag<Owner>("Owner");
-
-/**
- * The unique identifier of {@link Owner} safely derived from its
- * {@link Mnemonic}.
- */
-export type OwnerId = Id & Brand.Brand<"Owner">;
-
-export const makeOwner = (mnemonic?: Mnemonic): Effect.Effect<Owner> =>
-  Effect.gen(function* (_) {
-    if (mnemonic == null) mnemonic = createMnemonic();
-    const seed = mnemonicToSeed(mnemonic);
-    const id = yield* Effect.map(
-      slip21Derive(seed, ["Evolu", "Owner Id"]),
-      (key) => {
-        // convert key to nanoid
-        let id = "";
-        for (let i = 0; i < 21; i++) {
-          id += urlAlphabet[key[i] & 63];
-        }
-        return id as OwnerId;
-      },
-    );
-    const encryptionKey = yield* slip21Derive(seed, [
-      "Evolu",
-      "Encryption Key",
-    ]);
-    return { mnemonic, id, encryptionKey };
-  });
-
-// From https://github.com/ai/nanoid/blob/main/url-alphabet/index.js
-// It's copy-pasted for now because NanoId import breaks Metro bundler.
-// https://github.com/ai/nanoid/issues/468
-const urlAlphabet =
-  "useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";

package/src/Platform.ts

@@ -1,47 +0,0 @@
-import * as Context from "effect/Context";
-import * as Effect from "effect/Effect";
-import * as Scope from "effect/Scope";
-import { Config } from "./Config.js";
-
-/**
- * FlushSync is a service for libraries like React to synchronously flush
- * updates inside the provided callback to ensure the DOM is updated
- * immediately.
- *
- * https://react.dev/reference/react-dom/flushSync
- */
-export type FlushSync = (callback: () => void) => void;
-export const FlushSync = Context.GenericTag<FlushSync>("FlushSync");
-
-export class AppState extends Context.Tag("AppState")<
-  AppState,
-  {
-    readonly init: (options: {
-      readonly reloadUrl: string;
-      readonly onRequestSync: () => void;
-    }) => Effect.Effect<AppStateReset>;
-  }
->() {}
-
-interface AppStateReset {
-  readonly reset: Effect.Effect<void>;
-}
-
-export class SyncLock extends Context.Tag("SyncLock")<
-  SyncLock,
-  {
-    readonly tryAcquire: Effect.Effect<
-      SyncLockRelease,
-      SyncLockAlreadySyncingError,
-      Config | Scope.Scope
-    >;
-  }
->() {}
-
-export interface SyncLockRelease {
-  readonly release: Effect.Effect<void>;
-}
-
-export class SyncLockAlreadySyncingError {
-  readonly _tag = "SyncLockAlreadySyncingError";
-}

package/src/Protobuf.ts

@@ -1,155 +0,0 @@
-/* eslint-disable */
-// @generated by protobuf-ts 2.9.3 with parameter eslint_disable,optimize_code_size
-// @generated from protobuf file "Protobuf.proto" (syntax proto3)
-// tslint:disable
-import { MessageType } from "@protobuf-ts/runtime";
-import { MerkleTreeString, TimestampString } from "./Crdt.js";
-import { NodeId } from "./Crypto.js";
-import { OwnerId } from "./Owner.js";
-import { Id } from "./Model.js";
-/** @generated from protobuf message SyncRequest */
-export interface SyncRequest {
-  /** @generated from protobuf field: repeated EncryptedMessage messages = 1; */
-  messages: ReadonlyArray<EncryptedMessage>;
-  /** @generated from protobuf field: string userId = 2; */
-  userId: OwnerId;
-  /** @generated from protobuf field: string nodeId = 3; */
-  nodeId: NodeId;
-  /** @generated from protobuf field: string merkleTree = 4; */
-  merkleTree: MerkleTreeString;
-}
-/** @generated from protobuf message SyncResponse */
-export interface SyncResponse {
-  /** @generated from protobuf field: repeated EncryptedMessage messages = 1; */
-  messages: ReadonlyArray<EncryptedMessage>;
-  /** @generated from protobuf field: string merkleTree = 2; */
-  merkleTree: MerkleTreeString;
-}
-/** @generated from protobuf message EncryptedMessage */
-export interface EncryptedMessage {
-  /** @generated from protobuf field: string timestamp = 1; */
-  timestamp: TimestampString;
-  /** @generated from protobuf field: bytes content = 2; */
-  content: Uint8Array;
-}
-/** @generated from protobuf message MessageContent */
-export interface MessageContent {
-  /** @generated from protobuf field: string table = 1; */
-  table: string;
-  /** @generated from protobuf field: string row = 2; */
-  row: Id;
-  /** @generated from protobuf field: string column = 3; */
-  column: string;
-  /** @generated from protobuf oneof: value */
-  value:
-    | {
-        oneofKind: "stringValue";
-        /** @generated from protobuf field: string stringValue = 4; */
-        stringValue: string;
-      }
-    | {
-        oneofKind: "numberValue";
-        /** @generated from protobuf field: string numberValue = 5; */
-        numberValue: string;
-      }
-    | {
-        oneofKind: "bytesValue";
-        /** @generated from protobuf field: bytes bytesValue = 6; */
-        bytesValue: Uint8Array;
-      }
-    | {
-        oneofKind: "jsonValue";
-        /** @generated from protobuf field: string jsonValue = 7; */
-        jsonValue: string;
-      }
-    | {
-        oneofKind: undefined;
-      };
-}
-// @generated message type with reflection information, may provide speed optimized methods
-class SyncRequest$Type extends MessageType<SyncRequest> {
-  constructor() {
-    super("SyncRequest", [
-      {
-        no: 1,
-        name: "messages",
-        kind: "message",
-        repeat: 1 /*RepeatType.PACKED*/,
-        T: () => EncryptedMessage,
-      },
-      { no: 2, name: "userId", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-      { no: 3, name: "nodeId", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-      { no: 4, name: "merkleTree", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-    ]);
-  }
-}
-/** @generated MessageType for protobuf message SyncRequest */
-export const SyncRequest = new SyncRequest$Type();
-// @generated message type with reflection information, may provide speed optimized methods
-class SyncResponse$Type extends MessageType<SyncResponse> {
-  constructor() {
-    super("SyncResponse", [
-      {
-        no: 1,
-        name: "messages",
-        kind: "message",
-        repeat: 1 /*RepeatType.PACKED*/,
-        T: () => EncryptedMessage,
-      },
-      { no: 2, name: "merkleTree", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-    ]);
-  }
-}
-/** @generated MessageType for protobuf message SyncResponse */
-export const SyncResponse = new SyncResponse$Type();
-// @generated message type with reflection information, may provide speed optimized methods
-class EncryptedMessage$Type extends MessageType<EncryptedMessage> {
-  constructor() {
-    super("EncryptedMessage", [
-      { no: 1, name: "timestamp", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-      { no: 2, name: "content", kind: "scalar", T: 12 /*ScalarType.BYTES*/ },
-    ]);
-  }
-}
-/** @generated MessageType for protobuf message EncryptedMessage */
-export const EncryptedMessage = new EncryptedMessage$Type();
-// @generated message type with reflection information, may provide speed optimized methods
-class MessageContent$Type extends MessageType<MessageContent> {
-  constructor() {
-    super("MessageContent", [
-      { no: 1, name: "table", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-      { no: 2, name: "row", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-      { no: 3, name: "column", kind: "scalar", T: 9 /*ScalarType.STRING*/ },
-      {
-        no: 4,
-        name: "stringValue",
-        kind: "scalar",
-        oneof: "value",
-        T: 9 /*ScalarType.STRING*/,
-      },
-      {
-        no: 5,
-        name: "numberValue",
-        kind: "scalar",
-        oneof: "value",
-        T: 9 /*ScalarType.STRING*/,
-      },
-      {
-        no: 6,
-        name: "bytesValue",
-        kind: "scalar",
-        oneof: "value",
-        T: 12 /*ScalarType.BYTES*/,
-      },
-      {
-        no: 7,
-        name: "jsonValue",
-        kind: "scalar",
-        oneof: "value",
-        T: 9 /*ScalarType.STRING*/,
-      },
-    ]);
-  }
-}
-/** @generated MessageType for protobuf message MessageContent */
-export const MessageContent = new MessageContent$Type();

package/src/Public.ts

@@ -1,12 +0,0 @@
-export { sql } from "kysely";
-export type { NotNull } from "kysely";
-export { jsonArrayFrom, jsonObjectFrom } from "kysely/helpers/sqlite";
-export type { Timestamp, TimestampError } from "./Crdt.js";
-export { createMnemonic, parseMnemonic } from "./Crypto.js";
-export type { InvalidMnemonicError, Mnemonic } from "./Crypto.js";
-export type { ExtractRow, QueryResult } from "./Db.js";
-export * from "./Error.js";
-export { createIndexes } from "./Evolu.js";
-export * from "./Model.js";
-export type { Owner, OwnerId } from "./Owner.js";
-export type { SyncState } from "./Sync.js";

package/src/Socket.ts

@@ -1,83 +0,0 @@
-import { Config } from "./Config.js";
-import { Owner } from "./Owner.js";
-
-let syncTimeout: number | NodeJS.Timeout | undefined;
-let lockTimeout: number | NodeJS.Timeout | undefined;
-let socketTimeout: number | NodeJS.Timeout | undefined;
-let isLocked = false;
-const SocketTimeout = 3000;
-const SyncTimeout = 500;
-const SyncLockTimeout = 500;
-let socket: WebSocket;
-
-type ForceSyncMethod = ({
-  refreshQueries,
-}: {
-  refreshQueries: boolean;
-}) => () => void;
-
-const processWebsocketEvent = (
-  sync: ForceSyncMethod,
-  event: MessageEvent<any>,
-) => {
-  if (typeof event.data === "string" || isLocked === true) return;
-  clearTimeout(syncTimeout);
-  syncTimeout = undefined;
-  syncTimeout = setTimeout(() => {
-    isLocked = true;
-    sync({ refreshQueries: true })();
-    clearTimeout(syncTimeout);
-    clearTimeout(lockTimeout);
-    lockTimeout = setTimeout(() => {
-      isLocked = false;
-    }, SyncLockTimeout);
-  }, SyncTimeout);
-};
-
-export const createSocket = (
-  sync: ForceSyncMethod,
-  config: Config,
-  owner: Owner,
-): WebSocket | undefined => {
-  if (config.externalWebsocketConnection) {
-    // Hook up to an external WebSocket connection
-    config.externalWebsocketConnection.send(
-      JSON.stringify({ message: "subscribe", channelId: owner.id }),
-    );
-    config.externalWebsocketConnection.addEventListener("message", (event) =>
-      processWebsocketEvent(sync, event),
-    );
-    return config.externalWebsocketConnection;
-  }
-
-  if (config.enableWebsocketConnection) {
-    // Create a WebSocket connection
-    socket = new WebSocket(config.syncUrl?.replace("http", "ws"));
-    // Handle incoming WebSocket messages
-    socket.addEventListener("message", (event) =>
-      processWebsocketEvent(sync, event),
-    );
-
-    // Handle WebSocket errors
-    socket.onerror = (error) => {
-      // eslint-disable-next-line no-console
-      console.error("WebSocket error:", error);
-    };
-
-    // Handle WebSocket closure
-    socket.onclose = () => {
-      socketTimeout = setTimeout(
-        () => createSocket(sync, config, owner),
-        SocketTimeout,
-      );
-    };
-
-    socket.onopen = () => {
-      socket.send(
-        JSON.stringify({ message: "subscribe", channelId: owner.id }),
-      );
-      clearTimeout(socketTimeout);
-    };
-    return socket;
-  }
-};