@synnaxlabs/freighter 0.9.3 → 0.10.0

package/dist/http.d.ts

@@ -1,7 +1,8 @@
-import { type URL, type binary } from "@synnaxlabs/x";
-import { type z } from "zod";
+import { UnaryClient } from './unary';
 import { MiddlewareCollector } from './middleware';
-import { type UnaryClient } from './unary';
+import { z } from 'zod';
+import { URL, binary } from '@synnaxlabs/x';
+
 export declare const CONTENT_TYPE_HEADER_KEY = "Content-Type";
 /**
  * HTTPClientFactory provides a POST and GET implementation of the Unary
@@ -18,3 +19,4 @@ export declare class HTTPClient extends MiddlewareCollector implements UnaryClie
     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]>;
 }
+//# sourceMappingURL=http.d.ts.map

package/dist/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../src/http.ts"],"names":[],"mappings":"AAmBA,OAAO,EAAW,KAAK,GAAG,EAAE,KAAK,MAAM,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,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"}

package/dist/http.spec.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=http.spec.d.ts.map

package/dist/http.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.spec.d.ts","sourceRoot":"","sources":["../src/http.spec.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 export { BaseTypedError, decodeError, encodeError, EOF, errorZ, registerError, StreamClosed, Unreachable, } from './errors';
-export type { ErrorPayload as ErrorPayload, TypedError } from './errors';
+export type { ErrorPayload, TypedError } from './errors';
 export { HTTPClient } from './http';
-export type { Context as MetaData, Middleware, Next } from './middleware';
+export type { Context, Middleware, Next } from './middleware';
 export type { Stream, StreamClient } from './stream';
 export type { UnaryClient } from './unary';
 export { sendRequired } from './unary';
 export { WebSocketClient } from './websocket';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AASA,OAAO,EACL,cAAc,EACd,WAAW,EACX,WAAW,EACX,GAAG,EACH,MAAM,EACN,aAAa,EACb,YAAY,EACZ,WAAW,GACZ,MAAM,UAAU,CAAC;AAClB,YAAY,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACzD,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"}

package/dist/middleware.d.ts

@@ -46,3 +46,4 @@ export declare class MiddlewareCollector {
     executeMiddleware(ctx: Context, finalizer: Finalizer): Promise<[Context, Error | null]>;
 }
 export {};
+//# sourceMappingURL=middleware.d.ts.map

package/dist/middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../src/middleware.ts"],"names":[],"mappings":"AASA;;;;;;;GAOG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,IAAI,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC;AAED,eAAO,MAAM,KAAK,+BAAgC,CAAC;AACnD,MAAM,MAAM,IAAI,GAAG,CAAC,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC;AAE1C,sDAAsD;AACtD,MAAM,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;AAEtE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,KAAK,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;AAExF;;;GAGG;AACH,KAAK,SAAS,GAAG,CAAC,GAAG,EAAE,OAAO,KAAK,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;AAEpE;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B,UAAU,EAAE,UAAU,EAAE,CAAM;IAE9B,yCAAyC;IACzC,GAAG,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,GAAG,IAAI;IAI9B;;;;;;;;OAQG;IACG,iBAAiB,CACrB,GAAG,EAAE,OAAO,EACZ,SAAS,EAAE,SAAS,GACnB,OAAO,CAAC,CAAC,OAAO,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;CAUpC"}

package/dist/stream.d.ts

@@ -1,5 +1,6 @@
-import { type z } from "zod";
-import { type Transport } from './transport';
+import { Transport } from './transport';
+import { z } from 'zod';
+
 /**
  * Interface for an entity that receives a stream of responses.
  */
@@ -74,3 +75,4 @@ export interface StreamClient extends Transport {
      */
     stream: <RQ extends z.ZodTypeAny, RS extends z.ZodTypeAny = RQ>(target: string, reqSchema: RQ, resSchema: RS) => Promise<Stream<RQ, RS>>;
 }
+//# sourceMappingURL=stream.d.ts.map

package/dist/stream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,CAAC;AAE7B,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,WAAW,cAAc,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU;IACrD;;;;;;;;OAQG;IACH,OAAO,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IAE7D;;OAEG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU;IACnD;;;;;;;;;;MAUE;IACF,IAAI,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,KAAK,GAAG,IAAI,CAAC;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,CAAE,SAAQ,YAAY,CAAC,EAAE,CAAC;IACnF;;;;;;;;OAQG;IACH,SAAS,EAAE,MAAM,IAAI,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,CAC3E,SAAQ,kBAAkB,CAAC,EAAE,CAAC,EAC5B,cAAc,CAAC,EAAE,CAAC;CAAG;AAEzB;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,SAAS;IAC7C;;;;;;;;;;OAUG;IACH,MAAM,EAAE,CAAC,EAAE,SAAS,CAAC,CAAC,UAAU,EAAE,EAAE,SAAS,CAAC,CAAC,UAAU,GAAG,EAAE,EAC5D,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,EAAE,EACb,SAAS,EAAE,EAAE,KACV,OAAO,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;CAC9B"}

package/dist/transport.d.ts

@@ -1,4 +1,5 @@
-import { type Middleware } from './middleware';
+import { Middleware } from './middleware';
+
 /**
  * Transport is a based interface that represents a general transport for
  * exchanging messages between a client and a server.
@@ -11,3 +12,4 @@ export interface Transport {
      */
     use: (...mw: Middleware[]) => void;
 }
+//# sourceMappingURL=transport.d.ts.map

package/dist/transport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../src/transport.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,KAAK,IAAI,CAAC;CACpC"}

package/dist/unary.d.ts

@@ -1,5 +1,6 @@
-import { type z } from "zod";
-import { type Transport } from './transport';
+import { Transport } from './transport';
+import { z } from 'zod';
+
 /**
  * An interface for an entity that implements a simple request-response
  * transport between two entities.
@@ -14,3 +15,4 @@ 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 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

@@ -0,0 +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"}

package/dist/websocket.d.ts

@@ -1,7 +1,8 @@
-import { type URL, type binary } from "@synnaxlabs/x";
-import { z } from "zod";
+import { Stream, StreamClient } from './stream';
 import { MiddlewareCollector } from './middleware';
-import type { Stream, StreamClient } from './stream';
+import { z } from 'zod';
+import { URL, binary } from '@synnaxlabs/x';
+
 export declare const FREIGHTER_METADATA_PREFIX = "freighterctx";
 /**
  * WebSocketClient is an implementation of StreamClient that is backed by
@@ -22,3 +23,4 @@ export declare class WebSocketClient extends MiddlewareCollector implements Stre
     private buildURL;
     private wrapSocket;
 }
+//# sourceMappingURL=websocket.d.ts.map

package/dist/websocket.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../src/websocket.ts"],"names":[],"mappings":"AASA,OAAO,EAAW,KAAK,GAAG,EAAoB,KAAK,MAAM,EAAE,MAAM,eAAe,CAAC;AACjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,OAAO,EAAE,mBAAmB,EAAgB,MAAM,cAAc,CAAC;AACjE,OAAO,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AA4GrD,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"}

package/dist/websocket.spec.d.ts

@@ -1 +1,2 @@
 export {};
+//# sourceMappingURL=websocket.spec.d.ts.map

package/dist/websocket.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocket.spec.d.ts","sourceRoot":"","sources":["../src/websocket.spec.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@synnaxlabs/freighter",
   "private": false,
-  "version": "0.9.3",
+  "version": "0.10.0",
   "type": "module",
   "description": "a modular transport abstraction",
   "repository": "https://github.com/synnaxlabs/synnax/tree/main/freighter/ts",
@@ -20,18 +20,18 @@
   },
   "dependencies": {
     "js-convert-case": "^4.2.0",
-    "node-fetch": "2.6.11",
-    "ws": "^8.15.1",
+    "node-fetch": "3.3.2",
+    "ws": "^8.16.0",
     "zod": "3.22.4",
-    "@synnaxlabs/x": "0.15.0",
-    "@synnaxlabs/alamos": "0.3.0"
+    "@synnaxlabs/alamos": "0.3.0",
+    "@synnaxlabs/x": "0.16.0"
   },
   "devDependencies": {
-    "@types/node": "^20.10.5",
-    "@vitest/coverage-v8": "^1.2.2",
-    "typescript": "^5.3.3",
-    "vite": "^5.1.2",
-    "vitest": "^1.2.2",
+    "@types/node": "^20.12.7",
+    "@vitest/coverage-v8": "^1.5.0",
+    "typescript": "^5.4.5",
+    "vite": "5.2.8",
+    "vitest": "^1.5.0",
     "@synnaxlabs/tsconfig": "0.0.2",
     "@synnaxlabs/vite-plugin": "0.0.1",
     "eslint-config-synnaxlabs": "0.0.1"

package/src/errors.spec.ts

@@ -85,7 +85,7 @@ describe("errors", () => {
   test("encoding and decoding freighter errors", () => {
     [new EOF(), new StreamClosed(), new Unreachable()].forEach((error) => {
       const encoded = encodeError(error);
-      expect(encoded.type).toEqual(FREIGHTER);
+      expect(encoded.type.startsWith(FREIGHTER)).toBeTruthy();
       expect(encoded.data).toEqual(error.message);
       const decoded = decodeError(encoded);
       expect(decoded).toEqual(error);

package/src/errors.ts

@@ -143,8 +143,12 @@ export class UnknownError extends BaseTypedError implements TypedError {
   }
 }
 
+const FREIGHTER_ERROR_TYPE = "freighter.";
+
 /** Thrown/returned when a stream closed normally. */
 export class EOF extends BaseTypedError implements TypedError {
+  static readonly TYPE = FREIGHTER_ERROR_TYPE + "eof";
+
   constructor() {
     super("EOF", FREIGHTER);
   }
@@ -152,6 +156,8 @@ export class EOF extends BaseTypedError implements TypedError {
 
 /** Thrown/returned when a stream is closed abnormally. */
 export class StreamClosed extends BaseTypedError implements TypedError {
+  static readonly TYPE = FREIGHTER_ERROR_TYPE + "stream_closed";
+
   constructor() {
     super("StreamClosed", FREIGHTER);
   }
@@ -164,6 +170,7 @@ export interface UnreachableArgs {
 
 /** Thrown when a target is unreachable. */
 export class Unreachable extends BaseTypedError implements TypedError {
+  static readonly TYPE = FREIGHTER_ERROR_TYPE + "unreachable";
   url: URL;
 
   constructor(args: UnreachableArgs = {}) {
@@ -173,26 +180,24 @@ export class Unreachable extends BaseTypedError implements TypedError {
   }
 }
 
-const FREIGHTER_ERROR_TYPE = "freighter";
-
 const freighterErrorEncoder: ErrorEncoder = (error: TypedError) => {
   if (error.type !== FREIGHTER) return null;
-  if (error instanceof EOF) return { type: FREIGHTER_ERROR_TYPE, data: "EOF" };
+  if (error instanceof EOF) return { type: EOF.TYPE, data: "EOF" };
   if (error instanceof StreamClosed)
-    return { type: FREIGHTER_ERROR_TYPE, data: "StreamClosed" };
+    return { type: StreamClosed.TYPE, data: "StreamClosed" };
   if (error instanceof Unreachable)
-    return { type: FREIGHTER_ERROR_TYPE, data: "Unreachable" };
+    return { type: Unreachable.TYPE, data: "Unreachable" };
   throw new Error(`Unknown error type: ${error.type}: ${error.message}`);
 };
 
 const freighterErrorDecoder: ErrorDecoder = (encoded: ErrorPayload) => {
-  if (encoded.type !== FREIGHTER_ERROR_TYPE) return null;
-  switch (encoded.data) {
-    case "EOF":
+  if (!encoded.type.startsWith(FREIGHTER_ERROR_TYPE)) return null;
+  switch (encoded.type) {
+    case EOF.TYPE:
       return new EOF();
-    case "StreamClosed":
+    case StreamClosed.TYPE:
       return new StreamClosed();
-    case "Unreachable":
+    case Unreachable.TYPE:
       return new Unreachable();
     default:
       throw new Error(`Unknown error type: ${encoded.data}`);

package/src/index.ts

@@ -17,9 +17,9 @@ export {
   StreamClosed,
   Unreachable,
 } from "@/errors";
-export type { ErrorPayload as ErrorPayload, TypedError } from "@/errors";
+export type { ErrorPayload, TypedError } from "@/errors";
 export { HTTPClient } from "@/http";
-export type { Context as MetaData, Middleware, Next } from "@/middleware";
+export type { Context, Middleware, Next } from "@/middleware";
 export type { Stream, StreamClient } from "@/stream";
 export type { UnaryClient } from "@/unary";
 export { sendRequired } from "@/unary";

package/src/unary.ts

@@ -25,7 +25,7 @@ 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 ,
+    reqSchema: RQ,
     resSchema: RS,
   ) => Promise<[z.output<RS>, null] | [null, Error]>;
 }