@baeta/subscriptions-pubsub 2.0.0-next.14 → 2.0.0-next.16

package/CHANGELOG.md

@@ -1,56 +1,45 @@
 # @baeta/subscriptions-pubsub
 
-## 2.0.0-next.14
+## 2.0.0-next.16
 
-### Patch Changes
-
-- Fix wrong error being thrown in the case for single errors by [@andreisergiu98](https://github.com/andreisergiu98) in [#397](https://github.com/andreisergiu98/baeta/pull/397)
-
-## 2.0.0-next.13
-
-## 2.0.0-next.12
-
-## 2.0.0-next.11
-
-## 2.0.0-next.10
-
-## 2.0.0-next.9
+### Major Changes
 
-## 2.0.0-next.8
+- Drop support for Node.js v23 and v25. Baeta now targets the active LTS releases — Node.js `^22.20.0`, `^24.0.0`, or `>=26.0.0`. by [@andreisergiu98](https://github.com/andreisergiu98) in [#290](https://github.com/andreisergiu98/baeta/pull/290)
 
-## 2.0.0-next.7
+- `TypedPubSub` is now a concrete class you instantiate with `new`, the `createTypedPubSub()` factory has been removed, and the package targets `graphql-subscriptions` v3 only. Support for `graphql-subscriptions` v2 (and its runtime engine detection) is gone. by [@andreisergiu98](https://github.com/andreisergiu98) in [#290](https://github.com/andreisergiu98/baeta/pull/290)
 
-## 2.0.0-next.6
+  #### Creating the PubSub
 
-### Patch Changes
+  In v1, `TypedPubSub` was a _type_ and you built the instance with the `createTypedPubSub()` factory, which detected the engine version (`asyncIterator` for v2, `asyncIterableIterator` for v3) at runtime. In v2, `TypedPubSub` is the class itself.
 
-- Fix export for subscriptions-pubsub
+  **v1:**
 
-## 2.0.0-next.2
+  ```typescript
+  import { createTypedPubSub } from "@baeta/subscriptions-pubsub";
+  import { PubSub } from "graphql-subscriptions";
 
-### Patch Changes
+  export const pubsub = createTypedPubSub<PubSub, PubSubMap>(new PubSub());
+  ```
 
-- Fix broken types
+  **v2:**
 
-## 2.0.0-next.1
+  ```typescript
+  import { TypedPubSub } from "@baeta/subscriptions-pubsub";
+  import { PubSub } from "graphql-subscriptions";
 
-### Patch Changes
+  export const pubsub = new TypedPubSub<PubSub, PubSubMap>(new PubSub());
+  ```
 
-- Fix release version
+  The optional `{ prefix }` options object is unchanged and still passed as the second argument.
 
-## 2.0.0-next.0
+  #### Removed and changed exports
 
-### Major Changes
+  - `createTypedPubSub()` — removed; use `new TypedPubSub(...)`.
+  - `PubSubEngineV2` / `PubSubEngineV3` — removed. The package now targets a single `graphql-subscriptions` v3 engine.
+  - `TypedPubSub` — was a type alias in v1; is now the exported class.
+  - `TypedPubSubOptions` — unchanged.
 
-- [#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**.
+  Because v2 support is dropped, the `asyncIterator` method (the v2-only iterator) is no longer available — use `asyncIterableIterator(channel)` for the async iterable. `publish`, `subscribe`, and `unsubscribe` are unchanged.
 
 ## 1.0.9
 

package/README.md

@@ -5,9 +5,10 @@
 <div align="center">
   <h1>Baeta</h1>
   <a href="https://www.npmjs.com/package/@baeta/cli"><img src="https://img.shields.io/npm/v/@baeta/cli.svg?style=flat" /></a>
-   <a href="https://github.com/andreisergiu98/baeta/actions/workflows/checks.yml"><img src="https://img.shields.io/github/actions/workflow/status/andreisergiu98/baeta/checks.yml" /></a>
+   <a href="https://github.com/andreisergiu98/baeta/actions/workflows/build.yml"><img src="https://img.shields.io/github/actions/workflow/status/andreisergiu98/baeta/build.yml" /></a>
   <a href="https://github.com/andreisergiu98/baeta/pulls"><img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" /></a>
   <a href="https://github.com/andreisergiu98/baeta/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" /></a>
+  <img alt="nycrc config on GitHub" src="https://img.shields.io/nycrc/andreisergiu98/baeta?config=.nycrc.json&preferredThreshold=branches&color=green">
   <br />
   <br />
   <a href="https://baeta.io/docs/getting-started/installation">Getting Started</a>
@@ -35,10 +36,11 @@ Building GraphQL APIs shouldn't be complicated. **Baeta** is a modern, modular,
 - **Middleware & Directives**: Easy integration of custom behaviors
 - **High Performance**: Built for scalability and efficiency
 
-#### And optional extensions and plugins
+#### And optional app plugins and libraries
 
-- **@baeta/extension-auth**: Add powerful scope-based authorization
-- **@baeta/extension-cache**: Implement automatic caching with simple update patterns
+- **@baeta/auth**: Add powerful scope-based authorization
+- **@baeta/complexity**: Reject resource-exhausting queries with depth, breadth and complexity limits
+- **@baeta/cache**: Type-safe caching with declarative queries and automatic reconciliation
 - ... and more!
 
 ## Why use Baeta?
@@ -89,7 +91,7 @@ const usersQuery = Query.users.resolve(() => {
   return dataSource.user.findMany();
 });
 
-Query.$fields({
+export default Query.$fields({
   user: userQuery,
   users: usersQuery,
 });
@@ -98,17 +100,13 @@ Query.$fields({
 #### 3. Add authorization
 
 ```typescript
+import { auth, rule, scope } from "./lib/auth.ts";
 import { UserModule } from "./typedef.ts";
 
 const { Query } = UserModule;
 
 const userQuery = Query.user
-  .$auth({
-    $or: {
-      isPublic: true,
-      isLoggedIn: true,
-    },
-  })
+  .$use(auth(rule.or(scope.isPublic, scope.isLoggedIn)))
   .resolve(async ({ args }) => {
     // ...
   });
@@ -117,23 +115,33 @@ const userQuery = Query.user
 #### 4. Add caching
 
 ```typescript
-const { Query, Mutation, User } = UserModule;
-
-export const userCache = User.$createCache();
-
-const userQuery = Query.user
-  .$auth({
-    // ...
+import { createCache, defineQuery } from "@baeta/cache";
+import { redisClient } from "./lib/redis.ts";
+
+const { Query, Mutation } = UserModule;
+
+export const userCache = createCache(redisClient, {
+  name: "UserCache",
+  parse: JSON.parse,
+  serialize: JSON.stringify,
+})
+  .withQueries({
+    findUser: defineQuery({
+      resolve: async (args: { id: string }) => {
+        return dataSource.user.findUnique({ where: args });
+      },
+    }),
   })
-  .$useCache(userCache)
-  .resolve(async ({ args }) => {
-    // ...
-  });
+  .build();
+
+const userQuery = Query.user.map(({ args }) =>
+  userCache.queries.findUser({ id: args.where.id }),
+);
 
 const updateUserMutation = Mutation.updateUser
   .$use(async (next) => {
     const user = await next();
-    await userCache.save(user);
+    if (user) await userCache.update(user);
     return user;
   })
   .resolve(async ({ args }) => {

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../lib/typed-pubsub.ts"],"sourcesContent":["/** biome-ignore-all lint/suspicious/noExplicitAny: allow any args */\n\nimport type { PubSubEngine } 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\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 RestAsyncIterableIteratorFnArgs<Fn> = Fn extends (\n\ttriggers: string | readonly string[],\n\t...rest: infer Rest\n) => any\n\t? Rest\n\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 = new TypedPubSub<PubSub, PubSubMap>(new PubSub());\n *\n * // Usage with Redis\n * const pubsub = new TypedPubSub<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 class TypedPubSub<Engine extends PubSubEngine, Map extends PubSubMap> {\n\tprotected channelPrefix: string;\n\tprotected pubsub: Engine;\n\tprotected options?: TypedPubSubOptions;\n\n\tconstructor(pubsub: Engine, options?: TypedPubSubOptions) {\n\t\tthis.channelPrefix = options?.prefix ?? '';\n\t\tthis.pubsub = pubsub;\n\t\tthis.options = options;\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\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\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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0EA,IAAa,cAAb,MAA6E;CAC5E;CACA;CACA;CAEA,YAAY,QAAgB,SAA8B;AACzD,OAAK,gBAAgB,SAAS,UAAU;AACxC,OAAK,SAAS;AACd,OAAK,UAAU;;CAGhB,WACC,SACA,SACA,GAAG,SACC;AACJ,SAAO,KAAK,OAAO,QAAQ,KAAK,WAAW,QAAQ,EAAE,SAAS,GAAG,KAAK;;CAGvE,aACC,SACA,WACA,GAAG,SACC;AACJ,SAAO,KAAK,OAAO,UAAU,KAAK,WAAW,QAAQ,EAAE,WAAW,GAAG,KAAK;;CAG3E,eAAe,OAAe,GAAG,SAAuD;AACvF,SAAO,KAAK,OAAO,YAAY,OAAO,GAAG,KAAK;;CAG/C,yBACC,UACA,GAAG,SACC;AACJ,SAAO,KAAK,OAAO,sBAA8B,KAAK,YAAY,SAAS,EAAE,GAAG,KAAK;;CAGtF,cAA6C,YAAuB;AACnE,SAAO,GAAG,KAAK,gBAAgB,QAAQ,UAAU;;CAGlD,eAA8C,aAAyC;AACtF,SAAO,MAAM,QAAQ,SAAS,GAAG,SAAS,IAAI,KAAK,WAAW,GAAG,KAAK,WAAW,SAAS"}
+{"version":3,"file":"index.js","names":[],"sources":["../lib/typed-pubsub.ts"],"sourcesContent":["/** biome-ignore-all lint/suspicious/noExplicitAny: allow any args */\n\nimport type { PubSubEngine } 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\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 RestAsyncIterableIteratorFnArgs<Fn> = Fn extends (\n\ttriggers: string | readonly string[],\n\t...rest: infer Rest\n) => any\n\t? Rest\n\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 = new TypedPubSub<PubSub, PubSubMap>(new PubSub());\n *\n * // Usage with Redis\n * const pubsub = new TypedPubSub<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 class TypedPubSub<Engine extends PubSubEngine, Map extends PubSubMap> {\n\tprotected channelPrefix: string;\n\tprotected pubsub: Engine;\n\tprotected options?: TypedPubSubOptions;\n\n\tconstructor(pubsub: Engine, options?: TypedPubSubOptions) {\n\t\tthis.channelPrefix = options?.prefix ?? '';\n\t\tthis.pubsub = pubsub;\n\t\tthis.options = options;\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\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\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"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA0EA,IAAa,cAAb,MAA6E;CAC5E;CACA;CACA;CAEA,YAAY,QAAgB,SAA8B;EACzD,KAAK,gBAAgB,SAAS,UAAU;EACxC,KAAK,SAAS;EACd,KAAK,UAAU;CAChB;CAEA,WACC,SACA,SACA,GAAG,SACC;EACJ,OAAO,KAAK,OAAO,QAAQ,KAAK,WAAW,OAAO,GAAG,SAAS,GAAG,IAAI;CACtE;CAEA,aACC,SACA,WACA,GAAG,SACC;EACJ,OAAO,KAAK,OAAO,UAAU,KAAK,WAAW,OAAO,GAAG,WAAW,GAAG,IAAI;CAC1E;CAEA,eAAe,OAAe,GAAG,SAAuD;EACvF,OAAO,KAAK,OAAO,YAAY,OAAO,GAAG,IAAI;CAC9C;CAEA,yBACC,UACA,GAAG,SACC;EACJ,OAAO,KAAK,OAAO,sBAA8B,KAAK,YAAY,QAAQ,GAAG,GAAG,IAAI;CACrF;CAEA,cAA6C,YAAuB;EACnE,OAAO,GAAG,KAAK,gBAAgB,QAAQ,SAAS;CACjD;CAEA,eAA8C,aAAyC;EACtF,OAAO,MAAM,QAAQ,QAAQ,IAAI,SAAS,IAAI,KAAK,UAAU,IAAI,KAAK,WAAW,QAAQ;CAC1F;AACD"}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@baeta/subscriptions-pubsub",
-  "version": "2.0.0-next.14",
+  "version": "2.0.0-next.16",
+  "description": "Typed PubSub helpers for Baeta subscriptions.",
   "keywords": [
     "baeta",
     "builder",
@@ -21,14 +22,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/andreisergiu98/baeta.git",
+    "url": "git+https://github.com/andreisergiu98/baeta.git",
     "directory": "packages/subscriptions-pubsub"
   },
   "files": [
-    "dist",
-    "package.json"
+    "dist"
   ],
   "type": "module",
+  "sideEffects": false,
   "types": "dist/index.d.ts",
   "exports": {
     ".": {
@@ -37,13 +38,13 @@
     }
   },
   "publishConfig": {
-    "access": "public",
     "exports": {
       ".": {
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
       }
-    }
+    },
+    "access": "public"
   },
   "scripts": {
     "build": "builder build",
@@ -67,7 +68,7 @@
     ]
   },
   "engines": {
-    "node": ">=22.20.0"
+    "node": "^22.20.0 || ^24.0.0 || >=26.0.0"
   },
   "typedocOptions": {
     "entryPoints": [