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

package/CHANGELOG.md

@@ -0,0 +1,69 @@
+# @baeta/subscriptions-pubsub
+
+## 2.0.0-next.10
+
+## 2.0.0-next.9
+
+## 2.0.0-next.8
+
+## 2.0.0-next.7
+
+## 2.0.0-next.6
+
+### Patch Changes
+
+- Fix export for 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/README.md

@@ -5,7 +5,7 @@
 <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/testing.yml"><img src="https://img.shields.io/github/actions/workflow/status/andreisergiu98/baeta/testing.yml" /></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/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>
   <br />
@@ -77,43 +77,68 @@ type Query {
 #### 2. Implement your resolvers
 
 ```typescript
-import { getUserModule } from "./typedef";
+import { UserModule } from "./typedef.ts";
 
-const { Query } = getUserModule();
+const { Query } = UserModule;
 
-Query.user(({ args }) => {
+const userQuery = Query.user.resolve(({ args }) => {
   return dataSource.user.find(args.where);
 });
 
-Query.users(() => {
+const usersQuery = Query.users.resolve(() => {
   return dataSource.user.findMany();
 });
+
+Query.$fields({
+  user: userQuery,
+  users: usersQuery,
+});
 ```
 
 #### 3. Add authorization
 
 ```typescript
-const { Query, Mutation } = getUserModule();
-
-Query.users.$auth({
-  $or: {
-    isPublic: true,
-    isLoggedIn: true,
-  },
-});
+import { UserModule } from "./typedef.ts";
+
+const { Query } = UserModule;
+
+const userQuery = Query.user
+  .$auth({
+    $or: {
+      isPublic: true,
+      isLoggedIn: true,
+    },
+  })
+  .resolve(async ({ args }) => {
+    // ...
+  });
 ```
 
 #### 4. Add caching
 
 ```typescript
-import { getUserModule } from "./typedef";
-
-const { User, Query } = getUserModule();
+const { Query, Mutation, User } = UserModule;
 
 export const userCache = User.$createCache();
 
-Query.user.$useCache(userCache);
-Query.users.$useCache(userCache);
+const userQuery = Query.user
+  .$auth({
+    // ...
+  })
+  .$useCache(userCache)
+  .resolve(async ({ args }) => {
+    // ...
+  });
+
+const updateUserMutation = Mutation.updateUser
+  .$use(async (next) => {
+    const user = await next();
+    await userCache.save(user);
+    return user;
+  })
+  .resolve(async ({ args }) => {
+    // ...
+  });
 ```
 
 ## Compatibility

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+//#region lib/pubsub-engine.d.ts
+/** biome-ignore-all lint/suspicious/noExplicitAny: allow any args*/
+interface PubSubEngine {
+  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>;
+}
+//#endregion
+//#region lib/typed-pubsub.d.ts
+/**
+ * Configuration options for TypedPubSub
+ */
+interface TypedPubSubOptions {
+  /** Optional prefix for channel names */
+  prefix?: string;
+}
+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[];
+}
+//#endregion
+export { TypedPubSub, type TypedPubSubOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1 +1,65 @@
+//#region lib/typed-pubsub.ts
+/**
+* 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:",
+*   }
+* );
+* ```
+*/
+var TypedPubSub = class {
+	channelPrefix;
+	pubsub;
+	options;
+	constructor(pubsub, options) {
+		this.channelPrefix = options?.prefix ?? "";
+		this.pubsub = pubsub;
+		this.options = options;
+	}
+	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);
+	};
+	asyncIterableIterator = (triggers, ...rest) => {
+		return this.pubsub.asyncIterableIterator(this.mapTriggers(triggers), ...rest);
+	};
+	mapChannel = (channel) => {
+		return `${this.channelPrefix}${channel.toString()}`;
+	};
+	mapTriggers = (triggers) => {
+		return Array.isArray(triggers) ? triggers.map(this.mapChannel) : this.mapChannel(triggers);
+	};
+};
+
+//#endregion
+export { TypedPubSub };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
+{"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,AAAU;CACV,AAAU;CACV,AAAU;CAEV,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,AAAU,cAAmC,YAAuB;AACnE,SAAO,GAAG,KAAK,gBAAgB,QAAQ,UAAU;;CAGlD,AAAU,eAAoC,aAAyC;AACtF,SAAO,MAAM,QAAQ,SAAS,GAAG,SAAS,IAAI,KAAK,WAAW,GAAG,KAAK,WAAW,SAAS"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@baeta/subscriptions-pubsub",
-  "version": "2.0.0-next.0",
+  "version": "2.0.0-next.10",
   "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",
@@ -37,17 +37,23 @@
     "package.json"
   ],
   "scripts": {
-    "build": "tsup",
-    "prepack": "prep",
-    "postpack": "prep --clean",
-    "test": "ava",
+    "build": "builder build",
+    "prepack": "builder prepare",
+    "postpack": "builder prepare --clean",
+    "test": "builder test",
+    "test:circular": "builder test-circular",
     "types": "tsc --noEmit"
   },
+  "ava": {
+    "extensions": {
+      "ts": "module"
+    }
+  },
   "devDependencies": {
-    "@baeta/builder": "workspace:^",
-    "@baeta/testing": "workspace:^",
-    "@baeta/tsconfig": "workspace:^",
-    "graphql": "^16.11.0",
+    "@baeta/builder": "^0.0.0",
+    "@baeta/testing": "^0.0.0",
+    "@baeta/tsconfig": "^0.0.0",
+    "graphql": "^16.12.0",
     "graphql-subscriptions": "^3.0.0",
     "typescript": "^5.9.3"
   },
@@ -63,15 +69,6 @@
       }
     }
   },
-  "ava": {
-    "extensions": {
-      "ts": "module"
-    },
-    "nodeArguments": [
-      "--no-warnings",
-      "--experimental-transform-types"
-    ]
-  },
   "typedocOptions": {
     "entryPoints": [
       "./index.ts"
@@ -89,4 +86,4 @@
       "alphabetical-ignoring-documents"
     ]
   }
-}
+}