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

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @baeta/subscriptions-pubsub
 
+## 2.0.0-next.2
+
+### Patch Changes
+
+- Fix broken types
+
 ## 2.0.0-next.1
 
 ### Patch Changes

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.1",
+  "version": "2.0.0-next.2",
   "keywords": [
     "baeta",
     "graphql",