@livestore/common 0.3.2-dev.13 → 0.3.2-dev.14

package/src/schema/state/sqlite/db-schema/dsl/field-defs.ts

@@ -9,9 +9,15 @@ export type ColumnDefinition<TEncoded, TDecoded> = {
   readonly nullable: boolean
   /** @default false */
   readonly primaryKey: boolean
+  /** @default false */
+  readonly autoIncrement: boolean
+}
+
+export declare namespace ColumnDefinition {
+  export type Any = ColumnDefinition<any, any>
 }
 
-export const isColumnDefinition = (value: unknown): value is ColumnDefinition<any, any> => {
+export const isColumnDefinition = (value: unknown): value is ColumnDefinition.Any => {
   const validColumnTypes = ['text', 'integer', 'real', 'blob'] as const
   return (
     typeof value === 'object' &&
@@ -26,6 +32,7 @@ export type ColumnDefinitionInput = {
   readonly default?: unknown | NoDefault
   readonly nullable?: boolean
   readonly primaryKey?: boolean
+  readonly autoIncrement?: boolean
 }
 
 export const NoDefault = Symbol.for('NoDefault')
@@ -46,6 +53,7 @@ export type ColDefFn<TColumnType extends FieldColumnType> = {
     default: Option.None<never>
     nullable: false
     primaryKey: false
+    autoIncrement: false
   }
   <
     TEncoded extends DefaultEncodedForColumnType<TColumnType>,
@@ -53,11 +61,13 @@ export type ColDefFn<TColumnType extends FieldColumnType> = {
     const TNullable extends boolean = false,
     const TDefault extends TDecoded | SqlDefaultValue | NoDefault | (TNullable extends true ? null : never) = NoDefault,
     const TPrimaryKey extends boolean = false,
+    const TAutoIncrement extends boolean = false,
   >(args: {
     schema?: Schema.Schema<TDecoded, TEncoded>
     default?: TDefault
     nullable?: TNullable
     primaryKey?: TPrimaryKey
+    autoIncrement?: TAutoIncrement
   }): {
     columnType: TColumnType
     schema: TNullable extends true
@@ -66,6 +76,7 @@ export type ColDefFn<TColumnType extends FieldColumnType> = {
     default: TDefault extends NoDefault ? Option.None<never> : Option.Some<NoInfer<TDefault>>
     nullable: NoInfer<TNullable>
     primaryKey: NoInfer<TPrimaryKey>
+    autoIncrement: NoInfer<TAutoIncrement>
   }
 }
 
@@ -83,6 +94,7 @@ const makeColDef =
       default: default_,
       nullable,
       primaryKey: def?.primaryKey ?? false,
+      autoIncrement: def?.autoIncrement ?? false,
     } as any
   }
 
@@ -115,12 +127,14 @@ export type SpecializedColDefFn<
     default: Option.None<never>
     nullable: false
     primaryKey: false
+    autoIncrement: false
   }
   <
     TDecoded = TBaseDecoded,
     const TNullable extends boolean = false,
     const TDefault extends TDecoded | NoDefault | (TNullable extends true ? null : never) = NoDefault,
     const TPrimaryKey extends boolean = false,
+    const TAutoIncrement extends boolean = false,
   >(
     args: TAllowsCustomSchema extends true
       ? {
@@ -128,11 +142,13 @@ export type SpecializedColDefFn<
           default?: TDefault
           nullable?: TNullable
           primaryKey?: TPrimaryKey
+          autoIncrement?: TAutoIncrement
         }
       : {
           default?: TDefault
           nullable?: TNullable
           primaryKey?: TPrimaryKey
+          autoIncrement?: TAutoIncrement
         },
   ): {
     columnType: TColumnType
@@ -142,6 +158,7 @@ export type SpecializedColDefFn<
     default: TDefault extends NoDefault ? Option.None<never> : Option.Some<TDefault>
     nullable: NoInfer<TNullable>
     primaryKey: NoInfer<TPrimaryKey>
+    autoIncrement: NoInfer<TAutoIncrement>
   }
 }
 
@@ -176,6 +193,7 @@ const makeSpecializedColDef: MakeSpecializedColDefFn = (columnType, opts) => (de
     default: default_,
     nullable,
     primaryKey: def?.primaryKey ?? false,
+    autoIncrement: def?.autoIncrement ?? false,
   } as any
 }
 
@@ -214,7 +232,7 @@ export type DefaultEncodedForColumnType<TColumnType extends FieldColumnType> = T
     : TColumnType extends 'real'
       ? number
       : TColumnType extends 'blob'
-        ? Uint8Array
+        ? Uint8Array<ArrayBuffer>
         : never
 
 export const defaultSchemaForColumnType = <TColumnType extends FieldColumnType>(

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

@@ -92,6 +92,7 @@ const columsToAst = (columns: Columns): ReadonlyArray<SqliteAst.Column> => {
       default: column.default as any,
       nullable: column.nullable ?? false,
       primaryKey: column.primaryKey ?? false,
+      autoIncrement: column.autoIncrement ?? false,
       type: { _tag: column.columnType },
     } satisfies SqliteAst.Column
   })

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

@@ -16,6 +16,8 @@ export {
   clientDocument,
   tableIsClientDocumentTable,
 } from './client-document-def.ts'
+export * from './column-annotations.ts'
+export * from './column-spec.ts'
 export * from './table-def.ts'
 
 export const makeState = <TStateInput extends InputState>(inputSchema: TStateInput): InternalState => {