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

package/CHANGELOG.md

@@ -0,0 +1,55 @@
+# @baeta/subscriptions-pubsub
+
+## 2.0.0-next.2
+
+### Patch Changes
+
+- Fix broken types
+
+## 2.0.0-next.1
+
+### Patch Changes
+
+- Fix release version
+
+## 2.0.0-next.0
+
+### Major Changes
+
+- [#214](https://github.com/andreisergiu98/baeta/pull/214) [`31d1a50`](https://github.com/andreisergiu98/baeta/commit/31d1a509f96535b43ae85d19c770eb1a5f09dc94) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Baeta v2 – major refactor
+  - **Side-effect-free type generation & resolver definitions.**
+    The types generator and resolver definitions were reworked to be side-effect free, improving type safety.
+  - **Stricter type safety.**
+    You must now **explicitly define resolvers for every field** during development—breakages that used to surface at runtime are now caught at compile time.
+  - **Removed `@baeta/compiler`.**
+    Since modern runtimes can execute TypeScript natively, the separate compiler package is no longer needed. Use your runtime’s native TS support or your existing build setup.
+  - **Subscriptions update.**
+    `@baeta/subscriptions-pubsub` now targets **`graphql-subscriptions` v3**.
+
+## 1.0.9
+
+### Patch Changes
+
+- [`583014f`](https://github.com/andreisergiu98/baeta/commit/583014f0bac810b25d9a8226bda2df4c9039f5e3) Thanks [@andreisergiu98](https://github.com/andreisergiu98)! - Update dependencies
+
+## 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

@@ -0,0 +1,68 @@
+type Any$1 = any;
+interface PubSubEngine {
+    publish: (triggerName: string, payload: Any$1, ...rest: Any$1[]) => Promise<void>;
+    subscribe: (triggerName: string, onMessage: (message: Any$1) => Promise<void> | void, ...rest: Any$1[]) => Promise<number>;
+    unsubscribe: (subId: number, ...rest: Any$1[]) => void;
+    asyncIterableIterator: <T>(triggers: string | readonly string[], ...rest: Any$1[]) => 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 RestAsyncIterableIteratorFnArgs<Fn> = Fn extends (triggers: string | readonly string[], ...rest: infer Rest) => Any ? Rest : 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 = new TypedPubSub<PubSub, PubSubMap>(new PubSub());
+ *
+ * // Usage with Redis
+ * const pubsub = new TypedPubSub<RedisPubSub, PubSubMap>(
+ *   new RedisPubSub({
+ *     publisher: new Redis(options),
+ *     subscriber: new Redis(options),
+ *   }),
+ *   {
+ *     prefix: "feature-1:",
+ *   }
+ * );
+ * ```
+ */
+declare class TypedPubSub<Engine extends PubSubEngine, Map extends PubSubMap> {
+    protected channelPrefix: string;
+    protected pubsub: Engine;
+    protected options?: TypedPubSubOptions;
+    constructor(pubsub: Engine, options?: TypedPubSubOptions);
+    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;
+    asyncIterableIterator: <C extends keyof Map>(triggers: C | C[], ...rest: RestAsyncIterableIteratorFnArgs<Engine["asyncIterableIterator"]>) => AsyncIterableIterator<Map[C]>;
+    protected mapChannel: <C extends keyof Map>(channel: C) => string;
+    protected mapTriggers: <C extends keyof Map>(triggers: C | C[]) => string | string[];
+}
+
+export { TypedPubSub, type TypedPubSubOptions };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baeta/subscriptions-pubsub",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0-next.2",
   "keywords": [
     "baeta",
     "graphql",
@@ -27,8 +27,8 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./index.ts",
-      "default": "./index.ts"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
     }
   },
   "types": "dist/index.d.ts",
@@ -44,9 +44,9 @@
     "types": "tsc --noEmit"
   },
   "devDependencies": {
-    "@baeta/builder": "workspace:^",
-    "@baeta/testing": "workspace:^",
-    "@baeta/tsconfig": "workspace:^",
+    "@baeta/builder": "^0.0.0",
+    "@baeta/testing": "^0.0.0",
+    "@baeta/tsconfig": "^0.0.0",
     "graphql": "^16.11.0",
     "graphql-subscriptions": "^3.0.0",
     "typescript": "^5.9.3"
@@ -89,4 +89,4 @@
       "alphabetical-ignoring-documents"
     ]
   }
-}
+}