@orpc/bun 0.0.0 → 2.0.0-beta.8

package/{LICENCE → LICENSE}

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

package/README.md

@@ -1,14 +1,14 @@
 <h1 align="center">oRPC - Typesafe APIs Made Simple 🪄</h1>
 
 <div align="center">
-  <a href="https://codecov.io/gh/middleapi/orpc-bun">
-    <img alt="codecov" src="https://codecov.io/gh/middleapi/orpc-bun/branch/main/graph/badge.svg">
+  <a href="https://codecov.io/gh/middleapi/orpc">
+    <img alt="codecov" src="https://codecov.io/gh/middleapi/orpc/branch/main/graph/badge.svg">
   </a>
   <a href="https://www.npmjs.com/package/@orpc/bun">
     <img alt="weekly downloads" src="https://img.shields.io/npm/dw/%40orpc%2Fbun?logo=npm" />
   </a>
-  <a href="https://github.com/middleapi/orpc-bun/blob/main/LICENCE">
-    <img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc-bun?logo=open-source-initiative" />
+  <a href="https://github.com/middleapi/orpc/blob/main/LICENCE">
+    <img alt="MIT License" src="https://img.shields.io/github/license/middleapi/orpc?logo=open-source-initiative" />
   </a>
   <a href="https://discord.gg/TXEbwRBvQn">
     <img alt="Discord" src="https://img.shields.io/discord/1308966753044398161?color=7389D8&label&logo=discord&logoColor=ffffff" />
@@ -117,25 +117,25 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
 <table>
   <tr>
    <td align="center"><a href="https://github.com/rhinodavid?ref=orpc" target="_blank" rel="noopener" title="David Walsh"><img src="https://avatars.githubusercontent.com/u/5778036?u=b5521f07d2f88c3db2a0dae62b5f2f8357214af0&amp;v=4" width="119" alt="David Walsh"/><br />David Walsh</a></td>
+   <td align="center"><a href="https://github.com/Nic13Gamer?ref=orpc" target="_blank" rel="noopener" title="Nicholas"><img src="https://avatars.githubusercontent.com/u/54724556?u=56a7ab430ce7a80d648ab6eba051d454a818ed0b&amp;v=4" width="119" alt="Nicholas"/><br />Nicholas</a></td>
    <td align="center"><a href="https://github.com/Robbe95?ref=orpc" target="_blank" rel="noopener" title="Robbe Vaes"><img src="https://avatars.githubusercontent.com/u/44748019?u=e0232402c045ad4eac7cbd217f1f47e083103b89&amp;v=4" width="119" alt="Robbe Vaes"/><br />Robbe Vaes</a></td>
    <td align="center"><a href="https://github.com/aidansunbury?ref=orpc" target="_blank" rel="noopener" title="Aidan Sunbury"><img src="https://avatars.githubusercontent.com/u/64103161?v=4" width="119" alt="Aidan Sunbury"/><br />Aidan Sunbury</a></td>
    <td align="center"><a href="https://github.com/soonoo?ref=orpc" target="_blank" rel="noopener" title="soonoo"><img src="https://avatars.githubusercontent.com/u/5436405?u=5d0b4aa955c87e30e6bda7f0cccae5402da99528&amp;v=4" width="119" alt="soonoo"/><br />soonoo</a></td>
    <td align="center"><a href="https://github.com/kporten?ref=orpc" target="_blank" rel="noopener" title="Kevin Porten"><img src="https://avatars.githubusercontent.com/u/1839345?u=dc2263d5cfe0d927ce1a0be04a1d55dd6b55405c&amp;v=4" width="119" alt="Kevin Porten"/><br />Kevin Porten</a></td>
    <td align="center"><a href="https://github.com/pumpkinlink?ref=orpc" target="_blank" rel="noopener" title="Denis"><img src="https://avatars.githubusercontent.com/u/11864620?u=5f47bbe6c65d0f6f5cf011021490238e4b0593d0&amp;v=4" width="119" alt="Denis"/><br />Denis</a></td>
-   <td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&amp;v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
   </tr>
   <tr>
+   <td align="center"><a href="https://github.com/christopher-kapic?ref=orpc" target="_blank" rel="noopener" title="Christopher Kapic"><img src="https://avatars.githubusercontent.com/u/59740769?u=e7ad4b72b5bf6c9eb1644c26dbf3332a8f987377&amp;v=4" width="119" alt="Christopher Kapic"/><br />Christopher Kapic</a></td>
    <td align="center"><a href="https://github.com/thomasballinger?ref=orpc" target="_blank" rel="noopener" title="Tom Ballinger"><img src="https://avatars.githubusercontent.com/u/458879?u=4b045ac75d721b6ac2b42a74d7d37f61f0414031&amp;v=4" width="119" alt="Tom Ballinger"/><br />Tom Ballinger</a></td>
    <td align="center"><a href="https://github.com/SSam0419?ref=orpc" target="_blank" rel="noopener" title="Sam"><img src="https://avatars.githubusercontent.com/u/102863520?u=3c89611f549d5070be232eb4532f690c8f2e7a65&amp;v=4" width="119" alt="Sam"/><br />Sam</a></td>
    <td align="center"><a href="https://github.com/Titoine?ref=orpc" target="_blank" rel="noopener" title="Titoine"><img src="https://avatars.githubusercontent.com/u/3514286?u=1bb1e86b0c99c8a1121372e56d51a177eea12191&amp;v=4" width="119" alt="Titoine"/><br />Titoine</a></td>
    <td align="center"><a href="https://github.com/Mnigos?ref=orpc" target="_blank" rel="noopener" title="Igor Makowski"><img src="https://avatars.githubusercontent.com/u/56691628?u=ee8c879478f7c151b9156aef6c74243fa3e247a8&amp;v=4" width="119" alt="Igor Makowski"/><br />Igor Makowski</a></td>
    <td align="center"><a href="https://github.com/hanayashiki?ref=orpc" target="_blank" rel="noopener" title="hanayashiki"><img src="https://avatars.githubusercontent.com/u/26056783?u=06c3b9205a16fd41a871e82da1cc2a09306d53f5&amp;v=4" width="119" alt="hanayashiki"/><br />hanayashiki</a></td>
    <td align="center"><a href="https://github.com/ldub?ref=orpc" target="_blank" rel="noopener" title="Lev Dubinets"><img src="https://avatars.githubusercontent.com/u/3114081?u=f547f5d5012cab54851f1b1ad72d10e537f78fc2&amp;v=4" width="119" alt="Lev Dubinets"/><br />Lev Dubinets</a></td>
-   <td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&amp;v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
   </tr>
   <tr>
+   <td align="center"><a href="https://github.com/mr-kelly?ref=orpc" target="_blank" rel="noopener" title="Kelly Peilin Chan"><img src="https://avatars.githubusercontent.com/u/520852?u=6b0f7105f694e7b5cacf410a3f04c7044b469dc8&amp;v=4" width="119" alt="Kelly Peilin Chan"/><br />Kelly Peilin Chan</a></td>
    <td align="center"><a href="https://github.com/piscis?ref=orpc" target="_blank" rel="noopener" title="Alex"><img src="https://avatars.githubusercontent.com/u/326163?u=b245f368bd940cf51d08c0b6bf55f8257f359437&amp;v=4" width="119" alt="Alex"/><br />Alex</a></td>
-   <td align="center"><a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="nattstack"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&amp;v=4" width="119" alt="nattstack"/><br />nattstack</a></td>
    <td align="center"><a href="https://github.com/finom?ref=orpc" target="_blank" rel="noopener" title="Andrey Gubanov"><img src="https://avatars.githubusercontent.com/u/1082083?u=29e91400dbd4a9c217048a8f59562c4f740498e6&amp;v=4" width="119" alt="Andrey Gubanov"/><br />Andrey Gubanov</a></td>
   </tr>
 </table>
@@ -174,6 +174,7 @@ Like what we build over at [middleapi](https://github.com/middleapi)? You can he
   <a href="https://github.com/illarionvk?ref=orpc" target="_blank" rel="noopener" title="Illarion Koperski"><img src="https://avatars.githubusercontent.com/u/5012724?u=7cfa13652f7ac5fb3c56d880e3eb3fbe40c3ea34&amp;v=4" width="32" height="32" alt="Illarion Koperski" /></a>
   <a href="https://github.com/steelbrain?ref=orpc" target="_blank" rel="noopener" title="Anees Iqbal"><img src="https://avatars.githubusercontent.com/u/4278113?u=22b80b5399eed68ac76cd58b02961b0481f1db11&amp;v=4" width="32" height="32" alt="Anees Iqbal" /></a>
   <a href="https://github.com/Scrumplex?ref=orpc" target="_blank" rel="noopener" title="Sefa Eyeoglu"><img src="https://avatars.githubusercontent.com/u/11587657?u=ab503582165c0bbff0cca47ce31c9450bb1553c9&amp;v=4" width="32" height="32" alt="Sefa Eyeoglu" /></a>
+  <a href="https://github.com/nattstack?ref=orpc" target="_blank" rel="noopener" title="Natt"><img src="https://avatars.githubusercontent.com/u/31426677?u=fa9dbb8b3e66eb0ea3c88db5dc07f31c8c5418fe&amp;v=4" width="32" height="32" alt="Natt" /></a>
   <a href="https://github.com/ChromeGG?ref=orpc" target="_blank" rel="noopener" title="Adam Tkaczyk"><img src="https://avatars.githubusercontent.com/u/39050595?u=a58ca6042a6950e94e6e92442db76ef584279bc0&amp;v=4" width="32" height="32" alt="Adam Tkaczyk" /></a>
   <a href="https://github.com/plancraft?ref=orpc" target="_blank" rel="noopener" title="plancraft"><img src="https://avatars.githubusercontent.com/u/46482287?v=4" width="32" height="32" alt="plancraft" /></a>
 </p>
@@ -187,4 +188,4 @@ oRPC is inspired by existing solutions that prioritize type safety and developer
 
 ## License
 
-Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc-nest/blob/main/LICENCE) for more information.
+Distributed under the MIT License. See [LICENSE](https://github.com/middleapi/orpc/blob/main/LICENCE) for more information.

package/dist/index.d.mts

@@ -1,5 +1,76 @@
-import { RateLimiter, RateLimitOptions, RateLimitResult } from '@orpc/ratelimit';
+import { Publisher, PublisherOptions, PublisherSubscribeListenerOptions } from '@orpc/publisher';
+import { Promisable } from '@orpc/shared';
 import { RedisClient } from 'bun';
+import { RPCSerializer } from '@orpc/client';
+import { RateLimiter, RateLimitOptions, RateLimitResult } from '@orpc/ratelimit';
+
+interface BunRedisPublisherOptions extends PublisherOptions {
+    /**
+     * Redis subscriber instance.
+     * Pub/Sub takes over the connection, so a client with subscriptions
+     * cannot execute commands and must use a dedicated connection.
+     *
+     * @default redis.duplicate() (lazily created on first listen)
+     */
+    subscriber?: undefined | Promisable<RedisClient>;
+    /**
+     * The prefix to use for Redis keys.
+     */
+    prefix?: string;
+    /**
+     * Serializer for serialize and deserialize payloads.
+     *
+     * @default RPCSerializer
+     */
+    serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
+    /**
+     * Configuration for event replay support.
+     *
+     * When enabled, published events are temporarily stored so new
+     * subscribers can resume from a previous position using `lastEventId`.
+     *
+     * @default { enabled: false }
+     */
+    replay?: {
+        /**
+         * Whether event replay support is enabled.
+         *
+         * When enabled, published events are temporarily stored so new
+         * subscribers can resume from a previous position using `lastEventId`.
+         *
+         * @default false
+         */
+        enabled: boolean;
+        /**
+         * How long (in seconds) to retain events for replay.
+         *
+         * Expired events are cleaned up lazily for performance reasons, so
+         * some events may remain available slightly longer than this period.
+         *
+         * @default 300 (5 min)
+         */
+        seconds?: number;
+    };
+}
+declare class BunRedisPublisher<T extends Record<string, object>> extends Publisher<T> {
+    private readonly redis;
+    private subscriber;
+    private readonly prefix;
+    private readonly serializer;
+    private readonly replayEnabled;
+    private readonly replaySeconds;
+    /**
+     * The exactness of the `XTRIM` command.
+     * Used for testing purpose.
+     */
+    private readonly xTrimExactness;
+    constructor(redis: RedisClient, options?: BunRedisPublisherOptions);
+    private readonly firstPublishTimeMap;
+    publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
+    protected subscribeListener<K extends keyof T & string>(event: K, originalListener: (payload: T[K]) => void, { lastEventId, onError }?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
+    private serializePayload;
+    private deserializePayload;
+}
 
 interface BunRedisRateLimiterOptions {
     /**
@@ -38,5 +109,5 @@ declare class BunRedisRateLimiter implements RateLimiter {
     private resolveWeight;
 }
 
-export { BunRedisRateLimiter };
-export type { BunRedisRateLimiterOptions };
+export { BunRedisPublisher, BunRedisRateLimiter };
+export type { BunRedisPublisherOptions, BunRedisRateLimiterOptions };

package/dist/index.d.ts

@@ -1,5 +1,76 @@
-import { RateLimiter, RateLimitOptions, RateLimitResult } from '@orpc/ratelimit';
+import { Publisher, PublisherOptions, PublisherSubscribeListenerOptions } from '@orpc/publisher';
+import { Promisable } from '@orpc/shared';
 import { RedisClient } from 'bun';
+import { RPCSerializer } from '@orpc/client';
+import { RateLimiter, RateLimitOptions, RateLimitResult } from '@orpc/ratelimit';
+
+interface BunRedisPublisherOptions extends PublisherOptions {
+    /**
+     * Redis subscriber instance.
+     * Pub/Sub takes over the connection, so a client with subscriptions
+     * cannot execute commands and must use a dedicated connection.
+     *
+     * @default redis.duplicate() (lazily created on first listen)
+     */
+    subscriber?: undefined | Promisable<RedisClient>;
+    /**
+     * The prefix to use for Redis keys.
+     */
+    prefix?: string;
+    /**
+     * Serializer for serialize and deserialize payloads.
+     *
+     * @default RPCSerializer
+     */
+    serializer?: undefined | Pick<RPCSerializer, keyof RPCSerializer>;
+    /**
+     * Configuration for event replay support.
+     *
+     * When enabled, published events are temporarily stored so new
+     * subscribers can resume from a previous position using `lastEventId`.
+     *
+     * @default { enabled: false }
+     */
+    replay?: {
+        /**
+         * Whether event replay support is enabled.
+         *
+         * When enabled, published events are temporarily stored so new
+         * subscribers can resume from a previous position using `lastEventId`.
+         *
+         * @default false
+         */
+        enabled: boolean;
+        /**
+         * How long (in seconds) to retain events for replay.
+         *
+         * Expired events are cleaned up lazily for performance reasons, so
+         * some events may remain available slightly longer than this period.
+         *
+         * @default 300 (5 min)
+         */
+        seconds?: number;
+    };
+}
+declare class BunRedisPublisher<T extends Record<string, object>> extends Publisher<T> {
+    private readonly redis;
+    private subscriber;
+    private readonly prefix;
+    private readonly serializer;
+    private readonly replayEnabled;
+    private readonly replaySeconds;
+    /**
+     * The exactness of the `XTRIM` command.
+     * Used for testing purpose.
+     */
+    private readonly xTrimExactness;
+    constructor(redis: RedisClient, options?: BunRedisPublisherOptions);
+    private readonly firstPublishTimeMap;
+    publish<K extends keyof T & string>(event: K, payload: T[K]): Promise<void>;
+    protected subscribeListener<K extends keyof T & string>(event: K, originalListener: (payload: T[K]) => void, { lastEventId, onError }?: PublisherSubscribeListenerOptions): Promise<() => Promise<void>>;
+    private serializePayload;
+    private deserializePayload;
+}
 
 interface BunRedisRateLimiterOptions {
     /**
@@ -38,5 +109,5 @@ declare class BunRedisRateLimiter implements RateLimiter {
     private resolveWeight;
 }
 
-export { BunRedisRateLimiter };
-export type { BunRedisRateLimiterOptions };
+export { BunRedisPublisher, BunRedisRateLimiter };
+export type { BunRedisPublisherOptions, BunRedisRateLimiterOptions };

package/dist/index.mjs

@@ -1,4 +1,125 @@
-import { sleep } from '@orpc/shared';
+import { RPCSerializer } from '@orpc/client';
+import { Publisher } from '@orpc/publisher';
+import { stringifyJSON, parseEmptyableJSON, once, sleep } from '@orpc/shared';
+import { unwrapEvent, withEventMeta, getEventMeta } from '@standardserver/core';
+
+class BunRedisPublisher extends Publisher {
+  constructor(redis, options = {}) {
+    super(options);
+    this.redis = redis;
+    this.prefix = options.prefix ?? "";
+    this.serializer = options.serializer ?? new RPCSerializer();
+    this.replayEnabled = options.replay?.enabled ?? false;
+    this.replaySeconds = options.replay?.seconds ?? 300;
+    this.subscriber = options.subscriber;
+  }
+  subscriber;
+  prefix;
+  serializer;
+  replayEnabled;
+  replaySeconds;
+  /**
+   * The exactness of the `XTRIM` command.
+   * Used for testing purpose.
+   */
+  xTrimExactness = "~";
+  firstPublishTimeMap = /* @__PURE__ */ new Map();
+  async publish(event, payload) {
+    const redisKey = `${this.prefix}${event}`;
+    const data = this.serializePayload(payload);
+    let id;
+    if (this.replayEnabled) {
+      const now = Date.now();
+      for (const [event2, firstPublishTime] of this.firstPublishTimeMap) {
+        if (firstPublishTime + this.replaySeconds * 1e3 < now) {
+          this.firstPublishTimeMap.delete(event2);
+        }
+      }
+      if (!this.firstPublishTimeMap.has(event)) {
+        this.firstPublishTimeMap.set(event, now);
+        const result = await Promise.all([
+          this.redis.send("XADD", [redisKey, "*", "data", stringifyJSON(data)]),
+          this.redis.send("XTRIM", [redisKey, "MINID", this.xTrimExactness, `${now - this.replaySeconds * 1e3}-0`]),
+          // Use a 2x TTL so events published near the end of the replay window
+          // are not expired before the next window updates the key expiration.
+          this.redis.expire(redisKey, this.replaySeconds * 2)
+        ]);
+        id = result[0];
+      } else {
+        id = await this.redis.send("XADD", [redisKey, "*", "data", stringifyJSON(data)]);
+      }
+    }
+    await this.redis.publish(redisKey, stringifyJSON({ data, id }));
+  }
+  async subscribeListener(event, originalListener, { lastEventId, onError } = {}) {
+    const redisKey = `${this.prefix}${event}`;
+    let pendingPayloads = [];
+    const replayedIds = /* @__PURE__ */ new Set();
+    const deduplicatingListener = (payload) => {
+      if (pendingPayloads) {
+        pendingPayloads.push(payload);
+        return;
+      }
+      const id = getEventMeta(payload)?.id;
+      if (id !== void 0 && replayedIds.has(id)) {
+        return;
+      }
+      originalListener(payload);
+    };
+    const redisListener = (message) => {
+      try {
+        const { id, data } = parseEmptyableJSON(message);
+        const payload = this.deserializePayload(id, data);
+        deduplicatingListener(payload);
+      } catch (error) {
+        onError?.(error);
+      }
+    };
+    this.subscriber ??= this.redis.duplicate();
+    const subscriber = await this.subscriber;
+    try {
+      const subscribePromise = subscriber.subscribe(redisKey, redisListener);
+      try {
+        if (this.replayEnabled && lastEventId !== void 0) {
+          const results = await this.redis.send("XREAD", ["STREAMS", redisKey, lastEventId]);
+          if (results && results[redisKey]) {
+            const messages = results[redisKey];
+            for (const [id, message] of messages) {
+              const rawData = message[1];
+              const data = parseEmptyableJSON(rawData);
+              const payload = this.deserializePayload(id, data);
+              replayedIds.add(id);
+              originalListener(payload);
+            }
+          }
+        }
+      } finally {
+        const pending = pendingPayloads;
+        pendingPayloads = void 0;
+        for (const payload of pending) {
+          deduplicatingListener(payload);
+        }
+      }
+      await subscribePromise;
+    } catch (error) {
+      await subscriber.unsubscribe(redisKey, redisListener);
+      throw error;
+    }
+    return once(async () => {
+      await subscriber.unsubscribe(redisKey, redisListener);
+    });
+  }
+  serializePayload(payload) {
+    const [original, meta] = unwrapEvent(payload);
+    return { payload: this.serializer.serialize(original, { useFormDataForBlobFields: false }), meta };
+  }
+  deserializePayload(id, { payload, meta }) {
+    return withEventMeta(
+      this.serializer.deserialize(payload),
+      id === void 0 ? { ...meta } : { ...meta, id }
+    );
+  }
+}
 
 const FIXED_WINDOW_RATELIMIT_SCRIPT = `
 local key = KEYS[1]
@@ -88,4 +209,4 @@ class BunRedisRateLimiter {
   }
 }
 
-export { BunRedisRateLimiter };
+export { BunRedisPublisher, BunRedisRateLimiter };

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@orpc/bun",
   "type": "module",
-  "version": "0.0.0",
+  "version": "2.0.0-beta.8",
   "license": "MIT",
   "homepage": "https://orpc.dev",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/middleapi/orpc-bun.git",
+    "url": "git+https://github.com/middleapi/orpc.git",
     "directory": "packages/bun"
   },
   "sideEffects": false,
@@ -22,16 +22,21 @@
     "dist"
   ],
   "dependencies": {
-    "@orpc/publisher": "^2.0.0-beta.6",
-    "@orpc/ratelimit": "^2.0.0-beta.6",
-    "@orpc/server": "^2.0.0-beta.6",
-    "@orpc/shared": "^2.0.0-beta.6"
+    "@standardserver/core": "^0.0.25",
+    "@orpc/client": "2.0.0-beta.8",
+    "@orpc/publisher": "2.0.0-beta.8",
+    "@orpc/ratelimit": "2.0.0-beta.8",
+    "@orpc/server": "2.0.0-beta.8",
+    "@orpc/shared": "2.0.0-beta.8"
   },
   "devDependencies": {
+    "@types/bun": "^1.3.14",
     "redis": "^6.0.1"
   },
   "scripts": {
     "build": "unbuild",
-    "type:check": "tsc -b"
+    "type:check": "tsc -b",
+    "test": "bun --env-file=../../.env test",
+    "test:coverage": "bun --env-file=../../.env test --coverage"
   }
 }