@syncframe/redis 0.2.0 → 0.3.0

package/README.md

@@ -2,6 +2,8 @@
 
 Redis-backed [`SyncStore`](https://www.npmjs.com/package/@syncframe/core) and `SyncTransport` adapters for [`@syncframe/core`](https://www.npmjs.com/package/@syncframe/core), so a `SyncServer` can persist anchors and fan out snapshots across processes and serverless instances.
 
+Docs and demos: [syncframe.jkvc.ai](https://syncframe.jkvc.ai/)
+
 The adapters are **connection-injected** — you pass in your own [`ioredis`](https://www.npmjs.com/package/ioredis) clients, so connection, auth, and pooling stay in your app. The dependency on core is type-only, so this package adds no runtime coupling.
 
 ## Install

package/dist/index.d.ts

@@ -23,7 +23,7 @@ interface RedisStoreOptions {
 }
 /**
  * Anchors, meta, and content data are stored as JSON under namespaced keys.
- * The set of channel ids per room is tracked in a Redis set so `listAnchors`
+ * The set of channel ids per namespace is tracked in a Redis set so `listAnchors`
  * (and therefore snapshot building) works without key scanning.
  */
 declare class RedisStore implements SyncStore {
@@ -35,14 +35,14 @@ declare class RedisStore implements SyncStore {
     private channelsKey;
     private metaKey;
     private contentKey;
-    getAnchor(roomId: string, channelId: string): Promise<AnyAnchor | null>;
-    setAnchor(roomId: string, channelId: string, anchor: AnyAnchor): Promise<void>;
-    deleteAnchor(roomId: string, channelId: string): Promise<void>;
-    listAnchors(roomId: string): Promise<Record<string, AnyAnchor | null>>;
-    getMeta(roomId: string): Promise<Record<string, unknown>>;
-    setMeta(roomId: string, meta: Record<string, unknown>): Promise<void>;
-    getContentData(roomId: string): Promise<Record<string, unknown> | null>;
-    setContentData(roomId: string, data: Record<string, unknown>): Promise<void>;
+    getAnchor(namespace: string, channelId: string): Promise<AnyAnchor | null>;
+    setAnchor(namespace: string, channelId: string, anchor: AnyAnchor): Promise<void>;
+    deleteAnchor(namespace: string, channelId: string): Promise<void>;
+    listAnchors(namespace: string): Promise<Record<string, AnyAnchor | null>>;
+    getMeta(namespace: string): Promise<Record<string, unknown>>;
+    setMeta(namespace: string, meta: Record<string, unknown>): Promise<void>;
+    getContentData(namespace: string): Promise<Record<string, unknown> | null>;
+    setContentData(namespace: string, data: Record<string, unknown>): Promise<void>;
 }
 interface RedisTransportOptions {
     /** Client used to PUBLISH snapshots. */
@@ -61,8 +61,8 @@ declare class RedisTransport implements SyncTransport {
     private readonly prefix;
     constructor(options: RedisTransportOptions);
     private channel;
-    publish(roomId: string, snapshot: CoreSnapshot): Promise<void>;
-    subscribe(roomId: string, handler: (snapshot: CoreSnapshot) => void): Promise<() => void>;
+    publish(namespace: string, snapshot: CoreSnapshot): Promise<void>;
+    subscribe(namespace: string, handler: (snapshot: CoreSnapshot) => void): Promise<() => void>;
 }
 
 export { RedisStore, type RedisStoreOptions, RedisTransport, type RedisTransportOptions };

package/dist/index.js

@@ -11,57 +11,57 @@ var RedisStore = class {
     this.redis = options.redis;
     this.prefix = options.prefix ?? DEFAULT_PREFIX;
   }
-  ns(roomId) {
-    return `${this.prefix}:${roomId}`;
+  ns(namespace) {
+    return `${this.prefix}:${namespace}`;
   }
-  anchorKey(roomId, channelId) {
-    return `${this.ns(roomId)}:anchor:${channelId}`;
+  anchorKey(namespace, channelId) {
+    return `${this.ns(namespace)}:anchor:${channelId}`;
   }
-  channelsKey(roomId) {
-    return `${this.ns(roomId)}:channels`;
+  channelsKey(namespace) {
+    return `${this.ns(namespace)}:channels`;
   }
-  metaKey(roomId) {
-    return `${this.ns(roomId)}:meta`;
+  metaKey(namespace) {
+    return `${this.ns(namespace)}:meta`;
   }
-  contentKey(roomId) {
-    return `${this.ns(roomId)}:content`;
+  contentKey(namespace) {
+    return `${this.ns(namespace)}:content`;
   }
-  async getAnchor(roomId, channelId) {
-    return readJson(this.redis, this.anchorKey(roomId, channelId));
+  async getAnchor(namespace, channelId) {
+    return readJson(this.redis, this.anchorKey(namespace, channelId));
   }
-  async setAnchor(roomId, channelId, anchor) {
+  async setAnchor(namespace, channelId, anchor) {
     await Promise.all([
-      this.redis.set(this.anchorKey(roomId, channelId), JSON.stringify(anchor)),
-      this.redis.sadd(this.channelsKey(roomId), channelId)
+      this.redis.set(this.anchorKey(namespace, channelId), JSON.stringify(anchor)),
+      this.redis.sadd(this.channelsKey(namespace), channelId)
     ]);
   }
-  async deleteAnchor(roomId, channelId) {
+  async deleteAnchor(namespace, channelId) {
     await Promise.all([
-      this.redis.del(this.anchorKey(roomId, channelId)),
-      this.redis.srem(this.channelsKey(roomId), channelId)
+      this.redis.del(this.anchorKey(namespace, channelId)),
+      this.redis.srem(this.channelsKey(namespace), channelId)
     ]);
   }
-  async listAnchors(roomId) {
-    const channels = await this.redis.smembers(this.channelsKey(roomId));
+  async listAnchors(namespace) {
+    const channels = await this.redis.smembers(this.channelsKey(namespace));
     const entries = await Promise.all(
       channels.map(async (channelId) => [
         channelId,
-        await this.getAnchor(roomId, channelId)
+        await this.getAnchor(namespace, channelId)
       ])
     );
     return Object.fromEntries(entries);
   }
-  async getMeta(roomId) {
-    return await readJson(this.redis, this.metaKey(roomId)) ?? {};
+  async getMeta(namespace) {
+    return await readJson(this.redis, this.metaKey(namespace)) ?? {};
   }
-  async setMeta(roomId, meta) {
-    await this.redis.set(this.metaKey(roomId), JSON.stringify(meta));
+  async setMeta(namespace, meta) {
+    await this.redis.set(this.metaKey(namespace), JSON.stringify(meta));
   }
-  async getContentData(roomId) {
-    return readJson(this.redis, this.contentKey(roomId));
+  async getContentData(namespace) {
+    return readJson(this.redis, this.contentKey(namespace));
   }
-  async setContentData(roomId, data) {
-    await this.redis.set(this.contentKey(roomId), JSON.stringify(data));
+  async setContentData(namespace, data) {
+    await this.redis.set(this.contentKey(namespace), JSON.stringify(data));
   }
 };
 var RedisTransport = class {
@@ -73,15 +73,15 @@ var RedisTransport = class {
     this.createSubscriber = options.createSubscriber;
     this.prefix = options.prefix ?? DEFAULT_PREFIX;
   }
-  channel(roomId) {
-    return `${this.prefix}:${roomId}:updates`;
+  channel(namespace) {
+    return `${this.prefix}:${namespace}:updates`;
   }
-  async publish(roomId, snapshot) {
-    await this.redis.publish(this.channel(roomId), JSON.stringify(snapshot));
+  async publish(namespace, snapshot) {
+    await this.redis.publish(this.channel(namespace), JSON.stringify(snapshot));
   }
-  async subscribe(roomId, handler) {
+  async subscribe(namespace, handler) {
     const subscriber = this.createSubscriber();
-    const channel = this.channel(roomId);
+    const channel = this.channel(namespace);
     subscriber.on("message", (incoming, message) => {
       if (incoming === channel) handler(JSON.parse(message));
     });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAyBA,IAAM,cAAA,GAAiB,WAAA;AAEvB,eAAe,QAAA,CAAY,OAAc,GAAA,EAAgC;AACvE,EAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,GAAA,CAAI,GAAG,CAAA;AAC/B,EAAA,OAAO,GAAA,GAAO,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA,GAAU,IAAA;AACxC;AAcO,IAAM,aAAN,MAAsC;AAAA,EAC1B,KAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,OAAA,EAA4B;AACtC,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,MAAA,GAAS,QAAQ,MAAA,IAAU,cAAA;AAAA,EAClC;AAAA,EAEQ,GAAG,MAAA,EAAwB;AACjC,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,MAAM,CAAA,CAAA;AAAA,EACjC;AAAA,EACQ,SAAA,CAAU,QAAgB,SAAA,EAA2B;AAC3D,IAAA,OAAO,GAAG,IAAA,CAAK,EAAA,CAAG,MAAM,CAAC,WAAW,SAAS,CAAA,CAAA;AAAA,EAC/C;AAAA,EACQ,YAAY,MAAA,EAAwB;AAC1C,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,EAAA,CAAG,MAAM,CAAC,CAAA,SAAA,CAAA;AAAA,EAC3B;AAAA,EACQ,QAAQ,MAAA,EAAwB;AACtC,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,EAAA,CAAG,MAAM,CAAC,CAAA,KAAA,CAAA;AAAA,EAC3B;AAAA,EACQ,WAAW,MAAA,EAAwB;AACzC,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,EAAA,CAAG,MAAM,CAAC,CAAA,QAAA,CAAA;AAAA,EAC3B;AAAA,EAEA,MAAM,SAAA,CAAU,MAAA,EAAgB,SAAA,EAA8C;AAC5E,IAAA,OAAO,SAAoB,IAAA,CAAK,KAAA,EAAO,KAAK,SAAA,CAAU,MAAA,EAAQ,SAAS,CAAC,CAAA;AAAA,EAC1E;AAAA,EAEA,MAAM,SAAA,CAAU,MAAA,EAAgB,SAAA,EAAmB,MAAA,EAAkC;AACnF,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MAChB,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,IAAA,CAAK,SAAA,CAAU,MAAA,EAAQ,SAAS,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,MAAM,CAAC,CAAA;AAAA,MACxE,KAAK,KAAA,CAAM,IAAA,CAAK,KAAK,WAAA,CAAY,MAAM,GAAG,SAAS;AAAA,KACpD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,YAAA,CAAa,MAAA,EAAgB,SAAA,EAAkC;AACnE,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MAChB,KAAK,KAAA,CAAM,GAAA,CAAI,KAAK,SAAA,CAAU,MAAA,EAAQ,SAAS,CAAC,CAAA;AAAA,MAChD,KAAK,KAAA,CAAM,IAAA,CAAK,KAAK,WAAA,CAAY,MAAM,GAAG,SAAS;AAAA,KACpD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,YAAY,MAAA,EAA2D;AAC3E,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,KAAA,CAAM,SAAS,IAAA,CAAK,WAAA,CAAY,MAAM,CAAC,CAAA;AACnE,IAAA,MAAM,OAAA,GAAU,MAAM,OAAA,CAAQ,GAAA;AAAA,MAC5B,QAAA,CAAS,GAAA,CAAI,OAAO,SAAA,KAAmD;AAAA,QACrE,SAAA;AAAA,QACA,MAAM,IAAA,CAAK,SAAA,CAAU,MAAA,EAAQ,SAAS;AAAA,OACvC;AAAA,KACH;AACA,IAAA,OAAO,MAAA,CAAO,YAAY,OAAO,CAAA;AAAA,EACnC;AAAA,EAEA,MAAM,QAAQ,MAAA,EAAkD;AAC9D,IAAA,OAAQ,MAAM,SAAkC,IAAA,CAAK,KAAA,EAAO,KAAK,OAAA,CAAQ,MAAM,CAAC,CAAA,IAAM,EAAC;AAAA,EACzF;AAAA,EAEA,MAAM,OAAA,CAAQ,MAAA,EAAgB,IAAA,EAA8C;AAC1E,IAAA,MAAM,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,IAAI,CAAC,CAAA;AAAA,EACjE;AAAA,EAEA,MAAM,eAAe,MAAA,EAAyD;AAC5E,IAAA,OAAO,SAAkC,IAAA,CAAK,KAAA,EAAO,IAAA,CAAK,UAAA,CAAW,MAAM,CAAC,CAAA;AAAA,EAC9E;AAAA,EAEA,MAAM,cAAA,CAAe,MAAA,EAAgB,IAAA,EAA8C;AACjF,IAAA,MAAM,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,IAAA,CAAK,UAAA,CAAW,MAAM,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,IAAI,CAAC,CAAA;AAAA,EACpE;AACF;AAcO,IAAM,iBAAN,MAA8C;AAAA,EAClC,KAAA;AAAA,EACA,gBAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,OAAA,EAAgC;AAC1C,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,mBAAmB,OAAA,CAAQ,gBAAA;AAChC,IAAA,IAAA,CAAK,MAAA,GAAS,QAAQ,MAAA,IAAU,cAAA;AAAA,EAClC;AAAA,EAEQ,QAAQ,MAAA,EAAwB;AACtC,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,MAAM,CAAA,QAAA,CAAA;AAAA,EACjC;AAAA,EAEA,MAAM,OAAA,CAAQ,MAAA,EAAgB,QAAA,EAAuC;AACnE,IAAA,MAAM,IAAA,CAAK,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,QAAQ,CAAC,CAAA;AAAA,EACzE;AAAA,EAEA,MAAM,SAAA,CACJ,MAAA,EACA,OAAA,EACqB;AACrB,IAAA,MAAM,UAAA,GAAa,KAAK,gBAAA,EAAiB;AACzC,IAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,MAAM,CAAA;AAEnC,IAAA,UAAA,CAAW,EAAA,CAAG,SAAA,EAAW,CAAC,QAAA,EAAkB,OAAA,KAAoB;AAC9D,MAAA,IAAI,aAAa,OAAA,EAAS,OAAA,CAAQ,IAAA,CAAK,KAAA,CAAM,OAAO,CAAiB,CAAA;AAAA,IACvE,CAAC,CAAA;AACD,IAAA,MAAM,UAAA,CAAW,UAAU,OAAO,CAAA;AAElC,IAAA,OAAO,MAAM;AACX,MAAA,KAAK,WAAW,IAAA,EAAK;AAAA,IACvB,CAAA;AAAA,EACF;AACF","file":"index.js","sourcesContent":["/**\n * @syncframe/redis — Redis-backed adapters for @syncframe/core.\n *\n * Implements core's `SyncStore` and `SyncTransport` interfaces on top of Redis,\n * so a `SyncServer` can persist anchors and fan out snapshots across processes\n * and serverless instances.\n *\n * Core stays zero-dependency: these adapters only *implement* its interfaces.\n * Every `@syncframe/core` and `ioredis` import here is type-only and erased at\n * compile time — the package has no runtime dependency on core, and the Redis\n * client is injected by the caller (so connection, auth, and pooling concerns\n * live in the application, not here).\n */\n\nimport type Redis from 'ioredis';\n// Type-only imports from core's server entry. That entry is React-free, so it\n// never pulls hooks (which reference DOM globals) into this non-DOM package's\n// type-check.\nimport type {\n  SyncStore,\n  SyncTransport,\n  AnyAnchor,\n  CoreSnapshot,\n} from '@syncframe/core/server';\n\nconst DEFAULT_PREFIX = 'syncframe';\n\nasync function readJson<T>(redis: Redis, key: string): Promise<T | null> {\n  const raw = await redis.get(key);\n  return raw ? (JSON.parse(raw) as T) : null;\n}\n\nexport interface RedisStoreOptions {\n  /** Client used for all commands. */\n  redis: Redis;\n  /** Key namespace prefix. Default `\"syncframe\"`. */\n  prefix?: string;\n}\n\n/**\n * Anchors, meta, and content data are stored as JSON under namespaced keys.\n * The set of channel ids per room is tracked in a Redis set so `listAnchors`\n * (and therefore snapshot building) works without key scanning.\n */\nexport class RedisStore implements SyncStore {\n  private readonly redis: Redis;\n  private readonly prefix: string;\n\n  constructor(options: RedisStoreOptions) {\n    this.redis = options.redis;\n    this.prefix = options.prefix ?? DEFAULT_PREFIX;\n  }\n\n  private ns(roomId: string): string {\n    return `${this.prefix}:${roomId}`;\n  }\n  private anchorKey(roomId: string, channelId: string): string {\n    return `${this.ns(roomId)}:anchor:${channelId}`;\n  }\n  private channelsKey(roomId: string): string {\n    return `${this.ns(roomId)}:channels`;\n  }\n  private metaKey(roomId: string): string {\n    return `${this.ns(roomId)}:meta`;\n  }\n  private contentKey(roomId: string): string {\n    return `${this.ns(roomId)}:content`;\n  }\n\n  async getAnchor(roomId: string, channelId: string): Promise<AnyAnchor | null> {\n    return readJson<AnyAnchor>(this.redis, this.anchorKey(roomId, channelId));\n  }\n\n  async setAnchor(roomId: string, channelId: string, anchor: AnyAnchor): Promise<void> {\n    await Promise.all([\n      this.redis.set(this.anchorKey(roomId, channelId), JSON.stringify(anchor)),\n      this.redis.sadd(this.channelsKey(roomId), channelId),\n    ]);\n  }\n\n  async deleteAnchor(roomId: string, channelId: string): Promise<void> {\n    await Promise.all([\n      this.redis.del(this.anchorKey(roomId, channelId)),\n      this.redis.srem(this.channelsKey(roomId), channelId),\n    ]);\n  }\n\n  async listAnchors(roomId: string): Promise<Record<string, AnyAnchor | null>> {\n    const channels = await this.redis.smembers(this.channelsKey(roomId));\n    const entries = await Promise.all(\n      channels.map(async (channelId): Promise<[string, AnyAnchor | null]> => [\n        channelId,\n        await this.getAnchor(roomId, channelId),\n      ]),\n    );\n    return Object.fromEntries(entries);\n  }\n\n  async getMeta(roomId: string): Promise<Record<string, unknown>> {\n    return (await readJson<Record<string, unknown>>(this.redis, this.metaKey(roomId))) ?? {};\n  }\n\n  async setMeta(roomId: string, meta: Record<string, unknown>): Promise<void> {\n    await this.redis.set(this.metaKey(roomId), JSON.stringify(meta));\n  }\n\n  async getContentData(roomId: string): Promise<Record<string, unknown> | null> {\n    return readJson<Record<string, unknown>>(this.redis, this.contentKey(roomId));\n  }\n\n  async setContentData(roomId: string, data: Record<string, unknown>): Promise<void> {\n    await this.redis.set(this.contentKey(roomId), JSON.stringify(data));\n  }\n}\n\nexport interface RedisTransportOptions {\n  /** Client used to PUBLISH snapshots. */\n  redis: Redis;\n  /**\n   * Factory for a fresh subscriber connection. A Redis connection in subscribe\n   * mode can't issue other commands, so each `subscribe()` gets its own.\n   */\n  createSubscriber: () => Redis;\n  /** Channel namespace prefix. Default `\"syncframe\"`. */\n  prefix?: string;\n}\n\nexport class RedisTransport implements SyncTransport {\n  private readonly redis: Redis;\n  private readonly createSubscriber: () => Redis;\n  private readonly prefix: string;\n\n  constructor(options: RedisTransportOptions) {\n    this.redis = options.redis;\n    this.createSubscriber = options.createSubscriber;\n    this.prefix = options.prefix ?? DEFAULT_PREFIX;\n  }\n\n  private channel(roomId: string): string {\n    return `${this.prefix}:${roomId}:updates`;\n  }\n\n  async publish(roomId: string, snapshot: CoreSnapshot): Promise<void> {\n    await this.redis.publish(this.channel(roomId), JSON.stringify(snapshot));\n  }\n\n  async subscribe(\n    roomId: string,\n    handler: (snapshot: CoreSnapshot) => void,\n  ): Promise<() => void> {\n    const subscriber = this.createSubscriber();\n    const channel = this.channel(roomId);\n\n    subscriber.on('message', (incoming: string, message: string) => {\n      if (incoming === channel) handler(JSON.parse(message) as CoreSnapshot);\n    });\n    await subscriber.subscribe(channel);\n\n    return () => {\n      void subscriber.quit();\n    };\n  }\n}\n"]}
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAyBA,IAAM,cAAA,GAAiB,WAAA;AAEvB,eAAe,QAAA,CAAY,OAAc,GAAA,EAAgC;AACvE,EAAA,MAAM,GAAA,GAAM,MAAM,KAAA,CAAM,GAAA,CAAI,GAAG,CAAA;AAC/B,EAAA,OAAO,GAAA,GAAO,IAAA,CAAK,KAAA,CAAM,GAAG,CAAA,GAAU,IAAA;AACxC;AAcO,IAAM,aAAN,MAAsC;AAAA,EAC1B,KAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,OAAA,EAA4B;AACtC,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,MAAA,GAAS,QAAQ,MAAA,IAAU,cAAA;AAAA,EAClC;AAAA,EAEQ,GAAG,SAAA,EAA2B;AACpC,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,SAAS,CAAA,CAAA;AAAA,EACpC;AAAA,EACQ,SAAA,CAAU,WAAmB,SAAA,EAA2B;AAC9D,IAAA,OAAO,GAAG,IAAA,CAAK,EAAA,CAAG,SAAS,CAAC,WAAW,SAAS,CAAA,CAAA;AAAA,EAClD;AAAA,EACQ,YAAY,SAAA,EAA2B;AAC7C,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,EAAA,CAAG,SAAS,CAAC,CAAA,SAAA,CAAA;AAAA,EAC9B;AAAA,EACQ,QAAQ,SAAA,EAA2B;AACzC,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,EAAA,CAAG,SAAS,CAAC,CAAA,KAAA,CAAA;AAAA,EAC9B;AAAA,EACQ,WAAW,SAAA,EAA2B;AAC5C,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,EAAA,CAAG,SAAS,CAAC,CAAA,QAAA,CAAA;AAAA,EAC9B;AAAA,EAEA,MAAM,SAAA,CAAU,SAAA,EAAmB,SAAA,EAA8C;AAC/E,IAAA,OAAO,SAAoB,IAAA,CAAK,KAAA,EAAO,KAAK,SAAA,CAAU,SAAA,EAAW,SAAS,CAAC,CAAA;AAAA,EAC7E;AAAA,EAEA,MAAM,SAAA,CAAU,SAAA,EAAmB,SAAA,EAAmB,MAAA,EAAkC;AACtF,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MAChB,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,IAAA,CAAK,SAAA,CAAU,SAAA,EAAW,SAAS,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,MAAM,CAAC,CAAA;AAAA,MAC3E,KAAK,KAAA,CAAM,IAAA,CAAK,KAAK,WAAA,CAAY,SAAS,GAAG,SAAS;AAAA,KACvD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,YAAA,CAAa,SAAA,EAAmB,SAAA,EAAkC;AACtE,IAAA,MAAM,QAAQ,GAAA,CAAI;AAAA,MAChB,KAAK,KAAA,CAAM,GAAA,CAAI,KAAK,SAAA,CAAU,SAAA,EAAW,SAAS,CAAC,CAAA;AAAA,MACnD,KAAK,KAAA,CAAM,IAAA,CAAK,KAAK,WAAA,CAAY,SAAS,GAAG,SAAS;AAAA,KACvD,CAAA;AAAA,EACH;AAAA,EAEA,MAAM,YAAY,SAAA,EAA8D;AAC9E,IAAA,MAAM,QAAA,GAAW,MAAM,IAAA,CAAK,KAAA,CAAM,SAAS,IAAA,CAAK,WAAA,CAAY,SAAS,CAAC,CAAA;AACtE,IAAA,MAAM,OAAA,GAAU,MAAM,OAAA,CAAQ,GAAA;AAAA,MAC5B,QAAA,CAAS,GAAA,CAAI,OAAO,SAAA,KAAmD;AAAA,QACrE,SAAA;AAAA,QACA,MAAM,IAAA,CAAK,SAAA,CAAU,SAAA,EAAW,SAAS;AAAA,OAC1C;AAAA,KACH;AACA,IAAA,OAAO,MAAA,CAAO,YAAY,OAAO,CAAA;AAAA,EACnC;AAAA,EAEA,MAAM,QAAQ,SAAA,EAAqD;AACjE,IAAA,OAAQ,MAAM,SAAkC,IAAA,CAAK,KAAA,EAAO,KAAK,OAAA,CAAQ,SAAS,CAAC,CAAA,IAAM,EAAC;AAAA,EAC5F;AAAA,EAEA,MAAM,OAAA,CAAQ,SAAA,EAAmB,IAAA,EAA8C;AAC7E,IAAA,MAAM,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,IAAA,CAAK,OAAA,CAAQ,SAAS,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,IAAI,CAAC,CAAA;AAAA,EACpE;AAAA,EAEA,MAAM,eAAe,SAAA,EAA4D;AAC/E,IAAA,OAAO,SAAkC,IAAA,CAAK,KAAA,EAAO,IAAA,CAAK,UAAA,CAAW,SAAS,CAAC,CAAA;AAAA,EACjF;AAAA,EAEA,MAAM,cAAA,CAAe,SAAA,EAAmB,IAAA,EAA8C;AACpF,IAAA,MAAM,IAAA,CAAK,KAAA,CAAM,GAAA,CAAI,IAAA,CAAK,UAAA,CAAW,SAAS,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,IAAI,CAAC,CAAA;AAAA,EACvE;AACF;AAcO,IAAM,iBAAN,MAA8C;AAAA,EAClC,KAAA;AAAA,EACA,gBAAA;AAAA,EACA,MAAA;AAAA,EAEjB,YAAY,OAAA,EAAgC;AAC1C,IAAA,IAAA,CAAK,QAAQ,OAAA,CAAQ,KAAA;AACrB,IAAA,IAAA,CAAK,mBAAmB,OAAA,CAAQ,gBAAA;AAChC,IAAA,IAAA,CAAK,MAAA,GAAS,QAAQ,MAAA,IAAU,cAAA;AAAA,EAClC;AAAA,EAEQ,QAAQ,SAAA,EAA2B;AACzC,IAAA,OAAO,CAAA,EAAG,IAAA,CAAK,MAAM,CAAA,CAAA,EAAI,SAAS,CAAA,QAAA,CAAA;AAAA,EACpC;AAAA,EAEA,MAAM,OAAA,CAAQ,SAAA,EAAmB,QAAA,EAAuC;AACtE,IAAA,MAAM,IAAA,CAAK,KAAA,CAAM,OAAA,CAAQ,IAAA,CAAK,OAAA,CAAQ,SAAS,CAAA,EAAG,IAAA,CAAK,SAAA,CAAU,QAAQ,CAAC,CAAA;AAAA,EAC5E;AAAA,EAEA,MAAM,SAAA,CACJ,SAAA,EACA,OAAA,EACqB;AACrB,IAAA,MAAM,UAAA,GAAa,KAAK,gBAAA,EAAiB;AACzC,IAAA,MAAM,OAAA,GAAU,IAAA,CAAK,OAAA,CAAQ,SAAS,CAAA;AAEtC,IAAA,UAAA,CAAW,EAAA,CAAG,SAAA,EAAW,CAAC,QAAA,EAAkB,OAAA,KAAoB;AAC9D,MAAA,IAAI,aAAa,OAAA,EAAS,OAAA,CAAQ,IAAA,CAAK,KAAA,CAAM,OAAO,CAAiB,CAAA;AAAA,IACvE,CAAC,CAAA;AACD,IAAA,MAAM,UAAA,CAAW,UAAU,OAAO,CAAA;AAElC,IAAA,OAAO,MAAM;AACX,MAAA,KAAK,WAAW,IAAA,EAAK;AAAA,IACvB,CAAA;AAAA,EACF;AACF","file":"index.js","sourcesContent":["/**\n * @syncframe/redis — Redis-backed adapters for @syncframe/core.\n *\n * Implements core's `SyncStore` and `SyncTransport` interfaces on top of Redis,\n * so a `SyncServer` can persist anchors and fan out snapshots across processes\n * and serverless instances.\n *\n * Core stays zero-dependency: these adapters only *implement* its interfaces.\n * Every `@syncframe/core` and `ioredis` import here is type-only and erased at\n * compile time — the package has no runtime dependency on core, and the Redis\n * client is injected by the caller (so connection, auth, and pooling concerns\n * live in the application, not here).\n */\n\nimport type Redis from 'ioredis';\n// Type-only imports from core's server entry. That entry is React-free, so it\n// never pulls hooks (which reference DOM globals) into this non-DOM package's\n// type-check.\nimport type {\n  SyncStore,\n  SyncTransport,\n  AnyAnchor,\n  CoreSnapshot,\n} from '@syncframe/core/server';\n\nconst DEFAULT_PREFIX = 'syncframe';\n\nasync function readJson<T>(redis: Redis, key: string): Promise<T | null> {\n  const raw = await redis.get(key);\n  return raw ? (JSON.parse(raw) as T) : null;\n}\n\nexport interface RedisStoreOptions {\n  /** Client used for all commands. */\n  redis: Redis;\n  /** Key namespace prefix. Default `\"syncframe\"`. */\n  prefix?: string;\n}\n\n/**\n * Anchors, meta, and content data are stored as JSON under namespaced keys.\n * The set of channel ids per namespace is tracked in a Redis set so `listAnchors`\n * (and therefore snapshot building) works without key scanning.\n */\nexport class RedisStore implements SyncStore {\n  private readonly redis: Redis;\n  private readonly prefix: string;\n\n  constructor(options: RedisStoreOptions) {\n    this.redis = options.redis;\n    this.prefix = options.prefix ?? DEFAULT_PREFIX;\n  }\n\n  private ns(namespace: string): string {\n    return `${this.prefix}:${namespace}`;\n  }\n  private anchorKey(namespace: string, channelId: string): string {\n    return `${this.ns(namespace)}:anchor:${channelId}`;\n  }\n  private channelsKey(namespace: string): string {\n    return `${this.ns(namespace)}:channels`;\n  }\n  private metaKey(namespace: string): string {\n    return `${this.ns(namespace)}:meta`;\n  }\n  private contentKey(namespace: string): string {\n    return `${this.ns(namespace)}:content`;\n  }\n\n  async getAnchor(namespace: string, channelId: string): Promise<AnyAnchor | null> {\n    return readJson<AnyAnchor>(this.redis, this.anchorKey(namespace, channelId));\n  }\n\n  async setAnchor(namespace: string, channelId: string, anchor: AnyAnchor): Promise<void> {\n    await Promise.all([\n      this.redis.set(this.anchorKey(namespace, channelId), JSON.stringify(anchor)),\n      this.redis.sadd(this.channelsKey(namespace), channelId),\n    ]);\n  }\n\n  async deleteAnchor(namespace: string, channelId: string): Promise<void> {\n    await Promise.all([\n      this.redis.del(this.anchorKey(namespace, channelId)),\n      this.redis.srem(this.channelsKey(namespace), channelId),\n    ]);\n  }\n\n  async listAnchors(namespace: string): Promise<Record<string, AnyAnchor | null>> {\n    const channels = await this.redis.smembers(this.channelsKey(namespace));\n    const entries = await Promise.all(\n      channels.map(async (channelId): Promise<[string, AnyAnchor | null]> => [\n        channelId,\n        await this.getAnchor(namespace, channelId),\n      ]),\n    );\n    return Object.fromEntries(entries);\n  }\n\n  async getMeta(namespace: string): Promise<Record<string, unknown>> {\n    return (await readJson<Record<string, unknown>>(this.redis, this.metaKey(namespace))) ?? {};\n  }\n\n  async setMeta(namespace: string, meta: Record<string, unknown>): Promise<void> {\n    await this.redis.set(this.metaKey(namespace), JSON.stringify(meta));\n  }\n\n  async getContentData(namespace: string): Promise<Record<string, unknown> | null> {\n    return readJson<Record<string, unknown>>(this.redis, this.contentKey(namespace));\n  }\n\n  async setContentData(namespace: string, data: Record<string, unknown>): Promise<void> {\n    await this.redis.set(this.contentKey(namespace), JSON.stringify(data));\n  }\n}\n\nexport interface RedisTransportOptions {\n  /** Client used to PUBLISH snapshots. */\n  redis: Redis;\n  /**\n   * Factory for a fresh subscriber connection. A Redis connection in subscribe\n   * mode can't issue other commands, so each `subscribe()` gets its own.\n   */\n  createSubscriber: () => Redis;\n  /** Channel namespace prefix. Default `\"syncframe\"`. */\n  prefix?: string;\n}\n\nexport class RedisTransport implements SyncTransport {\n  private readonly redis: Redis;\n  private readonly createSubscriber: () => Redis;\n  private readonly prefix: string;\n\n  constructor(options: RedisTransportOptions) {\n    this.redis = options.redis;\n    this.createSubscriber = options.createSubscriber;\n    this.prefix = options.prefix ?? DEFAULT_PREFIX;\n  }\n\n  private channel(namespace: string): string {\n    return `${this.prefix}:${namespace}:updates`;\n  }\n\n  async publish(namespace: string, snapshot: CoreSnapshot): Promise<void> {\n    await this.redis.publish(this.channel(namespace), JSON.stringify(snapshot));\n  }\n\n  async subscribe(\n    namespace: string,\n    handler: (snapshot: CoreSnapshot) => void,\n  ): Promise<() => void> {\n    const subscriber = this.createSubscriber();\n    const channel = this.channel(namespace);\n\n    subscriber.on('message', (incoming: string, message: string) => {\n      if (incoming === channel) handler(JSON.parse(message) as CoreSnapshot);\n    });\n    await subscriber.subscribe(channel);\n\n    return () => {\n      void subscriber.quit();\n    };\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@syncframe/redis",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Redis-backed SyncStore + SyncTransport adapters for @syncframe/core",
   "license": "MIT",
   "type": "module",
@@ -18,7 +18,7 @@
     "url": "git+https://github.com/jkvc/syncframe.git",
     "directory": "packages/redis"
   },
-  "homepage": "https://github.com/jkvc/syncframe/tree/main/packages/redis#readme",
+  "homepage": "https://syncframe.jkvc.ai/",
   "bugs": "https://github.com/jkvc/syncframe/issues",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -32,7 +32,7 @@
     "dist"
   ],
   "dependencies": {
-    "@syncframe/core": "^0.2.0"
+    "@syncframe/core": "^0.3.0"
   },
   "peerDependencies": {
     "ioredis": "^5"