@livestore/common 0.0.0-snapshot-6c61bcbb96b4666b347d3a9845d9f909cf96ae6d → 0.0.0-snapshot-2a3ba4e86ce747d9ef59d22aabc4de9e0528846b

package/src/schema/schema.ts

@@ -5,8 +5,7 @@ import type { EventDef, EventDefRecord, Materializer, RawSqlEvent } from './Even
 import { rawSqlEvent } from './EventDef.js'
 import { tableIsClientDocumentTable } from './state/sqlite/client-document-def.js'
 import type { SqliteDsl } from './state/sqlite/db-schema/mod.js'
-import { SqliteAst } from './state/sqlite/db-schema/mod.js'
-import { systemTables } from './state/sqlite/system-tables.js'
+import { stateSystemTables } from './state/sqlite/system-tables.js'
 import type { TableDef } from './state/sqlite/table-def.js'
 
 export const LiveStoreSchemaSymbol = Symbol.for('livestore.LiveStoreSchema')
@@ -16,28 +15,24 @@ export type LiveStoreSchema<
   TDbSchema extends SqliteDsl.DbSchema = SqliteDsl.DbSchema,
   TEventsDefRecord extends EventDefRecord = EventDefRecord,
 > = {
-  readonly _Type: LiveStoreSchemaSymbol
+  readonly LiveStoreSchemaSymbol: LiveStoreSchemaSymbol
   /** Only used on type-level */
   readonly _DbSchemaType: TDbSchema
   /** Only used on type-level */
   readonly _EventDefMapType: TEventsDefRecord
 
-  // TODO remove in favour of `state`
-  readonly tables: Map<string, TableDef>
-  /** Compound hash of all table defs etc */
-  readonly hash: number
   readonly state: State
-
   readonly eventsDefsMap: Map<string, EventDef.AnyWithoutFn>
-
-  // readonly materializers: Map<string, Materializer>
-
-  migrationOptions: MigrationOptions
 }
 
+// TODO abstract this further away from sqlite/tables
 export type State = {
-  // TODO abstract this further away from sqlite/tables
-  readonly tables: Map<string, TableDef.Any>
+  readonly sqlite: {
+    readonly tables: Map<string, TableDef.Any>
+    readonly migrations: MigrationOptions
+    /** Compound hash of all table defs etc */
+    readonly hash: number
+  }
   readonly materializers: Map<string, Materializer>
 }
 
@@ -48,32 +43,12 @@ export type InputSchema = {
 
 export const makeSchema = <TInputSchema extends InputSchema>(
   /** Note when using the object-notation for tables/events, the object keys are ignored and not used as table/mutation names */
-  inputSchema: TInputSchema & {
-    /** "hard-reset" is currently the default strategy */
-    migrations?: MigrationOptions
-  },
+  inputSchema: TInputSchema,
 ): FromInputSchema.DeriveSchema<TInputSchema> => {
-  // const inputTables: ReadonlyArray<TableDef> = Array.isArray(inputSchema.tables)
-  //   ? inputSchema.tables
-  //   : Object.values(inputSchema.tables)
-
-  // const inputTables = []
-
-  // const tables = new Map<string, TableDef>()
-
-  // for (const tableDef of inputTables) {
-  //   // TODO validate tables (e.g. index names are unique)
-  //   if (tables.has(tableDef.sqliteDef.ast.name)) {
-  //     shouldNeverHappen(`Duplicate table name: ${tableDef.sqliteDef.ast.name}. Please use unique names for tables.`)
-  //   }
-  //   tables.set(tableDef.sqliteDef.ast.name, tableDef)
-  // }
-
   const state = inputSchema.state
-  const tables = inputSchema.state.tables
+  const tables = inputSchema.state.sqlite.tables
 
-  for (const tableDef of systemTables) {
-    // // @ts-expect-error TODO fix type level issue
+  for (const tableDef of stateSystemTables) {
     tables.set(tableDef.sqliteDef.name, tableDef)
   }
 
@@ -100,22 +75,12 @@ export const makeSchema = <TInputSchema extends InputSchema>(
     }
   }
 
-  const hash = SqliteAst.hash({
-    _tag: 'dbSchema',
-    tables: [...tables.values()].map((_) => _.sqliteDef.ast),
-  })
-
   return {
-    _Type: LiveStoreSchemaSymbol,
+    LiveStoreSchemaSymbol,
     _DbSchemaType: Symbol.for('livestore.DbSchemaType') as any,
     _EventDefMapType: Symbol.for('livestore.EventDefMapType') as any,
-    // tables,
-    // events,
     state,
-    tables: state.tables,
     eventsDefsMap,
-    migrationOptions: inputSchema.migrations ?? { strategy: 'from-eventlog' },
-    hash,
   } satisfies LiveStoreSchema
 }
 
@@ -139,7 +104,7 @@ export const getEventDef = <TSchema extends LiveStoreSchema>(
 
 export namespace FromInputSchema {
   export type DeriveSchema<TInputSchema extends InputSchema> = LiveStoreSchema<
-    DbSchemaFromInputSchemaTables<TInputSchema['state']['tables']>,
+    DbSchemaFromInputSchemaTables<TInputSchema['state']['sqlite']['tables']>,
     EventDefRecordFromInputSchemaEvents<TInputSchema['events']>
   >
 
@@ -148,7 +113,7 @@ export namespace FromInputSchema {
    * - array: we use the table name of each array item (= table definition) as the object key
    * - object: we discard the keys of the input object and use the table name of each object value (= table definition) as the new object key
    */
-  type DbSchemaFromInputSchemaTables<TTables extends InputSchema['state']['tables']> =
+  type DbSchemaFromInputSchemaTables<TTables extends InputSchema['state']['sqlite']['tables']> =
     TTables extends ReadonlyArray<TableDef>
       ? { [K in TTables[number] as K['sqliteDef']['name']]: K['sqliteDef'] }
       : TTables extends Record<string, TableDef>

package/src/schema/state/sqlite/mod.ts

@@ -1,9 +1,11 @@
 import { shouldNeverHappen } from '@livestore/utils'
 
+import type { MigrationOptions } from '../../../adapter-types.js'
 import { type Materializer, rawSqlEvent, rawSqlMaterializer } from '../../EventDef.js'
 import type { State } from '../../schema.js'
 import { ClientDocumentTableDefSymbol, tableIsClientDocumentTable } from './client-document-def.js'
-import { systemTables } from './system-tables.js'
+import { SqliteAst } from './db-schema/mod.js'
+import { stateSystemTables } from './system-tables.js'
 import { type TableDef, type TableDefBase } from './table-def.js'
 
 export * from './table-def.js'
@@ -32,7 +34,7 @@ export const makeState = <TStateInput extends InputState>(inputSchema: TStateInp
     tables.set(sqliteDef.ast.name, tableDef)
   }
 
-  for (const tableDef of systemTables) {
+  for (const tableDef of stateSystemTables) {
     tables.set(tableDef.sqliteDef.name, tableDef)
   }
 
@@ -53,10 +55,19 @@ export const makeState = <TStateInput extends InputState>(inputSchema: TStateInp
     }
   }
 
-  return { tables, materializers }
+  const hash = SqliteAst.hash({
+    _tag: 'dbSchema',
+    tables: [...tables.values()].map((_) => _.sqliteDef.ast),
+  })
+
+  return { sqlite: { tables, migrations: inputSchema.migrations ?? { strategy: 'auto' }, hash }, materializers }
 }
 
 export type InputState = {
   readonly tables: Record<string, TableDefBase> | ReadonlyArray<TableDefBase>
   readonly materializers: Record<string, Materializer<any>>
+  /**
+   * @default { strategy: 'auto' }
+   */
+  readonly migrations?: MigrationOptions
 }

package/src/schema/state/sqlite/system-tables.ts

@@ -66,17 +66,16 @@ export const leaderMergeCounterTable = table({
 
 export type LeaderMergeCounterRow = typeof leaderMergeCounterTable.Type
 
-export const systemTables = [
+export const stateSystemTables = [
   schemaMetaTable,
   schemaEventDefsMetaTable,
   sessionChangesetMetaTable,
   leaderMergeCounterTable,
 ]
 
-/// Eventlog DB
+export const isStateSystemTable = (tableName: string) => stateSystemTables.some((_) => _.sqliteDef.name === tableName)
 
-export const SyncStatus = Schema.Literal('synced', 'pending', 'error', 'clientOnly')
-export type SyncStatus = typeof SyncStatus.Type
+/// Eventlog DB
 
 export const EVENTLOG_META_TABLE = 'eventlog'
 
@@ -113,3 +112,5 @@ export const syncStatusTable = table({
 })
 
 export type SyncStatusRow = typeof syncStatusTable.Type
+
+export const eventlogSystemTables = [eventlogMetaTable, syncStatusTable]

package/src/schema-management/migrations.ts

@@ -6,16 +6,16 @@ import type { LiveStoreSchema } from '../schema/mod.js'
 import { SqliteAst, SqliteDsl } from '../schema/state/sqlite/db-schema/mod.js'
 import type { SchemaEventDefsMetaRow, SchemaMetaRow } from '../schema/state/sqlite/system-tables.js'
 import {
+  isStateSystemTable,
   SCHEMA_EVENT_DEFS_META_TABLE,
   SCHEMA_META_TABLE,
   schemaEventDefsMetaTable,
-  schemaMetaTable,
-  systemTables,
+  stateSystemTables,
 } from '../schema/state/sqlite/system-tables.js'
 import { sql } from '../util.js'
 import type { SchemaManager } from './common.js'
 import { dbExecute, dbSelect } from './common.js'
-import { validateSchema } from './validate-mutation-defs.js'
+import { validateSchema } from './validate-schema.js'
 
 const getMemoizedTimestamp = memoizeByStringifyArgs(() => new Date().toISOString())
 
@@ -55,11 +55,13 @@ export const migrateDb = ({
   onProgress?: (opts: { done: number; total: number }) => Effect.Effect<void>
 }): Effect.Effect<MigrationsReport, UnexpectedError> =>
   Effect.gen(function* () {
-    yield* migrateTable({
-      db,
-      tableAst: schemaMetaTable.sqliteDef.ast,
-      behaviour: 'create-if-not-exists',
-    })
+    for (const tableDef of stateSystemTables) {
+      yield* migrateTable({
+        db,
+        tableAst: tableDef.sqliteDef.ast,
+        behaviour: 'create-if-not-exists',
+      })
+    }
 
     // TODO enforce that migrating tables isn't allowed once the store is running
 
@@ -72,11 +74,11 @@ export const migrateDb = ({
       schemaMetaRows.map(({ tableName, schemaHash }) => [tableName, schemaHash]),
     )
 
-    const tableDefs = new Set([
+    const tableDefs = [
       // NOTE it's important the `SCHEMA_META_TABLE` comes first since we're writing to it below
-      ...systemTables,
-      ...Array.from(schema.tables.values()).filter((_) => _.sqliteDef.name !== SCHEMA_META_TABLE),
-    ])
+      ...stateSystemTables,
+      ...Array.from(schema.state.sqlite.tables.values()).filter((_) => !isStateSystemTable(_.sqliteDef.name)),
+    ]
 
     const tablesToMigrate = new Set<{ tableAst: SqliteAst.Table; schemaHash: number }>()
 

package/dist/schema-management/validate-mutation-defs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate-mutation-defs.d.ts","sourceRoot":"","sources":["../../src/schema-management/validate-mutation-defs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAU,MAAM,yBAAyB,CAAA;AAExD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,aAAa,CAAA;AAE9D,eAAO,MAAM,cAAc,GAAI,QAAQ,eAAe,EAAE,eAAe,aAAa,gDAsBhF,CAAA;AAEJ,eAAO,MAAM,gBAAgB,GAC3B,UAAU,QAAQ,CAAC,YAAY,EAC/B,eAAe,aAAa,EAC5B,wBAAwB,YAAY,GAAG,SAAS,SA0BjD,CAAA"}

package/dist/schema-management/validate-mutation-defs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"validate-mutation-defs.js","sourceRoot":"","sources":["../../src/schema-management/validate-mutation-defs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAExD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAKrD,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,MAAuB,EAAE,aAA4B,EAAE,EAAE,CACtF,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,gCAAgC;IAChC,MAAM,uBAAuB,GAAG,aAAa,CAAC,gBAAgB,EAAE,CAAA;IAEhE,MAAM,gBAAgB,GAAG,uBAAuB,CAAC,MAAM,CACrD,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,sBAAsB,CAAC,SAAS,CAAC,CACxF,CAAA;IAED,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,CAAC,IAAI,eAAe,CAAC;YACzB,KAAK,EAAE,iCAAiC,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SACpG,CAAC,CAAA;IACJ,CAAC;IAED,KAAK,MAAM,CAAC,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,aAAa,EAAE,CAAC;QAChD,MAAM,sBAAsB,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAA;QAEvG,gBAAgB,CAAC,QAAQ,EAAE,aAAa,EAAE,sBAAsB,CAAC,CAAA;IACnE,CAAC;IAED,yBAAyB;AAC3B,CAAC,CAAC,CAAA;AAEJ,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAC9B,QAA+B,EAC/B,aAA4B,EAC5B,sBAAgD,EAChD,EAAE;IACF,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;IAE/C,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,aAAa,CAAC,eAAe,CAAC;YAC5B,UAAU;YACV,SAAS,EAAE,QAAQ,CAAC,IAAI;SACzB,CAAC,CAAA;QAEF,OAAM;IACR,CAAC;IAED,IAAI,UAAU,KAAK,sBAAsB,CAAC,UAAU;QAAE,OAAM;IAE5D,mHAAmH;IACnH,2GAA2G;IAE3G,6CAA6C;IAC7C,iGAAiG;IACjG,IAAI;IAEJ,aAAa,CAAC,eAAe,CAAC;QAC5B,UAAU;QACV,SAAS,EAAE,QAAQ,CAAC,IAAI;KACzB,CAAC,CAAA;AACJ,CAAC,CAAA"}