@livestore/common 0.3.0-dev.21 → 0.3.0-dev.23

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livestore/common",
-  "version": "0.3.0-dev.21",
+  "version": "0.3.0-dev.23",
   "type": "module",
   "sideEffects": false,
   "exports": {
@@ -54,7 +54,7 @@
     "graphology": "0.26.0-alpha1",
     "graphology-dag": "0.4.1",
     "graphology-types": "0.24.8",
-    "@livestore/utils": "0.3.0-dev.21"
+    "@livestore/utils": "0.3.0-dev.23"
   },
   "devDependencies": {
     "vitest": "^3.0.8"

package/src/adapter-types.ts

@@ -239,6 +239,12 @@ export type Adapter = (opts: {
   bootStatusQueue: Queue.Queue<BootStatus>
   shutdown: (cause: Cause.Cause<any>) => void
   connectDevtoolsToStore: ConnectDevtoolsToStore
+  /**
+   * Payload that will be passed to the sync backend when connecting
+   *
+   * @default undefined
+   */
+  syncPayload: Schema.JsonValue | undefined
 }) => Effect.Effect<ClientSession, UnexpectedError, Scope.Scope>
 
 export const MigrationsReportEntry = Schema.Struct({

package/src/leader-thread/make-leader-thread-layer.ts

@@ -1,4 +1,4 @@
-import type { HttpClient, Scope } from '@livestore/utils/effect'
+import type { HttpClient, Schema, Scope } from '@livestore/utils/effect'
 import { Deferred, Effect, Layer, Queue, SubscriptionRef } from '@livestore/utils/effect'
 
 import type { BootStatus, MakeSqliteDb, MigrationsReport, SqliteError } from '../adapter-types.js'
@@ -28,6 +28,7 @@ export const makeLeaderThreadLayer = ({
   schema,
   storeId,
   clientId,
+  syncPayload,
   makeSqliteDb,
   syncOptions,
   dbReadModel,
@@ -36,6 +37,7 @@ export const makeLeaderThreadLayer = ({
   shutdownChannel,
 }: {
   storeId: string
+  syncPayload: Schema.JsonValue | undefined
   clientId: string
   schema: LiveStoreSchema
   makeSqliteDb: MakeSqliteDb
@@ -54,7 +56,9 @@ export const makeLeaderThreadLayer = ({
       dbReadModel.select<{ count: number }>(sql`select count(*) as count from sqlite_master`)[0]!.count === 0
 
     const syncBackend =
-      syncOptions?.makeBackend === undefined ? undefined : yield* syncOptions.makeBackend({ storeId, clientId })
+      syncOptions?.makeBackend === undefined
+        ? undefined
+        : yield* syncOptions.makeBackend({ storeId, clientId, payload: syncPayload })
 
     const initialBlockingSyncContext = yield* makeInitialBlockingSyncContext({
       initialSyncOptions: syncOptions?.initialSyncOptions ?? { _tag: 'Skip' },

package/src/sync/sync.ts

@@ -12,10 +12,13 @@ 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>
+  makeBackend?: (
+    args: MakeBackendArgs,
+  ) => Effect.Effect<SyncBackend<any>, UnexpectedError, Scope.Scope | HttpClient.HttpClient>
   /** @default { _tag: 'Skip' } */
   initialSyncOptions?: InitialSyncOptions
 }

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.21' as const
+export const liveStoreVersion = '0.3.0-dev.23' as const
 
 /**
  * This version number is incremented whenever the internal storage format changes in a breaking way.

package/dist/devtools/devtools-sessions-channel.d.ts

@@ -1,28 +0,0 @@
-import type { ParseResult, Scope, WebChannel } from '@livestore/utils/effect';
-import { Duration, Effect, Schema, Subscribable } from '@livestore/utils/effect';
-export declare const RequestSessions: Schema.TaggedStruct<"RequestSessions", {}>;
-export type RequestSessions = typeof RequestSessions.Type;
-export declare const SessionInfo: Schema.TaggedStruct<"SessionInfo", {
-    storeId: typeof Schema.String;
-    clientId: typeof Schema.String;
-    sessionId: typeof Schema.String;
-}>;
-export type SessionInfo = typeof SessionInfo.Type;
-export declare const Message: Schema.Union<[Schema.TaggedStruct<"RequestSessions", {}>, Schema.TaggedStruct<"SessionInfo", {
-    storeId: typeof Schema.String;
-    clientId: typeof Schema.String;
-    sessionId: typeof Schema.String;
-}>]>;
-export type Message = typeof Message.Type;
-/** Usually called in client session */
-export declare const provideSessionInfo: ({ webChannel, sessionInfo, }: {
-    webChannel: WebChannel.WebChannel<Message, Message>;
-    sessionInfo: SessionInfo;
-}) => Effect.Effect<void, ParseResult.ParseError>;
-/** Usually called in devtools */
-export declare const requestSessionInfoSubscription: ({ webChannel, pollInterval, staleTimeout, }: {
-    webChannel: WebChannel.WebChannel<Message, Message>;
-    pollInterval?: Duration.DurationInput;
-    staleTimeout?: Duration.DurationInput;
-}) => Effect.Effect<Subscribable.Subscribable<Set<SessionInfo>>, ParseResult.ParseError, Scope.Scope>;
-//# sourceMappingURL=devtools-sessions-channel.d.ts.map

package/dist/devtools/devtools-sessions-channel.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"devtools-sessions-channel.d.ts","sourceRoot":"","sources":["../../src/devtools/devtools-sessions-channel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAA;AAC7E,OAAO,EAEL,QAAQ,EACR,MAAM,EAIN,MAAM,EAEN,YAAY,EAEb,MAAM,yBAAyB,CAAA;AAEhC,eAAO,MAAM,eAAe,4CAA6C,CAAA;AACzE,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD,eAAO,MAAM,WAAW;;;;EAItB,CAAA;AACF,MAAM,MAAM,WAAW,GAAG,OAAO,WAAW,CAAC,IAAI,CAAA;AAEjD,eAAO,MAAM,OAAO;;;;IAA6C,CAAA;AACjE,MAAM,MAAM,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,CAAA;AAEzC,uCAAuC;AACvC,eAAO,MAAM,kBAAkB,GAAI,8BAGhC;IACD,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACnD,WAAW,EAAE,WAAW,CAAA;CACzB,KAAG,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,UAAU,CAU1C,CAAA;AAEJ,iCAAiC;AACjC,eAAO,MAAM,8BAA8B,GAAI,6CAI5C;IACD,UAAU,EAAE,UAAU,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;IACnD,YAAY,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAA;IACrC,YAAY,CAAC,EAAE,QAAQ,CAAC,aAAa,CAAA;CACtC,KAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,EAAE,WAAW,CAAC,UAAU,EAAE,KAAK,CAAC,KAAK,CA2C9F,CAAA"}

package/dist/devtools/devtools-sessions-channel.js

@@ -1,34 +0,0 @@
-import { Data, Duration, Effect, FiberMap, HashSet, Schedule, Schema, Stream, Subscribable, SubscriptionRef, } from '@livestore/utils/effect';
-export const RequestSessions = Schema.TaggedStruct('RequestSessions', {});
-export const SessionInfo = Schema.TaggedStruct('SessionInfo', {
-    storeId: Schema.String,
-    clientId: Schema.String,
-    sessionId: Schema.String,
-});
-export const Message = Schema.Union(RequestSessions, SessionInfo);
-/** Usually called in client session */
-export const provideSessionInfo = ({ webChannel, sessionInfo, }) => Effect.gen(function* () {
-    yield* webChannel.send(sessionInfo);
-    yield* webChannel.listen.pipe(Stream.flatten(), Stream.filter(Schema.is(RequestSessions)), Stream.tap(() => webChannel.send(sessionInfo)), Stream.runDrain);
-});
-/** Usually called in devtools */
-export const requestSessionInfoSubscription = ({ webChannel, pollInterval = Duration.seconds(1), staleTimeout = Duration.seconds(5), }) => Effect.gen(function* () {
-    yield* webChannel
-        .send(RequestSessions.make({}))
-        .pipe(Effect.repeat(Schedule.spaced(pollInterval)), Effect.interruptible, Effect.tapCauseLogPretty, Effect.forkScoped);
-    const timeoutFiberMap = yield* FiberMap.make();
-    const sessionInfoSubRef = yield* SubscriptionRef.make(HashSet.empty());
-    yield* webChannel.listen.pipe(Stream.flatten(), Stream.filter(Schema.is(SessionInfo)), Stream.map(Data.struct), Stream.tap(Effect.fn(function* (sessionInfo) {
-        yield* SubscriptionRef.getAndUpdate(sessionInfoSubRef, HashSet.add(sessionInfo));
-        // Remove sessionInfo from cache after staleTimeout (unless a new identical item resets the timeout)
-        yield* FiberMap.run(timeoutFiberMap, sessionInfo, Effect.gen(function* () {
-            yield* Effect.sleep(staleTimeout);
-            yield* SubscriptionRef.getAndUpdate(sessionInfoSubRef, HashSet.remove(sessionInfo));
-        }));
-    })), Stream.runDrain, Effect.tapCauseLogPretty, Effect.forkScoped);
-    return Subscribable.make({
-        get: sessionInfoSubRef.get.pipe(Effect.map((sessionInfos) => new Set(sessionInfos))),
-        changes: sessionInfoSubRef.changes.pipe(Stream.map((sessionInfos) => new Set(sessionInfos))),
-    });
-});
-//# sourceMappingURL=devtools-sessions-channel.js.map

package/dist/devtools/devtools-sessions-channel.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"devtools-sessions-channel.js","sourceRoot":"","sources":["../../src/devtools/devtools-sessions-channel.ts"],"names":[],"mappings":"AACA,OAAO,EACL,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,MAAM,EACN,MAAM,EACN,YAAY,EACZ,eAAe,GAChB,MAAM,yBAAyB,CAAA;AAEhC,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC,YAAY,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAA;AAGzE,MAAM,CAAC,MAAM,WAAW,GAAG,MAAM,CAAC,YAAY,CAAC,aAAa,EAAE;IAC5D,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM;IACvB,SAAS,EAAE,MAAM,CAAC,MAAM;CACzB,CAAC,CAAA;AAGF,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,EAAE,WAAW,CAAC,CAAA;AAGjE,uCAAuC;AACvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,EACjC,UAAU,EACV,WAAW,GAIZ,EAA+C,EAAE,CAChD,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,KAAK,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;IAEnC,KAAK,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAC3B,MAAM,CAAC,OAAO,EAAE,EAChB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,eAAe,CAAC,CAAC,EACzC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,EAC9C,MAAM,CAAC,QAAQ,CAChB,CAAA;AACH,CAAC,CAAC,CAAA;AAEJ,iCAAiC;AACjC,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,EAC7C,UAAU,EACV,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,EAClC,YAAY,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAKnC,EAAmG,EAAE,CACpG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,KAAK,CAAC,CAAC,UAAU;SACd,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAC9B,IAAI,CACH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,EAC5C,MAAM,CAAC,aAAa,EACpB,MAAM,CAAC,iBAAiB,EACxB,MAAM,CAAC,UAAU,CAClB,CAAA;IAEH,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAe,CAAA;IAE3D,MAAM,iBAAiB,GAAG,KAAK,CAAC,CAAC,eAAe,CAAC,IAAI,CAA+B,OAAO,CAAC,KAAK,EAAE,CAAC,CAAA;IAEpG,KAAK,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAC3B,MAAM,CAAC,OAAO,EAAE,EAChB,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,EACrC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EACvB,MAAM,CAAC,GAAG,CACR,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,WAAW;QAC9B,KAAK,CAAC,CAAC,eAAe,CAAC,YAAY,CAAC,iBAAiB,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAA;QAEhF,oGAAoG;QACpG,KAAK,CAAC,CAAC,QAAQ,CAAC,GAAG,CACjB,eAAe,EACf,WAAW,EACX,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;YAClB,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;YACjC,KAAK,CAAC,CAAC,eAAe,CAAC,YAAY,CAAC,iBAAiB,EAAE,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAA;QACrF,CAAC,CAAC,CACH,CAAA;IACH,CAAC,CAAC,CACH,EACD,MAAM,CAAC,QAAQ,EACf,MAAM,CAAC,iBAAiB,EACxB,MAAM,CAAC,UAAU,CAClB,CAAA;IAED,OAAO,YAAY,CAAC,IAAI,CAAC;QACvB,GAAG,EAAE,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QACpF,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,YAAY,EAAE,EAAE,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;KAC7F,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/devtools/index.d.ts

@@ -1,39 +0,0 @@
-import { Schema } from '@livestore/utils/effect';
-export * from './devtools-messages.js';
-export * from './devtools-window-message.js';
-export * as SessionsChannel from './devtools-sessions-channel.js';
-export declare const ClientSessionInfo: Schema.Struct<{
-    storeId: typeof Schema.String;
-    clientId: typeof Schema.String;
-    sessionId: typeof Schema.String;
-}>;
-export declare const DevtoolsMode: Schema.Union<[Schema.TaggedStruct<"expo", {
-    clientSessionInfo: Schema.UndefinedOr<Schema.Struct<{
-        storeId: typeof Schema.String;
-        clientId: typeof Schema.String;
-        sessionId: typeof Schema.String;
-    }>>;
-}>, Schema.TaggedStruct<"node", {
-    clientSessionInfo: Schema.UndefinedOr<Schema.Struct<{
-        storeId: typeof Schema.String;
-        clientId: typeof Schema.String;
-        sessionId: typeof Schema.String;
-    }>>;
-    url: typeof Schema.String;
-}>, Schema.TaggedStruct<"web", {
-    clientSessionInfo: Schema.UndefinedOr<Schema.Struct<{
-        storeId: typeof Schema.String;
-        clientId: typeof Schema.String;
-        sessionId: typeof Schema.String;
-    }>>;
-}>, Schema.TaggedStruct<"browser-extension", {
-    clientSessionInfo: Schema.UndefinedOr<Schema.Struct<{
-        storeId: typeof Schema.String;
-        clientId: typeof Schema.String;
-        sessionId: typeof Schema.String;
-    }>>;
-}>]>;
-export type DevtoolsMode = typeof DevtoolsMode.Type;
-export declare const DevtoolsModeTag: Schema.SchemaClass<"expo" | "node" | "web" | "browser-extension", "expo" | "node" | "web" | "browser-extension", never>;
-export type DevtoolsModeTag = typeof DevtoolsModeTag.Type;
-//# sourceMappingURL=index.d.ts.map

package/dist/devtools/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/devtools/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,cAAc,wBAAwB,CAAA;AACtC,cAAc,8BAA8B,CAAA;AAC5C,OAAO,KAAK,eAAe,MAAM,gCAAgC,CAAA;AACjE,eAAO,MAAM,iBAAiB;;;;EAI5B,CAAA;AAEF,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;IAexB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC,IAAI,CAAA;AAEnD,eAAO,MAAM,eAAe,yHAA6D,CAAA;AACzF,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA"}

package/dist/devtools/index.js

@@ -1,23 +0,0 @@
-import { Schema } from '@livestore/utils/effect';
-export * from './devtools-messages.js';
-export * from './devtools-window-message.js';
-export * as SessionsChannel from './devtools-sessions-channel.js';
-export const ClientSessionInfo = Schema.Struct({
-    storeId: Schema.String,
-    clientId: Schema.String,
-    sessionId: Schema.String,
-});
-export const DevtoolsMode = Schema.Union(Schema.TaggedStruct('expo', {
-    clientSessionInfo: Schema.UndefinedOr(ClientSessionInfo),
-}), 
-// TODO add storeId, clientId and sessionId for Node
-Schema.TaggedStruct('node', {
-    clientSessionInfo: Schema.UndefinedOr(ClientSessionInfo),
-    url: Schema.String,
-}), Schema.TaggedStruct('web', {
-    clientSessionInfo: Schema.UndefinedOr(ClientSessionInfo),
-}), Schema.TaggedStruct('browser-extension', {
-    clientSessionInfo: Schema.UndefinedOr(ClientSessionInfo),
-}));
-export const DevtoolsModeTag = DevtoolsMode.pipe(Schema.pluck('_tag'), Schema.typeSchema);
-//# sourceMappingURL=index.js.map

package/dist/devtools/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/devtools/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAEhD,cAAc,wBAAwB,CAAA;AACtC,cAAc,8BAA8B,CAAA;AAC5C,OAAO,KAAK,eAAe,MAAM,gCAAgC,CAAA;AACjE,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7C,OAAO,EAAE,MAAM,CAAC,MAAM;IACtB,QAAQ,EAAE,MAAM,CAAC,MAAM;IACvB,SAAS,EAAE,MAAM,CAAC,MAAM;CACzB,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CACtC,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE;IAC1B,iBAAiB,EAAE,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC;CACzD,CAAC;AACF,oDAAoD;AACpD,MAAM,CAAC,YAAY,CAAC,MAAM,EAAE;IAC1B,iBAAiB,EAAE,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC;IACxD,GAAG,EAAE,MAAM,CAAC,MAAM;CACnB,CAAC,EACF,MAAM,CAAC,YAAY,CAAC,KAAK,EAAE;IACzB,iBAAiB,EAAE,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC;CACzD,CAAC,EACF,MAAM,CAAC,YAAY,CAAC,mBAAmB,EAAE;IACvC,iBAAiB,EAAE,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC;CACzD,CAAC,CACH,CAAA;AAID,MAAM,CAAC,MAAM,eAAe,GAAG,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAA"}