@livestore/common 0.0.55-dev.2 → 0.0.55-dev.3

package/src/devtools/index.ts

@@ -1,13 +1,46 @@
+import type { Effect, Scope } from '@livestore/utils/effect'
 import { BrowserChannel, Schema } from '@livestore/utils/effect'
 
 export * from './devtools-messages.js'
 export * from './devtools-window-message.js'
 
 export namespace WebBridge {
-  export const makeBroadcastChannel = (key?: string) =>
+  export class AppHostReady extends Schema.TaggedStruct('LSD.WebBridge.AppHostReady', {
+    channelId: Schema.String,
+    isLeader: Schema.Boolean,
+  }) {}
+
+  export class DevtoolsReady extends Schema.TaggedStruct('LSD.WebBridge.DevtoolsReady', {
+    devtoolsId: Schema.String,
+  }) {}
+
+  export class ConnectToDevtools extends Schema.TaggedStruct('LSD.WebBridge.ConnectToDevtools', {
+    devtoolsId: Schema.String,
+    channelId: Schema.String,
+    /**
+     * Given the m:n relationship between devtools and app hosts and the fact that channelIds are usually
+     * sticky, we generate a new unique id for the lifetime of the web bridge.
+     */
+    webBridgeId: Schema.String,
+    isLeader: Schema.Boolean,
+  }) {}
+
+  export class AppHostWillDisconnect extends Schema.TaggedStruct('LSD.WebBridge.AppHostWillDisconnect', {
+    channelId: Schema.String,
+  }) {}
+
+  // export class DevtoolsWillDisconnect extends Schema.TaggedStruct('LSD.WebBridge.DevtoolsWillDisconnect', {
+  //   channelId: Schema.String,
+  // }) {}
+
+  export class All extends Schema.Union(AppHostReady, DevtoolsReady, ConnectToDevtools, AppHostWillDisconnect) {}
+
+  export const makeBroadcastChannel = (
+    key?: string,
+  ): Effect.Effect<BrowserChannel.BrowserChannel<typeof All.Type, typeof All.Type>, never, Scope.Scope> =>
     BrowserChannel.broadcastChannel({
       channelName: `livestore-web-bridge-devtools${key ? `-${key}` : ''}`,
-      listenSchema: Schema.Never,
-      sendSchema: Schema.Never,
+      listenSchema: All,
+      sendSchema: All,
     })
 }

package/src/schema/index.ts

@@ -40,11 +40,20 @@ export type LiveStoreSchema<
   readonly hash: number
 
   migrationOptions: MigrationOptions
+
+  key: string
 }
 
 export type InputSchema = {
   readonly tables: Record<string, TableDef> | ReadonlyArray<TableDef>
   readonly mutations?: ReadonlyArray<MutationDef.Any> | Record<string, MutationDef.Any>
+  /**
+   * Can be used to isolate multiple LiveStore apps running in the same origin
+   *
+   * Make sure you also use this key in the `storage` options (e.g. directory, prefix etc) to make sure
+   * different instances of LiveStore aren't overlapping on the storage level.
+   */
+  readonly key?: string
 }
 
 export const makeSchema = <TInputSchema extends InputSchema>(
@@ -111,6 +120,7 @@ export const makeSchema = <TInputSchema extends InputSchema>(
     mutations,
     migrationOptions: inputSchema.migrations ?? { strategy: 'hard-reset' },
     hash,
+    key: inputSchema.key ?? '',
   } satisfies LiveStoreSchema
 }