@livestore/common 0.3.0-dev.27 → 0.3.0-dev.29

package/dist/schema/client-document-def.d.ts

@@ -0,0 +1,223 @@
+import type { Option, Types } from '@livestore/utils/effect';
+import { Schema } from '@livestore/utils/effect';
+import { SessionIdSymbol } from '../adapter-types.js';
+import type { QueryBuilder } from '../query-builder/mod.js';
+import { SqliteDsl } from './db-schema/mod.js';
+import type { EventDef, Materializer } from './EventDef.js';
+import type { TableDef, TableDefBase } from './table-def.js';
+/**
+ * Special:
+ * - Synced across client sessions (e.g. tabs) but not across different clients
+ * - Derived setters
+ *   - Emits client-only events
+ *   - Has implicit setter-reducers
+ * - Similar to `React.useState` (except it's persisted)
+ *
+ * Careful:
+ * - When changing the table definitions in a non-backwards compatible way, the state might be lost without
+ *   explicit reducers to handle the old auto-generated events
+ */
+export declare const clientDocument: <TName extends string, TType, TEncoded, const TOptions extends ClientDocumentTableOptions.Input<NoInfer<TType>>>({ name, schema: valueSchema, ...inputOptions }: {
+    name: TName;
+    schema: Schema.Schema<TType, TEncoded>;
+} & TOptions) => ClientDocumentTableDef<TName, TType, TEncoded, Types.Simplify<ClientDocumentTableOptions.WithDefaults<TOptions>>>;
+export declare const deriveEventAndMaterializer: ({ name, valueSchema, defaultValue, partialSet, }: {
+    name: string;
+    valueSchema: Schema.Schema<any, any>;
+    defaultValue: any;
+    partialSet: boolean;
+}) => {
+    eventDef: EventDef<`${string}Set`, {
+        readonly value: any;
+        readonly id: string | typeof SessionIdSymbol;
+    }, {
+        readonly value: any;
+        readonly id: string | typeof SessionIdSymbol;
+    }, true>;
+    materializer: Materializer<EventDef<`${string}Set`, {
+        readonly value: any;
+        readonly id: string | typeof SessionIdSymbol;
+    }, {
+        readonly value: any;
+        readonly id: string | typeof SessionIdSymbol;
+    }, true>>;
+};
+export declare const tableIsClientDocumentTable: <TTableDef extends TableDefBase>(tableDef: TTableDef) => tableDef is TTableDef & {
+    options: {
+        isClientDocumentTable: true;
+    };
+} & ClientDocumentTableDef.Trait<TTableDef["sqliteDef"]["name"], any, any, any>;
+export type ClientDocumentTableOptions<TType> = {
+    partialSet: boolean;
+    default: {
+        id: SessionIdSymbol | string | undefined;
+        value: TType;
+    };
+};
+export declare namespace ClientDocumentTableOptions {
+    type Input<TType> = {
+        /**
+         * Whether to allow for partial set operations. Only applies if the schema is a struct.
+         *
+         * @default true
+         */
+        partialSet?: boolean;
+        default: {
+            id?: SessionIdSymbol | string | undefined;
+            value: TType;
+        };
+    };
+    type WithDefaults<TInput extends Input<any>> = {
+        partialSet: TInput['partialSet'] extends false ? false : true;
+        default: {
+            id: TInput['default']['id'] extends string | SessionIdSymbol ? TInput['default']['id'] : undefined;
+            value: TInput['default']['value'];
+        };
+    };
+}
+export type ClientDocumentTableDef<TName extends string, TType, TEncoded, TOptions extends ClientDocumentTableOptions<TType>> = TableDef<ClientDocumentTableDef.SqliteDef<TName, TType>, {
+    isClientDocumentTable: true;
+}> & ClientDocumentTableDef.Trait<TName, TType, TEncoded, TOptions>;
+export declare namespace ClientDocumentTableDef {
+    type Any = ClientDocumentTableDef<any, any, any, any>;
+    type SqliteDef<TName extends string, TType> = SqliteDsl.TableDefinition<TName, {
+        id: SqliteDsl.ColumnDefinition<string, string> & {
+            default: Option.Some<string>;
+        };
+        value: SqliteDsl.ColumnDefinition<string, TType> & {
+            default: Option.Some<TType>;
+        };
+    }>;
+    type TableDefBase_<TName extends string, TType> = TableDefBase<SqliteDef<TName, TType>, {
+        isClientDocumentTable: true;
+    }>;
+    interface Trait<TName extends string, TType, TEncoded, TOptions extends ClientDocumentTableOptions<TType>> {
+        /**
+         * Get the current value of the client document table.
+         *
+         * @example
+         * ```ts
+         * const someDocumentTable = State.SQLite.clientDocument({
+         *   name: 'SomeDocumentTable',
+         *   schema: Schema.Struct({
+         *     someField: Schema.String,
+         *   }),
+         *   default: { value: { someField: 'some-value' } },
+         * })
+         *
+         * const value$ = queryDb(someDocumentTable.get('some-id'))
+         *
+         * // When you've set a default id, you can omit the id argument
+         *
+         * const uiState = State.SQLite.clientDocument({
+         *   name: 'UiState',
+         *   schema: Schema.Struct({
+         *     someField: Schema.String,
+         *   }),
+         *   default: { id: SessionIdSymbol, value: { someField: 'some-value' } },
+         * })
+         *
+         * const value$ = queryDb(uiState.get())
+         * ```
+         */
+        readonly get: MakeGetQueryBuilder<TName, TType, TOptions>;
+        /**
+         * Derived event definition for setting the value of the client document table.
+         * If the document doesn't exist yet, the first .set event will create it.
+         *
+         * @example
+         * ```ts
+         * const someDocumentTable = State.SQLite.clientDocument({
+         *   name: 'SomeDocumentTable',
+         *   schema: Schema.Struct({
+         *     someField: Schema.String,
+         *     someOtherField: Schema.String,
+         *   }),
+         *   default: { value: { someField: 'some-default-value', someOtherField: 'some-other-default-value' } },
+         * })
+         *
+         * const setEventDef = store.commit(someDocumentTable.set({ someField: 'explicit-value' }, 'some-id'))
+         * // Will commit an event with the following payload:
+         * // { id: 'some-id', value: { someField: 'explicit-value', someOtherField: 'some-other-default-value' } }
+         * ```
+         *
+         * Similar to `.get`, you can omit the id argument if you've set a default id.
+         *
+         * @example
+         * ```ts
+         * const uiState = State.SQLite.clientDocument({
+         *   name: 'UiState',
+         *   schema: Schema.Struct({ someField: Schema.String }),
+         *   default: { id: SessionIdSymbol, value: { someField: 'some-default-value' } },
+         * })
+         *
+         * const setEventDef = store.commit(uiState.set({ someField: 'explicit-value' }))
+         * // Will commit an event with the following payload:
+         * // { id: '...', value: { someField: 'explicit-value' } }
+         * //        ^^^
+         * //        Automatically replaced with the client session id
+         * ```
+         */
+        readonly set: SetEventDefLike<TName, TType, TOptions>;
+        readonly Value: TType;
+        readonly valueSchema: Schema.Schema<TType, TEncoded>;
+        readonly default: TOptions['default'];
+        readonly [ClientDocumentTableDefSymbol]: {
+            readonly options: TOptions;
+            readonly derived: {
+                readonly setEventDef: SetEventDef<TName, TType, TOptions>;
+                readonly setMaterializer: Materializer<SetEventDef<TName, TType, TOptions>>;
+            };
+        };
+    }
+    type GetOptions<TTableDef extends TraitAny> = TTableDef extends ClientDocumentTableDef.Trait<any, any, any, infer TOptions> ? TOptions : never;
+    type TraitAny = Trait<any, any, any, any>;
+    type DefaultIdType<TTableDef extends TraitAny> = TTableDef extends ClientDocumentTableDef.Trait<any, any, any, infer TOptions> ? TOptions['default']['id'] extends SessionIdSymbol | string ? TOptions['default']['id'] : never : never;
+    type SetEventDefLike<TName extends string, TType, TOptions extends ClientDocumentTableOptions<TType>> = (TOptions['default']['id'] extends undefined ? (args: TOptions['partialSet'] extends false ? TType : Partial<TType>, id: string | SessionIdSymbol) => {
+        name: `${TName}Set`;
+        args: {
+            id: string;
+            value: TType;
+        };
+    } : (args: TOptions['partialSet'] extends false ? TType : Partial<TType>, id?: string | SessionIdSymbol) => {
+        name: `${TName}Set`;
+        args: {
+            id: string;
+            value: TType;
+        };
+    }) & {
+        readonly name: `${TName}Set`;
+        readonly schema: Schema.Schema<any>;
+        readonly Event: {
+            readonly name: `${TName}Set`;
+            readonly args: {
+                id: string;
+                value: TType;
+            };
+        };
+        readonly options: {
+            derived: true;
+            clientOnly: true;
+            facts: undefined;
+        };
+    };
+    type SetEventDef<TName extends string, TType, TOptions extends ClientDocumentTableOptions<TType>> = EventDef<TName, TOptions['partialSet'] extends false ? {
+        id: string;
+        value: TType;
+    } : {
+        id: string;
+        value: Partial<TType>;
+    }, any, true>;
+    type MakeGetQueryBuilder<TName extends string, TType, TOptions extends ClientDocumentTableOptions<TType>> = TOptions extends ClientDocumentTableOptions<TType> & {
+        default: {
+            id: string | SessionIdSymbol;
+        };
+    } ? (id?: TOptions['default']['id'] | SessionIdSymbol, options?: {
+        default: Partial<TType>;
+    }) => QueryBuilder<TType, ClientDocumentTableDef.TableDefBase_<TName, TType>, QueryBuilder.ApiFeature> : (id: string | SessionIdSymbol, options?: {
+        default: Partial<TType>;
+    }) => QueryBuilder<TType, ClientDocumentTableDef.TableDefBase_<TName, TType>, QueryBuilder.ApiFeature>;
+}
+export declare const ClientDocumentTableDefSymbol: unique symbol;
+export type ClientDocumentTableDefSymbol = typeof ClientDocumentTableDefSymbol;
+//# sourceMappingURL=client-document-def.d.ts.map

package/dist/schema/client-document-def.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-document-def.d.ts","sourceRoot":"","sources":["../../src/schema/client-document-def.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAC5D,OAAO,EAAE,MAAM,EAAa,MAAM,yBAAyB,CAAA;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,YAAY,EAAmB,MAAM,yBAAyB,CAAA;AAG5E,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAE3D,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAG5D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,GACzB,KAAK,SAAS,MAAM,EACpB,KAAK,EACL,QAAQ,EACR,KAAK,CAAC,QAAQ,SAAS,0BAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EACvE,gDAIC;IACD,IAAI,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;CACvC,GAAG,QAAQ,KAAG,sBAAsB,CACnC,KAAK,EACL,KAAK,EACL,QAAQ,EACR,KAAK,CAAC,QAAQ,CAAC,0BAA0B,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAmElE,CAAA;AAkBD,eAAO,MAAM,0BAA0B,GAAI,kDAKxC;IACD,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;IACpC,YAAY,EAAE,GAAG,CAAA;IACjB,UAAU,EAAE,OAAO,CAAA;CACpB;;;;;;;;;;;;;;;CAsEA,CAAA;AAED,eAAO,MAAM,0BAA0B,GAAI,SAAS,SAAS,YAAY,EACvE,UAAU,SAAS,KAClB,QAAQ,IAAI,SAAS,GAAG;IACzB,OAAO,EAAE;QAAE,qBAAqB,EAAE,IAAI,CAAA;KAAE,CAAA;CACzC,GAAG,sBAAsB,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAC7B,CAAA;AAgCjD,MAAM,MAAM,0BAA0B,CAAC,KAAK,IAAI;IAC9C,UAAU,EAAE,OAAO,CAAA;IACnB,OAAO,EAAE;QACP,EAAE,EAAE,eAAe,GAAG,MAAM,GAAG,SAAS,CAAA;QACxC,KAAK,EAAE,KAAK,CAAA;KACb,CAAA;CACF,CAAA;AAED,yBAAiB,0BAA0B,CAAC;IAC1C,KAAY,KAAK,CAAC,KAAK,IAAI;QACzB;;;;WAIG;QACH,UAAU,CAAC,EAAE,OAAO,CAAA;QACpB,OAAO,EAAE;YACP,EAAE,CAAC,EAAE,eAAe,GAAG,MAAM,GAAG,SAAS,CAAA;YACzC,KAAK,EAAE,KAAK,CAAA;SACb,CAAA;KACF,CAAA;IAED,KAAY,YAAY,CAAC,MAAM,SAAS,KAAK,CAAC,GAAG,CAAC,IAAI;QACpD,UAAU,EAAE,MAAM,CAAC,YAAY,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,IAAI,CAAA;QAC7D,OAAO,EAAE;YACP,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,eAAe,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,SAAS,CAAA;YAClG,KAAK,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAA;SAClC,CAAA;KACF,CAAA;CACF;AAED,MAAM,MAAM,sBAAsB,CAChC,KAAK,SAAS,MAAM,EACpB,KAAK,EACL,QAAQ,EACR,QAAQ,SAAS,0BAA0B,CAAC,KAAK,CAAC,IAChD,QAAQ,CACV,sBAAsB,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EAC9C;IACE,qBAAqB,EAAE,IAAI,CAAA;CAC5B,CACF,GACC,sBAAsB,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;AAEhE,yBAAiB,sBAAsB,CAAC;IACtC,KAAY,GAAG,GAAG,sBAAsB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAE5D,KAAY,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,IAAI,SAAS,CAAC,eAAe,CAC5E,KAAK,EACL;QACE,EAAE,EAAE,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG;YAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;SAAE,CAAA;QACjF,KAAK,EAAE,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG;YAAE,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;SAAE,CAAA;KACnF,CACF,CAAA;IAED,KAAY,aAAa,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,IAAI,YAAY,CACnE,SAAS,CAAC,KAAK,EAAE,KAAK,CAAC,EACvB;QACE,qBAAqB,EAAE,IAAI,CAAA;KAC5B,CACF,CAAA;IAED,UAAiB,KAAK,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,SAAS,0BAA0B,CAAC,KAAK,CAAC;QAC9G;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,QAAQ,CAAC,GAAG,EAAE,mBAAmB,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;QACzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAoCG;QACH,QAAQ,CAAC,GAAG,EAAE,eAAe,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;QACrD,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;QACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAA;QACpD,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;QACrC,QAAQ,CAAC,CAAC,4BAA4B,CAAC,EAAE;YACvC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAA;YAC1B,QAAQ,CAAC,OAAO,EAAE;gBAChB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAA;gBACzD,QAAQ,CAAC,eAAe,EAAE,YAAY,CAAC,WAAW,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC,CAAA;aAC5E,CAAA;SACF,CAAA;KACF;IAED,KAAY,UAAU,CAAC,SAAS,SAAS,QAAQ,IAC/C,SAAS,SAAS,sBAAsB,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC,GAAG,QAAQ,GAAG,KAAK,CAAA;IAElG,KAAY,QAAQ,GAAG,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAA;IAEhD,KAAY,aAAa,CAAC,SAAS,SAAS,QAAQ,IAClD,SAAS,SAAS,sBAAsB,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,QAAQ,CAAC,GACzE,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,eAAe,GAAG,MAAM,GACxD,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GACzB,KAAK,GACP,KAAK,CAAA;IAEX,KAAY,eAAe,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,EAAE,QAAQ,SAAS,0BAA0B,CAAC,KAAK,CAAC,IAEzG,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GACxC,CACE,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,EACnE,EAAE,EAAE,MAAM,GAAG,eAAe,KACzB;QAAE,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC;QAAC,IAAI,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,KAAK,CAAA;SAAE,CAAA;KAAE,GAChE,CACE,IAAI,EAAE,QAAQ,CAAC,YAAY,CAAC,SAAS,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,EACnE,EAAE,CAAC,EAAE,MAAM,GAAG,eAAe,KAC1B;QAAE,IAAI,EAAE,GAAG,KAAK,KAAK,CAAC;QAAC,IAAI,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,KAAK,EAAE,KAAK,CAAA;SAAE,CAAA;KAAE,CAAC,GAAG;QACtE,QAAQ,CAAC,IAAI,EAAE,GAAG,KAAK,KAAK,CAAA;QAC5B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;QACnC,QAAQ,CAAC,KAAK,EAAE;YACd,QAAQ,CAAC,IAAI,EAAE,GAAG,KAAK,KAAK,CAAA;YAC5B,QAAQ,CAAC,IAAI,EAAE;gBAAE,EAAE,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,KAAK,CAAA;aAAE,CAAA;SAC5C,CAAA;QACD,QAAQ,CAAC,OAAO,EAAE;YAAE,OAAO,EAAE,IAAI,CAAC;YAAC,UAAU,EAAE,IAAI,CAAC;YAAC,KAAK,EAAE,SAAS,CAAA;SAAE,CAAA;KACxE,CAAA;IAEH,KAAY,WAAW,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,EAAE,QAAQ,SAAS,0BAA0B,CAAC,KAAK,CAAC,IAAI,QAAQ,CACjH,KAAK,EACL,QAAQ,CAAC,YAAY,CAAC,SAAS,KAAK,GAAG;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,KAAK,CAAA;KAAE,GAAG;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;KAAE,EAC3G,GAAG,EACH,IAAI,CACL,CAAA;IAED,KAAY,mBAAmB,CAC7B,KAAK,SAAS,MAAM,EACpB,KAAK,EACL,QAAQ,SAAS,0BAA0B,CAAC,KAAK,CAAC,IAChD,QAAQ,SAAS,0BAA0B,CAAC,KAAK,CAAC,GAAG;QAAE,OAAO,EAAE;YAAE,EAAE,EAAE,MAAM,GAAG,eAAe,CAAA;SAAE,CAAA;KAAE,GAClG,CACE,EAAE,CAAC,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,eAAe,EAChD,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;KAAE,KAClC,YAAY,CAAC,KAAK,EAAE,sBAAsB,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,GACrG,CACE,EAAE,EAAE,MAAM,GAAG,eAAe,EAC5B,OAAO,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAA;KAAE,KAClC,YAAY,CAAC,KAAK,EAAE,sBAAsB,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,YAAY,CAAC,UAAU,CAAC,CAAA;CAC1G;AAED,eAAO,MAAM,4BAA4B,eAAmC,CAAA;AAC5E,MAAM,MAAM,4BAA4B,GAAG,OAAO,4BAA4B,CAAA"}

package/dist/schema/client-document-def.js

@@ -0,0 +1,170 @@
+import { shouldNeverHappen } from '@livestore/utils';
+import { Schema, SchemaAST } from '@livestore/utils/effect';
+import { SessionIdSymbol } from '../adapter-types.js';
+import { QueryBuilderAstSymbol, QueryBuilderTypeId } from '../query-builder/mod.js';
+import { sql } from '../util.js';
+import { SqliteDsl } from './db-schema/mod.js';
+import { defineEvent, defineMaterializer } from './EventDef.js';
+import { table } from './table-def.js';
+/**
+ * Special:
+ * - Synced across client sessions (e.g. tabs) but not across different clients
+ * - Derived setters
+ *   - Emits client-only events
+ *   - Has implicit setter-reducers
+ * - Similar to `React.useState` (except it's persisted)
+ *
+ * Careful:
+ * - When changing the table definitions in a non-backwards compatible way, the state might be lost without
+ *   explicit reducers to handle the old auto-generated events
+ */
+export const clientDocument = ({ name, schema: valueSchema, ...inputOptions }) => {
+    const options = {
+        partialSet: inputOptions.partialSet ?? true,
+        default: {
+            id: inputOptions.default.id,
+            value: inputOptions.default.value,
+        },
+    };
+    const columns = {
+        id: SqliteDsl.text({ primaryKey: true }),
+        value: SqliteDsl.json({ schema: valueSchema }),
+    };
+    const tableDef = table({ name, columns });
+    // @ts-expect-error TODO properly type this
+    tableDef.options.isClientDocumentTable = true;
+    const { eventDef: derivedSetEventDef, materializer: derivedSetMaterializer } = deriveEventAndMaterializer({
+        name,
+        valueSchema,
+        defaultValue: options.default.value,
+        partialSet: options.partialSet,
+    });
+    const setEventDef = (...args) => {
+        const [value, id = options.default.id] = args;
+        return derivedSetEventDef({ id, value });
+    };
+    Object.defineProperty(setEventDef, 'name', { value: `${name}Set` });
+    Object.defineProperty(setEventDef, 'schema', {
+        value: Schema.Struct({
+            id: Schema.String,
+            value: options.partialSet ? Schema.partial(valueSchema) : valueSchema,
+        }).annotations({ title: `${name}Set:Args` }),
+    });
+    Object.defineProperty(setEventDef, 'options', { value: { derived: true, clientOnly: true, facts: undefined } });
+    const clientDocumentTableDefTrait = {
+        get: makeGetQueryBuilder(() => clientDocumentTableDef),
+        set: setEventDef,
+        Value: 'only-for-type-inference',
+        default: options.default,
+        valueSchema,
+        [ClientDocumentTableDefSymbol]: {
+            derived: {
+                setEventDef: derivedSetEventDef,
+                setMaterializer: derivedSetMaterializer,
+            },
+            options,
+        },
+    };
+    const clientDocumentTableDef = {
+        ...tableDef,
+        ...clientDocumentTableDefTrait,
+    };
+    return clientDocumentTableDef;
+};
+const mergeDefaultValues = (defaultValues, explicitDefaultValues) => {
+    if (typeof defaultValues !== 'object' ||
+        typeof explicitDefaultValues !== 'object' ||
+        defaultValues === null ||
+        explicitDefaultValues === null) {
+        return explicitDefaultValues;
+    }
+    return Object.keys(defaultValues).reduce((acc, key) => {
+        acc[key] = explicitDefaultValues[key] ?? defaultValues[key];
+        return acc;
+    }, {});
+};
+export const deriveEventAndMaterializer = ({ name, valueSchema, defaultValue, partialSet, }) => {
+    const derivedSetEventDef = defineEvent({
+        name: `${name}Set`,
+        schema: Schema.Struct({
+            id: Schema.Union(Schema.String, Schema.UniqueSymbolFromSelf(SessionIdSymbol)),
+            value: partialSet ? Schema.partial(valueSchema) : valueSchema,
+        }).annotations({ title: `${name}Set:Args` }),
+        clientOnly: true,
+        derived: true,
+    });
+    const derivedSetMaterializer = defineMaterializer(derivedSetEventDef, ({ id, value }) => {
+        if (id === SessionIdSymbol) {
+            return shouldNeverHappen(`SessionIdSymbol needs to be replaced before materializing the set event`);
+        }
+        // Override the full value if it's not an object or no partial set is allowed
+        const schemaProps = SchemaAST.getPropertySignatures(valueSchema.ast);
+        if (schemaProps.length === 0 || partialSet === false) {
+            const valueColJsonSchema = Schema.parseJson(valueSchema);
+            const encodedInsertValue = Schema.encodeSyncDebug(valueColJsonSchema)(value ?? defaultValue);
+            const encodedUpdateValue = Schema.encodeSyncDebug(valueColJsonSchema)(value);
+            return {
+                sql: `INSERT INTO '${name}' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?`,
+                bindValues: [id, encodedInsertValue, encodedUpdateValue],
+                writeTables: new Set([name]),
+            };
+        }
+        else {
+            const valueColJsonSchema = Schema.parseJson(Schema.partial(valueSchema));
+            const encodedInsertValue = Schema.encodeSyncDebug(valueColJsonSchema)(mergeDefaultValues(defaultValue, value));
+            let jsonSetSql = 'value';
+            const setBindValues = [];
+            const keys = Object.keys(value);
+            const partialUpdateSchema = valueSchema.pipe(Schema.pick(...keys));
+            const encodedPartialUpdate = Schema.encodeSyncDebug(partialUpdateSchema)(value);
+            for (const key in encodedPartialUpdate) {
+                const encodedValueForKey = encodedPartialUpdate[key];
+                // Skipping undefined values
+                if (encodedValueForKey === undefined) {
+                    continue;
+                }
+                jsonSetSql = `json_set(${jsonSetSql}, ?, json(?))`;
+                setBindValues.push(`$.${key}`, JSON.stringify(encodedValueForKey));
+            }
+            const onConflictClause = setBindValues.length > 0
+                ? `ON CONFLICT (id) DO UPDATE SET value = ${jsonSetSql}`
+                : 'ON CONFLICT (id) DO NOTHING';
+            const sqlQuery = `
+      INSERT INTO '${name}' (id, value)
+      VALUES (?, ?)
+      ${onConflictClause}
+    `;
+            return {
+                sql: sqlQuery,
+                bindValues: [id, encodedInsertValue, ...setBindValues],
+                writeTables: new Set([name]),
+            };
+        }
+    });
+    return { eventDef: derivedSetEventDef, materializer: derivedSetMaterializer };
+};
+export const tableIsClientDocumentTable = (tableDef) => tableDef.options.isClientDocumentTable === true;
+const makeGetQueryBuilder = (getTableDef) => {
+    return ((...args) => {
+        const tableDef = getTableDef();
+        const [id = tableDef[ClientDocumentTableDefSymbol].options.default.id, options = {}] = args;
+        const explicitDefaultValues = options.default ?? tableDef[ClientDocumentTableDefSymbol].options.default.value;
+        const ast = {
+            _tag: 'RowQuery',
+            tableDef,
+            id,
+            explicitDefaultValues,
+        };
+        const query = sql `SELECT * FROM '${tableDef.sqliteDef.name}' WHERE id = ?`;
+        return {
+            [QueryBuilderTypeId]: QueryBuilderTypeId,
+            [QueryBuilderAstSymbol]: ast,
+            ResultType: 'only-for-type-inference',
+            asSql: () => ({ query, bindValues: [id] }),
+            toString: () => query.toString(),
+            ...{}, // Needed for type cast
+        };
+    });
+};
+export const ClientDocumentTableDefSymbol = Symbol('ClientDocumentTableDef');
+//# sourceMappingURL=client-document-def.js.map

package/dist/schema/client-document-def.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-document-def.js","sourceRoot":"","sources":["../../src/schema/client-document-def.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAA;AAEpD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAErD,OAAO,EAAE,qBAAqB,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACnF,OAAO,EAAE,GAAG,EAAE,MAAM,YAAY,CAAA;AAChC,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAE9C,OAAO,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAE/D,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAK5B,EACA,IAAI,EACJ,MAAM,EAAE,WAAW,EACnB,GAAG,YAAY,EAIL,EAKV,EAAE;IACF,MAAM,OAAO,GAAG;QACd,UAAU,EAAE,YAAY,CAAC,UAAU,IAAI,IAAI;QAC3C,OAAO,EAAE;YACP,EAAE,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE;YAC3B,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,KAAK;SAClC;KAC0C,CAAA;IAE7C,MAAM,OAAO,GAAG;QACd,EAAE,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QACxC,KAAK,EAAE,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;KAC/C,CAAA;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAA;IAEzC,2CAA2C;IAC3C,QAAQ,CAAC,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAA;IAE7C,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,sBAAsB,EAAE,GAAG,0BAA0B,CAAC;QACxG,IAAI;QACJ,WAAW;QACX,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK;QACnC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAA;IAEF,MAAM,WAAW,GAAG,CAAC,GAAG,IAAW,EAAE,EAAE;QACrC,MAAM,CAAC,KAAK,EAAE,EAAE,GAAG,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI,CAAA;QAC7C,OAAO,kBAAkB,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,CAAA;IAC1C,CAAC,CAAA;IAED,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,GAAG,IAAI,KAAK,EAAE,CAAC,CAAA;IACnE,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,QAAQ,EAAE;QAC3C,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,MAAM;YACjB,KAAK,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW;SACtE,CAAC,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,UAAU,EAAE,CAAC;KAC7C,CAAC,CAAA;IACF,MAAM,CAAC,cAAc,CAAC,WAAW,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,EAAE,CAAC,CAAA;IAE/G,MAAM,2BAA2B,GAK7B;QACF,GAAG,EAAE,mBAAmB,CAAC,GAAG,EAAE,CAAC,sBAAsB,CAAQ;QAC7D,GAAG,EAAE,WAAkB;QACvB,KAAK,EAAE,yBAAgC;QACvC,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,WAAW;QACX,CAAC,4BAA4B,CAAC,EAAE;YAC9B,OAAO,EAAE;gBACP,WAAW,EAAE,kBAAyB;gBACtC,eAAe,EAAE,sBAA6B;aAC/C;YACD,OAAO;SACR;KACF,CAAA;IAED,MAAM,sBAAsB,GAAG;QAC7B,GAAG,QAAQ;QACX,GAAG,2BAA2B;KACxB,CAAA;IAER,OAAO,sBAAsB,CAAA;AAC/B,CAAC,CAAA;AAED,MAAM,kBAAkB,GAAG,CAAI,aAAgB,EAAE,qBAAwB,EAAK,EAAE;IAC9E,IACE,OAAO,aAAa,KAAK,QAAQ;QACjC,OAAO,qBAAqB,KAAK,QAAQ;QACzC,aAAa,KAAK,IAAI;QACtB,qBAAqB,KAAK,IAAI,EAC9B,CAAC;QACD,OAAO,qBAAqB,CAAA;IAC9B,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,aAAoB,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC3D,GAAG,CAAC,GAAG,CAAC,GAAI,qBAA6B,CAAC,GAAG,CAAC,IAAK,aAAqB,CAAC,GAAG,CAAC,CAAA;QAC7E,OAAO,GAAG,CAAA;IACZ,CAAC,EAAE,EAAS,CAAC,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,EACzC,IAAI,EACJ,WAAW,EACX,YAAY,EACZ,UAAU,GAMX,EAAE,EAAE;IACH,MAAM,kBAAkB,GAAG,WAAW,CAAC;QACrC,IAAI,EAAE,GAAG,IAAI,KAAK;QAClB,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC;YACpB,EAAE,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,oBAAoB,CAAC,eAAe,CAAC,CAAC;YAC7E,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW;SAC9D,CAAC,CAAC,WAAW,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,UAAU,EAAE,CAAC;QAC5C,UAAU,EAAE,IAAI;QAChB,OAAO,EAAE,IAAI;KACd,CAAC,CAAA;IAEF,MAAM,sBAAsB,GAAG,kBAAkB,CAAC,kBAAkB,EAAE,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QACtF,IAAI,EAAE,KAAK,eAAe,EAAE,CAAC;YAC3B,OAAO,iBAAiB,CAAC,yEAAyE,CAAC,CAAA;QACrG,CAAC;QAED,6EAA6E;QAC7E,MAAM,WAAW,GAAG,SAAS,CAAC,qBAAqB,CAAC,WAAW,CAAC,GAAG,CAAC,CAAA;QACpE,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,UAAU,KAAK,KAAK,EAAE,CAAC;YACrD,MAAM,kBAAkB,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAA;YACxD,MAAM,kBAAkB,GAAG,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,KAAK,IAAI,YAAY,CAAC,CAAA;YAC5F,MAAM,kBAAkB,GAAG,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,KAAK,CAAC,CAAA;YAE5E,OAAO;gBACL,GAAG,EAAE,gBAAgB,IAAI,sEAAsE;gBAC/F,UAAU,EAAE,CAAC,EAAE,EAAE,kBAAkB,EAAE,kBAAkB,CAAC;gBACxD,WAAW,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;aAC7B,CAAA;QACH,CAAC;aAAM,CAAC;YACN,MAAM,kBAAkB,GAAG,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAA;YAExE,MAAM,kBAAkB,GAAG,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,CAAC,kBAAkB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC,CAAA;YAE9G,IAAI,UAAU,GAAG,OAAO,CAAA;YACxB,MAAM,aAAa,GAAc,EAAE,CAAA;YAEnC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;YAC/B,MAAM,mBAAmB,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,CAAA;YAClE,MAAM,oBAAoB,GAAG,MAAM,CAAC,eAAe,CAAC,mBAAmB,CAAC,CAAC,KAAK,CAAC,CAAA;YAE/E,KAAK,MAAM,GAAG,IAAI,oBAAoB,EAAE,CAAC;gBACvC,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAA;gBACpD,4BAA4B;gBAC5B,IAAI,kBAAkB,KAAK,SAAS,EAAE,CAAC;oBACrC,SAAQ;gBACV,CAAC;gBACD,UAAU,GAAG,YAAY,UAAU,eAAe,CAAA;gBAClD,aAAa,CAAC,IAAI,CAAC,KAAK,GAAG,EAAE,EAAE,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,CAAC,CAAA;YACpE,CAAC;YAED,MAAM,gBAAgB,GACpB,aAAa,CAAC,MAAM,GAAG,CAAC;gBACtB,CAAC,CAAC,0CAA0C,UAAU,EAAE;gBACxD,CAAC,CAAC,6BAA6B,CAAA;YAEnC,MAAM,QAAQ,GAAG;qBACF,IAAI;;QAEjB,gBAAgB;KACnB,CAAA;YAEC,OAAO;gBACL,GAAG,EAAE,QAAQ;gBACb,UAAU,EAAE,CAAC,EAAE,EAAE,kBAAkB,EAAE,GAAG,aAAa,CAAC;gBACtD,WAAW,EAAE,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;aAC7B,CAAA;QACH,CAAC;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,YAAY,EAAE,sBAAsB,EAAE,CAAA;AAC/E,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,0BAA0B,GAAG,CACxC,QAAmB,EAG2D,EAAE,CAChF,QAAQ,CAAC,OAAO,CAAC,qBAAqB,KAAK,IAAI,CAAA;AAEjD,MAAM,mBAAmB,GAAG,CAC1B,WAA4B,EAC+B,EAAE;IAC7D,OAAO,CAAC,CAAC,GAAG,IAAW,EAAE,EAAE;QACzB,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAA;QAE9B,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,GAAG,EAAE,CAAC,GAAG,IAAI,CAAA;QAE3F,MAAM,qBAAqB,GAAG,OAAO,CAAC,OAAO,IAAI,QAAQ,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAA;QAE7G,MAAM,GAAG,GAA6B;YACpC,IAAI,EAAE,UAAU;YAChB,QAAQ;YACR,EAAE;YACF,qBAAqB;SACtB,CAAA;QAED,MAAM,KAAK,GAAG,GAAG,CAAA,kBAAkB,QAAQ,CAAC,SAAS,CAAC,IAAI,gBAAgB,CAAA;QAE1E,OAAO;YACL,CAAC,kBAAkB,CAAC,EAAE,kBAAkB;YACxC,CAAC,qBAAqB,CAAC,EAAE,GAAG;YAC5B,UAAU,EAAE,yBAAgC;YAC5C,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;YAC1C,QAAQ,EAAE,GAAG,EAAE,CAAC,KAAK,CAAC,QAAQ,EAAE;YAChC,GAAI,EAAU,EAAE,uBAAuB;SACxC,CAAA;IACH,CAAC,CAAQ,CAAA;AACX,CAAC,CAAA;AAsMD,MAAM,CAAC,MAAM,4BAA4B,GAAG,MAAM,CAAC,wBAAwB,CAAC,CAAA"}

package/dist/schema/client-document-def.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=client-document-def.test.d.ts.map

package/dist/schema/client-document-def.test.d.ts.map

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

package/dist/schema/client-document-def.test.js

@@ -0,0 +1,201 @@
+import { Schema } from '@livestore/utils/effect';
+import { describe, expect, test } from 'vitest';
+import { tables } from '../__tests__/fixture.js';
+import { clientDocument, ClientDocumentTableDefSymbol } from './client-document-def.js';
+const materializerContext = {
+    currentFacts: new Map(),
+    clientOnly: false,
+};
+describe('client document table', () => {
+    test('set event', () => {
+        expect(patchId(tables.UiState.set({ showSidebar: false }, 'session-1'))).toMatchInlineSnapshot(`
+      {
+        "args": {
+          "id": "session-1",
+          "value": {
+            "showSidebar": false,
+          },
+        },
+        "id": "00000000-0000-0000-0000-000000000000",
+        "name": "UiStateSet",
+      }
+    `);
+        expect(patchId(tables.appConfig.set({ fontSize: 12, theme: 'dark' }))).toMatchInlineSnapshot(`
+      {
+        "args": {
+          "id": "static",
+          "value": {
+            "fontSize": 12,
+            "theme": "dark",
+          },
+        },
+        "id": "00000000-0000-0000-0000-000000000000",
+        "name": "AppConfigSet",
+      }
+    `);
+    });
+    describe('materializer', () => {
+        const forSchema = (schema, value, id, options) => {
+            const Doc = clientDocument({
+                name: 'test',
+                schema,
+                default: { value },
+                ...options,
+            });
+            const materializer = Doc[ClientDocumentTableDefSymbol].derived.setMaterializer;
+            return materializer(Doc.set(value, id).args, materializerContext);
+        };
+        test('string value', () => {
+            expect(forSchema(Schema.String, 'hello', 'id1')).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "id1",
+            ""hello"",
+            ""hello"",
+          ],
+          "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
+          "writeTables": Set {
+            "test",
+          },
+        }
+      `);
+        });
+        test('struct value (partial set=true)', () => {
+            expect(forSchema(Schema.Struct({ a: Schema.String }), { a: 'hello' }, 'id1', { partialSet: true }))
+                .toMatchInlineSnapshot(`
+          {
+            "bindValues": [
+              "id1",
+              "{"a":"hello"}",
+              "$.a",
+              ""hello"",
+            ],
+            "sql": "
+                INSERT INTO 'test' (id, value)
+                VALUES (?, ?)
+                ON CONFLICT (id) DO UPDATE SET value = json_set(value, ?, json(?))
+              ",
+            "writeTables": Set {
+              "test",
+            },
+          }
+        `);
+        });
+        test('struct value (partial set=false)', () => {
+            expect(forSchema(Schema.Struct({ a: Schema.String }), { a: 'hello' }, 'id1', { partialSet: false }))
+                .toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "id1",
+            "{"a":"hello"}",
+            "{"a":"hello"}",
+          ],
+          "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
+          "writeTables": Set {
+            "test",
+          },
+        }
+      `);
+        });
+        test('struct value (partial set=true) advanced', () => {
+            expect(forSchema(Schema.Struct({ a: Schema.String, b: Schema.String, c: Schema.Number }), { a: 'hello', c: 123 }, 'id1', { partialSet: true })).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "id1",
+            "{"a":"hello","c":123}",
+            "$.a",
+            ""hello"",
+            "$.c",
+            "123",
+          ],
+          "sql": "
+              INSERT INTO 'test' (id, value)
+              VALUES (?, ?)
+              ON CONFLICT (id) DO UPDATE SET value = json_set(json_set(value, ?, json(?)), ?, json(?))
+            ",
+          "writeTables": Set {
+            "test",
+          },
+        }
+      `);
+        });
+        test('struct value (partial set=true), explicit undefined, filter out undefined values', () => {
+            expect(forSchema(Schema.Struct({ a: Schema.String.pipe(Schema.optional), b: Schema.String }), { a: undefined, b: 'hello' }, 'id1', {
+                partialSet: true,
+            })).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "id1",
+            "{"b":"hello"}",
+            "$.b",
+            ""hello"",
+          ],
+          "sql": "
+              INSERT INTO 'test' (id, value)
+              VALUES (?, ?)
+              ON CONFLICT (id) DO UPDATE SET value = json_set(value, ?, json(?))
+            ",
+          "writeTables": Set {
+            "test",
+          },
+        }
+      `);
+        });
+        test('struct value (partial set=true), explicit undefined, nothing to update', () => {
+            expect(forSchema(Schema.Struct({ a: Schema.String.pipe(Schema.optional) }), { a: undefined }, 'id1', {
+                partialSet: true,
+            })).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "id1",
+            "{}",
+          ],
+          "sql": "
+              INSERT INTO 'test' (id, value)
+              VALUES (?, ?)
+              ON CONFLICT (id) DO NOTHING
+            ",
+          "writeTables": Set {
+            "test",
+          },
+        }
+      `);
+        });
+        test('struct union value', () => {
+            expect(forSchema(Schema.Union(Schema.Struct({ a: Schema.String }), Schema.Struct({ b: Schema.String })), { a: 'hello' }, 'id1')).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "id1",
+            "{"a":"hello"}",
+            "{"a":"hello"}",
+          ],
+          "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
+          "writeTables": Set {
+            "test",
+          },
+        }
+      `);
+        });
+        test('array value', () => {
+            expect(forSchema(Schema.Array(Schema.String), ['hello', 'world'], 'id1')).toMatchInlineSnapshot(`
+        {
+          "bindValues": [
+            "id1",
+            "["hello","world"]",
+            "["hello","world"]",
+          ],
+          "sql": "INSERT INTO 'test' (id, value) VALUES (?, ?) ON CONFLICT (id) DO UPDATE SET value = ?",
+          "writeTables": Set {
+            "test",
+          },
+        }
+      `);
+        });
+    });
+});
+const patchId = (muationEvent) => {
+    // TODO use new id paradigm
+    const id = `00000000-0000-0000-0000-000000000000`;
+    return { ...muationEvent, id };
+};
+//# sourceMappingURL=client-document-def.test.js.map

package/dist/schema/client-document-def.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client-document-def.test.js","sourceRoot":"","sources":["../../src/schema/client-document-def.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAChD,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAA;AAE/C,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAChD,OAAO,EAAE,cAAc,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAA;AAGvF,MAAM,mBAAmB,GAAG;IAC1B,YAAY,EAAE,IAAI,GAAG,EAAE;IACvB,UAAU,EAAE,KAAK;CAClB,CAAA;AAED,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAI,CAAC,WAAW,EAAE,GAAG,EAAE;QACrB,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;KAW9F,CAAC,CAAA;QAEF,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;KAY5F,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,MAAM,SAAS,GAAG,CAAI,MAA6B,EAAE,KAAQ,EAAE,EAAW,EAAE,OAAkC,EAAE,EAAE;YAChH,MAAM,GAAG,GAAG,cAAc,CAAC;gBACzB,IAAI,EAAE,MAAM;gBACZ,MAAM;gBACN,OAAO,EAAE,EAAE,KAAK,EAAE;gBAClB,GAAG,OAAO;aACX,CAAC,CAAA;YAEF,MAAM,YAAY,GAAG,GAAG,CAAC,4BAA4B,CAAC,CAAC,OAAO,CAAC,eAAe,CAAA;YAE9E,OAAO,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,KAAK,EAAE,EAAS,CAAC,CAAC,IAAI,EAAE,mBAAmB,CAAC,CAAA;QAC1E,CAAC,CAAA;QAED,IAAI,CAAC,cAAc,EAAE,GAAG,EAAE;YACxB,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;OAYtE,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,iCAAiC,EAAE,GAAG,EAAE;YAC3C,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;iBAChG,qBAAqB,CAAC;;;;;;;;;;;;;;;;;SAiBtB,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC5C,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;iBACjG,qBAAqB,CAAC;;;;;;;;;;;;OAYxB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,0CAA0C,EAAE,GAAG,EAAE;YACpD,MAAM,CACJ,SAAS,CACP,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EACvE,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,EAAS,EAC7B,KAAK,EACL,EAAE,UAAU,EAAE,IAAI,EAAE,CACrB,CACF,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;OAmBvB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,kFAAkF,EAAE,GAAG,EAAE;YAC5F,MAAM,CACJ,SAAS,CACP,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAC3E,EAAE,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,OAAO,EAAE,EAC5B,KAAK,EACL;gBACE,UAAU,EAAE,IAAI;aACjB,CACF,CACF,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;OAiBvB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,wEAAwE,EAAE,GAAG,EAAE;YAClF,MAAM,CACJ,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE;gBAC5F,UAAU,EAAE,IAAI;aACjB,CAAC,CACH,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;OAevB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,oBAAoB,EAAE,GAAG,EAAE;YAC9B,MAAM,CACJ,SAAS,CACP,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,EACtF,EAAE,CAAC,EAAE,OAAO,EAAE,EACd,KAAK,CACN,CACF,CAAC,qBAAqB,CAAC;;;;;;;;;;;;OAYvB,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE;YACvB,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;OAY/F,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA;AAEF,MAAM,OAAO,GAAG,CAAC,YAA8C,EAAE,EAAE;IACjE,2BAA2B;IAC3B,MAAM,EAAE,GAAG,sCAAsC,CAAA;IACjD,OAAO,EAAE,GAAG,YAAY,EAAE,EAAE,EAAE,CAAA;AAChC,CAAC,CAAA"}