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

package/src/devtools/devtools-messages.ts

@@ -135,10 +135,24 @@ export class MessagePortForStoreRes extends LSDReqResMessage('LSD.MessagePortFor
   port: Transferable.MessagePort,
 }) {}
 
-export class NetworkStatusChanged extends LSDChannelMessage('LSD.NetworkStatusChanged', {
+export class NetworkStatusSubscribe extends LSDReqResMessage('LSD.NetworkStatusSubscribe', {}) {}
+export class NetworkStatusUnsubscribe extends LSDReqResMessage('LSD.NetworkStatusUnsubscribe', {}) {}
+
+export class NetworkStatusRes extends LSDReqResMessage('LSD.NetworkStatusRes', {
   networkStatus: NetworkStatus,
 }) {}
 
+export class SyncingInfoReq extends LSDReqResMessage('LSD.SyncingInfoReq', {}) {}
+
+export class SyncingInfo extends Schema.Struct({
+  enabled: Schema.Boolean,
+  metadata: Schema.Record({ key: Schema.String, value: Schema.Any }),
+}) {}
+
+export class SyncingInfoRes extends LSDReqResMessage('LSD.SyncingInfoRes', {
+  syncingInfo: SyncingInfo,
+}) {}
+
 export class DevtoolsReady extends LSDMessage('LSD.DevtoolsReady', {}) {}
 
 export class DevtoolsConnected extends LSDChannelMessage('LSD.DevtoolsConnected', {}) {}
@@ -147,7 +161,7 @@ export class AppHostReady extends LSDChannelMessage('LSD.AppHostReady', {
   isLeaderTab: Schema.Boolean,
 }) {}
 
-export class Disconnect extends LSDReqResMessage('LSD.Disconnect', {}) {}
+export class Disconnect extends LSDChannelMessage('LSD.Disconnect', {}) {}
 
 export class Ping extends LSDReqResMessage('LSD.Ping', {}) {}
 
@@ -159,12 +173,15 @@ export const MessageToAppHostCoordinator = Schema.Union(
   MutationLogReq,
   ResetAllDataReq,
   MessagePortForStoreRes,
+  NetworkStatusSubscribe,
+  NetworkStatusUnsubscribe,
   DevtoolsReady,
   Disconnect,
   DevtoolsConnected,
   RunMutationReq,
   Ping,
   DatabaseFileInfoReq,
+  SyncingInfoReq,
 ).annotations({ identifier: 'LSD.MessageToAppHostCoordinator' })
 
 export type MessageToAppHostCoordinator = typeof MessageToAppHostCoordinator.Type
@@ -193,10 +210,11 @@ export const MessageFromAppHostCoordinator = Schema.Union(
   Disconnect,
   MutationBroadcast,
   AppHostReady,
-  NetworkStatusChanged,
+  NetworkStatusRes,
   RunMutationRes,
   Pong,
   DatabaseFileInfoRes,
+  SyncingInfoRes,
 ).annotations({ identifier: 'LSD.MessageFromAppHostCoordinator' })
 
 export type MessageFromAppHostCoordinator = typeof MessageFromAppHostCoordinator.Type

package/src/devtools/devtools-window-message.ts

@@ -4,7 +4,7 @@ const channelId = Schema.String
 
 export namespace DevtoolsWindowMessage {
   /** Message is being created in contentscript-iframe, sent to contentscript and then sent to Store */
-  export class MessagePortReady extends Schema.TaggedStruct('LSD.WindowMessage.MessagePortForStore', {
+  export class MessagePortReady extends Schema.TaggedStruct('LSD.WindowMessage.MessagePortReady', {
     port: Transferable.MessagePort,
     channelId,
   }) {}

package/src/devtools/index.ts

@@ -1,2 +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 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: 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
 }