@synnaxlabs/freighter 0.24.0 → 0.26.0

package/dist/http.d.ts

@@ -1,7 +1,7 @@
-import { UnaryClient } from './unary';
-import { MiddlewareCollector } from './middleware';
-import { z } from 'zod';
 import { binary, URL } from '@synnaxlabs/x';
+import { z } from 'zod';
+import { MiddlewareCollector } from './middleware';
+import { UnaryClient } from './unary';
 
 export declare const CONTENT_TYPE_HEADER_KEY = "Content-Type";
 /**
@@ -13,9 +13,9 @@ export declare const CONTENT_TYPE_HEADER_KEY = "Content-Type";
  */
 export declare class HTTPClient extends MiddlewareCollector implements UnaryClient {
     endpoint: URL;
-    encoder: binary.EncoderDecoder;
+    encoder: binary.Codec;
     fetch: typeof fetch;
-    constructor(endpoint: URL, encoder: binary.EncoderDecoder, secure?: boolean);
+    constructor(endpoint: URL, encoder: binary.Codec, secure?: boolean);
     get headers(): Record<string, string>;
     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, Error | null]>;
 }

package/dist/http.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,KAAK,MAAM,EAAU,KAAK,GAAG,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B,OAAO,EAAgB,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,eAAO,MAAM,uBAAuB,iBAAiB,CAAC;AAYtD;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,mBAAoB,YAAW,WAAW;IACxE,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,MAAM,CAAC,cAAc,CAAC;IAC/B,KAAK,EAAE,OAAO,KAAK,CAAC;gBAER,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,GAAE,OAAe;IAclF,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAIpC;IAEK,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,EAC9D,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,GACZ,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;CAuDhD"}
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAE,KAAK,MAAM,EAAW,KAAK,GAAG,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAG7B,OAAO,EAAgB,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACjE,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,SAAS,CAAC;AAE3C,eAAO,MAAM,uBAAuB,iBAAiB,CAAC;AAYtD;;;;;;GAMG;AACH,qBAAa,UAAW,SAAQ,mBAAoB,YAAW,WAAW;IACxE,QAAQ,EAAE,GAAG,CAAC;IACd,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC;IACtB,KAAK,EAAE,OAAO,KAAK,CAAC;gBAER,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAE,OAAe;IAczE,IAAI,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAIpC;IAEK,IAAI,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,EAC9D,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,GACZ,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;CAuDhD"}

package/dist/stream.d.ts

@@ -1,5 +1,5 @@
-import { Transport } from './transport';
 import { z } from 'zod';
+import { Transport } from './transport';
 
 /**
  * Interface for an entity that receives a stream of responses.

package/dist/unary.d.ts

@@ -1,5 +1,5 @@
-import { Transport } from './transport';
 import { z } from 'zod';
+import { Transport } from './transport';
 
 /**
  * An interface for an entity that implements a simple request-response

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,kEAIf,WAAW,UACX,MAAM,OACT,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,CAAC,aACpB,EAAE,aACF,EAAE,KACZ,QAAQ,EAAE,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;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"}

package/dist/websocket.d.ts

@@ -1,7 +1,7 @@
-import { Stream, StreamClient } from './stream';
-import { MiddlewareCollector } from './middleware';
-import { z } from 'zod';
 import { binary, URL } from '@synnaxlabs/x';
+import { z } from 'zod';
+import { MiddlewareCollector } from './middleware';
+import { Stream, StreamClient } from './stream';
 
 export declare const FREIGHTER_METADATA_PREFIX = "freighterctx";
 /**
@@ -10,14 +10,14 @@ export declare const FREIGHTER_METADATA_PREFIX = "freighterctx";
  */
 export declare class WebSocketClient extends MiddlewareCollector implements StreamClient {
     baseUrl: URL;
-    encoder: binary.EncoderDecoder;
+    encoder: binary.Codec;
     static readonly MESSAGE_TYPE = "arraybuffer";
     /**
      * @param encoder - The encoder to use for encoding messages and decoding
      *   responses.
      * @param baseEndpoint - A base url to use as a prefix for all requests.
      */
-    constructor(baseEndpoint: URL, encoder: binary.EncoderDecoder, secure?: boolean);
+    constructor(baseEndpoint: URL, encoder: binary.Codec, secure?: boolean);
     /** Implements the StreamClient interface. */
     stream<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>(target: string, reqSchema: RQ, resSchema: RS): Promise<Stream<RQ, RS>>;
     private buildURL;

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,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AAgHrD,eAAO,MAAM,yBAAyB,iBAAiB,CAAC;AAQxD;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,mBAAoB,YAAW,YAAY;IAC9E,OAAO,EAAE,GAAG,CAAC;IACb,OAAO,EAAE,MAAM,CAAC,cAAc,CAAC;IAE/B,MAAM,CAAC,QAAQ,CAAC,YAAY,iBAAiB;IAE7C;;;;OAIG;gBACS,YAAY,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,MAAM,UAAQ;IAM7E,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,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AA2GrD,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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synnaxlabs/freighter",
-  "version": "0.24.0",
+  "version": "0.26.0",
   "type": "module",
   "description": "a modular transport abstraction",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/freighter/ts",
@@ -17,8 +17,8 @@
     "node-fetch": "2.6.11",
     "ws": "^8.17.0",
     "zod": "3.23.8",
-    "@synnaxlabs/alamos": "0.24.0",
-    "@synnaxlabs/x": "0.24.0"
+    "@synnaxlabs/alamos": "0.26.0",
+    "@synnaxlabs/x": "0.26.0"
   },
   "devDependencies": {
     "@types/node": "^20.12.7",
@@ -26,8 +26,8 @@
     "typescript": "^5.4.5",
     "vite": "5.2.11",
     "vitest": "^1.5.0",
-    "@synnaxlabs/tsconfig": "0.0.2",
     "@synnaxlabs/vite-plugin": "0.0.1",
+    "@synnaxlabs/tsconfig": "0.0.2",
     "eslint-config-synnaxlabs": "0.0.1"
   },
   "peerDependencies": {

package/src/http.spec.ts

@@ -7,7 +7,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { binary,URL } from "@synnaxlabs/x";
+import { binary, URL } from "@synnaxlabs/x";
 import { describe, expect, test } from "vitest";
 import { z } from "zod";
 
@@ -20,7 +20,7 @@ const ENDPOINT = new URL({
   pathPrefix: "unary",
 });
 
-const client = new HTTPClient(ENDPOINT, new binary.JSONEncoderDecoder());
+const client = new HTTPClient(ENDPOINT, new binary.JSONCodec());
 
 const messageZ = z.object({
   id: z.number().optional(),

package/src/http.ts

@@ -17,7 +17,7 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-import { type binary,runtime, type URL } from "@synnaxlabs/x";
+import { type binary, runtime, type URL } from "@synnaxlabs/x";
 import { type z } from "zod";
 
 import { decodeError, errorZ, Unreachable } from "@/errors";
@@ -45,10 +45,10 @@ const resolveFetchAPI = (protocol: "http" | "https"): typeof fetch => {
  */
 export class HTTPClient extends MiddlewareCollector implements UnaryClient {
   endpoint: URL;
-  encoder: binary.EncoderDecoder;
+  encoder: binary.Codec;
   fetch: typeof fetch;
 
-  constructor(endpoint: URL, encoder: binary.EncoderDecoder, secure: boolean = false) {
+  constructor(endpoint: URL, encoder: binary.Codec, secure: boolean = false) {
     super();
     this.endpoint = endpoint.replace({ protocol: secure ? "https" : "http" });
     this.encoder = encoder;
@@ -74,7 +74,7 @@ export class HTTPClient extends MiddlewareCollector implements UnaryClient {
     reqSchema: RQ,
     resSchema: RS,
   ): Promise<[z.output<RS> | null, Error | null]> {
-    req = reqSchema?.parse(req)
+    req = reqSchema?.parse(req);
     let res: RS | null = null;
     const url = this.endpoint.child(target);
     const request: RequestInit = {};

package/src/websocket.spec.ts

@@ -31,7 +31,7 @@ const MessageSchema = z.object({
   message: z.string().optional(),
 });
 
-const client = new WebSocketClient(url, new binary.JSONEncoderDecoder());
+const client = new WebSocketClient(url, new binary.JSONCodec());
 
 class MyCustomError extends BaseTypedError {
   code: number;
@@ -105,7 +105,7 @@ describe("websocket", () => {
   });
 
   test("middleware", async () => {
-    const myClient = new WebSocketClient(url, new binary.JSONEncoderDecoder());
+    const myClient = new WebSocketClient(url, new binary.JSONCodec());
     let c = 0;
     myClient.use(async (md, next): Promise<[Context, Error | null]> => {
       if (md.params !== undefined) {

package/src/websocket.ts

@@ -38,7 +38,7 @@ type ReceiveCallbacksQueue = Array<{
 class WebSocketStream<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>
   implements Stream<RQ, RS>
 {
-  private readonly encoder: binary.EncoderDecoder;
+  private readonly encoder: binary.Codec;
   private readonly reqSchema: RQ;
   private readonly resSchema: RS;
   private readonly ws: WebSocket;
@@ -47,12 +47,7 @@ class WebSocketStream<RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>
   private readonly receiveDataQueue: Message[] = [];
   private readonly receiveCallbacksQueue: ReceiveCallbacksQueue = [];
 
-  constructor(
-    ws: WebSocket,
-    encoder: binary.EncoderDecoder,
-    reqSchema: RQ,
-    resSchema: RS,
-  ) {
+  constructor(ws: WebSocket, encoder: binary.Codec, reqSchema: RQ, resSchema: RS) {
     this.encoder = encoder;
     this.reqSchema = reqSchema;
     this.resSchema = resSchema;
@@ -139,7 +134,7 @@ const isNormalClosure = (ev: CloseEvent): boolean => NORMAL_CLOSURES.includes(ev
  */
 export class WebSocketClient extends MiddlewareCollector implements StreamClient {
   baseUrl: URL;
-  encoder: binary.EncoderDecoder;
+  encoder: binary.Codec;
 
   static readonly MESSAGE_TYPE = "arraybuffer";
 
@@ -148,7 +143,7 @@ export class WebSocketClient extends MiddlewareCollector implements StreamClient
    *   responses.
    * @param baseEndpoint - A base url to use as a prefix for all requests.
    */
-  constructor(baseEndpoint: URL, encoder: binary.EncoderDecoder, secure = false) {
+  constructor(baseEndpoint: URL, encoder: binary.Codec, secure = false) {
     super();
     this.baseUrl = baseEndpoint.replace({ protocol: secure ? "wss" : "ws" });
     this.encoder = encoder;