@evolu/common 5.4.7 → 6.0.0

package/dist/src/Evolu/Schema.d.ts

@@ -0,0 +1,201 @@
+import { Kysely, SelectQueryBuilder } from "kysely";
+import { ReadonlyRecord } from "../Object.js";
+import { Result } from "../Result.js";
+import { SqliteBoolean, SqliteQueryOptions, SqliteValue } from "../Sqlite.js";
+import { AnyType, BrandType, InferErrors, InferInput, InferType, MergeObjectTypeErrors, NullableToOptionalProps, ObjectType, OptionalType, Type, TypeError } from "../Type.js";
+import { Simplify } from "../Types.js";
+import { DbSchema } from "./Db.js";
+import { DbIndexesBuilder } from "./Kysely.js";
+import { ShardOwner, SharedOwner } from "./Owner.js";
+import { BinaryId } 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}.
+ *
+ * ### Example
+ *
+ * ```ts
+ * const TodoId = id("Todo");
+ * type TodoId = typeof TodoId.Type;
+ *
+ * const TodoCategoryId = id("TodoCategory");
+ * type TodoCategoryId = typeof TodoCategoryId.Type;
+ *
+ * const NonEmptyString50 = maxLength(50)(NonEmptyString);
+ * type NonEmptyString50 = typeof NonEmptyString50.Type;
+ *
+ * // Database schema.
+ * const Schema = {
+ *   todo: {
+ *     id: TodoId,
+ *     title: NonEmptyString1000,
+ *     isCompleted: nullable(SqliteBoolean),
+ *     categoryId: nullable(TodoCategoryId),
+ *   },
+ *   todoCategory: {
+ *     id: TodoCategoryId,
+ *     name: NonEmptyString50,
+ *     json: nullable(SomeJson),
+ *   },
+ * };
+ * ```
+ */
+export type EvoluSchema = ReadonlyRecord<string, ReadonlyRecord<string, Type<any, any, any, any, any>> & {
+    readonly id: Type<any, any, any, any, any>;
+}>;
+export type CreateQuery<S extends EvoluSchema> = <R extends Row>(queryCallback: (db: Pick<Kysely<{
+    [Table in keyof S]: {
+        readonly [Column in keyof S[Table]]: Column extends "id" | "createdAt" | "updatedAt" ? InferType<S[Table][Column]> : InferType<S[Table][Column]> | null;
+    } & DefaultColumns;
+} & {
+    readonly evolu_history: {
+        readonly timestamp: BinaryTimestamp;
+        readonly table: keyof S;
+        readonly row: BinaryId;
+        readonly column: string;
+        readonly value: SqliteValue;
+    };
+}>, "selectFrom" | "fn" | "with" | "withRecursive">) => SelectQueryBuilder<any, any, R>, options?: SqliteQueryOptions) => Query<Simplify<R>>;
+export declare const DefaultColumns: ObjectType<{
+    createdAt: BrandType<Type<"String", string, string, import("../Type.js").StringError, string, import("../Type.js").StringError>, "DateIso", import("../Type.js").DateIsoStringError, import("../Type.js").StringError>;
+    updatedAt: BrandType<Type<"String", string, string, import("../Type.js").StringError, string, import("../Type.js").StringError>, "DateIso", import("../Type.js").DateIsoStringError, import("../Type.js").StringError>;
+    isDeleted: import("../Type.js").UnionType<[Type<"Null", null, null, import("../Type.js").NullError, null, import("../Type.js").NullError>, import("../Type.js").TransformType<Type<"Boolean", boolean, boolean, import("../Type.js").BooleanError, boolean, import("../Type.js").BooleanError>, import("../Type.js").UnionType<[import("../Type.js").LiteralType<0>, import("../Type.js").LiteralType<1>]>, never>]>;
+}>;
+export type DefaultColumns = typeof DefaultColumns.Type;
+/**
+ * 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 declare const ValidEvoluSchema: BrandType<import("../Type.js").RecordType<"Brand", string & import("../Types.js").Brand<"Base64Url"> & import("../Types.js").Brand<"MaxLength256">, string, import("../Type.js").MaxLengthError<256>, string & import("../Types.js").Brand<"Base64Url">, import("../Type.js").StringError | import("../Type.js").RegexError<"Base64Url">, import("../Type.js").ObjectWithRecordType<{
+    id: Type<"EvoluType", AnyType, AnyType, import("../Type.js").EvoluTypeError, AnyType, import("../Type.js").EvoluTypeError>;
+}, "Brand", string & import("../Types.js").Brand<"Base64Url"> & import("../Types.js").Brand<"MaxLength256">, string, import("../Type.js").MaxLengthError<256>, string & import("../Types.js").Brand<"Base64Url">, import("../Type.js").StringError | import("../Type.js").RegexError<"Base64Url">, Type<"Unknown", unknown, unknown, never, unknown, never>>>, "ValidEvoluSchema", ValidEvoluSchemaError, import("../Type.js").RecordError<import("../Type.js").MaxLengthError<256>, import("../Type.js").ObjectWithRecordError<{
+    id: import("../Type.js").EvoluTypeError;
+}, import("../Type.js").MaxLengthError<256>, never>> | import("../Type.js").RecordError<import("../Type.js").StringError | import("../Type.js").RegexError<"Base64Url">, import("../Type.js").ObjectWithRecordError<{
+    id: import("../Type.js").EvoluTypeError;
+}, import("../Type.js").StringError | import("../Type.js").RegexError<"Base64Url">, never>>>;
+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 declare const assertValidEvoluSchema: (value: unknown) => ValidEvoluSchema;
+export declare const validEvoluSchemaToDbSchema: (validEvoluSchema: ValidEvoluSchema, indexes?: DbIndexesBuilder) => DbSchema;
+export type MutationKind = "insert" | "update" | "upsert";
+export type Mutation<S extends EvoluSchema, Kind extends MutationKind> = <TableName extends keyof S>(table: TableName, props: InferInput<ObjectType<MutationMapping<S[TableName], Kind>>>, options?: MutationOptions) => Result<{
+    readonly id: S[TableName]["id"]["Type"];
+}, ValidMutationSizeError | MergeObjectTypeErrors<ObjectType<MutationMapping<S[TableName], Kind>>>>;
+export type MutationMapping<P extends Record<string, AnyType>, M extends MutationKind> = M extends "insert" ? InsertableProps<P> : M extends "update" ? UpdateableProps<P> : UpsertableProps<P>;
+export interface MutationOptions {
+    readonly onComplete?: () => void;
+    /**
+     * Only validate, don't mutate.
+     *
+     * For example, `onChange` handler can call `insert`/`update`/`upsert` with
+     * `onlyValidate: true`.
+     */
+    readonly onlyValidate?: boolean;
+    /**
+     * The owner to use for this mutation. Can be a {@link ShardOwner} for sharding
+     * app data or a {@link SharedOwner} for collaborative write access. If
+     * omitted, defaults to the app's {@link AppOwner}.
+     */
+    readonly owner?: ShardOwner | SharedOwner;
+}
+/**
+ * Evolu has to limit the maximum mutation size. Otherwise, sync couldn't use
+ * the {@link maxProtocolMessageRangesSize}. The max size is 640KB in bytes,
+ * measured via MessagePack. Evolu Protocol DbChange will be smaller thanks to
+ * various optimizations.
+ */
+export declare const maxMutationSize = 655360;
+export interface ValidMutationSizeError extends TypeError<"ValidMutationSize"> {
+}
+export declare const formatValidMutationSizeError: import("../Type.js").TypeErrorFormatter<ValidMutationSizeError>;
+export type ValidMutationSize<Props extends Record<string, AnyType>> = BrandType<ObjectType<Props>, "ValidMutationSize", ValidMutationSizeError, InferErrors<ObjectType<Props>>>;
+/**
+ * Type Factory to create insertable {@link Type}. It makes nullable Types
+ * optional, omits Id, and ensures the {@link maxMutationSize}.
+ *
+ * ### Example
+ *
+ * ```ts
+ * const InsertableTodo = insertable(Schema.todo);
+ * type InsertableTodo = typeof InsertableTodo.Type;
+ * const todo = InsertableTodo.from({ title });
+ * if (!todo.ok) return; // handle errors
+ * ```
+ */
+export declare const insertable: <Props extends Record<string, AnyType>>(props: Props) => ValidMutationSize<InsertableProps<Props>>;
+export type InsertableProps<Props extends Record<string, AnyType>> = Omit<NullableToOptionalProps<Props>, "id">;
+export type Insertable<Props extends Record<string, AnyType>> = InferInput<ObjectType<InsertableProps<Props>>>;
+/**
+ * Type Factory to create updateable {@link Type}. It makes everything except for
+ * the `id` column partial (i.e. optional) and ensures the
+ * {@link maxMutationSize}.
+ *
+ * ### Example
+ *
+ * ```ts
+ * const UpdateableTodo = updateable(Schema.todo);
+ * type UpdateableTodo = typeof UpdateableTodo.Type;
+ *
+ * // `id` is required; all other fields are optional.
+ * const todoResult = UpdateableTodo.from({
+ *   id: "123",
+ *   title: "New Title",
+ * });
+ * if (!todo.ok) return; // handle errors
+ * ```
+ */
+export declare const updateable: <Props extends Record<string, AnyType>>(props: Props) => ValidMutationSize<UpdateableProps<Props>>;
+export type UpdateableProps<Props extends Record<string, AnyType>> = {
+    [K in keyof Props]: K extends "id" ? Props[K] : OptionalType<Props[K]>;
+} & {
+    isDeleted: OptionalType<typeof SqliteBoolean>;
+};
+export type Updateable<Props extends Record<string, AnyType>> = InferInput<ObjectType<UpdateableProps<Props>>>;
+/**
+ * Type Factory to create upsertable Type. It makes nullable Types optional and
+ * ensures the {@link maxMutationSize}.
+ *
+ * ### Example
+ *
+ * ```ts
+ * const UpsertableTodo = upsertable(Schema.todo);
+ * type UpsertableTodo = typeof UpsertableTodo.Type;
+ * const todo = UpsertableTodo.from({ id, title });
+ * if (!todo.ok) return; // handle errors
+ * ```
+ */
+export declare const upsertable: <Props extends Record<string, AnyType>>(props: Props) => ValidMutationSize<UpsertableProps<Props>>;
+export type UpsertableProps<Props extends Record<string, AnyType>> = NullableToOptionalProps<Props>;
+export type Upsertable<Props extends Record<string, AnyType>> = InferInput<ObjectType<UpsertableProps<Props>>>;
+export type InferEvoluSchemaError<S extends EvoluSchema> = {
+    [Table in keyof S]: InferMutationTypeErrors<S[Table]>;
+}[keyof S];
+export type InferMutationTypeErrors<T extends Record<string, AnyType>> = InferColumnErrors<T, "insert"> | InferColumnErrors<T, "update"> | InferColumnErrors<T, "upsert">;
+export type InferColumnErrors<T extends Record<string, AnyType>, M extends MutationKind> = {
+    [Column in keyof MutationMapping<T, M>]: InferErrors<MutationMapping<T, M>[Column]>;
+}[keyof MutationMapping<T, M>];
+//# sourceMappingURL=Schema.d.ts.map

package/dist/src/Evolu/Schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../../src/Evolu/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,QAAQ,CAAC;AAEpD,OAAO,EAA8B,cAAc,EAAE,MAAM,cAAc,CAAC;AAC1E,OAAO,EAAW,MAAM,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC9E,OAAO,EACL,OAAO,EAEP,SAAS,EAKT,WAAW,EACX,UAAU,EACV,SAAS,EACT,qBAAqB,EAErB,uBAAuB,EAGvB,UAAU,EAGV,YAAY,EAEZ,IAAI,EACJ,SAAS,EAEV,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAW,MAAM,SAAS,CAAC;AAC5C,OAAO,EAAiB,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAC9D,OAAO,EAAY,UAAU,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC/D,OAAO,EAEL,QAAQ,EAET,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,MAAM,WAAW,GAAG,cAAc,CACtC,MAAM,EACN,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,GAAG;IACtD,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;CAC5C,CACF,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,CAAC,SAAS,GAAG,EAC7D,aAAa,EAAE,CACb,EAAE,EAAE,IAAI,CACN,MAAM,CACJ;KACG,KAAK,IAAI,MAAM,CAAC,GAAG;QAClB,QAAQ,EAAE,MAAM,IAAI,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,MAAM,SACvC,IAAI,GACJ,WAAW,GACX,WAAW,GACX,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAC3B,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI;KACvC,GAAG,cAAc;CACnB,GAAG;IACF,QAAQ,CAAC,aAAa,EAAE;QACtB,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;QACpC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACxB,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC;QACvB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;QACxB,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;KAC7B,CAAC;CACH,CACF,EACD,YAAY,GAAG,IAAI,GAAG,MAAM,GAAG,eAAe,CAC/C,KACE,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EACpC,OAAO,CAAC,EAAE,kBAAkB,KACzB,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AAExB,eAAO,MAAM,cAAc;;;;EAIzB,CAAC;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,cAAc,CAAC,IAAI,CAAC;AAKxD;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB;;;;;;4FAyB5B,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,OAAO,gBAAgB,CAAC,IAAI,CAAC;AAE5D,MAAM,WAAW,qBAAsB,SAAQ,SAAS,CAAC,kBAAkB,CAAC;IAC1E,QAAQ,CAAC,MAAM,EAAE;QACf,IAAI,EAAE,oBAAoB,CAAC;QAC3B,SAAS,EAAE,MAAM,CAAC;QAClB,UAAU,EAAE,MAAM,CAAC;KACpB,CAAC;CACH;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,GAAI,OAAO,OAAO,KAAG,gBAOvD,CAAC;AAiCF,eAAO,MAAM,0BAA0B,GACrC,kBAAkB,gBAAgB,EAClC,UAAU,gBAAgB,KACzB,QAaF,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAE1D,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,WAAW,EAAE,IAAI,SAAS,YAAY,IAAI,CACvE,SAAS,SAAS,MAAM,CAAC,EAEzB,KAAK,EAAE,SAAS,EAChB,KAAK,EAAE,UAAU,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,EAClE,OAAO,CAAC,EAAE,eAAe,KACtB,MAAM,CACT;IAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAA;CAAE,EACzC,sBAAsB,GACtB,qBAAqB,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CACzE,CAAC;AAEF,MAAM,MAAM,eAAe,CACzB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,CAAC,SAAS,YAAY,IACpB,CAAC,SAAS,QAAQ,GAClB,eAAe,CAAC,CAAC,CAAC,GAClB,CAAC,SAAS,QAAQ,GAChB,eAAe,CAAC,CAAC,CAAC,GAClB,eAAe,CAAC,CAAC,CAAC,CAAC;AAEzB,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,IAAI,CAAC;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;OAIG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CAC3C;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,SAAS,CAAC;AAStC,MAAM,WAAW,sBACf,SAAQ,SAAS,CAAC,mBAAmB,CAAC;CAAG;AAE3C,eAAO,MAAM,4BAA4B,iEAItC,CAAC;AAEJ,MAAM,MAAM,iBAAiB,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACjE,SAAS,CACP,UAAU,CAAC,KAAK,CAAC,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,WAAW,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAC/B,CAAC;AAEJ;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,OAAO,KAAK,KACX,iBAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,CAI1C,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,CACvE,uBAAuB,CAAC,KAAK,CAAC,EAC9B,IAAI,CACL,CAAC;AAEF,MAAM,MAAM,UAAU,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,UAAU,CACxE,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CACnC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,OAAO,KAAK,KACX,iBAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,CAM1C,CAAC;AAEF,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;KAClE,CAAC,IAAI,MAAM,KAAK,GAAG,CAAC,SAAS,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;CACvE,GAAG;IAAE,SAAS,EAAE,YAAY,CAAC,OAAO,aAAa,CAAC,CAAA;CAAE,CAAC;AAEtD,MAAM,MAAM,UAAU,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,UAAU,CACxE,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CACnC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,UAAU,GAAI,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC9D,OAAO,KAAK,KACX,iBAAiB,CAAC,eAAe,CAAC,KAAK,CAAC,CACG,CAAC;AAE/C,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAC/D,uBAAuB,CAAC,KAAK,CAAC,CAAC;AAEjC,MAAM,MAAM,UAAU,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,UAAU,CACxE,UAAU,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CACnC,CAAC;AAEF,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,WAAW,IAAI;KACxD,KAAK,IAAI,MAAM,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;CACtD,CAAC,MAAM,CAAC,CAAC,CAAC;AAEX,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACjE,iBAAiB,CAAC,CAAC,EAAE,QAAQ,CAAC,GAC9B,iBAAiB,CAAC,CAAC,EAAE,QAAQ,CAAC,GAC9B,iBAAiB,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC;AAEnC,MAAM,MAAM,iBAAiB,CAC3B,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACjC,CAAC,SAAS,YAAY,IACpB;KACD,MAAM,IAAI,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,WAAW,CAClD,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAC9B;CACF,CAAC,MAAM,eAAe,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC"}

package/dist/src/Evolu/Schema.js

@@ -0,0 +1,150 @@
+import { pack } from "msgpackr";
+import { mapObject, objectToEntries } from "../Object.js";
+import { err, ok } from "../Result.js";
+import { SqliteBoolean } from "../Sqlite.js";
+import { brand, createTypeErrorFormatter, DateIsoString, EvoluType, nullableToOptional, nullOr, object, omit, optional, record, Unknown, } from "../Type.js";
+import { createIndexes } from "./Kysely.js";
+import { Base64Url256, } from "./Protocol.js";
+export const DefaultColumns = object({
+    createdAt: DateIsoString,
+    updatedAt: DateIsoString,
+    isDeleted: nullOr(SqliteBoolean),
+});
+const isDefaultColumnName = (value) => 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]) {
+            if (isDefaultColumnName(columnName)) {
+                return err({
+                    type: "ValidEvoluSchema",
+                    value,
+                    reason: {
+                        kind: "DefaultColumnError",
+                        tableName,
+                        columnName,
+                    },
+                });
+            }
+        }
+    }
+    return ok(value);
+});
+/**
+ * Asserts that the given value is {@link ValidEvoluSchema}.
+ *
+ * Throws an error if the value is not a valid Evolu schema.
+ */
+export const assertValidEvoluSchema = (value) => {
+    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) => {
+    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, indexes) => {
+    const tables = objectToEntries(validEvoluSchema).map(([tableName, table]) => ({
+        name: tableName,
+        columns: objectToEntries(table)
+            .filter(([k]) => k !== "id")
+            .map(([k]) => k),
+    }));
+    return {
+        tables,
+        indexes: createIndexes(indexes),
+    };
+};
+/**
+ * Evolu has to limit the maximum mutation size. Otherwise, sync couldn't use
+ * the {@link maxProtocolMessageRangesSize}. The max size is 640KB in bytes,
+ * measured via MessagePack. Evolu Protocol DbChange will be smaller thanks to
+ * various optimizations.
+ */
+export const maxMutationSize = 655360;
+const validMutationSize = (type) => brand("ValidMutationSize", type, (value) => pack(value).byteLength <= maxMutationSize
+    ? ok(value)
+    : err({ type: "ValidMutationSize", value }));
+export const formatValidMutationSizeError = createTypeErrorFormatter((error) => `The mutation size exceeds the maximum limit of ${maxMutationSize} bytes. The provided mutation has a size of ${pack(error.value).byteLength} bytes.`);
+/**
+ * Type Factory to create insertable {@link Type}. It makes nullable Types
+ * optional, omits Id, and ensures the {@link maxMutationSize}.
+ *
+ * ### Example
+ *
+ * ```ts
+ * const InsertableTodo = insertable(Schema.todo);
+ * type InsertableTodo = typeof InsertableTodo.Type;
+ * const todo = InsertableTodo.from({ title });
+ * if (!todo.ok) return; // handle errors
+ * ```
+ */
+export const insertable = (props) => {
+    const optionalNullable = nullableToOptional(props);
+    const withoutId = omit(optionalNullable, "id");
+    return validMutationSize(withoutId);
+};
+/**
+ * Type Factory to create updateable {@link Type}. It makes everything except for
+ * the `id` column partial (i.e. optional) and ensures the
+ * {@link maxMutationSize}.
+ *
+ * ### Example
+ *
+ * ```ts
+ * const UpdateableTodo = updateable(Schema.todo);
+ * type UpdateableTodo = typeof UpdateableTodo.Type;
+ *
+ * // `id` is required; all other fields are optional.
+ * const todoResult = UpdateableTodo.from({
+ *   id: "123",
+ *   title: "New Title",
+ * });
+ * if (!todo.ok) return; // handle errors
+ * ```
+ */
+export const updateable = (props) => {
+    const propsWithIsDeleted = { ...props, isDeleted: SqliteBoolean };
+    const updateableProps = mapObject(propsWithIsDeleted, (value, key) => key === "id" ? value : optional(value));
+    return validMutationSize(object(updateableProps));
+};
+/**
+ * Type Factory to create upsertable Type. It makes nullable Types optional and
+ * ensures the {@link maxMutationSize}.
+ *
+ * ### Example
+ *
+ * ```ts
+ * const UpsertableTodo = upsertable(Schema.todo);
+ * type UpsertableTodo = typeof UpsertableTodo.Type;
+ * const todo = UpsertableTodo.from({ id, title });
+ * if (!todo.ok) return; // handle errors
+ * ```
+ */
+export const upsertable = (props) => validMutationSize(nullableToOptional(props));

package/dist/src/Evolu/Storage.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Evolu Storage for SQLite
+ *
+ * Evolu uses a Skiplist, which leverages SQLite indexes. The core logic is
+ * implemented in SQL, so it doesn't have to make roundtrips to the DB.
+ *
+ * The ideal storage for a Relay should use a similar architecture to
+ * [strfry](https://github.com/hoytech/strfry) (a KV storage), but with Skiplist
+ * to ensure that insertion order doesn't matter (local-first apps can often
+ * write in the past.)
+ *
+ * The ideal client implementation should probably use the SQLite extension
+ * instead of SQL or even a KV storage, when such a thing for browsers/native
+ * will exist and will be faster than SQLite.
+ *
+ * # Scaling
+ *
+ * The load can be distributed by deploying multiple relays, synchronized with
+ * each other, if necessary. One relay should handle hundreds of thousands of
+ * users, and when it goes down, nothing happens, because it will be
+ * synchronized later.
+ *
+ * @module
+ */
+import { RandomDep } from "../Random.js";
+import { Result } from "../Result.js";
+import { SqliteDep, SqliteError } from "../Sqlite.js";
+import { NonNegativeInt } from "../Type.js";
+import { BinaryOwnerId, Storage } from "./Protocol.js";
+import { BinaryTimestamp } from "./Timestamp.js";
+/** Common interface for both client and relay SQLite storages. */
+export interface SqliteStorageBase {
+    readonly insertTimestamp: (ownerId: BinaryOwnerId, timestamp: BinaryTimestamp) => Result<void, SqliteError>;
+    readonly getSize: Storage["getSize"];
+    readonly fingerprint: Storage["fingerprint"];
+    readonly fingerprintRanges: Storage["fingerprintRanges"];
+    readonly findLowerBound: Storage["findLowerBound"];
+    readonly iterate: Storage["iterate"];
+}
+export interface SqliteStorageBaseDep {
+    readonly storage: SqliteStorageBase;
+}
+export type SqliteStorageDeps = SqliteDep & RandomDep;
+export interface CreateSqliteStorageBaseOptions {
+    onStorageError: (error: SqliteError) => void;
+}
+export declare const createSqliteStorageBase: (deps: SqliteStorageDeps) => (options: CreateSqliteStorageBaseOptions) => Result<SqliteStorageBase, SqliteError>;
+export declare const getTimestampByIndex: (deps: SqliteDep) => (ownerId: BinaryOwnerId, index: NonNegativeInt) => Result<BinaryTimestamp, SqliteError>;
+//# sourceMappingURL=Storage.d.ts.map

package/dist/src/Evolu/Storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Storage.d.ts","sourceRoot":"","sources":["../../../src/Evolu/Storage.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAIH,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAM,MAAM,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAO,SAAS,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAe,cAAc,EAAe,MAAM,YAAY,CAAC;AAGtE,OAAO,EACL,aAAa,EAQb,OAAO,EAER,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,eAAe,EAAwB,MAAM,gBAAgB,CAAC;AAEvE,kEAAkE;AAClE,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,eAAe,EAAE,CACxB,OAAO,EAAE,aAAa,EACtB,SAAS,EAAE,eAAe,KACvB,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAE/B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;IACrC,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;IAC7C,QAAQ,CAAC,iBAAiB,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IACzD,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACnD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,OAAO,EAAE,iBAAiB,CAAC;CACrC;AAED,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,SAAS,CAAC;AAEtD,MAAM,WAAW,8BAA8B;IAC7C,cAAc,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;CAC9C;AAED,eAAO,MAAM,uBAAuB,GACjC,MAAM,iBAAiB,MAEtB,SAAS,8BAA8B,KACtC,MAAM,CAAC,iBAAiB,EAAE,WAAW,CAyIvC,CAAC;AA09BJ,eAAO,MAAM,mBAAmB,GAC7B,MAAM,SAAS,MAEd,SAAS,aAAa,EACtB,OAAO,cAAc,KACpB,MAAM,CAAC,eAAe,EAAE,WAAW,CA6ErC,CAAC"}