@evolu/common 6.0.1-preview.2 → 6.0.1-preview.4

package/src/Evolu/Evolu.ts

@@ -1,5 +1,5 @@
 import { isNonEmptyArray, isNonEmptyReadonlyArray } from "../Array.js";
-import { assertNonEmptyArray } from "../Assert.js";
+import { assert, assertNonEmptyArray } from "../Assert.js";
 import { createCallbacks } from "../Callbacks.js";
 import { ConsoleDep } from "../Console.js";
 import { SymmetricCryptoDecryptError } from "../Crypto.js";
@@ -44,9 +44,9 @@ import {
   SubscribedQueries,
 } from "./Query.js";
 import {
-  assertValidEvoluSchema,
   CreateQuery,
   EvoluSchema,
+  evoluSchemaToDbSchema,
   insertable,
   Mutation,
   MutationKind,
@@ -54,7 +54,7 @@ import {
   MutationOptions,
   updateable,
   upsertable,
-  validEvoluSchemaToDbSchema,
+  ValidateSchema,
   ValidMutationSize,
   ValidMutationSizeError,
 } from "./Schema.js";
@@ -431,9 +431,7 @@ let tabId: Id | null = null;
 export const createEvolu =
   (deps: EvoluDeps) =>
   <S extends EvoluSchema>(
-    // TODO: Validate missing Id, unsupported types, used default types via TS types
-    // with type errors messages as we had it in the old Evolu.
-    schema: S,
+    schema: ValidateSchema<S> extends never ? S : ValidateSchema<S>,
     partialConfig: Partial<EvoluConfigWithInitialData<S>> = {},
   ): Evolu<S> => {
     const config = { ...defaultConfig, ...partialConfig };
@@ -441,11 +439,14 @@ export const createEvolu =
     let evolu = evoluInstances.get(config.name);
 
     if (evolu == null) {
-      evolu = createEvoluInstance(deps)(schema, config as IntentionalNever);
+      evolu = createEvoluInstance(deps)(
+        schema as EvoluSchema,
+        config as IntentionalNever,
+      );
       evoluInstances.set(config.name, evolu);
     } else {
       // Hot reloading. Note that indexes are intentionally omitted.
-      evolu.ensureSchema(schema);
+      evolu.ensureSchema(schema as EvoluSchema);
     }
 
     return evolu as IntentionalNever;
@@ -554,10 +555,7 @@ const createEvoluInstance =
       }
     });
 
-    const dbSchema = validEvoluSchemaToDbSchema(
-      assertValidEvoluSchema(schema),
-      indexes,
-    );
+    const dbSchema = evoluSchemaToDbSchema(schema, indexes);
 
     const mutationTypesCache = new Map<
       MutationKind,
@@ -592,21 +590,17 @@ const createEvoluInstance =
     if (initialData)
       initialData({
         insert: (table, props) => {
-          const Type = getMutationType(table, "insert");
           const id = createId(deps);
+          const values = getMutationType(table, "insert").fromUnknown(props);
 
-          const result = Type.fromUnknown(props);
-
-          if (result.ok) {
-            initialDataDbChanges.push({
-              id,
-              table,
-              values: result.value,
-            } as unknown as DbChange);
+          if (values.ok) {
+            const dbChange = { table, id, values: values.value };
+            assertValidDbChange(dbChange);
+            initialDataDbChanges.push(dbChange);
             return ok({ id });
           }
 
-          return result;
+          return values;
         },
       });
 
@@ -654,14 +648,14 @@ const createEvoluInstance =
           } else {
             // Remove `id` from values.
             const { id: _id, ...values } = result.value;
-            // EvoluSchema Types ensure valid types.
-            const change = { table, id, values } as unknown as DbChange;
-            mutateMicrotaskQueue.push([change, options?.onComplete]);
+            const dbChange = { table, id, values };
+            assertValidDbChange(dbChange);
+            mutateMicrotaskQueue.push([dbChange, options?.onComplete]);
           }
 
           if (mutateMicrotaskQueue.length === 1)
             queueMicrotask(() => {
-              const changes = [];
+              const changes: Array<DbChange> = [];
               const onCompletes = [];
 
               for (const [change, onComplete] of mutateMicrotaskQueue) {
@@ -807,6 +801,7 @@ const createEvoluInstance =
         const onCompleteId = callbacks.register(() => {
           resolve();
         });
+
         dbWorker.postMessage({
           type: "reset",
           onCompleteId,
@@ -822,11 +817,8 @@ const createEvoluInstance =
 
       ensureSchema: (schema) => {
         mutationTypesCache.clear();
-        const validSchema = assertValidEvoluSchema(schema);
-        dbWorker.postMessage({
-          type: "ensureDbSchema",
-          dbSchema: validEvoluSchemaToDbSchema(validSchema),
-        });
+        const dbSchema = evoluSchemaToDbSchema(schema);
+        dbWorker.postMessage({ type: "ensureDbSchema", dbSchema });
       },
 
       exportDatabase: () => {
@@ -945,3 +937,14 @@ const createLoadingPromises = (
 
   return loadingPromises;
 };
+
+const assertValidDbChange: (dbChange: {
+  table: string;
+  id: Id;
+  values: unknown;
+}) => asserts dbChange is DbChange = (dbChange) => {
+  assert(
+    DbChange.is(dbChange),
+    `Failed to create DbChange for table "${dbChange.table}". If you see this message, you either disabled EvoluSchema validation or Evolu has a bug - please report it.`,
+  );
+};

package/src/Evolu/Protocol.ts

@@ -144,7 +144,7 @@ import {
 } from "../Crypto.js";
 import { eqArrayNumber } from "../Eq.js";
 import { computeBalancedBuckets } from "../Number.js";
-import { objectToEntries, ReadonlyRecord } from "../Object.js";
+import { objectToEntries } from "../Object.js";
 import { err, ok, Result } from "../Result.js";
 import { SqliteValue } from "../Sqlite.js";
 import {
@@ -157,7 +157,9 @@ import {
   NanoId,
   NonNegativeInt,
   Number,
+  object,
   PositiveInt,
+  record,
 } from "../Type.js";
 import { Brand, Predicate } from "../Types.js";
 import {
@@ -293,15 +295,23 @@ export interface CrdtMessage {
   readonly change: DbChange;
 }
 
+/**
+ * Base64Url string with maximum length of 256 characters. Encoding strings as
+ * Base64UrlString saves up to 25% in size compared to regular strings.
+ */
+export const Base64Url256 = maxLength(256)(Base64Url);
+export type Base64Url256 = typeof Base64Url256.Type;
+
 /**
  * A DbChange is a change to a table row. Together with a unique
  * {@link Timestamp}, it forms a {@link CrdtMessage}.
  */
-export interface DbChange {
-  readonly table: Base64Url256;
-  readonly id: Id;
-  readonly values: ReadonlyRecord<Base64Url256, SqliteValue>;
-}
+export const DbChange = object({
+  table: Base64Url256,
+  id: Id,
+  values: record(Base64Url256, SqliteValue),
+});
+export type DbChange = typeof DbChange.Type;
 
 export const RangeType = {
   Fingerprint: 1,
@@ -1434,13 +1444,6 @@ export const ownerIdToBinaryOwnerId = (ownerId: OwnerId): BinaryOwnerId =>
 export const binaryOwnerIdToOwnerId = (binaryOwnerId: BinaryOwnerId): OwnerId =>
   decodeOwnerId(createBuffer(binaryOwnerId));
 
-/**
- * Base64Url string with maximum length of 256 characters. Encoding strings as
- * Base64UrlString saves up to 25% in size compared to regular strings.
- */
-export const Base64Url256 = maxLength(256)(Base64Url);
-export type Base64Url256 = typeof Base64Url256.Type;
-
 /**
  * Union type for all variants of Base64Url strings with limited length. All
  * these types use Base64Url alphabet and are < 256 characters.

package/src/Evolu/Schema.ts

@@ -1,5 +1,6 @@
 import { Kysely, SelectQueryBuilder } from "kysely";
 import { pack } from "msgpackr";
+import { assert } from "../Assert.js";
 import { mapObject, objectToEntries, ReadonlyRecord } from "../Object.js";
 import { err, ok, Result } from "../Result.js";
 import { SqliteBoolean, SqliteQueryOptions, SqliteValue } from "../Sqlite.js";
@@ -9,8 +10,7 @@ import {
   BrandType,
   createTypeErrorFormatter,
   DateIsoString,
-  EvoluType,
-  Id,
+  IdType,
   InferErrors,
   InferInput,
   InferType,
@@ -23,32 +23,20 @@ import {
   omit,
   optional,
   OptionalType,
-  record,
   Type,
   TypeError,
-  Unknown,
 } from "../Type.js";
 import { Simplify } from "../Types.js";
-import { DbSchema, DbTable } from "./Db.js";
+import { DbSchema } from "./Db.js";
 import { createIndexes, DbIndexesBuilder } from "./Kysely.js";
 import { AppOwner, ShardOwner, SharedOwner } from "./Owner.js";
-import {
-  Base64Url256,
-  BinaryId,
-  maxProtocolMessageRangesSize,
-} from "./Protocol.js";
+import { BinaryId, maxProtocolMessageRangesSize } from "./Protocol.js";
 import { Query, Row } from "./Query.js";
 import { BinaryTimestamp } from "./Timestamp.js";
 
 /**
  * Defines the schema of an Evolu database.
  *
- * - Each top-level key represents a table name.
- * - The value for each table name is a record of column names mapped to their
- *   respective data types, defined by {@link Type}.
- * - Each table must include a mandatory `id` column of type {@link Id}.
- * - No table may contain {@link DefaultColumns}.
- *
  * Table schema defines columns that are required for table rows. For not
  * required columns, use {@link nullOr}.
  *
@@ -82,11 +70,105 @@ import { BinaryTimestamp } from "./Timestamp.js";
  */
 export type EvoluSchema = ReadonlyRecord<
   string,
-  ReadonlyRecord<string, Type<any, any, any, any, any>> & {
-    readonly id: Type<any, any, any, any, any>;
-  }
+  // TypeScript errors are cryptic so we use ValidateSchema.
+  ReadonlyRecord<string, Type<any, any, any, any, any>>
 >;
 
+/**
+ * Validates an {@link EvoluSchema} at compile time, returning the first error
+ * found as a readable string literal type. This approach provides much clearer
+ * and more actionable TypeScript errors than the default, which are often hard
+ * to read.
+ *
+ * Validates the following schema requirements:
+ *
+ * 1. All tables must have an 'id' column
+ * 2. The 'id' column must be a branded ID type (created with id() function)
+ * 3. Tables cannot use default column names (createdAt, updatedAt, isDeleted)
+ * 4. All column types must be compatible with SQLite (extend SqliteValue)
+ */
+export type ValidateSchema<S extends EvoluSchema> =
+  ValidateSchemaHasId<S> extends never
+    ? ValidateIdColumnType<S> extends never
+      ? ValidateNoDefaultColumns<S> extends never
+        ? ValidateColumnTypes<S> extends never
+          ? S
+          : ValidateColumnTypes<S>
+        : ValidateNoDefaultColumns<S>
+      : ValidateIdColumnType<S>
+    : ValidateSchemaHasId<S>;
+
+export type ValidateSchemaHasId<S extends EvoluSchema> =
+  keyof S extends infer TableName
+    ? TableName extends keyof S
+      ? "id" extends keyof S[TableName]
+        ? never
+        : SchemaValidationError<`Table "${TableName & string}" is missing required id column.`>
+      : never
+    : never;
+
+export type ValidateIdColumnType<S extends EvoluSchema> =
+  keyof S extends infer TableName
+    ? TableName extends keyof S
+      ? "id" extends keyof S[TableName]
+        ? S[TableName]["id"] extends IdType<any>
+          ? never
+          : SchemaValidationError<`Table "${TableName & string}" id column must be a branded ID type (created with id("${TableName & string}")).`>
+        : never
+      : never
+    : never;
+
+export type ValidateNoDefaultColumns<S extends EvoluSchema> =
+  keyof S extends infer TableName
+    ? TableName extends keyof S
+      ? keyof S[TableName] extends infer ColumnName
+        ? ColumnName extends keyof S[TableName]
+          ? ColumnName extends "createdAt" | "updatedAt" | "isDeleted"
+            ? SchemaValidationError<`Table "${TableName & string}" uses default column name "${ColumnName & string}". Default columns (createdAt, updatedAt, isDeleted) are added automatically.`>
+            : never
+          : never
+        : never
+      : never
+    : never;
+
+export type ValidateColumnTypes<S extends EvoluSchema> =
+  keyof S extends infer TableName
+    ? TableName extends keyof S
+      ? keyof S[TableName] extends infer ColumnName
+        ? ColumnName extends keyof S[TableName]
+          ? InferType<S[TableName][ColumnName]> extends SqliteValue
+            ? never
+            : SchemaValidationError<`Table "${TableName & string}" column "${ColumnName & string}" type is not compatible with SQLite. Column types must extend SqliteValue (string, number, Uint8Array, or null).`>
+          : never
+        : never
+      : never
+    : never;
+
+/** Schema validation error that shows clear, readable messages */
+export type SchemaValidationError<Message extends string> =
+  `❌ Schema Error: ${Message}`;
+
+export const evoluSchemaToDbSchema = (
+  schema: EvoluSchema,
+  indexes?: DbIndexesBuilder,
+): DbSchema => {
+  const tables = objectToEntries(schema).map(([tableName, table]) => ({
+    name: tableName,
+    columns: objectToEntries(table)
+      .filter(([k]) => k !== "id")
+      .map(([k]) => k),
+  }));
+
+  const dbSchema = { tables, indexes: createIndexes(indexes) };
+
+  assert(
+    DbSchema.is(dbSchema),
+    "Invalid EvoluSchema: Table and column names must use only characters A-Za-z0-9_- and be at most 256 characters long.",
+  );
+
+  return dbSchema;
+};
+
 export type CreateQuery<S extends EvoluSchema> = <R extends Row>(
   queryCallback: (
     db: Pick<
@@ -104,7 +186,7 @@ export type CreateQuery<S extends EvoluSchema> = <R extends Row>(
           readonly evolu_history: {
             readonly timestamp: BinaryTimestamp;
             readonly table: keyof S;
-            readonly row: BinaryId;
+            readonly id: BinaryId;
             readonly column: string;
             readonly value: SqliteValue;
           };
@@ -123,116 +205,6 @@ export const DefaultColumns = object({
 });
 export type DefaultColumns = typeof DefaultColumns.Type;
 
-const isDefaultColumnName = (value: string): boolean =>
-  value === "createdAt" || value === "updatedAt" || value === "isDeleted";
-
-/**
- * Valid {@link EvoluSchema}.
- *
- * - Table and column names must be Base64Url strings.
- * - Each table must include an `id` column of type {@link Id}.
- * - Default column names (`createdAt`, `updatedAt`, `isDeleted`) are not allowed.
- */
-export const ValidEvoluSchema = brand(
-  "ValidEvoluSchema",
-  record(
-    Base64Url256,
-    object({ id: EvoluType }, record(Base64Url256, Unknown)),
-  ),
-  (value) => {
-    for (const tableName in value) {
-      for (const columnName in value[tableName as never]) {
-        if (isDefaultColumnName(columnName)) {
-          return err<ValidEvoluSchemaError>({
-            type: "ValidEvoluSchema",
-            value,
-            reason: {
-              kind: "DefaultColumnError",
-              tableName,
-              columnName,
-            },
-          });
-        }
-      }
-    }
-
-    return ok(value);
-  },
-);
-
-export type ValidEvoluSchema = typeof ValidEvoluSchema.Type;
-
-export interface ValidEvoluSchemaError extends TypeError<"ValidEvoluSchema"> {
-  readonly reason: {
-    kind: "DefaultColumnError";
-    tableName: string;
-    columnName: string;
-  };
-}
-
-/**
- * Asserts that the given value is {@link ValidEvoluSchema}.
- *
- * Throws an error if the value is not a valid Evolu schema.
- */
-export const assertValidEvoluSchema = (value: unknown): ValidEvoluSchema => {
-  const validEvoluSchema = ValidEvoluSchema.fromUnknown(value);
-  if (!validEvoluSchema.ok) {
-    const message = formatValidEvoluSchemaError(validEvoluSchema.error);
-    throw new Error(`Invalid Evolu schema: ${message}`);
-  }
-  return validEvoluSchema.value;
-};
-
-const formatValidEvoluSchemaError = (
-  error: typeof ValidEvoluSchema.Error | typeof ValidEvoluSchema.ParentError,
-): string => {
-  if (error.type === "Record") {
-    if (error.reason.kind === "Key") {
-      return `The table "${error.reason.key}" has invalid name. A table name must be Base64Url256 string (A-Z, a-z, 0-9, -, _).`;
-    }
-
-    if (
-      error.reason.kind === "Value" &&
-      error.reason.error.reason.kind === "Props" &&
-      error.reason.error.reason.errors.id?.type === "EvoluType"
-    ) {
-      return `The table "${error.reason.key}" has invalid ID column. Check examples.`;
-    }
-
-    if (
-      error.reason.kind === "Value" &&
-      error.reason.error.reason.kind === "IndexKey"
-    ) {
-      return `The table "${error.reason.key}" has invalid column name "${error.reason.error.reason.key}". A column name must be Base64Url256 string (A-Z, a-z, 0-9, -, _).`;
-    }
-  }
-
-  if (error.type === "ValidEvoluSchema") {
-    return `The table "${error.reason.tableName}" uses reserved column name "${error.reason.columnName}". Reserved column names are: createdAt, updatedAt, isDeleted.`;
-  }
-
-  return JSON.stringify(error, null, 2);
-};
-
-export const validEvoluSchemaToDbSchema = (
-  validEvoluSchema: ValidEvoluSchema,
-  indexes?: DbIndexesBuilder,
-): DbSchema => {
-  const tables = objectToEntries(validEvoluSchema).map(
-    ([tableName, table]): DbTable => ({
-      name: tableName,
-      columns: objectToEntries(table)
-        .filter(([k]) => k !== "id")
-        .map(([k]) => k as Base64Url256),
-    }),
-  );
-  return {
-    tables,
-    indexes: createIndexes(indexes),
-  };
-};
-
 export type MutationKind = "insert" | "update" | "upsert";
 
 export type Mutation<S extends EvoluSchema, Kind extends MutationKind> = <