@baeta/subscriptions-pubsub 1.0.8 → 2.0.0-next.0

package/dist/index.js

@@ -1,47 +1 @@
-// lib/typed-pubsub.ts
-var TypedPubSubBase = class {
-  constructor(pubsub, options) {
-    this.pubsub = pubsub;
-    this.options = options;
-    this.channelPrefix = options?.prefix ?? "";
-  }
-  channelPrefix;
-  publish = (channel, message, ...rest) => {
-    return this.pubsub.publish(this.mapChannel(channel), message, ...rest);
-  };
-  subscribe = (channel, onMessage, ...rest) => {
-    return this.pubsub.subscribe(this.mapChannel(channel), onMessage, ...rest);
-  };
-  unsubscribe = (subId, ...rest) => {
-    return this.pubsub.unsubscribe(subId, ...rest);
-  };
-  mapChannel = (channel) => {
-    return `${this.channelPrefix}${channel.toString()}`;
-  };
-  mapTriggers = (triggers) => {
-    return Array.isArray(triggers) ? triggers.map(this.mapChannel) : this.mapChannel(triggers);
-  };
-};
-var TypedPubSubV2 = class extends TypedPubSubBase {
-  asyncIterator = (triggers, ...rest) => {
-    return this.pubsub.asyncIterator(this.mapTriggers(triggers), ...rest);
-  };
-};
-var TypedPubSubV3 = class extends TypedPubSubBase {
-  asyncIterableIterator = (triggers, ...rest) => {
-    return this.pubsub.asyncIterableIterator(this.mapTriggers(triggers), ...rest);
-  };
-};
-function createTypedPubSub(pubsub, options) {
-  if ("asyncIterator" in pubsub) {
-    return new TypedPubSubV2(pubsub, options);
-  }
-  if ("asyncIterableIterator" in pubsub) {
-    return new TypedPubSubV3(pubsub, options);
-  }
-  throw new Error("Unsupported PubSub");
-}
-export {
-  createTypedPubSub
-};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../lib/typed-pubsub.ts"],"sourcesContent":["import type { PubSubEngineV2, PubSubEngineV3 } from './pubsub-engine.ts';\n\n/**\n * Configuration options for TypedPubSub\n */\nexport interface TypedPubSubOptions {\n\t/** Optional prefix for channel names */\n\tprefix?: string;\n}\n\n// biome-ignore lint/suspicious/noExplicitAny: we need to use `any` in this file to support dynamic typing\ntype Any = any;\n\ntype PubSubMap = Record<string, Any>;\ntype OnMessage<Payload> = (message: Payload) => Promise<void> | void;\n\ntype RestPayloadFnArgs<Fn> = Fn extends (\n\ttriggerName: string,\n\tpayload: Any,\n\t...rest: infer Rest\n) => Any\n\t? Rest\n\t: never;\n\ntype RestSubscribeFnArgs<Fn> = Fn extends (\n\ttriggerName: string,\n\tonMessage: OnMessage<Any>,\n\t...rest: infer Rest\n) => Any\n\t? Rest\n\t: never;\n\ntype RestUnsubscribeFnArgs<Fn> = Fn extends (subId: number, ...rest: infer Rest) => Any\n\t? Rest\n\t: never;\n\ntype RestAsyncIteratorFnArgs<Fn> = Fn extends (\n\ttriggers: string | string[],\n\t...rest: infer Rest\n) => Any\n\t? Rest\n\t: never;\n\ntype RestAsyncIterableIteratorFnArgs<Fn> = Fn extends (\n\ttriggers: string | readonly string[],\n\t...rest: infer Rest\n) => Any\n\t? Rest\n\t: never;\n\nclass TypedPubSubBase<Engine extends PubSubEngineV2 | PubSubEngineV3, Map extends PubSubMap> {\n\tprotected channelPrefix: string;\n\n\tconstructor(\n\t\tprotected pubsub: Engine,\n\t\tprotected options?: TypedPubSubOptions,\n\t) {\n\t\tthis.channelPrefix = options?.prefix ?? '';\n\t}\n\n\tpublish = <C extends keyof Map>(\n\t\tchannel: C,\n\t\tmessage: Map[C],\n\t\t...rest: RestPayloadFnArgs<Engine['publish']>\n\t) => {\n\t\treturn this.pubsub.publish(this.mapChannel(channel), message, ...rest);\n\t};\n\n\tsubscribe = <C extends keyof Map>(\n\t\tchannel: C,\n\t\tonMessage: OnMessage<Map[C]>,\n\t\t...rest: RestSubscribeFnArgs<Engine['subscribe']>\n\t) => {\n\t\treturn this.pubsub.subscribe(this.mapChannel(channel), onMessage, ...rest);\n\t};\n\n\tunsubscribe = (subId: number, ...rest: RestUnsubscribeFnArgs<Engine['unsubscribe']>) => {\n\t\treturn this.pubsub.unsubscribe(subId, ...rest);\n\t};\n\n\tprotected mapChannel = <C extends keyof Map>(channel: C): string => {\n\t\treturn `${this.channelPrefix}${channel.toString()}`;\n\t};\n\n\tprotected mapTriggers = <C extends keyof Map>(triggers: C | C[]): string | string[] => {\n\t\treturn Array.isArray(triggers) ? triggers.map(this.mapChannel) : this.mapChannel(triggers);\n\t};\n}\n\nclass TypedPubSubV2<Engine extends PubSubEngineV2, Map extends PubSubMap> extends TypedPubSubBase<\n\tEngine,\n\tMap\n> {\n\tasyncIterator = <C extends keyof Map>(\n\t\ttriggers: C | C[],\n\t\t...rest: RestAsyncIteratorFnArgs<Engine['asyncIterator']>\n\t) => {\n\t\treturn this.pubsub.asyncIterator<Map[C]>(this.mapTriggers(triggers), ...rest);\n\t};\n}\n\n/** @hidden */\nclass TypedPubSubV3<Engine extends PubSubEngineV3, Map extends PubSubMap> extends TypedPubSubBase<\n\tEngine,\n\tMap\n> {\n\tasyncIterableIterator = <C extends keyof Map>(\n\t\ttriggers: C | C[],\n\t\t...rest: RestAsyncIterableIteratorFnArgs<Engine['asyncIterableIterator']>\n\t) => {\n\t\treturn this.pubsub.asyncIterableIterator<Map[C]>(this.mapTriggers(triggers), ...rest);\n\t};\n}\n\nexport type TypedPubSub<\n\tEngine extends PubSubEngineV2 | PubSubEngineV3,\n\t// biome-ignore lint/suspicious/noExplicitAny: accept any for dynamic typing\n\tMap extends Record<string, any>,\n> = Engine extends PubSubEngineV3\n\t? TypedPubSubV3<Engine, Map>\n\t: Engine extends PubSubEngineV2\n\t\t? TypedPubSubV2<Engine, Map>\n\t\t: never;\n\n/**\n * Creates a type-safe wrapper around a PubSub implementation.\n *\n * This utility ensures that your subscription channels and their payloads\n * are properly typed, helping catch potential errors at compile time.\n *\n * @param pubsub - The PubSub engine instance (e.g., PubSub, RedisPubSub)\n * @param options - Configuration options\n *\n * @example\n * ```typescript\n * // Define your event map\n * type PubSubMap = {\n *   \"user-updated\": User;\n *   [c: `user-updated-${string}`]: User;\n * };\n *\n * // Create typed PubSub instance\n * const pubsub = createTypedPubSub<PubSub, PubSubMap>(new PubSub());\n *\n * // Usage with Redis\n * const pubsub = createTypedPubSub<RedisPubSub, PubSubMap>(\n *   new RedisPubSub({\n *     publisher: new Redis(options),\n *     subscriber: new Redis(options),\n *   }),\n *   {\n *     prefix: \"feature-1:\",\n *   }\n * );\n * ```\n */\nexport function createTypedPubSub<\n\tEngine extends PubSubEngineV2 | PubSubEngineV3,\n\t// biome-ignore lint/suspicious/noExplicitAny: accept any for dynamic typing\n\tMap extends Record<string, any>,\n>(pubsub: Engine, options?: TypedPubSubOptions): TypedPubSub<Engine, Map> {\n\tif ('asyncIterator' in pubsub) {\n\t\treturn new TypedPubSubV2<PubSubEngineV2, Map>(pubsub, options) as TypedPubSub<Engine, Map>;\n\t}\n\n\tif ('asyncIterableIterator' in pubsub) {\n\t\treturn new TypedPubSubV3<PubSubEngineV3, PubSubMap>(pubsub, options) as TypedPubSub<\n\t\t\tEngine,\n\t\t\tMap\n\t\t>;\n\t}\n\n\tthrow new Error('Unsupported PubSub');\n}\n"],"mappings":";AAkDA,IAAM,kBAAN,MAA6F;AAAA,EAG5F,YACW,QACA,SACT;AAFS;AACA;AAEV,SAAK,gBAAgB,SAAS,UAAU;AAAA,EACzC;AAAA,EAPU;AAAA,EASV,UAAU,CACT,SACA,YACG,SACC;AACJ,WAAO,KAAK,OAAO,QAAQ,KAAK,WAAW,OAAO,GAAG,SAAS,GAAG,IAAI;AAAA,EACtE;AAAA,EAEA,YAAY,CACX,SACA,cACG,SACC;AACJ,WAAO,KAAK,OAAO,UAAU,KAAK,WAAW,OAAO,GAAG,WAAW,GAAG,IAAI;AAAA,EAC1E;AAAA,EAEA,cAAc,CAAC,UAAkB,SAAuD;AACvF,WAAO,KAAK,OAAO,YAAY,OAAO,GAAG,IAAI;AAAA,EAC9C;AAAA,EAEU,aAAa,CAAsB,YAAuB;AACnE,WAAO,GAAG,KAAK,aAAa,GAAG,QAAQ,SAAS,CAAC;AAAA,EAClD;AAAA,EAEU,cAAc,CAAsB,aAAyC;AACtF,WAAO,MAAM,QAAQ,QAAQ,IAAI,SAAS,IAAI,KAAK,UAAU,IAAI,KAAK,WAAW,QAAQ;AAAA,EAC1F;AACD;AAEA,IAAM,gBAAN,cAAkF,gBAGhF;AAAA,EACD,gBAAgB,CACf,aACG,SACC;AACJ,WAAO,KAAK,OAAO,cAAsB,KAAK,YAAY,QAAQ,GAAG,GAAG,IAAI;AAAA,EAC7E;AACD;AAGA,IAAM,gBAAN,cAAkF,gBAGhF;AAAA,EACD,wBAAwB,CACvB,aACG,SACC;AACJ,WAAO,KAAK,OAAO,sBAA8B,KAAK,YAAY,QAAQ,GAAG,GAAG,IAAI;AAAA,EACrF;AACD;AA4CO,SAAS,kBAId,QAAgB,SAAwD;AACzE,MAAI,mBAAmB,QAAQ;AAC9B,WAAO,IAAI,cAAmC,QAAQ,OAAO;AAAA,EAC9D;AAEA,MAAI,2BAA2B,QAAQ;AACtC,WAAO,IAAI,cAAyC,QAAQ,OAAO;AAAA,EAIpE;AAEA,QAAM,IAAI,MAAM,oBAAoB;AACrC;","names":[]}
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baeta/subscriptions-pubsub",
-  "version": "1.0.8",
+  "version": "2.0.0-next.0",
   "keywords": [
     "baeta",
     "graphql",
@@ -27,8 +27,8 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "default": "./dist/index.js"
+      "types": "./index.ts",
+      "default": "./index.ts"
     }
   },
   "types": "dist/index.d.ts",
@@ -44,16 +44,15 @@
     "types": "tsc --noEmit"
   },
   "devDependencies": {
-    "@baeta/builder": "^0.0.0",
-    "@baeta/tsconfig": "^0.0.0",
-    "ava": "^6.2.0",
-    "graphql": "^16.9.0",
-    "graphql-subscriptions-v2": "npm:graphql-subscriptions@^2.0.0",
-    "graphql-subscriptions-v3": "npm:graphql-subscriptions@^3.0.0",
-    "typescript": "^5.7.2"
+    "@baeta/builder": "workspace:^",
+    "@baeta/testing": "workspace:^",
+    "@baeta/tsconfig": "workspace:^",
+    "graphql": "^16.11.0",
+    "graphql-subscriptions": "^3.0.0",
+    "typescript": "^5.9.3"
   },
   "engines": {
-    "node": ">=22.12.0"
+    "node": ">=22.20.0"
   },
   "publishConfig": {
     "access": "public",
@@ -90,4 +89,4 @@
       "alphabetical-ignoring-documents"
     ]
   }
-}
+}

package/CHANGELOG.md

@@ -1,23 +0,0 @@
-# @baeta/subscriptions-pubsub
-
-## 1.0.8
-
-### Patch Changes
-
-- [#189](https://github.com/andreisergiu98/baeta/pull/189) [`d500378`](https://github.com/andreisergiu98/baeta/commit/d500378198e0a9c48298c4242913bca8ad348228) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - add jsdocs
-
-- [#165](https://github.com/andreisergiu98/baeta/pull/165) [`1334c2a`](https://github.com/andreisergiu98/baeta/commit/1334c2a866676c88f0f3d380b22133d81c4e98bc) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - mark as stable
-
-## 0.0.2
-
-### Patch Changes
-
-- [`b59db50`](https://github.com/andreisergiu98/baeta/commit/b59db501a83275ab2d964933080e688a3a5d8820) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - add readme
-
-## 0.0.1
-
-### Patch Changes
-
-- [#180](https://github.com/andreisergiu98/baeta/pull/180) [`483c709`](https://github.com/andreisergiu98/baeta/commit/483c70932f815fd114732c00b74f9488d7924c72) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Raise minimum required NodeJS version to 22.12.0. Drop CommonJS builds in favor of the require_esm feature from NodeJS 22.12.0 onwards.
-
-- [`de6e89c`](https://github.com/andreisergiu98/baeta/commit/de6e89c1b592e280967c73a4137d24ee56ef1857) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - raise es target to 2024

package/dist/index.d.ts

@@ -1,82 +0,0 @@
-interface PubSubEngineV2 {
-    publish: (triggerName: string, payload: any, ...rest: any[]) => Promise<void>;
-    subscribe: (triggerName: string, onMessage: (message: any) => Promise<void> | void, ...rest: any[]) => Promise<number>;
-    unsubscribe: (subId: number, ...rest: any[]) => void;
-    asyncIterator: <T>(triggers: string | string[], ...rest: any[]) => AsyncIterator<T>;
-}
-interface PubSubEngineV3 {
-    publish: (triggerName: string, payload: any, ...rest: any[]) => Promise<void>;
-    subscribe: (triggerName: string, onMessage: (message: any) => Promise<void> | void, ...rest: any[]) => Promise<number>;
-    unsubscribe: (subId: number, ...rest: any[]) => void;
-    asyncIterableIterator: <T>(triggers: string | readonly string[], ...rest: any[]) => AsyncIterableIterator<T>;
-}
-
-/**
- * Configuration options for TypedPubSub
- */
-interface TypedPubSubOptions {
-    /** Optional prefix for channel names */
-    prefix?: string;
-}
-type Any = any;
-type PubSubMap = Record<string, Any>;
-type OnMessage<Payload> = (message: Payload) => Promise<void> | void;
-type RestPayloadFnArgs<Fn> = Fn extends (triggerName: string, payload: Any, ...rest: infer Rest) => Any ? Rest : never;
-type RestSubscribeFnArgs<Fn> = Fn extends (triggerName: string, onMessage: OnMessage<Any>, ...rest: infer Rest) => Any ? Rest : never;
-type RestUnsubscribeFnArgs<Fn> = Fn extends (subId: number, ...rest: infer Rest) => Any ? Rest : never;
-type RestAsyncIteratorFnArgs<Fn> = Fn extends (triggers: string | string[], ...rest: infer Rest) => Any ? Rest : never;
-type RestAsyncIterableIteratorFnArgs<Fn> = Fn extends (triggers: string | readonly string[], ...rest: infer Rest) => Any ? Rest : never;
-declare class TypedPubSubBase<Engine extends PubSubEngineV2 | PubSubEngineV3, Map extends PubSubMap> {
-    protected pubsub: Engine;
-    protected options?: TypedPubSubOptions | undefined;
-    protected channelPrefix: string;
-    constructor(pubsub: Engine, options?: TypedPubSubOptions | undefined);
-    publish: <C extends keyof Map>(channel: C, message: Map[C], ...rest: RestPayloadFnArgs<Engine["publish"]>) => Promise<void>;
-    subscribe: <C extends keyof Map>(channel: C, onMessage: OnMessage<Map[C]>, ...rest: RestSubscribeFnArgs<Engine["subscribe"]>) => Promise<number>;
-    unsubscribe: (subId: number, ...rest: RestUnsubscribeFnArgs<Engine["unsubscribe"]>) => void;
-    protected mapChannel: <C extends keyof Map>(channel: C) => string;
-    protected mapTriggers: <C extends keyof Map>(triggers: C | C[]) => string | string[];
-}
-declare class TypedPubSubV2<Engine extends PubSubEngineV2, Map extends PubSubMap> extends TypedPubSubBase<Engine, Map> {
-    asyncIterator: <C extends keyof Map>(triggers: C | C[], ...rest: RestAsyncIteratorFnArgs<Engine["asyncIterator"]>) => AsyncIterator<Map[C], any, any>;
-}
-/** @hidden */
-declare class TypedPubSubV3<Engine extends PubSubEngineV3, Map extends PubSubMap> extends TypedPubSubBase<Engine, Map> {
-    asyncIterableIterator: <C extends keyof Map>(triggers: C | C[], ...rest: RestAsyncIterableIteratorFnArgs<Engine["asyncIterableIterator"]>) => AsyncIterableIterator<Map[C]>;
-}
-type TypedPubSub<Engine extends PubSubEngineV2 | PubSubEngineV3, Map extends Record<string, any>> = Engine extends PubSubEngineV3 ? TypedPubSubV3<Engine, Map> : Engine extends PubSubEngineV2 ? TypedPubSubV2<Engine, Map> : never;
-/**
- * Creates a type-safe wrapper around a PubSub implementation.
- *
- * This utility ensures that your subscription channels and their payloads
- * are properly typed, helping catch potential errors at compile time.
- *
- * @param pubsub - The PubSub engine instance (e.g., PubSub, RedisPubSub)
- * @param options - Configuration options
- *
- * @example
- * ```typescript
- * // Define your event map
- * type PubSubMap = {
- *   "user-updated": User;
- *   [c: `user-updated-${string}`]: User;
- * };
- *
- * // Create typed PubSub instance
- * const pubsub = createTypedPubSub<PubSub, PubSubMap>(new PubSub());
- *
- * // Usage with Redis
- * const pubsub = createTypedPubSub<RedisPubSub, PubSubMap>(
- *   new RedisPubSub({
- *     publisher: new Redis(options),
- *     subscriber: new Redis(options),
- *   }),
- *   {
- *     prefix: "feature-1:",
- *   }
- * );
- * ```
- */
-declare function createTypedPubSub<Engine extends PubSubEngineV2 | PubSubEngineV3, Map extends Record<string, any>>(pubsub: Engine, options?: TypedPubSubOptions): TypedPubSub<Engine, Map>;
-
-export { type PubSubEngineV2, type PubSubEngineV3, type TypedPubSub, type TypedPubSubOptions, createTypedPubSub };