@livestore/common 0.3.0-dev.22 → 0.3.0-dev.24

package/src/query-info.ts

@@ -9,7 +9,7 @@ import type { DbSchema } from './schema/mod.js'
  *
  * This information is currently only used for derived mutations.
  */
-export type QueryInfo = QueryInfo.None | QueryInfo.Row | QueryInfo.Col | QueryInfo.ColJsonValue
+export type QueryInfo = QueryInfo.None | QueryInfo.Row | QueryInfo.Col | QueryInfo.ColJsonValue | QueryInfo.Write
 // export type QueryInfo<TTableDef extends DbSchema.TableDefBase = DbSchema.TableDefBase> =
 // | QueryInfo.None
 // | QueryInfo.Row<TTableDef>
@@ -45,6 +45,11 @@ export namespace QueryInfo {
     jsonPath: string
   }
 
+  // NOTE Not yet used but we might want to use this in order to avoid write queries in read-only situations
+  export type Write = {
+    _tag: 'Write'
+  }
+
   // NOTE maybe we want to bring back type-params back like below
   // export type Row<TTableDef extends DbSchema.TableDefBase> = {
   //   _tag: 'Row'

package/src/rehydrate-from-mutationlog.ts

@@ -65,7 +65,7 @@ This likely means the schema has changed in an incompatible way.
           mutation: row.mutation,
           args,
           clientId: row.clientId,
-          sessionId: row.sessionId ?? undefined,
+          sessionId: row.sessionId,
         } satisfies MutationEvent.AnyEncoded
 
         yield* applyMutation(mutationEventEncoded, { skipMutationLog: true })

package/src/schema/MutationEvent.ts

@@ -21,7 +21,7 @@ export type MutationEvent<TMutationsDef extends MutationDef.Any> = {
   id: EventId.EventId
   parentId: EventId.EventId
   clientId: string
-  sessionId: string | undefined
+  sessionId: string
 }
 
 export type MutationEventEncoded<TMutationsDef extends MutationDef.Any> = {
@@ -30,7 +30,7 @@ export type MutationEventEncoded<TMutationsDef extends MutationDef.Any> = {
   id: EventId.EventId
   parentId: EventId.EventId
   clientId: string
-  sessionId: string | undefined
+  sessionId: string
 }
 
 export type AnyDecoded = MutationEvent<MutationDef.Any>
@@ -40,7 +40,7 @@ export const AnyDecoded = Schema.Struct({
   id: EventId.EventId,
   parentId: EventId.EventId,
   clientId: Schema.String,
-  sessionId: Schema.UndefinedOr(Schema.String),
+  sessionId: Schema.String,
 }).annotations({ title: 'MutationEvent.AnyDecoded' })
 
 export type AnyEncoded = MutationEventEncoded<MutationDef.Any>
@@ -50,7 +50,7 @@ export const AnyEncoded = Schema.Struct({
   id: EventId.EventId,
   parentId: EventId.EventId,
   clientId: Schema.String,
-  sessionId: Schema.UndefinedOr(Schema.String),
+  sessionId: Schema.String,
 }).annotations({ title: 'MutationEvent.AnyEncoded' })
 
 export const AnyEncodedGlobal = Schema.Struct({
@@ -59,6 +59,7 @@ export const AnyEncodedGlobal = Schema.Struct({
   id: EventId.GlobalEventId,
   parentId: EventId.GlobalEventId,
   clientId: Schema.String,
+  sessionId: Schema.String,
 }).annotations({ title: 'MutationEvent.AnyEncodedGlobal' })
 export type AnyEncodedGlobal = typeof AnyEncodedGlobal.Type
 
@@ -90,7 +91,7 @@ export type ForMutationDefRecord<TMutationsDefRecord extends MutationDefRecord>
       id: EventId.EventId
       parentId: EventId.EventId
       clientId: string
-      sessionId: string | undefined
+      sessionId: string
     }
   }[keyof TMutationsDefRecord],
   {
@@ -100,7 +101,7 @@ export type ForMutationDefRecord<TMutationsDefRecord extends MutationDefRecord>
       id: EventId.EventId
       parentId: EventId.EventId
       clientId: string
-      sessionId: string | undefined
+      sessionId: string
     }
   }[keyof TMutationsDefRecord]
 >
@@ -131,7 +132,7 @@ export const makeMutationEventSchema = <TSchema extends LiveStoreSchema>(
         id: EventId.EventId,
         parentId: EventId.EventId,
         clientId: Schema.String,
-        sessionId: Schema.UndefinedOr(Schema.String),
+        sessionId: Schema.String,
       }),
     ),
   ).annotations({ title: 'MutationEvent' }) as any
@@ -157,7 +158,7 @@ export class EncodedWithMeta extends Schema.Class<EncodedWithMeta>('MutationEven
   id: EventId.EventId,
   parentId: EventId.EventId,
   clientId: Schema.String,
-  sessionId: Schema.UndefinedOr(Schema.String),
+  sessionId: Schema.String,
   // TODO get rid of `meta` again by cleaning up the usage implementations
   meta: Schema.optionalWith(
     Schema.Any as Schema.Schema<{
@@ -188,7 +189,6 @@ export class EncodedWithMeta extends Schema.Class<EncodedWithMeta>('MutationEven
       ...mutationEvent,
       id: { global: mutationEvent.id, client: EventId.clientDefault },
       parentId: { global: mutationEvent.parentId, client: EventId.clientDefault },
-      sessionId: undefined,
     })
 
   toGlobal = (): AnyEncodedGlobal => ({
@@ -203,6 +203,6 @@ export const isEqualEncoded = (a: AnyEncoded, b: AnyEncoded) =>
   a.id.client === b.id.client &&
   a.mutation === b.mutation &&
   a.clientId === b.clientId &&
-  // a.sessionId === b.sessionId &&
+  a.sessionId === b.sessionId &&
   // TODO use schema equality here
   JSON.stringify(a.args) === JSON.stringify(b.args)

package/src/schema/db-schema/dsl/mod.ts

@@ -52,8 +52,13 @@ export type AnyIfConstained<In, Out> = '__constrained' extends keyof In ? any :
 export type EmptyObjIfConstained<In> = '__constrained' extends keyof In ? {} : In
 
 export type StructSchemaForColumns<TCols extends ConstraintColumns> = Schema.Schema<
-  AnyIfConstained<TCols, { readonly [K in keyof TCols]: TCols[K]['schema']['Type'] }>,
-  AnyIfConstained<TCols, { readonly [K in keyof TCols]: TCols[K]['schema']['Encoded'] }>
+  AnyIfConstained<TCols, FromColumns.RowDecoded<TCols>>,
+  AnyIfConstained<TCols, FromColumns.RowEncoded<TCols>>
+>
+
+export type InsertStructSchemaForColumns<TCols extends ConstraintColumns> = Schema.Schema<
+  AnyIfConstained<TCols, FromColumns.InsertRowDecoded<TCols>>,
+  AnyIfConstained<TCols, FromColumns.InsertRowEncoded<TCols>>
 >
 
 export const structSchemaForTable = <TTableDefinition extends TableDefinition<any, any>>(
@@ -63,6 +68,20 @@ export const structSchemaForTable = <TTableDefinition extends TableDefinition<an
     title: tableDef.name,
   }) as any
 
+export const insertStructSchemaForTable = <TTableDefinition extends TableDefinition<any, any>>(
+  tableDef: TTableDefinition,
+): InsertStructSchemaForColumns<TTableDefinition['columns']> =>
+  Schema.Struct(
+    Object.fromEntries(
+      tableDef.ast.columns.map((column) => [
+        column.name,
+        column.nullable === true || column.default._tag === 'Some' ? Schema.optional(column.schema) : column.schema,
+      ]),
+    ),
+  ).annotations({
+    title: tableDef.name,
+  }) as any
+
 const columsToAst = (columns: Columns): ReadonlyArray<SqliteAst.Column> => {
   return Object.entries(columns).map(([name, column]) => {
     return {
@@ -161,6 +180,10 @@ export namespace FromColumns {
     readonly [K in keyof TColumns]: Schema.Schema.Type<TColumns[K]['schema']>
   }
 
+  export type RowEncodedAll<TColumns extends Columns> = {
+    readonly [K in keyof TColumns]: Schema.Schema.Encoded<TColumns[K]['schema']>
+  }
+
   export type RowEncoded<TColumns extends Columns> = Types.Simplify<
     Nullable<Pick<RowEncodeNonNullable<TColumns>, NullableColumnNames<TColumns>>> &
       Omit<RowEncodeNonNullable<TColumns>, NullableColumnNames<TColumns>>
@@ -192,4 +215,9 @@ export namespace FromColumns {
     Pick<RowDecodedAll<TColumns>, RequiredInsertColumnNames<TColumns>> &
       Partial<Omit<RowDecodedAll<TColumns>, RequiredInsertColumnNames<TColumns>>>
   >
+
+  export type InsertRowEncoded<TColumns extends Columns> = Types.Simplify<
+    Pick<RowEncodedAll<TColumns>, RequiredInsertColumnNames<TColumns>> &
+      Partial<Omit<RowEncodedAll<TColumns>, RequiredInsertColumnNames<TColumns>>>
+  >
 }

package/src/schema/mutations.ts

@@ -1,5 +1,6 @@
 import { Schema } from '@livestore/utils/effect'
 
+import type { QueryBuilder } from '../query-builder/mod.js'
 import type { BindValues } from '../sql-queries/sql-queries.js'
 
 export type MutationDefMap = {
@@ -20,7 +21,10 @@ export type InternalMutationSchema<TRecord extends MutationDefRecord = MutationD
 
 export type MutationDefSqlResult<TTo> =
   | SingleOrReadonlyArray<string>
-  | ((args: TTo) => SingleOrReadonlyArray<
+  | ((
+      args: TTo,
+      context: { currentFacts: MutationEventFacts; clientOnly: boolean },
+    ) => SingleOrReadonlyArray<
       | string
       | {
           sql: string
@@ -28,8 +32,15 @@ export type MutationDefSqlResult<TTo> =
           bindValues: BindValues
           writeTables?: ReadonlySet<string>
         }
+      | QueryBuilder.Any
     >)
 
+export type MutationHandlerResult = {
+  sql: string
+  bindValues: BindValues
+  writeTables?: ReadonlySet<string>
+}
+
 export type SingleOrReadonlyArray<T> = T | ReadonlyArray<T>
 
 export type MutationDef<TName extends string, TFrom, TTo> = {

package/src/schema/system-tables.ts

@@ -79,8 +79,7 @@ export const mutationLogMetaTable = table(
     mutation: SqliteDsl.text({}),
     argsJson: SqliteDsl.text({ schema: Schema.parseJson(Schema.Any) }),
     clientId: SqliteDsl.text({}),
-    /** Only available for mutations which were executed in this client */
-    sessionId: SqliteDsl.text({ nullable: true }),
+    sessionId: SqliteDsl.text({}),
     schemaHash: SqliteDsl.integer({}),
     syncMetadataJson: SqliteDsl.text({ schema: Schema.parseJson(Schema.Option(Schema.JsonValue)) }),
   },

package/src/schema/table-def.ts

@@ -19,12 +19,12 @@ export type DefaultSqliteTableDefConstrained = SqliteDsl.TableDefinition<string,
 export type TableDefBase<
   TSqliteDef extends DefaultSqliteTableDef = DefaultSqliteTableDefConstrained,
   TOptions extends TableOptions = TableOptions,
-  TSchema = SqliteDsl.StructSchemaForColumns<TSqliteDef['columns']>,
 > = {
   sqliteDef: TSqliteDef
   options: TOptions
   // Derived from `sqliteDef`, so only exposed for convenience
-  schema: TSchema
+  schema: SqliteDsl.StructSchemaForColumns<TSqliteDef['columns']>
+  insertSchema: SqliteDsl.InsertStructSchemaForColumns<TSqliteDef['columns']>
 }
 
 export type TableDef<
@@ -47,7 +47,10 @@ export type TableDef<
   options: TOptions
   // Derived from `sqliteDef`, so only exposed for convenience
   schema: TSchema
-  query: QueryBuilder<ReadonlyArray<Schema.Schema.Type<TSchema>>, TableDef<TSqliteDef & {}, TOptions>>
+  insertSchema: SqliteDsl.InsertStructSchemaForColumns<TSqliteDef['columns']>
+  query: QueryBuilder<ReadonlyArray<Schema.Schema.Type<TSchema>>, TableDefBase<TSqliteDef & {}, TOptions>>
+  readonly Type: Schema.Schema.Type<TSchema>
+  readonly Encoded: Schema.Schema.Encoded<TSchema>
 } & (TOptions['deriveMutations']['enabled'] extends true
   ? DerivedMutationHelperFns<TSqliteDef['columns'], TOptions>
   : {})
@@ -195,7 +198,14 @@ export const table = <
   const isSingleColumn = SqliteDsl.isColumnDefinition(columnOrColumns) === true
 
   const schema = SqliteDsl.structSchemaForTable(sqliteDef)
-  const tableDef = { sqliteDef, options: options_, schema } satisfies TableDefBase
+  const insertSchema = SqliteDsl.insertStructSchemaForTable(sqliteDef)
+  const tableDef = {
+    sqliteDef,
+    options: options_,
+    schema,
+    insertSchema,
+  } satisfies TableDefBase
+
   const query = makeQueryBuilder(tableDef)
   // const tableDef = { ...tableDefBase, query } satisfies TableDef
 

package/src/sync/next/rebase-events.ts

@@ -51,7 +51,7 @@ export const rebaseEvents = ({
   rebaseFn: RebaseFn
   currentFactsSnapshot: MutationEventFactsSnapshot
   clientId: string
-  sessionId: string | undefined
+  sessionId: string
 }): ReadonlyArray<MutationEvent.AnyDecoded> => {
   const initialSnapshot = new Map(currentFactsSnapshot)
   applyFactGroups(

package/src/sync/sync.ts

@@ -12,14 +12,19 @@ import type * as MutationEvent from '../schema/MutationEvent.js'
 export type MakeBackendArgs = {
   storeId: string
   clientId: string
+  payload: Schema.JsonValue | undefined
 }
 
 export type SyncOptions = {
-  makeBackend?: (args: MakeBackendArgs) => Effect.Effect<SyncBackend<any>, UnexpectedError, Scope.Scope>
+  backend?: SyncBackendConstructor<any>
   /** @default { _tag: 'Skip' } */
   initialSyncOptions?: InitialSyncOptions
 }
 
+export type SyncBackendConstructor<TSyncMetadata = Schema.JsonValue> = (
+  args: MakeBackendArgs,
+) => Effect.Effect<SyncBackend<TSyncMetadata>, UnexpectedError, Scope.Scope | HttpClient.HttpClient>
+
 export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
   pull: (
     args: Option.Option<{
@@ -54,6 +59,10 @@ export type SyncBackend<TSyncMetadata = Schema.JsonValue> = {
     HttpClient.HttpClient
   >
   isConnected: SubscriptionRef.SubscriptionRef<boolean>
+  /**
+   * Metadata describing the sync backend.
+   */
+  metadata: { name: string; description: string } & Record<string, Schema.JsonValue>
 }
 
 export class IsOfflineError extends Schema.TaggedError<IsOfflineError>()('IsOfflineError', {}) {}

package/src/sync/syncstate.test.ts

@@ -19,7 +19,7 @@ class TestEvent extends MutationEvent.EncodedWithMeta {
       args: payload,
 
       clientId: 'static-local-id',
-      sessionId: undefined,
+      sessionId: 'static-session-id',
     })
   }
 

package/src/version.ts

@@ -2,7 +2,7 @@
 // import packageJson from '../package.json' with { type: 'json' }
 // export const liveStoreVersion = packageJson.version
 
-export const liveStoreVersion = '0.3.0-dev.22' as const
+export const liveStoreVersion = '0.3.0-dev.24' as const
 
 /**
  * This version number is incremented whenever the internal storage format changes in a breaking way.