@synnaxlabs/freighter 0.35.0 → 0.36.0

package/dist/index.d.ts

@@ -4,6 +4,6 @@ export { HTTPClient } from './http';
 export type { Context, Middleware, Next } from './middleware';
 export type { Stream, StreamClient } from './stream';
 export type { UnaryClient } from './unary';
-export { sendRequired } from './unary';
+export { sendRequired, unaryWithBreaker } from './unary';
 export { WebSocketClient } from './websocket';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EACL,cAAc,EACd,WAAW,EACX,WAAW,EACX,GAAG,EACH,YAAY,EACZ,MAAM,EACN,aAAa,EACb,YAAY,EACZ,WAAW,GACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAC9D,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACrD,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,YAAY,EAAE,YAAY,EAAE,kBAAkB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAC7E,OAAO,EACL,cAAc,EACd,WAAW,EACX,WAAW,EACX,GAAG,EACH,YAAY,EACZ,MAAM,EACN,aAAa,EACb,YAAY,EACZ,WAAW,GACZ,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAC9D,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACrD,YAAY,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}

package/dist/unary.d.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod';
 import { Transport } from './transport';
+import { breaker } from '@synnaxlabs/x';
 /**
  * An interface for an entity that implements a simple request-response
  * transport between two entities.
@@ -13,5 +14,6 @@ export interface UnaryClient extends Transport {
      */
     send: <RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>(target: string, req: z.input<RQ> | z.output<RQ>, reqSchema: RQ, resSchema: RS) => Promise<[z.output<RS>, null] | [null, Error]>;
 }
+export declare const unaryWithBreaker: (base: UnaryClient, cfg: breaker.Config) => UnaryClient;
 export declare const sendRequired: <RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>(client: UnaryClient, target: string, req: z.input<RQ> | z.output<RQ>, reqSchema: RQ, resSchema: RS) => Promise<z.output<RS>>;
 //# sourceMappingURL=unary.d.ts.map

package/dist/unary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unary.d.ts","sourceRoot":"","sources":["../src/unary.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C;;;;;OAKG;IACH,IAAI,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,EAC1D,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAC/B,SAAS,EAAE,EAAE,EACb,SAAS,EAAE,EAAE,KACV,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;CACpD;AAED,eAAO,MAAM,YAAY,GACvB,EAAE,SAAS,CAAC,CAAC,UAAU,EACvB,EAAE,SAAS,CAAC,CAAC,UAAU,eAEf,WAAW,UACX,MAAM,OACT,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,aACpB,EAAE,aACF,EAAE,KACZ,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAItB,CAAC"}
+{"version":3,"file":"unary.d.ts","sourceRoot":"","sources":["../src/unary.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAIxC;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C;;;;;OAKG;IACH,IAAI,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,EAC1D,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAC/B,SAAS,EAAE,EAAE,EACb,SAAS,EAAE,EAAE,KACV,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;CACpD;AAED,eAAO,MAAM,gBAAgB,SACrB,WAAW,OACZ,OAAO,CAAC,MAAM,KAClB,WA2BF,CAAC;AAEF,eAAO,MAAM,YAAY,GACvB,EAAE,SAAS,CAAC,CAAC,UAAU,EACvB,EAAE,SAAS,CAAC,CAAC,UAAU,eAEf,WAAW,UACX,MAAM,OACT,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,aACpB,EAAE,aACF,EAAE,KACZ,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAItB,CAAC"}

package/dist/websocket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../src/websocket.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,MAAM,EAA6B,KAAK,GAAG,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAgB,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AA2G1D,eAAO,MAAM,yBAAyB,iBAAiB,CAAC;AAQxD;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,mBAAoB,YAAW,YAAY;IAC9E,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;IAEtB,MAAM,CAAC,QAAQ,CAAC,YAAY,iBAAiB;IAE7C;;;;OAIG;gBACS,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,UAAQ;IAMpE,6CAA6C;IACvC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,EAChE,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,EAAE,EACb,SAAS,EAAE,EAAE,GACZ,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAmB1B,OAAO,CAAC,QAAQ;YAWF,UAAU;CAezB"}
+{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../src/websocket.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,MAAM,EAA6B,KAAK,GAAG,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAgB,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,KAAK,MAAM,EAAE,KAAK,YAAY,EAAE,MAAM,UAAU,CAAC;AAoH1D,eAAO,MAAM,yBAAyB,iBAAiB,CAAC;AAQxD;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,mBAAoB,YAAW,YAAY;IAC9E,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;IAEtB,MAAM,CAAC,QAAQ,CAAC,YAAY,iBAAiB;IAE7C;;;;OAIG;gBACS,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,UAAQ;IAMpE,6CAA6C;IACvC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,EAChE,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,EAAE,EACb,SAAS,EAAE,EAAE,GACZ,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAmB1B,OAAO,CAAC,QAAQ;YAWF,UAAU;CAsBzB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synnaxlabs/freighter",
-  "version": "0.35.0",
+  "version": "0.36.0",
   "type": "module",
   "description": "a modular transport abstraction",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/freighter/ts",
@@ -16,19 +16,19 @@
   "dependencies": {
     "node-fetch": "^2.7.0",
     "ws": "^8.18.0",
-    "zod": "^3.23.8",
-    "@synnaxlabs/x": "0.35.0",
-    "@synnaxlabs/alamos": "0.35.0"
+    "zod": "^3.24.1",
+    "@synnaxlabs/alamos": "0.36.0",
+    "@synnaxlabs/x": "0.36.0"
   },
   "devDependencies": {
     "@types/node": "^22.7.5",
-    "@vitest/coverage-v8": "^2.1.4",
-    "eslint": "^9.12.0",
+    "@vitest/coverage-v8": "^2.1.8",
+    "eslint": "^9.16.0",
     "typescript": "^5.6.3",
-    "vite": "^5.4.10",
-    "vitest": "^2.1.4",
-    "@synnaxlabs/vite-plugin": "0.0.1",
+    "vite": "^6.0.3",
+    "vitest": "^2.1.8",
     "@synnaxlabs/tsconfig": "0.0.2",
+    "@synnaxlabs/vite-plugin": "0.0.1",
     "eslint-config-synnaxlabs": "0.0.1"
   },
   "main": "dist/freighter.cjs",

package/src/index.ts

@@ -23,5 +23,5 @@ export { HTTPClient } from "@/http";
 export type { Context, Middleware, Next } from "@/middleware";
 export type { Stream, StreamClient } from "@/stream";
 export type { UnaryClient } from "@/unary";
-export { sendRequired } from "@/unary";
+export { sendRequired, unaryWithBreaker } from "@/unary";
 export { WebSocketClient } from "@/websocket";

package/src/unary.ts

@@ -10,6 +10,9 @@
 import { type z } from "zod";
 
 import { type Transport } from "@/transport";
+import { breaker } from "@synnaxlabs/x";
+import { Middleware } from "@/middleware";
+import { Unreachable } from "@/errors";
 
 /**
  * An interface for an entity that implements a simple request-response
@@ -30,6 +33,38 @@ export interface UnaryClient extends Transport {
   ) => Promise<[z.output<RS>, null] | [null, Error]>;
 }
 
+export const unaryWithBreaker = (
+  base: UnaryClient,
+  cfg: breaker.Config,
+): UnaryClient => {
+  class WithBreaker implements UnaryClient {
+    readonly wrapped: UnaryClient;
+
+    constructor(wrapper: UnaryClient) {
+      this.wrapped = wrapper;
+    }
+
+    use(...mw: Middleware[]) {
+      this.wrapped.use(...mw);
+    }
+
+    async send<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>(
+      target: string,
+      req: z.input<RQ> | z.output<RQ>,
+      reqSchema: RQ,
+      resSchema: RS,
+    ): Promise<[z.output<RS>, null] | [null, Error]> {
+      const brk = breaker.create(cfg);
+      do {
+        const [res, err] = await this.wrapped.send(target, req, reqSchema, resSchema);
+        if (err == null || !Unreachable.matches(err)) return [res, err];
+        if (!(await brk())) return [res, err];
+      } while (true);
+    }
+  }
+  return new WithBreaker(base);
+};
+
 export const sendRequired = async <
   RQ extends z.ZodTypeAny,
   RS extends z.ZodTypeAny = RQ,

package/src/websocket.spec.ts

@@ -103,17 +103,26 @@ describe("websocket", () => {
     expect(response).toBeNull();
   });
 
-  test("middleware", async () => {
-    const myClient = new WebSocketClient(url, new binary.JSONCodec());
-    let c = 0;
-    myClient.use(async (md, next): Promise<[Context, Error | null]> => {
-      if (md.params !== undefined) {
-        c++;
-        md.params.Test = "test";
-      }
-      return await next(md);
+  describe("middleware", () => {
+    test("receive middleware", async () => {
+      const myClient = new WebSocketClient(url, new binary.JSONCodec());
+      let c = 0;
+      myClient.use(async (md, next): Promise<[Context, Error | null]> => {
+        if (md.params !== undefined) {
+          c++;
+          md.params.Test = "test";
+        }
+        return await next(md);
+      });
+      await myClient.stream("stream/middlewareCheck", MessageSchema, MessageSchema);
+      expect(c).toEqual(1);
+    });
+
+    test("middleware error on server", async () => {
+      const myClient = new WebSocketClient(url, new binary.JSONCodec());
+      await expect(
+        myClient.stream("stream/middlewareCheck", MessageSchema, MessageSchema),
+      ).rejects.toThrow("test param not found");
     });
-    await myClient.stream("stream/middlewareCheck", MessageSchema, MessageSchema);
-    expect(c).toEqual(1);
   });
 });

package/src/websocket.ts

@@ -22,7 +22,7 @@ const resolveWebSocketConstructor = (): ((target: string) => WebSocket) => {
 };
 
 const MessageSchema = z.object({
-  type: z.union([z.literal("data"), z.literal("close")]),
+  type: z.union([z.literal("data"), z.literal("close"), z.literal("open")]),
   payload: z.unknown().optional(),
   error: z.optional(errorZ),
 });
@@ -57,6 +57,15 @@ class WebSocketStream<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>
     this.listenForMessages();
   }
 
+  async receiveOpenAck(): Promise<Error | null> {
+    const msg = await this.receiveMsg();
+    if (msg.type !== "open") {
+      if (msg.error == null) throw new Error("Message error must be defined");
+      return decodeError(msg.error);
+    }
+    return null;
+  }
+
   /** Implements the Stream protocol */
   send(req: z.input<RQ>): Error | null {
     if (this.serverClosed != null) return new EOF();
@@ -191,7 +200,14 @@ export class WebSocketClient extends MiddlewareCollector implements StreamClient
   ): Promise<WebSocketStream<RQ, RS> | Error> {
     return await new Promise((resolve) => {
       ws.onopen = () => {
-        resolve(new WebSocketStream<RQ, RS>(ws, this.encoder, reqSchema, resSchema));
+        const oWs = new WebSocketStream<RQ, RS>(ws, this.encoder, reqSchema, resSchema);
+        oWs
+          .receiveOpenAck()
+          .then((err) => {
+            if (err != null) resolve(err);
+            else resolve(oWs);
+          })
+          .catch((err) => resolve(err));
       };
       ws.onerror = (ev: Event) => {
         const ev_ = ev as ErrorEvent;