@livestore/common 0.3.2-dev.9 → 0.4.0-dev.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/.tsbuildinfo +1 -1
- package/dist/ClientSessionLeaderThreadProxy.d.ts +2 -2
- package/dist/ClientSessionLeaderThreadProxy.d.ts.map +1 -1
- package/dist/adapter-types.d.ts +4 -4
- package/dist/adapter-types.d.ts.map +1 -1
- package/dist/debug-info.d.ts +17 -17
- package/dist/devtools/devtools-messages-client-session.d.ts +38 -38
- package/dist/devtools/devtools-messages-common.d.ts +6 -6
- package/dist/devtools/devtools-messages-leader.d.ts +28 -28
- package/dist/devtools/devtools-messages-leader.d.ts.map +1 -1
- package/dist/devtools/devtools-messages-leader.js.map +1 -1
- package/dist/leader-thread/LeaderSyncProcessor.js +3 -1
- package/dist/leader-thread/LeaderSyncProcessor.js.map +1 -1
- package/dist/leader-thread/make-leader-thread-layer.d.ts.map +1 -1
- package/dist/leader-thread/make-leader-thread-layer.js +21 -4
- package/dist/leader-thread/make-leader-thread-layer.js.map +1 -1
- package/dist/leader-thread/shutdown-channel.d.ts +2 -2
- package/dist/leader-thread/shutdown-channel.d.ts.map +1 -1
- package/dist/leader-thread/shutdown-channel.js +2 -2
- package/dist/leader-thread/shutdown-channel.js.map +1 -1
- package/dist/leader-thread/types.d.ts +1 -1
- package/dist/leader-thread/types.d.ts.map +1 -1
- package/dist/materializer-helper.d.ts +3 -3
- package/dist/materializer-helper.d.ts.map +1 -1
- package/dist/materializer-helper.js +2 -2
- package/dist/materializer-helper.js.map +1 -1
- package/dist/rematerialize-from-eventlog.js +1 -1
- package/dist/rematerialize-from-eventlog.js.map +1 -1
- package/dist/schema/EventDef.d.ts +104 -178
- package/dist/schema/EventSequenceNumber.d.ts +5 -0
- package/dist/schema/EventSequenceNumber.d.ts.map +1 -1
- package/dist/schema/EventSequenceNumber.js +7 -2
- package/dist/schema/EventSequenceNumber.js.map +1 -1
- package/dist/schema/EventSequenceNumber.test.js +2 -2
- package/dist/schema/LiveStoreEvent.d.ts +6 -5
- package/dist/schema/LiveStoreEvent.d.ts.map +1 -1
- package/dist/schema/LiveStoreEvent.js +5 -0
- package/dist/schema/LiveStoreEvent.js.map +1 -1
- package/dist/schema/schema.d.ts +3 -0
- package/dist/schema/schema.d.ts.map +1 -1
- package/dist/schema/schema.js.map +1 -1
- package/dist/schema/state/sqlite/client-document-def.d.ts +3 -2
- package/dist/schema/state/sqlite/client-document-def.d.ts.map +1 -1
- package/dist/schema/state/sqlite/client-document-def.js +6 -4
- package/dist/schema/state/sqlite/client-document-def.js.map +1 -1
- package/dist/schema/state/sqlite/client-document-def.test.js +76 -1
- package/dist/schema/state/sqlite/client-document-def.test.js.map +1 -1
- package/dist/schema/state/sqlite/column-annotations.d.ts +34 -0
- package/dist/schema/state/sqlite/column-annotations.d.ts.map +1 -0
- package/dist/schema/state/sqlite/column-annotations.js +50 -0
- package/dist/schema/state/sqlite/column-annotations.js.map +1 -0
- package/dist/schema/state/sqlite/column-annotations.test.d.ts +2 -0
- package/dist/schema/state/sqlite/column-annotations.test.d.ts.map +1 -0
- package/dist/schema/state/sqlite/column-annotations.test.js +179 -0
- package/dist/schema/state/sqlite/column-annotations.test.js.map +1 -0
- package/dist/schema/state/sqlite/column-spec.d.ts +11 -0
- package/dist/schema/state/sqlite/column-spec.d.ts.map +1 -0
- package/dist/schema/state/sqlite/column-spec.js +39 -0
- package/dist/schema/state/sqlite/column-spec.js.map +1 -0
- package/dist/schema/state/sqlite/column-spec.test.d.ts +2 -0
- package/dist/schema/state/sqlite/column-spec.test.d.ts.map +1 -0
- package/dist/schema/state/sqlite/column-spec.test.js +146 -0
- package/dist/schema/state/sqlite/column-spec.test.js.map +1 -0
- package/dist/schema/state/sqlite/db-schema/ast/sqlite.d.ts +1 -0
- package/dist/schema/state/sqlite/db-schema/ast/sqlite.d.ts.map +1 -1
- package/dist/schema/state/sqlite/db-schema/ast/sqlite.js +1 -0
- package/dist/schema/state/sqlite/db-schema/ast/sqlite.js.map +1 -1
- package/dist/schema/state/sqlite/db-schema/dsl/field-defs.d.ts +17 -4
- package/dist/schema/state/sqlite/db-schema/dsl/field-defs.d.ts.map +1 -1
- package/dist/schema/state/sqlite/db-schema/dsl/field-defs.js +2 -0
- package/dist/schema/state/sqlite/db-schema/dsl/field-defs.js.map +1 -1
- package/dist/schema/state/sqlite/db-schema/dsl/mod.d.ts +65 -165
- package/dist/schema/state/sqlite/db-schema/dsl/mod.d.ts.map +1 -1
- package/dist/schema/state/sqlite/db-schema/dsl/mod.js +1 -0
- package/dist/schema/state/sqlite/db-schema/dsl/mod.js.map +1 -1
- package/dist/schema/state/sqlite/mod.d.ts +2 -0
- package/dist/schema/state/sqlite/mod.d.ts.map +1 -1
- package/dist/schema/state/sqlite/mod.js +2 -0
- package/dist/schema/state/sqlite/mod.js.map +1 -1
- package/dist/schema/state/sqlite/query-builder/api.d.ts +309 -560
- package/dist/schema/state/sqlite/query-builder/api.d.ts.map +1 -1
- package/dist/schema/state/sqlite/query-builder/astToSql.d.ts +1 -0
- package/dist/schema/state/sqlite/query-builder/astToSql.d.ts.map +1 -1
- package/dist/schema/state/sqlite/query-builder/astToSql.js +8 -6
- package/dist/schema/state/sqlite/query-builder/astToSql.js.map +1 -1
- package/dist/schema/state/sqlite/system-tables.d.ts +464 -46
- package/dist/schema/state/sqlite/system-tables.d.ts.map +1 -1
- package/dist/schema/state/sqlite/table-def.d.ts +161 -152
- package/dist/schema/state/sqlite/table-def.d.ts.map +1 -1
- package/dist/schema/state/sqlite/table-def.js +251 -5
- package/dist/schema/state/sqlite/table-def.js.map +1 -1
- package/dist/schema/state/sqlite/table-def.test.d.ts +2 -0
- package/dist/schema/state/sqlite/table-def.test.d.ts.map +1 -0
- package/dist/schema/state/sqlite/table-def.test.js +635 -0
- package/dist/schema/state/sqlite/table-def.test.js.map +1 -0
- package/dist/schema-management/common.d.ts +1 -1
- package/dist/schema-management/common.d.ts.map +1 -1
- package/dist/schema-management/common.js +11 -2
- package/dist/schema-management/common.js.map +1 -1
- package/dist/schema-management/migrations.d.ts +0 -1
- package/dist/schema-management/migrations.d.ts.map +1 -1
- package/dist/schema-management/migrations.js +4 -30
- package/dist/schema-management/migrations.js.map +1 -1
- package/dist/schema-management/migrations.test.d.ts +2 -0
- package/dist/schema-management/migrations.test.d.ts.map +1 -0
- package/dist/schema-management/migrations.test.js +52 -0
- package/dist/schema-management/migrations.test.js.map +1 -0
- package/dist/sql-queries/types.d.ts +37 -133
- package/dist/sqlite-db-helper.d.ts +3 -1
- package/dist/sqlite-db-helper.d.ts.map +1 -1
- package/dist/sqlite-db-helper.js +16 -0
- package/dist/sqlite-db-helper.js.map +1 -1
- package/dist/sqlite-types.d.ts +4 -4
- package/dist/sqlite-types.d.ts.map +1 -1
- package/dist/sync/ClientSessionSyncProcessor.d.ts +2 -2
- package/dist/sync/ClientSessionSyncProcessor.d.ts.map +1 -1
- package/dist/sync/ClientSessionSyncProcessor.js +8 -7
- package/dist/sync/ClientSessionSyncProcessor.js.map +1 -1
- package/dist/sync/sync.d.ts.map +1 -1
- package/dist/sync/sync.js.map +1 -1
- package/dist/util.d.ts +3 -3
- package/dist/util.d.ts.map +1 -1
- package/dist/util.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +4 -4
- package/src/ClientSessionLeaderThreadProxy.ts +2 -2
- package/src/adapter-types.ts +6 -4
- package/src/devtools/devtools-messages-leader.ts +3 -3
- package/src/leader-thread/LeaderSyncProcessor.ts +3 -1
- package/src/leader-thread/make-leader-thread-layer.ts +26 -7
- package/src/leader-thread/shutdown-channel.ts +2 -2
- package/src/leader-thread/types.ts +1 -1
- package/src/materializer-helper.ts +5 -11
- package/src/rematerialize-from-eventlog.ts +2 -2
- package/src/schema/EventSequenceNumber.test.ts +2 -2
- package/src/schema/EventSequenceNumber.ts +8 -2
- package/src/schema/LiveStoreEvent.ts +7 -1
- package/src/schema/schema.ts +4 -0
- package/src/schema/state/sqlite/client-document-def.test.ts +89 -1
- package/src/schema/state/sqlite/client-document-def.ts +7 -4
- package/src/schema/state/sqlite/column-annotations.test.ts +212 -0
- package/src/schema/state/sqlite/column-annotations.ts +77 -0
- package/src/schema/state/sqlite/column-spec.test.ts +223 -0
- package/src/schema/state/sqlite/column-spec.ts +42 -0
- package/src/schema/state/sqlite/db-schema/ast/sqlite.ts +2 -0
- package/src/schema/state/sqlite/db-schema/dsl/__snapshots__/field-defs.test.ts.snap +15 -0
- package/src/schema/state/sqlite/db-schema/dsl/field-defs.ts +20 -2
- package/src/schema/state/sqlite/db-schema/dsl/mod.ts +1 -0
- package/src/schema/state/sqlite/mod.ts +2 -0
- package/src/schema/state/sqlite/query-builder/api.ts +4 -3
- package/src/schema/state/sqlite/query-builder/astToSql.ts +9 -7
- package/src/schema/state/sqlite/table-def.test.ts +798 -0
- package/src/schema/state/sqlite/table-def.ts +472 -16
- package/src/schema-management/common.ts +10 -3
- package/src/schema-management/migrations.ts +4 -33
- package/src/sqlite-db-helper.ts +19 -1
- package/src/sqlite-types.ts +4 -4
- package/src/sync/ClientSessionSyncProcessor.ts +13 -8
- package/src/sync/sync.ts +2 -0
- package/src/util.ts +7 -2
- package/src/version.ts +1 -1
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"system-tables.d.ts","sourceRoot":"","sources":["../../../../src/schema/state/sqlite/system-tables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAQhD,eAAO,MAAM,iBAAiB,uBAAuB,CAAA;AAErD,eAAO,MAAM,eAAe
|
1
|
+
{"version":3,"file":"system-tables.d.ts","sourceRoot":"","sources":["../../../../src/schema/state/sqlite/system-tables.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAQhD,eAAO,MAAM,iBAAiB,uBAAuB,CAAA;AAErD,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;IAKxB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;IAAtB,sBAAsB;;;;;;;;;;;;;;;;;UAGxB,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEvD,eAAO,MAAM,4BAA4B,kCAAkC,CAAA;AAE3E,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;IAKjC,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;IAAtB,sBAAsB;;;;;;;;;;;;;;;;;UAGxB,CAAA;AAEF,MAAM,MAAM,sBAAsB,GAAG,OAAO,wBAAwB,CAAC,IAAI,CAAA;AAEzE;;;GAGG;AACH,eAAO,MAAM,4BAA4B,kCAAkC,CAAA;AAE3E,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAWpC,CAAA;AAEF,MAAM,MAAM,uBAAuB,GAAG,OAAO,yBAAyB,CAAC,IAAI,CAAA;AAE3E,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;IA1C1B,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;IAAtB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IActB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;IAAtB,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BsF,CAAA;AAEhH,eAAO,MAAM,kBAAkB,GAAI,WAAW,MAAM,YAAkE,CAAA;AAItH,eAAO,MAAM,mBAAmB,aAAa,CAAA;AAE7C,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAU1B,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAA5B,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;UAY9B,CAAA;AAEF,MAAM,MAAM,eAAe,GAAG,OAAO,iBAAiB,CAAC,IAAI,CAAA;AAE3D,eAAO,MAAM,iBAAiB,4BAA4B,CAAA;AAG1D,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;;;UAK1B,CAAA;AAEF,MAAM,MAAM,aAAa,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEvD,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IA5B7B,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAA5B,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA4BiD,CAAA"}
|
@@ -1,166 +1,175 @@
|
|
1
|
-
import
|
2
|
-
import type
|
3
|
-
import
|
4
|
-
import type { QueryBuilder } from
|
5
|
-
export declare const blob: SqliteDsl.ColDefFn<"blob">,
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
) => SqliteDsl.ColDefFn<TColumnType>,
|
10
|
-
datetime: SqliteDsl.SpecializedColDefFn<"text", false, Date>,
|
11
|
-
integer: SqliteDsl.ColDefFn<"integer">,
|
12
|
-
isColumnDefinition: (
|
13
|
-
value: unknown,
|
14
|
-
) => value is SqliteDsl.ColumnDefinition<any, any>,
|
15
|
-
json: SqliteDsl.SpecializedColDefFn<"text", true, unknown>,
|
16
|
-
real: SqliteDsl.ColDefFn<"real">,
|
17
|
-
text: SqliteDsl.ColDefFn<"text">;
|
18
|
-
export type StateType = "singleton" | "dynamic";
|
19
|
-
export type DefaultSqliteTableDef = SqliteDsl.TableDefinition<
|
20
|
-
string,
|
21
|
-
SqliteDsl.Columns
|
22
|
-
>;
|
23
|
-
export type DefaultSqliteTableDefConstrained = SqliteDsl.TableDefinition<
|
24
|
-
string,
|
25
|
-
SqliteDsl.ConstraintColumns
|
26
|
-
>;
|
1
|
+
import { type Nullable } from '@livestore/utils';
|
2
|
+
import { Schema, SchemaAST, type Types } from '@livestore/utils/effect';
|
3
|
+
import { SqliteDsl } from './db-schema/mod.ts';
|
4
|
+
import type { QueryBuilder } from './query-builder/mod.ts';
|
5
|
+
export declare const blob: SqliteDsl.ColDefFn<"blob">, boolean: SqliteDsl.SpecializedColDefFn<"integer", false, boolean>, column: <TColumnType extends SqliteDsl.FieldColumnType>(columnType: TColumnType) => SqliteDsl.ColDefFn<TColumnType>, datetime: SqliteDsl.SpecializedColDefFn<"text", false, Date>, integer: SqliteDsl.ColDefFn<"integer">, isColumnDefinition: (value: unknown) => value is SqliteDsl.ColumnDefinition.Any, json: SqliteDsl.SpecializedColDefFn<"text", true, unknown>, real: SqliteDsl.ColDefFn<"real">, text: SqliteDsl.ColDefFn<"text">;
|
6
|
+
export type StateType = 'singleton' | 'dynamic';
|
7
|
+
export type DefaultSqliteTableDef = SqliteDsl.TableDefinition<string, SqliteDsl.Columns>;
|
8
|
+
export type DefaultSqliteTableDefConstrained = SqliteDsl.TableDefinition<string, SqliteDsl.ConstraintColumns>;
|
27
9
|
export declare const TableDefInternalsSymbol: unique symbol;
|
28
10
|
export type TableDefInternalsSymbol = typeof TableDefInternalsSymbol;
|
29
|
-
export type TableDefBase<
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
options: TOptions;
|
35
|
-
rowSchema: SqliteDsl.StructSchemaForColumns<TSqliteDef["columns"]>;
|
36
|
-
insertSchema: SqliteDsl.InsertStructSchemaForColumns<TSqliteDef["columns"]>;
|
11
|
+
export type TableDefBase<TSqliteDef extends DefaultSqliteTableDef = DefaultSqliteTableDefConstrained, TOptions extends TableOptions = TableOptions> = {
|
12
|
+
sqliteDef: TSqliteDef;
|
13
|
+
options: TOptions;
|
14
|
+
rowSchema: SqliteDsl.StructSchemaForColumns<TSqliteDef['columns']>;
|
15
|
+
insertSchema: SqliteDsl.InsertStructSchemaForColumns<TSqliteDef['columns']>;
|
37
16
|
};
|
38
|
-
export type TableDef<
|
39
|
-
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
{
|
51
|
-
readonly [K in keyof TSqliteDef["columns"]]: TSqliteDef["columns"][K]["schema"]["Encoded"];
|
52
|
-
}
|
53
|
-
>
|
54
|
-
>,
|
55
|
-
> = {
|
56
|
-
sqliteDef: TSqliteDef;
|
57
|
-
options: TOptions;
|
58
|
-
rowSchema: TSchema;
|
59
|
-
insertSchema: SqliteDsl.InsertStructSchemaForColumns<TSqliteDef["columns"]>;
|
60
|
-
readonly Type: Schema.Schema.Type<TSchema>;
|
61
|
-
readonly Encoded: Schema.Schema.Encoded<TSchema>;
|
62
|
-
} & QueryBuilder<
|
63
|
-
ReadonlyArray<Schema.Schema.Type<TSchema>>,
|
64
|
-
TableDefBase<TSqliteDef & {}, TOptions>
|
65
|
-
>;
|
17
|
+
export type TableDef<TSqliteDef extends DefaultSqliteTableDef = DefaultSqliteTableDefConstrained, TOptions extends TableOptions = TableOptions, TSchema = Schema.Schema<SqliteDsl.AnyIfConstained<TSqliteDef['columns'], {
|
18
|
+
readonly [K in keyof TSqliteDef['columns']]: TSqliteDef['columns'][K]['schema']['Type'];
|
19
|
+
}>, SqliteDsl.AnyIfConstained<TSqliteDef['columns'], {
|
20
|
+
readonly [K in keyof TSqliteDef['columns']]: TSqliteDef['columns'][K]['schema']['Encoded'];
|
21
|
+
}>>> = {
|
22
|
+
sqliteDef: TSqliteDef;
|
23
|
+
options: TOptions;
|
24
|
+
rowSchema: TSchema;
|
25
|
+
insertSchema: SqliteDsl.InsertStructSchemaForColumns<TSqliteDef['columns']>;
|
26
|
+
readonly Type: Schema.Schema.Type<TSchema>;
|
27
|
+
readonly Encoded: Schema.Schema.Encoded<TSchema>;
|
28
|
+
} & QueryBuilder<ReadonlyArray<Schema.Schema.Type<TSchema>>, TableDefBase<TSqliteDef & {}, TOptions>>;
|
66
29
|
export type TableOptionsInput = Partial<{
|
67
|
-
|
30
|
+
indexes: SqliteDsl.Index[];
|
68
31
|
}>;
|
69
32
|
export declare namespace TableDef {
|
70
|
-
|
33
|
+
type Any = TableDef<any, any>;
|
71
34
|
}
|
72
35
|
export type TableOptions = {
|
73
|
-
|
74
|
-
|
36
|
+
/** Derived based on whether the table definition has one or more columns (besides the `id` column) */
|
37
|
+
readonly isClientDocumentTable: boolean;
|
75
38
|
};
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
|
84
|
-
|
85
|
-
|
39
|
+
/**
|
40
|
+
* Creates a SQLite table definition from columns or an Effect Schema.
|
41
|
+
*
|
42
|
+
* This function supports two main ways to define a table:
|
43
|
+
* 1. Using explicit column definitions
|
44
|
+
* 2. Using an Effect Schema (either the `name` property needs to be provided or the schema needs to have a title/identifier)
|
45
|
+
*
|
46
|
+
* ```ts
|
47
|
+
* // Using explicit columns
|
48
|
+
* const usersTable = State.SQLite.table({
|
49
|
+
* name: 'users',
|
50
|
+
* columns: {
|
51
|
+
* id: State.SQLite.text({ primaryKey: true }),
|
52
|
+
* name: State.SQLite.text({ nullable: false }),
|
53
|
+
* email: State.SQLite.text({ nullable: false }),
|
54
|
+
* age: State.SQLite.integer({ nullable: true }),
|
55
|
+
* },
|
56
|
+
* })
|
57
|
+
* ```
|
58
|
+
*
|
59
|
+
* ```ts
|
60
|
+
* // Using Effect Schema with annotations
|
61
|
+
* import { Schema } from '@livestore/utils/effect'
|
62
|
+
*
|
63
|
+
* const UserSchema = Schema.Struct({
|
64
|
+
* id: Schema.Int.pipe(State.SQLite.withPrimaryKey).pipe(State.SQLite.withAutoIncrement),
|
65
|
+
* email: Schema.String.pipe(State.SQLite.withUnique),
|
66
|
+
* name: Schema.String,
|
67
|
+
* active: Schema.Boolean.pipe(State.SQLite.withDefault(true)),
|
68
|
+
* createdAt: Schema.optional(Schema.Date),
|
69
|
+
* })
|
70
|
+
*
|
71
|
+
* // Option 1: With explicit name
|
72
|
+
* const usersTable = State.SQLite.table({
|
73
|
+
* name: 'users',
|
74
|
+
* schema: UserSchema,
|
75
|
+
* })
|
76
|
+
*
|
77
|
+
* // Option 2: With name from schema annotation (title or identifier)
|
78
|
+
* const AnnotatedUserSchema = UserSchema.annotations({ title: 'users' })
|
79
|
+
* const usersTable2 = State.SQLite.table({
|
80
|
+
* schema: AnnotatedUserSchema,
|
81
|
+
* })
|
82
|
+
* ```
|
83
|
+
*
|
84
|
+
* ```ts
|
85
|
+
* // Adding indexes
|
86
|
+
* const PostSchema = Schema.Struct({
|
87
|
+
* id: Schema.String.pipe(State.SQLite.withPrimaryKey),
|
88
|
+
* title: Schema.String,
|
89
|
+
* authorId: Schema.String,
|
90
|
+
* createdAt: Schema.Date,
|
91
|
+
* }).annotations({ identifier: 'posts' })
|
92
|
+
*
|
93
|
+
* const postsTable = State.SQLite.table({
|
94
|
+
* schema: PostSchema,
|
95
|
+
* indexes: [
|
96
|
+
* { name: 'idx_posts_author', columns: ['authorId'] },
|
97
|
+
* { name: 'idx_posts_created', columns: ['createdAt'], isUnique: false },
|
98
|
+
* ],
|
99
|
+
* })
|
100
|
+
* ```
|
101
|
+
*
|
102
|
+
* @remarks
|
103
|
+
* - Primary key columns are automatically non-nullable
|
104
|
+
* - Columns with `State.SQLite.withUnique` annotation automatically get unique indexes
|
105
|
+
* - The `State.SQLite.withAutoIncrement` annotation only works with integer primary keys
|
106
|
+
* - Default values can be literal values or SQL expressions
|
107
|
+
* - When using Effect Schema without explicit name, the schema must have a title or identifier annotation
|
108
|
+
*/
|
109
|
+
export declare function table<TName extends string, TColumns extends SqliteDsl.Columns | SqliteDsl.ColumnDefinition.Any, const TOptionsInput extends TableOptionsInput = TableOptionsInput>(args: {
|
110
|
+
name: TName;
|
111
|
+
columns: TColumns;
|
112
|
+
} & Partial<TOptionsInput>): TableDef<SqliteTableDefForInput<TName, TColumns>, WithDefaults<TColumns>>;
|
113
|
+
export declare function table<TName extends string, TSchema extends Schema.Schema.AnyNoContext, const TOptionsInput extends TableOptionsInput = TableOptionsInput>(args: {
|
114
|
+
name: TName;
|
115
|
+
schema: TSchema;
|
116
|
+
} & Partial<TOptionsInput>): TableDef<SqliteTableDefForSchemaInput<TName, Schema.Schema.Type<TSchema>, Schema.Schema.Encoded<TSchema>, TSchema>, TableOptions>;
|
117
|
+
export declare function table<TSchema extends Schema.Schema.AnyNoContext, const TOptionsInput extends TableOptionsInput = TableOptionsInput>(args: {
|
118
|
+
schema: TSchema;
|
119
|
+
} & Partial<TOptionsInput>): TableDef<SqliteTableDefForSchemaInput<string, Schema.Schema.Type<TSchema>, Schema.Schema.Encoded<TSchema>, TSchema>, TableOptions>;
|
86
120
|
export declare namespace FromTable {
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
>;
|
100
|
-
};
|
101
|
-
type RowEncoded<TTableDef extends TableDefBase> = Types.Simplify<
|
102
|
-
Nullable<
|
103
|
-
Pick<RowEncodeNonNullable<TTableDef>, NullableColumnNames<TTableDef>>
|
104
|
-
> &
|
105
|
-
Omit<RowEncodeNonNullable<TTableDef>, NullableColumnNames<TTableDef>>
|
106
|
-
>;
|
107
|
-
type RowDecodedAll<TTableDef extends TableDefBase> = {
|
108
|
-
[K in keyof TTableDef["sqliteDef"]["columns"]]: Schema.Schema.Type<
|
109
|
-
TTableDef["sqliteDef"]["columns"][K]["schema"]
|
110
|
-
>;
|
111
|
-
};
|
121
|
+
type RowDecoded<TTableDef extends TableDefBase> = Types.Simplify<Nullable<Pick<RowDecodedAll<TTableDef>, NullableColumnNames<TTableDef>>> & Omit<RowDecodedAll<TTableDef>, NullableColumnNames<TTableDef>>>;
|
122
|
+
type NullableColumnNames<TTableDef extends TableDefBase> = FromColumns.NullableColumnNames<TTableDef['sqliteDef']['columns']>;
|
123
|
+
type Columns<TTableDef extends TableDefBase> = {
|
124
|
+
[K in keyof TTableDef['sqliteDef']['columns']]: TTableDef['sqliteDef']['columns'][K]['columnType'];
|
125
|
+
};
|
126
|
+
type RowEncodeNonNullable<TTableDef extends TableDefBase> = {
|
127
|
+
[K in keyof TTableDef['sqliteDef']['columns']]: Schema.Schema.Encoded<TTableDef['sqliteDef']['columns'][K]['schema']>;
|
128
|
+
};
|
129
|
+
type RowEncoded<TTableDef extends TableDefBase> = Types.Simplify<Nullable<Pick<RowEncodeNonNullable<TTableDef>, NullableColumnNames<TTableDef>>> & Omit<RowEncodeNonNullable<TTableDef>, NullableColumnNames<TTableDef>>>;
|
130
|
+
type RowDecodedAll<TTableDef extends TableDefBase> = {
|
131
|
+
[K in keyof TTableDef['sqliteDef']['columns']]: Schema.Schema.Type<TTableDef['sqliteDef']['columns'][K]['schema']>;
|
132
|
+
};
|
112
133
|
}
|
113
134
|
export declare namespace FromColumns {
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
|
127
|
-
type RowEncodeNonNullable<TColumns extends SqliteDsl.Columns> = {
|
128
|
-
[K in keyof TColumns]: Schema.Schema.Encoded<TColumns[K]["schema"]>;
|
129
|
-
};
|
130
|
-
type NullableColumnNames<TColumns extends SqliteDsl.Columns> = keyof {
|
131
|
-
[K in keyof TColumns as TColumns[K]["default"] extends true
|
132
|
-
? K
|
133
|
-
: never]: {};
|
134
|
-
};
|
135
|
-
type RequiredInsertColumnNames<TColumns extends SqliteDsl.Columns> =
|
136
|
-
SqliteDsl.FromColumns.RequiredInsertColumnNames<TColumns>;
|
137
|
-
type InsertRowDecoded<TColumns extends SqliteDsl.Columns> =
|
138
|
-
SqliteDsl.FromColumns.InsertRowDecoded<TColumns>;
|
135
|
+
type RowDecoded<TColumns extends SqliteDsl.Columns> = Types.Simplify<Nullable<Pick<RowDecodedAll<TColumns>, NullableColumnNames<TColumns>>> & Omit<RowDecodedAll<TColumns>, NullableColumnNames<TColumns>>>;
|
136
|
+
type RowDecodedAll<TColumns extends SqliteDsl.Columns> = {
|
137
|
+
[K in keyof TColumns]: Schema.Schema.Type<TColumns[K]['schema']>;
|
138
|
+
};
|
139
|
+
type RowEncoded<TColumns extends SqliteDsl.Columns> = Types.Simplify<Nullable<Pick<RowEncodeNonNullable<TColumns>, NullableColumnNames<TColumns>>> & Omit<RowEncodeNonNullable<TColumns>, NullableColumnNames<TColumns>>>;
|
140
|
+
type RowEncodeNonNullable<TColumns extends SqliteDsl.Columns> = {
|
141
|
+
[K in keyof TColumns]: Schema.Schema.Encoded<TColumns[K]['schema']>;
|
142
|
+
};
|
143
|
+
type NullableColumnNames<TColumns extends SqliteDsl.Columns> = keyof {
|
144
|
+
[K in keyof TColumns as TColumns[K]['default'] extends true ? K : never]: {};
|
145
|
+
};
|
146
|
+
type RequiredInsertColumnNames<TColumns extends SqliteDsl.Columns> = SqliteDsl.FromColumns.RequiredInsertColumnNames<TColumns>;
|
147
|
+
type InsertRowDecoded<TColumns extends SqliteDsl.Columns> = SqliteDsl.FromColumns.InsertRowDecoded<TColumns>;
|
139
148
|
}
|
140
|
-
export type SqliteTableDefForInput<
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
TColumns extends SqliteDsl.Columns | SqliteDsl.ColumnDefinition<any, any>,
|
146
|
-
> = {
|
147
|
-
isClientDocumentTable: false;
|
148
|
-
requiredInsertColumnNames: SqliteDsl.FromColumns.RequiredInsertColumnNames<
|
149
|
-
ToColumns<TColumns>
|
150
|
-
>;
|
149
|
+
export type SqliteTableDefForInput<TName extends string, TColumns extends SqliteDsl.Columns | SqliteDsl.ColumnDefinition.Any> = SqliteDsl.TableDefinition<TName, PrettifyFlat<ToColumns<TColumns>>>;
|
150
|
+
export type SqliteTableDefForSchemaInput<TName extends string, TType, TEncoded, _TSchema = any> = TableDefInput.ForSchema<TName, TType, TEncoded, _TSchema>;
|
151
|
+
export type WithDefaults<TColumns extends SqliteDsl.Columns | SqliteDsl.ColumnDefinition.Any> = {
|
152
|
+
isClientDocumentTable: false;
|
153
|
+
requiredInsertColumnNames: SqliteDsl.FromColumns.RequiredInsertColumnNames<ToColumns<TColumns>>;
|
151
154
|
};
|
152
|
-
export type PrettifyFlat<T> = T extends infer U
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
> =
|
160
|
-
|
161
|
-
|
162
|
-
|
163
|
-
|
164
|
-
|
165
|
-
|
166
|
-
|
155
|
+
export type PrettifyFlat<T> = T extends infer U ? {
|
156
|
+
[K in keyof U]: U[K];
|
157
|
+
} : never;
|
158
|
+
export type ToColumns<TColumns extends SqliteDsl.Columns | SqliteDsl.ColumnDefinition.Any> = TColumns extends SqliteDsl.Columns ? TColumns : TColumns extends SqliteDsl.ColumnDefinition.Any ? {
|
159
|
+
value: TColumns;
|
160
|
+
} : never;
|
161
|
+
export declare namespace SchemaToColumns {
|
162
|
+
type ColumnDefForType<TEncoded, TType> = SqliteDsl.ColumnDefinition<TEncoded, TType>;
|
163
|
+
type FromTypes<TType, TEncoded> = TType extends Record<string, any> ? TEncoded extends Record<string, any> ? {
|
164
|
+
[K in keyof TType & keyof TEncoded]: ColumnDefForType<TEncoded[K], TType[K]>;
|
165
|
+
} : SqliteDsl.Columns : SqliteDsl.Columns;
|
166
|
+
}
|
167
|
+
export declare namespace TableDefInput {
|
168
|
+
type ForColumns<TName extends string, TColumns extends SqliteDsl.Columns | SqliteDsl.ColumnDefinition.Any> = SqliteDsl.TableDefinition<TName, PrettifyFlat<ToColumns<TColumns>>>;
|
169
|
+
type ForSchema<TName extends string, TType, TEncoded, _TSchema = any> = SqliteDsl.TableDefinition<TName, SchemaToColumns.FromTypes<TType, TEncoded>>;
|
170
|
+
}
|
171
|
+
/**
|
172
|
+
* Maps a schema to a SQLite column definition, respecting column annotations.
|
173
|
+
*/
|
174
|
+
export declare const getColumnDefForSchema: (schema: Schema.Schema.AnyNoContext, propertySignature?: SchemaAST.PropertySignature) => SqliteDsl.ColumnDefinition.Any;
|
175
|
+
//# sourceMappingURL=table-def.d.ts.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"table-def.d.ts","sourceRoot":"","sources":["../../../../src/schema/state/sqlite/table-def.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,
|
1
|
+
{"version":3,"file":"table-def.d.ts","sourceRoot":"","sources":["../../../../src/schema/state/sqlite/table-def.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,EAAqC,MAAM,kBAAkB,CAAA;AACnF,OAAO,EAAU,MAAM,EAAE,SAAS,EAAE,KAAK,KAAK,EAAE,MAAM,yBAAyB,CAAA;AAG/E,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAA;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAA;AAG1D,eAAO,MAAQ,IAAI,8BAAE,OAAO,4DAAE,MAAM,+GAAE,QAAQ,sDAAE,OAAO,iCAAE,kBAAkB,+DAAE,IAAI,wDAAE,IAAI,8BAAE,IAAI,4BAAc,CAAA;AAE3G,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,SAAS,CAAA;AAE/C,MAAM,MAAM,qBAAqB,GAAG,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;AACxF,MAAM,MAAM,gCAAgC,GAAG,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,CAAC,iBAAiB,CAAC,CAAA;AAG7G,eAAO,MAAM,uBAAuB,eAA8B,CAAA;AAClE,MAAM,MAAM,uBAAuB,GAAG,OAAO,uBAAuB,CAAA;AAEpE,MAAM,MAAM,YAAY,CAEtB,UAAU,SAAS,qBAAqB,GAAG,gCAAgC,EAC3E,QAAQ,SAAS,YAAY,GAAG,YAAY,IAC1C;IACF,SAAS,EAAE,UAAU,CAAA;IACrB,OAAO,EAAE,QAAQ,CAAA;IAEjB,SAAS,EAAE,SAAS,CAAC,sBAAsB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IAClE,YAAY,EAAE,SAAS,CAAC,4BAA4B,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;CAC5E,CAAA;AAED,MAAM,MAAM,QAAQ,CAIlB,UAAU,SAAS,qBAAqB,GAAG,gCAAgC,EAC3E,QAAQ,SAAS,YAAY,GAAG,YAAY,EAI5C,OAAO,GAAG,MAAM,CAAC,MAAM,CACrB,SAAS,CAAC,eAAe,CACvB,UAAU,CAAC,SAAS,CAAC,EACrB;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC;CAAE,CAC5F,EACD,SAAS,CAAC,eAAe,CACvB,UAAU,CAAC,SAAS,CAAC,EACrB;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,UAAU,CAAC,SAAS,CAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC;CAAE,CAC/F,CACF,IACC;IACF,SAAS,EAAE,UAAU,CAAA;IACrB,OAAO,EAAE,QAAQ,CAAA;IAEjB,SAAS,EAAE,OAAO,CAAA;IAClB,YAAY,EAAE,SAAS,CAAC,4BAA4B,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAA;IAE3E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC1C,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;CACjD,GAAG,YAAY,CAAC,aAAa,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,YAAY,CAAC,UAAU,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC,CAAA;AAErG,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC;IACtC,OAAO,EAAE,SAAS,CAAC,KAAK,EAAE,CAAA;CAC3B,CAAC,CAAA;AAEF,yBAAiB,QAAQ,CAAC;IACxB,KAAY,GAAG,GAAG,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAA;CACrC;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,sGAAsG;IACtG,QAAQ,CAAC,qBAAqB,EAAE,OAAO,CAAA;CACxC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqEG;AAGH,wBAAgB,KAAK,CACnB,KAAK,SAAS,MAAM,EACpB,QAAQ,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,EACnE,KAAK,CAAC,aAAa,SAAS,iBAAiB,GAAG,iBAAiB,EAEjE,IAAI,EAAE;IACJ,IAAI,EAAE,KAAK,CAAA;IACX,OAAO,EAAE,QAAQ,CAAA;CAClB,GAAG,OAAO,CAAC,aAAa,CAAC,GACzB,QAAQ,CAAC,sBAAsB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAA;AAG5E,wBAAgB,KAAK,CACnB,KAAK,SAAS,MAAM,EACpB,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAC1C,KAAK,CAAC,aAAa,SAAS,iBAAiB,GAAG,iBAAiB,EAEjE,IAAI,EAAE;IACJ,IAAI,EAAE,KAAK,CAAA;IACX,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,OAAO,CAAC,aAAa,CAAC,GACzB,QAAQ,CACT,4BAA4B,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EACzG,YAAY,CACb,CAAA;AAGD,wBAAgB,KAAK,CACnB,OAAO,SAAS,MAAM,CAAC,MAAM,CAAC,YAAY,EAC1C,KAAK,CAAC,aAAa,SAAS,iBAAiB,GAAG,iBAAiB,EAEjE,IAAI,EAAE;IACJ,MAAM,EAAE,OAAO,CAAA;CAChB,GAAG,OAAO,CAAC,aAAa,CAAC,GACzB,QAAQ,CACT,4BAA4B,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,EAC1G,YAAY,CACb,CAAA;AAyGD,yBAAiB,SAAS,CAAC;IAEzB,KAAY,UAAU,CAAC,SAAS,SAAS,YAAY,IAAI,KAAK,CAAC,QAAQ,CACrE,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,GACtE,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,CACjE,CAAA;IAED,KAAY,mBAAmB,CAAC,SAAS,SAAS,YAAY,IAAI,WAAW,CAAC,mBAAmB,CAC/F,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAClC,CAAA;IAED,KAAY,OAAO,CAAC,SAAS,SAAS,YAAY,IAAI;SACnD,CAAC,IAAI,MAAM,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC;KACnG,CAAA;IAED,KAAY,oBAAoB,CAAC,SAAS,SAAS,YAAY,IAAI;SAChE,CAAC,IAAI,MAAM,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CACnE,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAC/C;KACF,CAAA;IAED,KAAY,UAAU,CAAC,SAAS,SAAS,YAAY,IAAI,KAAK,CAAC,QAAQ,CACrE,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,CAAC,GAC7E,IAAI,CAAC,oBAAoB,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC,SAAS,CAAC,CAAC,CACxE,CAAA;IAED,KAAY,aAAa,CAAC,SAAS,SAAS,YAAY,IAAI;SACzD,CAAC,IAAI,MAAM,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KACnH,CAAA;CACF;AAED,yBAAiB,WAAW,CAAC;IAE3B,KAAY,UAAU,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,CACzE,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,GACpE,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAC/D,CAAA;IAED,KAAY,aAAa,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,IAAI;SAC7D,CAAC,IAAI,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KACjE,CAAA;IAED,KAAY,UAAU,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,CACzE,QAAQ,CAAC,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CAAC,GAC3E,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CAAC,CACtE,CAAA;IAED,KAAY,oBAAoB,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,IAAI;SACpE,CAAC,IAAI,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;KACpE,CAAA;IAED,KAAY,mBAAmB,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,IAAI,MAAM;SACzE,CAAC,IAAI,MAAM,QAAQ,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,IAAI,GAAG,CAAC,GAAG,KAAK,GAAG,EAAE;KAC7E,CAAA;IAED,KAAY,yBAAyB,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,IACtE,SAAS,CAAC,WAAW,CAAC,yBAAyB,CAAC,QAAQ,CAAC,CAAA;IAE3D,KAAY,gBAAgB,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,IAAI,SAAS,CAAC,WAAW,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAA;CACpH;AAED,MAAM,MAAM,sBAAsB,CAChC,KAAK,SAAS,MAAM,EACpB,QAAQ,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,IACjE,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAEvE,MAAM,MAAM,4BAA4B,CACtC,KAAK,SAAS,MAAM,EACpB,KAAK,EACL,QAAQ,EACR,QAAQ,GAAG,GAAG,IACZ,aAAa,CAAC,SAAS,CAAC,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;AAE7D,MAAM,MAAM,YAAY,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,IAAI;IAC9F,qBAAqB,EAAE,KAAK,CAAA;IAC5B,yBAAyB,EAAE,SAAS,CAAC,WAAW,CAAC,yBAAyB,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;CAChG,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,CAAC,GAAG;KAAG,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CAAE,GAAG,KAAK,CAAA;AAElF,MAAM,MAAM,SAAS,CAAC,QAAQ,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,IACvF,QAAQ,SAAS,SAAS,CAAC,OAAO,GAC9B,QAAQ,GACR,QAAQ,SAAS,SAAS,CAAC,gBAAgB,CAAC,GAAG,GAC7C;IAAE,KAAK,EAAE,QAAQ,CAAA;CAAE,GACnB,KAAK,CAAA;AAEb,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IAEvC,KAAY,gBAAgB,CAAC,QAAQ,EAAE,KAAK,IAAI,SAAS,CAAC,gBAAgB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;IAG3F,KAAY,SAAS,CAAC,KAAK,EAAE,QAAQ,IAAI,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GACtE,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAClC;SACG,CAAC,IAAI,MAAM,KAAK,GAAG,MAAM,QAAQ,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;KAC7E,GACD,SAAS,CAAC,OAAO,GACnB,SAAS,CAAC,OAAO,CAAA;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,aAAa,CAAC;IACrC,KAAY,UAAU,CACpB,KAAK,SAAS,MAAM,EACpB,QAAQ,SAAS,SAAS,CAAC,OAAO,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,IACjE,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,YAAY,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;IAEvE,KAAY,SAAS,CAAC,KAAK,SAAS,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,GAAG,GAAG,IAAI,SAAS,CAAC,eAAe,CACtG,KAAK,EACL,eAAe,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,CAC3C,CAAA;CACF;AA2GD;;GAEG;AACH,eAAO,MAAM,qBAAqB,GAChC,QAAQ,MAAM,CAAC,MAAM,CAAC,YAAY,EAClC,oBAAoB,SAAS,CAAC,iBAAiB,KAC9C,SAAS,CAAC,gBAAgB,CAAC,GA4I7B,CAAA"}
|
@@ -1,16 +1,53 @@
|
|
1
|
+
import { shouldNeverHappen } from '@livestore/utils';
|
2
|
+
import { Option, Schema, SchemaAST } from '@livestore/utils/effect';
|
3
|
+
import { AutoIncrement, ColumnType, Default, PrimaryKeyId, Unique } from "./column-annotations.js";
|
1
4
|
import { SqliteDsl } from "./db-schema/mod.js";
|
2
5
|
import { makeQueryBuilder, QueryBuilderAstSymbol, QueryBuilderTypeId } from "./query-builder/mod.js";
|
3
6
|
export const { blob, boolean, column, datetime, integer, isColumnDefinition, json, real, text } = SqliteDsl;
|
4
7
|
// TODO use to hide table def internals
|
5
8
|
export const TableDefInternalsSymbol = Symbol('TableDefInternals');
|
6
|
-
|
7
|
-
|
8
|
-
const
|
9
|
+
// Implementation
|
10
|
+
export function table(args) {
|
11
|
+
const { ...options } = args;
|
12
|
+
let tableName;
|
13
|
+
let columns;
|
14
|
+
let additionalIndexes = [];
|
15
|
+
if ('columns' in args) {
|
16
|
+
tableName = args.name;
|
17
|
+
const columnOrColumns = args.columns;
|
18
|
+
columns = (SqliteDsl.isColumnDefinition(columnOrColumns) ? { value: columnOrColumns } : columnOrColumns);
|
19
|
+
additionalIndexes = [];
|
20
|
+
}
|
21
|
+
else if ('schema' in args) {
|
22
|
+
const result = schemaFieldsToColumns(SchemaAST.getPropertySignatures(args.schema.ast));
|
23
|
+
columns = result.columns;
|
24
|
+
// We'll set tableName first, then use it for index names
|
25
|
+
let tempTableName;
|
26
|
+
// If name is provided, use it; otherwise extract from schema annotations
|
27
|
+
if ('name' in args) {
|
28
|
+
tempTableName = args.name;
|
29
|
+
}
|
30
|
+
else {
|
31
|
+
// Use title or identifier, with preference for title
|
32
|
+
tempTableName = SchemaAST.getTitleAnnotation(args.schema.ast).pipe(Option.orElse(() => SchemaAST.getIdentifierAnnotation(args.schema.ast)), Option.getOrElse(() => shouldNeverHappen('When using schema without explicit name, the schema must have a title or identifier annotation')));
|
33
|
+
}
|
34
|
+
tableName = tempTableName;
|
35
|
+
// Create unique indexes for columns with unique annotation
|
36
|
+
additionalIndexes = (result.uniqueColumns || []).map((columnName) => ({
|
37
|
+
name: `idx_${tableName}_${columnName}_unique`,
|
38
|
+
columns: [columnName],
|
39
|
+
isUnique: true,
|
40
|
+
}));
|
41
|
+
}
|
42
|
+
else {
|
43
|
+
return shouldNeverHappen('Either `columns` or `schema` must be provided when calling `table()`');
|
44
|
+
}
|
9
45
|
const options_ = {
|
10
46
|
isClientDocumentTable: false,
|
11
47
|
};
|
12
|
-
|
13
|
-
const
|
48
|
+
// Combine user-provided indexes with unique column indexes
|
49
|
+
const allIndexes = [...(options?.indexes ?? []), ...additionalIndexes];
|
50
|
+
const sqliteDef = SqliteDsl.table(tableName, columns, allIndexes);
|
14
51
|
const rowSchema = SqliteDsl.structSchemaForTable(sqliteDef);
|
15
52
|
const insertSchema = SqliteDsl.insertStructSchemaForTable(sqliteDef);
|
16
53
|
const tableDef = {
|
@@ -32,5 +69,214 @@ export const table = (args) => {
|
|
32
69
|
// @ts-expect-error TODO properly type this
|
33
70
|
tableDef[QueryBuilderTypeId] = query[QueryBuilderTypeId];
|
34
71
|
return tableDef;
|
72
|
+
}
|
73
|
+
/**
|
74
|
+
* Checks if a property signature has a specific annotation, checking both
|
75
|
+
* the property signature itself and its type AST.
|
76
|
+
*/
|
77
|
+
const hasPropertyAnnotation = (propertySignature, annotationId) => {
|
78
|
+
// When using Schema.optional(Schema.String).pipe(withPrimaryKey) in a struct,
|
79
|
+
// the annotation ends up on a PropertySignatureDeclaration, not the Union type
|
80
|
+
// Check if this is a PropertySignatureDeclaration with annotations
|
81
|
+
if ('annotations' in propertySignature && propertySignature.annotations) {
|
82
|
+
const annotation = SchemaAST.getAnnotation(annotationId)(propertySignature);
|
83
|
+
if (Option.isSome(annotation)) {
|
84
|
+
return annotation;
|
85
|
+
}
|
86
|
+
}
|
87
|
+
// Otherwise check the type AST
|
88
|
+
return SchemaAST.getAnnotation(annotationId)(propertySignature.type);
|
89
|
+
};
|
90
|
+
/**
|
91
|
+
* Maps schema property signatures to SQLite column definitions.
|
92
|
+
* Returns both columns and unique column names for index creation.
|
93
|
+
*/
|
94
|
+
const schemaFieldsToColumns = (propertySignatures) => {
|
95
|
+
const columns = {};
|
96
|
+
const uniqueColumns = [];
|
97
|
+
for (const prop of propertySignatures) {
|
98
|
+
if (typeof prop.name === 'string') {
|
99
|
+
// Create a schema from the AST
|
100
|
+
const fieldSchema = Schema.make(prop.type);
|
101
|
+
// Check if property has primary key annotation
|
102
|
+
const hasPrimaryKey = hasPropertyAnnotation(prop, PrimaryKeyId).pipe(Option.getOrElse(() => false));
|
103
|
+
// Check if property has unique annotation
|
104
|
+
const hasUnique = hasPropertyAnnotation(prop, Unique).pipe(Option.getOrElse(() => false));
|
105
|
+
columns[prop.name] = schemaFieldToColumn(fieldSchema, prop, hasPrimaryKey);
|
106
|
+
if (hasUnique) {
|
107
|
+
uniqueColumns.push(prop.name);
|
108
|
+
}
|
109
|
+
}
|
110
|
+
}
|
111
|
+
return { columns, uniqueColumns };
|
112
|
+
};
|
113
|
+
/**
|
114
|
+
* Converts a schema field and its property signature to a SQLite column definition.
|
115
|
+
*/
|
116
|
+
const schemaFieldToColumn = (fieldSchema, propertySignature, forceHasPrimaryKey) => {
|
117
|
+
// Determine column type based on schema type
|
118
|
+
const columnDef = getColumnDefForSchema(fieldSchema, propertySignature);
|
119
|
+
// Create a new object with appropriate properties
|
120
|
+
const result = {
|
121
|
+
columnType: columnDef.columnType,
|
122
|
+
schema: columnDef.schema,
|
123
|
+
default: columnDef.default,
|
124
|
+
nullable: columnDef.nullable,
|
125
|
+
primaryKey: columnDef.primaryKey,
|
126
|
+
autoIncrement: columnDef.autoIncrement,
|
127
|
+
};
|
128
|
+
// Set primaryKey property explicitly
|
129
|
+
if (forceHasPrimaryKey || columnDef.primaryKey) {
|
130
|
+
result.primaryKey = true;
|
131
|
+
}
|
132
|
+
else {
|
133
|
+
result.primaryKey = false;
|
134
|
+
}
|
135
|
+
// Check for invalid primary key + nullable combination
|
136
|
+
if (result.primaryKey && (propertySignature.isOptional || columnDef.nullable)) {
|
137
|
+
return shouldNeverHappen(`Primary key columns cannot be nullable. Found nullable primary key for column. ` +
|
138
|
+
`Either remove the primary key annotation or use a non-nullable schema.`);
|
139
|
+
}
|
140
|
+
// Set nullable property explicitly
|
141
|
+
if (propertySignature.isOptional) {
|
142
|
+
result.nullable = true;
|
143
|
+
}
|
144
|
+
else if (columnDef.nullable) {
|
145
|
+
result.nullable = true;
|
146
|
+
}
|
147
|
+
else {
|
148
|
+
result.nullable = false;
|
149
|
+
}
|
150
|
+
// Only add autoIncrement if it's true
|
151
|
+
if (columnDef.autoIncrement) {
|
152
|
+
result.autoIncrement = true;
|
153
|
+
}
|
154
|
+
return result;
|
155
|
+
};
|
156
|
+
/**
|
157
|
+
* Maps a schema to a SQLite column definition, respecting column annotations.
|
158
|
+
*/
|
159
|
+
export const getColumnDefForSchema = (schema, propertySignature) => {
|
160
|
+
const ast = schema.ast;
|
161
|
+
// Check for annotations
|
162
|
+
const hasPrimaryKey = propertySignature
|
163
|
+
? hasPropertyAnnotation(propertySignature, PrimaryKeyId).pipe(Option.getOrElse(() => false))
|
164
|
+
: SchemaAST.getAnnotation(PrimaryKeyId)(ast).pipe(Option.getOrElse(() => false));
|
165
|
+
const hasAutoIncrement = propertySignature
|
166
|
+
? hasPropertyAnnotation(propertySignature, AutoIncrement).pipe(Option.getOrElse(() => false))
|
167
|
+
: SchemaAST.getAnnotation(AutoIncrement)(ast).pipe(Option.getOrElse(() => false));
|
168
|
+
const defaultValue = propertySignature
|
169
|
+
? hasPropertyAnnotation(propertySignature, Default)
|
170
|
+
: SchemaAST.getAnnotation(Default)(ast);
|
171
|
+
/** Adds annotations to a column definition if they are present. */
|
172
|
+
const withAnnotationsIfNeeded = (columnDef) => {
|
173
|
+
const result = { ...columnDef };
|
174
|
+
if (hasPrimaryKey) {
|
175
|
+
result.primaryKey = true;
|
176
|
+
}
|
177
|
+
if (hasAutoIncrement) {
|
178
|
+
result.autoIncrement = true;
|
179
|
+
}
|
180
|
+
if (Option.isSome(defaultValue)) {
|
181
|
+
result.default = Option.some(defaultValue.value);
|
182
|
+
}
|
183
|
+
return result;
|
184
|
+
};
|
185
|
+
// Check for custom column type annotation
|
186
|
+
const columnTypeAnnotation = SchemaAST.getAnnotation(ColumnType)(ast);
|
187
|
+
if (Option.isSome(columnTypeAnnotation)) {
|
188
|
+
const columnType = columnTypeAnnotation.value;
|
189
|
+
let columnDef;
|
190
|
+
switch (columnType) {
|
191
|
+
case 'text':
|
192
|
+
columnDef = SqliteDsl.text();
|
193
|
+
break;
|
194
|
+
case 'integer':
|
195
|
+
columnDef = SqliteDsl.integer();
|
196
|
+
break;
|
197
|
+
case 'real':
|
198
|
+
columnDef = SqliteDsl.real();
|
199
|
+
break;
|
200
|
+
case 'blob':
|
201
|
+
columnDef = SqliteDsl.blob();
|
202
|
+
break;
|
203
|
+
default:
|
204
|
+
return shouldNeverHappen(`Unsupported column type annotation: ${columnType}`);
|
205
|
+
}
|
206
|
+
return withAnnotationsIfNeeded(columnDef);
|
207
|
+
}
|
208
|
+
// Check for refinements (e.g., Schema.Int)
|
209
|
+
if (SchemaAST.isRefinement(ast)) {
|
210
|
+
// Check if this is specifically Schema.Int by looking at the identifier annotation
|
211
|
+
const identifier = SchemaAST.getIdentifierAnnotation(ast).pipe(Option.getOrElse(() => ''));
|
212
|
+
if (identifier === 'Int') {
|
213
|
+
return withAnnotationsIfNeeded(SqliteDsl.integer());
|
214
|
+
}
|
215
|
+
// For other refinements, check the underlying type
|
216
|
+
return getColumnDefForSchema(Schema.make(ast.from), propertySignature);
|
217
|
+
}
|
218
|
+
// Check for string types
|
219
|
+
if (SchemaAST.isStringKeyword(ast)) {
|
220
|
+
return withAnnotationsIfNeeded(SqliteDsl.text());
|
221
|
+
}
|
222
|
+
// Check for number types
|
223
|
+
if (SchemaAST.isNumberKeyword(ast)) {
|
224
|
+
return withAnnotationsIfNeeded(SqliteDsl.real());
|
225
|
+
}
|
226
|
+
// Check for boolean types
|
227
|
+
if (SchemaAST.isBooleanKeyword(ast)) {
|
228
|
+
return withAnnotationsIfNeeded(SqliteDsl.boolean());
|
229
|
+
}
|
230
|
+
// Check for unions (like optional or nullable)
|
231
|
+
if (SchemaAST.isUnion(ast)) {
|
232
|
+
// Check if this union contains null or undefined (making it nullable/optional)
|
233
|
+
let hasNull = false;
|
234
|
+
let hasUndefined = false;
|
235
|
+
let nonNullableType;
|
236
|
+
for (const type of ast.types) {
|
237
|
+
if (SchemaAST.isUndefinedKeyword(type)) {
|
238
|
+
hasUndefined = true;
|
239
|
+
}
|
240
|
+
else if (SchemaAST.isLiteral(type) && type.literal === null) {
|
241
|
+
hasNull = true;
|
242
|
+
}
|
243
|
+
else {
|
244
|
+
nonNullableType = type;
|
245
|
+
}
|
246
|
+
}
|
247
|
+
// If we found a non-nullable type, use it for the column definition
|
248
|
+
if (nonNullableType) {
|
249
|
+
const innerSchema = Schema.make(nonNullableType);
|
250
|
+
const innerColumnDef = getColumnDefForSchema(innerSchema, propertySignature);
|
251
|
+
// If the union contains null or undefined, mark as nullable
|
252
|
+
if (hasNull || hasUndefined) {
|
253
|
+
return withAnnotationsIfNeeded({
|
254
|
+
...innerColumnDef,
|
255
|
+
nullable: true,
|
256
|
+
});
|
257
|
+
}
|
258
|
+
return withAnnotationsIfNeeded(innerColumnDef);
|
259
|
+
}
|
260
|
+
}
|
261
|
+
// Check for Date types
|
262
|
+
if (SchemaAST.isTransformation(ast)) {
|
263
|
+
// Try to map the transformation's target type
|
264
|
+
return getColumnDefForSchema(Schema.make(ast.to), propertySignature);
|
265
|
+
}
|
266
|
+
// Check for literal types
|
267
|
+
if (SchemaAST.isLiteral(ast)) {
|
268
|
+
const value = ast.literal;
|
269
|
+
if (typeof value === 'string') {
|
270
|
+
return withAnnotationsIfNeeded(SqliteDsl.text());
|
271
|
+
}
|
272
|
+
else if (typeof value === 'number') {
|
273
|
+
return withAnnotationsIfNeeded(SqliteDsl.real());
|
274
|
+
}
|
275
|
+
else if (typeof value === 'boolean') {
|
276
|
+
return withAnnotationsIfNeeded(SqliteDsl.boolean());
|
277
|
+
}
|
278
|
+
}
|
279
|
+
// Default to JSON column for complex types
|
280
|
+
return withAnnotationsIfNeeded(SqliteDsl.json({ schema }));
|
35
281
|
};
|
36
282
|
//# sourceMappingURL=table-def.js.map
|