@livestore/common 0.0.53-dev.2 → 0.0.54-dev.0

package/src/devtools/index.ts

@@ -0,0 +1,146 @@
+import { Schema } from '@livestore/utils/effect'
+import { type SqliteDsl as __SqliteDsl } from 'effect-db-schema'
+
+import { LiveStoreSchemaSchema } from '../schema/index.js'
+import { mutationEventSchemaEncodedAny } from '../schema/mutations.js'
+
+const requestId = Schema.String
+
+export class SnapshotReq extends Schema.TaggedStruct('LSD.SnapshotReq', {
+  requestId,
+}) {}
+
+export class SnapshotRes extends Schema.TaggedStruct('LSD.SnapshotRes', {
+  requestId,
+  snapshot: Schema.Uint8Array,
+}) {}
+
+export class SerializedSchemaReq extends Schema.TaggedStruct('LSD.SerializedSchemaReq', {
+  requestId,
+}) {}
+
+export class SerializedSchemaRes extends Schema.TaggedStruct('LSD.SerializedSchemaRes', {
+  requestId,
+  schema: LiveStoreSchemaSchema,
+}) {}
+
+export class MutationBroadcast extends Schema.TaggedStruct('LSD.MutationBroadcast', {
+  requestId,
+  mutationEventEncoded: mutationEventSchemaEncodedAny,
+  persisted: Schema.Boolean,
+}) {}
+
+export class MutationLogReq extends Schema.TaggedStruct('LSD.MutationLogReq', {
+  requestId,
+}) {}
+
+export class MutationLogRes extends Schema.TaggedStruct('LSD.MutationLogRes', {
+  requestId,
+  mutationLog: Schema.Uint8Array,
+}) {}
+
+export class SubscribeSignalsReq extends Schema.TaggedStruct('LSD.SubscribeSignalsReq', {
+  requestId,
+  includeResults: Schema.Boolean,
+}) {}
+
+export class SubscribeSignalsRes extends Schema.TaggedStruct('LSD.SubscribeSignalsRes', {
+  requestId,
+  signals: Schema.Any,
+}) {}
+
+export class SubscribeLiveQueriesReq extends Schema.TaggedStruct('LSD.SubscribeLiveQueriesReq', {
+  requestId,
+}) {}
+
+export class SerializedLiveQuery extends Schema.Struct({
+  _tag: Schema.Literal('js', 'sql', 'graphql'),
+  id: Schema.Number,
+  label: Schema.String,
+  runs: Schema.Number,
+  executionTimes: Schema.Array(Schema.Number),
+  lastestResult: Schema.Any,
+  activeSubscriptions: Schema.Array(
+    Schema.Struct({ frames: Schema.Array(Schema.Struct({ name: Schema.String, filePath: Schema.String })) }),
+  ),
+}) {}
+
+export class SubscribeLiveQueriesRes extends Schema.TaggedStruct('LSD.SubscribeLiveQueriesRes', {
+  requestId,
+  liveQueries: Schema.Array(SerializedLiveQuery),
+}) {}
+
+export class ResetAllDataReq extends Schema.TaggedStruct('LSD.ResetAllDataReq', {
+  requestId,
+  mode: Schema.Literal('all-data', 'only-app-db'),
+}) {}
+
+export class ResetAllDataRes extends Schema.TaggedStruct('LSD.ResetAllDataRes', {
+  requestId,
+}) {}
+
+export class AppHostReadyReq extends Schema.TaggedStruct('LSD.AppHostReadyReq', {
+  requestId,
+}) {}
+export class AppHostReadyRes extends Schema.TaggedStruct('LSD.AppHostReadyRes', {
+  requestId,
+}) {}
+
+export class Disconnect extends Schema.TaggedStruct('LSD.Disconnect', {
+  requestId,
+}) {}
+
+export class SchemaChanged extends Schema.TaggedStruct('LSD.SchemaChanged', {
+  requestId,
+}) {}
+
+// export const Message = Schema.Union(
+//   SnapshotReq,
+//   SnapshotRes,
+//   SerializedSchemaReq,
+//   SerializedSchemaRes,
+//   MutationBroadcast,
+//   MutationLogReq,
+//   MutationLogRes,
+//   SubscribeSignalsReq,
+//   SubscribeSignalsRes,
+//   SubscribeLiveQueriesReq,
+//   SubscribeLiveQueriesRes,
+//   ResetAllDataReq,
+//   ResetAllDataRes,
+//   Disconnect,
+//   SchemaChanged,
+//   AppHostReadyReq,
+//   AppHostReadyRes,
+// )
+
+// export type Message = typeof Message.Type
+
+export const MessageToAppHost = Schema.Union(
+  SnapshotReq,
+  SerializedSchemaReq,
+  MutationLogReq,
+  SubscribeSignalsReq,
+  SubscribeLiveQueriesReq,
+  ResetAllDataReq,
+  AppHostReadyReq,
+)
+
+export type MessageToAppHost = typeof MessageToAppHost.Type
+
+export const MessageFromAppHost = Schema.Union(
+  SnapshotRes,
+  SerializedSchemaRes,
+  MutationLogRes,
+  SubscribeSignalsRes,
+  SubscribeLiveQueriesRes,
+  ResetAllDataRes,
+  AppHostReadyRes,
+  Disconnect,
+  SchemaChanged,
+  MutationBroadcast,
+)
+
+export type MessageFromAppHost = typeof MessageFromAppHost.Type
+
+export const makeBc = () => new BroadcastChannel('livestore-devtools')

package/src/index.ts

@@ -8,3 +8,4 @@ export * from './rehydrate-from-mutationlog.js'
 export * from './query-info.js'
 export * from './derived-mutations.js'
 export * from './sync/index.js'
+export * as Devtools from './devtools/index.js'

package/src/schema/index.ts

@@ -1,6 +1,7 @@
-import { isReadonlyArray, shouldNeverHappen } from '@livestore/utils'
+import { isReadonlyArray, pick, shouldNeverHappen } from '@livestore/utils'
 import type { ReadonlyArray } from '@livestore/utils/effect'
-import { SqliteAst, type SqliteDsl } from 'effect-db-schema'
+import { ReadonlyRecord, Schema } from '@livestore/utils/effect'
+import { SqliteAst, SqliteDsl } from 'effect-db-schema'
 
 import type { MigrationOptions } from '../adapter-types.js'
 import { makeDerivedMutationDefsForTable } from '../derived-mutations.js'
@@ -12,7 +13,7 @@ import {
   rawSqlMutation,
 } from './mutations.js'
 import { systemTables } from './system-tables.js'
-import { type TableDef, tableHasDerivedMutations } from './table-def.js'
+import { table, type TableDef, tableHasDerivedMutations } from './table-def.js'
 
 export * from './system-tables.js'
 export * as DbSchema from './table-def.js'
@@ -20,10 +21,14 @@ export * as ParseUtils from './parse-utils.js'
 export * from './mutations.js'
 export * from './schema-helpers.js'
 
+export const LiveStoreSchemaSymbol = Symbol.for('livestore.LiveStoreSchema')
+export type LiveStoreSchemaSymbol = typeof LiveStoreSchemaSymbol
+
 export type LiveStoreSchema<
   TDbSchema extends SqliteDsl.DbSchema = SqliteDsl.DbSchema,
   TMutationsDefRecord extends MutationDefRecord = MutationDefRecord,
 > = {
+  readonly _Type: LiveStoreSchemaSymbol
   /** Only used on type-level */
   readonly _DbSchemaType: TDbSchema
   /** Only used on type-level */
@@ -99,8 +104,9 @@ export const makeSchema = <TInputSchema extends InputSchema>(
   })
 
   return {
-    _DbSchemaType: Symbol('livestore.DbSchemaType') as any,
-    _MutationDefMapType: Symbol('livestore.MutationDefMapType') as any,
+    _Type: LiveStoreSchemaSymbol,
+    _DbSchemaType: Symbol.for('livestore.DbSchemaType') as any,
+    _MutationDefMapType: Symbol.for('livestore.MutationDefMapType') as any,
     tables,
     mutations,
     migrationOptions: inputSchema.migrations ?? { strategy: 'hard-reset' },
@@ -133,3 +139,65 @@ namespace FromInputSchema {
         ? { [K in keyof TMutations as TMutations[K]['name']]: TMutations[K] } & { 'livestore.RawSql': RawSqlMutation }
         : never
 }
+
+export const LiveStoreSchemaFromSelf: Schema.Schema<LiveStoreSchema> = Schema.declare(
+  (_): _ is LiveStoreSchema =>
+    (_ as any)._DbSchemaType === Symbol.for('livestore.DbSchemaType') &&
+    (_ as any)._MutationDefMapType === Symbol.for('livestore.MutationDefMapType'),
+  {
+    identifier: 'LiveStoreSchemaFromSelf',
+    pretty: () => (_) => `LiveStoreSchema(hash: ${_.hash})`,
+    arbitrary: () => (fc) => fc.anything as any,
+    equivalence: () => (a, b) => a.hash === b.hash,
+  },
+)
+
+export const TableDefColumnSchema = Schema.Struct({
+  columnType: Schema.Literal('blob', 'integer', 'text', 'real'),
+  nullable: Schema.Boolean,
+  primaryKey: Schema.Boolean,
+})
+
+export const TableDefSqliteSchema = Schema.Struct({
+  name: Schema.String,
+  columns: Schema.Record(Schema.String, TableDefColumnSchema),
+  ast: Schema.Any,
+})
+
+export const TableDefSchema = Schema.Struct({
+  sqliteDef: TableDefSqliteSchema,
+  isSingleColumn: Schema.Boolean,
+  options: Schema.Any,
+})
+
+export const LiveStoreSchemaSchema = Schema.transform(
+  Schema.Struct({
+    tables: Schema.Record(Schema.String, TableDefSchema),
+    // mutations: Schema.Record(Schema.String, MutationDef.AnySchema),
+    // migrationOptions: Schema.Struct({ strategy: Schema.Literal('hard-reset') }),
+  }),
+  LiveStoreSchemaFromSelf,
+  {
+    encode: (schema) => ({
+      tables: ReadonlyRecord.map(Object.fromEntries(schema.tables.entries()), (t) => ({
+        sqliteDef: {
+          name: t.sqliteDef.name,
+          columns: ReadonlyRecord.map(t.sqliteDef.columns, (c) => pick(c!, ['columnType', 'nullable', 'primaryKey'])),
+          ast: JSON.parse(JSON.stringify(t.sqliteDef.ast)),
+        },
+        isSingleColumn: t.isSingleColumn,
+        options: t.options,
+      })),
+    }),
+    decode: (schema) => {
+      const tables = ReadonlyRecord.map(schema.tables, (t) => {
+        const columns = ReadonlyRecord.map(t.sqliteDef.columns, (c) => {
+          const makeCol = SqliteDsl[c.columnType] as any
+          return makeCol({ nullable: c.nullable, primaryKey: c.primaryKey })
+        })
+        return table(t.sqliteDef.name, columns, t.options)
+      })
+      return makeSchema({ tables })
+    },
+  },
+)

package/dist/database-types.d.ts

@@ -1,77 +0,0 @@
-import type * as otel from '@opentelemetry/api';
-import type { LiveStoreSchema, MutationEvent } from './schema/index.js';
-import type { PreparedBindValues } from './util.js';
-export interface PreparedStatement {
-    execute(bindValues: PreparedBindValues | undefined): GetRowsChangedCount;
-    select<T>(bindValues: PreparedBindValues | undefined): ReadonlyArray<T>;
-    finalize(): void;
-}
-export type DatabaseImpl = {
-    /** Main thread database (usually in-memory) */
-    mainDb: InMemoryDatabase;
-    storageDb: StorageDatabase;
-};
-export type InMemoryDatabase = {
-    _tag: 'InMemoryDatabase';
-    prepare(queryStr: string): PreparedStatement;
-    execute(queryStr: string, bindValues: PreparedBindValues | undefined): GetRowsChangedCount;
-    dangerouslyReset(): Promise<void>;
-    export(): Uint8Array;
-};
-export type ResetMode = 'all-data' | 'only-app-db';
-export type StorageDatabase = {
-    execute(queryStr: string, bindValues: PreparedBindValues | undefined, span: otel.Span | undefined): Promise<void>;
-    mutate(mutationEventEncoded: MutationEvent.Any, span: otel.Span): Promise<void>;
-    dangerouslyReset(mode: ResetMode): Promise<void>;
-    export(span: otel.Span | undefined): Promise<Uint8Array | undefined>;
-    /**
-     * This is different from `export` since in `getInitialSnapshot` is usually the place for migrations etc to happen
-     */
-    getInitialSnapshot(): Promise<Uint8Array>;
-    getMutationLogData(): Promise<Uint8Array>;
-    shutdown(): Promise<void>;
-};
-export type GetRowsChangedCount = () => number;
-export type BootDb = {
-    _tag: 'BootDb';
-    execute(queryStr: string, bindValues?: PreparedBindValues): void;
-    mutate: <const TMutationArg extends ReadonlyArray<MutationEvent.Any>>(...list: TMutationArg) => void;
-    select<T>(queryStr: string, bindValues?: PreparedBindValues): ReadonlyArray<T>;
-    txn(callback: () => void): void;
-};
-export type MigrationOptions<TSchema extends LiveStoreSchema = LiveStoreSchema> = MigrationOptionsFromMutationLog<TSchema> | {
-    strategy: 'hard-reset';
-    hooks?: Partial<MigrationHooks>;
-} | {
-    strategy: 'manual';
-    migrate: (oldDb: Uint8Array) => Promise<Uint8Array> | Uint8Array;
-    hooks?: Partial<MigrationHooks>;
-};
-export type MigrationHooks = {
-    /** Runs on the empty in-memory database with no database schemas applied yet */
-    init: MigrationHook;
-    /** Runs before applying the migration strategy but after table schemas have been applied and singleton rows have been created */
-    pre: MigrationHook;
-    /** Runs after applying the migration strategy before creating export snapshot and closing the database */
-    post: MigrationHook;
-};
-export type MigrationHook = (db: InMemoryDatabase) => void | Promise<void>;
-export type MigrationOptionsFromMutationLog<TSchema extends LiveStoreSchema = LiveStoreSchema> = {
-    strategy: 'from-mutation-log';
-    /**
-     * Mutations to exclude in the mutation log
-     *
-     * @default new Set(['livestore.RawSql'])
-     */
-    excludeMutations?: ReadonlySet<keyof TSchema['_MutationDefMapType'] & string>;
-    hooks?: Partial<MigrationHooks>;
-    logging?: {
-        excludeAffectedRows?: (sqlStmt: string) => boolean;
-    };
-};
-export type DatabaseFactory = (opts: {
-    otelTracer: otel.Tracer;
-    otelContext: otel.Context;
-    schema: LiveStoreSchema;
-}) => DatabaseImpl | Promise<DatabaseImpl>;
-//# sourceMappingURL=database-types.d.ts.map

package/dist/database-types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"database-types.d.ts","sourceRoot":"","sources":["../src/database-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,IAAI,MAAM,oBAAoB,CAAA;AAE/C,OAAO,KAAK,EAAE,eAAe,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAEnD,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,UAAU,EAAE,kBAAkB,GAAG,SAAS,GAAG,mBAAmB,CAAA;IACxE,MAAM,CAAC,CAAC,EAAE,UAAU,EAAE,kBAAkB,GAAG,SAAS,GAAG,aAAa,CAAC,CAAC,CAAC,CAAA;IACvE,QAAQ,IAAI,IAAI,CAAA;CACjB;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,+CAA+C;IAC/C,MAAM,EAAE,gBAAgB,CAAA;IACxB,SAAS,EAAE,eAAe,CAAA;CAC3B,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,EAAE,kBAAkB,CAAA;IACxB,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,iBAAiB,CAAA;IAC5C,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,GAAG,SAAS,GAAG,mBAAmB,CAAA;IAC1F,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;IACjC,MAAM,IAAI,UAAU,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,GAAG,aAAa,CAAA;AAElD,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,kBAAkB,GAAG,SAAS,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACjH,MAAM,CAAC,oBAAoB,EAAE,aAAa,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC/E,gBAAgB,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAChD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,GAAG,SAAS,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CAAA;IACpE;;OAEG;IACH,kBAAkB,IAAI,OAAO,CAAC,UAAU,CAAC,CAAA;IACzC,kBAAkB,IAAI,OAAO,CAAC,UAAU,CAAC,CAAA;IACzC,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG,MAAM,MAAM,CAAA;AAE9C,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,QAAQ,CAAA;IACd,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,kBAAkB,GAAG,IAAI,CAAA;IAChE,MAAM,EAAE,CAAC,KAAK,CAAC,YAAY,SAAS,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,EAAE,YAAY,KAAK,IAAI,CAAA;IACpG,MAAM,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,kBAAkB,GAAG,aAAa,CAAC,CAAC,CAAC,CAAA;IAC9E,GAAG,CAAC,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAA;CAChC,CAAA;AAID,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,eAAe,GAAG,eAAe,IAC1E,+BAA+B,CAAC,OAAO,CAAC,GACxC;IACE,QAAQ,EAAE,YAAY,CAAA;IACtB,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;CAChC,GACD;IACE,QAAQ,EAAE,QAAQ,CAAA;IAClB,OAAO,EAAE,CAAC,KAAK,EAAE,UAAU,KAAK,OAAO,CAAC,UAAU,CAAC,GAAG,UAAU,CAAA;IAChE,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;CAChC,CAAA;AAEL,MAAM,MAAM,cAAc,GAAG;IAC3B,gFAAgF;IAChF,IAAI,EAAE,aAAa,CAAA;IACnB,iIAAiI;IACjI,GAAG,EAAE,aAAa,CAAA;IAClB,0GAA0G;IAC1G,IAAI,EAAE,aAAa,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG,CAAC,EAAE,EAAE,gBAAgB,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;AAE1E,MAAM,MAAM,+BAA+B,CAAC,OAAO,SAAS,eAAe,GAAG,eAAe,IAAI;IAC/F,QAAQ,EAAE,mBAAmB,CAAA;IAC7B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,WAAW,CAAC,MAAM,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,CAAC,CAAA;IAC7E,KAAK,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAA;IAC/B,OAAO,CAAC,EAAE;QACR,mBAAmB,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAA;KACnD,CAAA;CACF,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE;IACnC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAA;IACvB,WAAW,EAAE,IAAI,CAAC,OAAO,CAAA;IACzB,MAAM,EAAE,eAAe,CAAA;CACxB,KAAK,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC,CAAA"}

package/dist/database-types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=database-types.js.map

package/dist/database-types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"database-types.js","sourceRoot":"","sources":["../src/database-types.ts"],"names":[],"mappings":""}