@synnaxlabs/freighter 0.23.0 → 0.25.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";
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export type { ErrorPayload, TypedError } from './errors';
-export { BaseTypedError, decodeError, encodeError, EOF, errorZ, registerError, StreamClosed, Unreachable, } from './errors';
+export type { ErrorPayload, MatchableErrorType, TypedError } from './errors';
+export { BaseTypedError, decodeError, encodeError, EOF, errorMatcher, errorZ, registerError, StreamClosed, Unreachable, } from './errors';
 export { HTTPClient } from './http';
 export type { Context, Middleware, Next } from './middleware';
 export type { Stream, StreamClient } from './stream';

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,UAAU,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EACL,cAAc,EACd,WAAW,EACX,WAAW,EACX,GAAG,EACH,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,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC"}

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";
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@synnaxlabs/freighter",
-  "version": "0.23.0",
+  "version": "0.25.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.23.0",
-    "@synnaxlabs/x": "0.23.0"
+    "@synnaxlabs/alamos": "0.25.0",
+    "@synnaxlabs/x": "0.25.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/errors.spec.ts

@@ -28,12 +28,14 @@ import {
 } from "@/errors";
 
 class MyCustomError extends BaseTypedError {
+  type = "MyCustomError";
   constructor(message: string) {
-    super(message, "MyCustomError");
+    super(message);
   }
 }
 
-const myCustomErrorEncoder = (error: MyCustomError): ErrorPayload => {
+const myCustomErrorEncoder = (error: MyCustomError): ErrorPayload | null => {
+  if (error.type !== "MyCustomError") return null;
   return { type: "MyCustomError", data: error.message };
 };
 

package/src/errors.ts

@@ -10,6 +10,15 @@
 import { URL } from "@synnaxlabs/x";
 import { z } from "zod";
 
+/** Basic interface for an error or error type that can be matched against a candidate error */
+export interface MatchableErrorType {
+  /**
+   * @returns a function that matches errors of the given type. Returns true if
+   * the provided instance of Error or a string message contains the provided error type.
+   */
+  matches: (e: string | Error | unknown) => boolean;
+}
+
 export interface TypedError extends Error {
   discriminator: "FreighterError";
   /**
@@ -19,13 +28,27 @@ export interface TypedError extends Error {
   type: string;
 }
 
+/**
+ * @param type - the error type to match
+ * @returns a function that matches errors of the given type. Returns true if
+ * the provided instance of Error or a string message contains the provided error type.
+ */
+export const errorMatcher =
+  (type: string) =>
+  (e: string | Error | unknown): boolean => {
+    if (e != null && typeof e === "object" && "type" in e && typeof e.type === "string")
+      return e.type.includes(type);
+    if (e instanceof Error) return e.message.includes(type);
+    if (typeof e !== "string") return false;
+    return e.includes(type);
+  };
+
 export class BaseTypedError extends Error implements TypedError {
   readonly discriminator = "FreighterError";
-  type: string;
+  type: string = "";
 
-  constructor(message: string, type: string) {
+  constructor(message?: string) {
     super(message);
-    this.type = type;
   }
 }
 
@@ -138,8 +161,9 @@ export const decodeError = (payload: ErrorPayload): Error | null => {
 };
 
 export class UnknownError extends BaseTypedError implements TypedError {
+  type = "unknown";
   constructor(message: string) {
-    super(message, UNKNOWN);
+    super(message);
   }
 }
 
@@ -148,18 +172,22 @@ 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";
+  type = EOF.TYPE;
+  static readonly matches = errorMatcher(EOF.TYPE);
 
   constructor() {
-    super("EOF", FREIGHTER);
+    super("EOF");
   }
 }
 
 /** Thrown/returned when a stream is closed abnormally. */
 export class StreamClosed extends BaseTypedError implements TypedError {
   static readonly TYPE = FREIGHTER_ERROR_TYPE + "stream_closed";
+  static readonly matches = errorMatcher(StreamClosed.TYPE);
+  type = StreamClosed.TYPE;
 
   constructor() {
-    super("StreamClosed", FREIGHTER);
+    super("StreamClosed");
   }
 }
 
@@ -171,21 +199,23 @@ export interface UnreachableArgs {
 /** Thrown when a target is unreachable. */
 export class Unreachable extends BaseTypedError implements TypedError {
   static readonly TYPE = FREIGHTER_ERROR_TYPE + "unreachable";
+  type = Unreachable.TYPE;
+  static readonly matches = errorMatcher(Unreachable.TYPE);
   url: URL;
 
   constructor(args: UnreachableArgs = {}) {
     const { message = "Unreachable", url = URL.UNKNOWN } = args;
-    super(message, FREIGHTER);
+    super(message);
     this.url = url;
   }
 }
 
 const freighterErrorEncoder: ErrorEncoder = (error: TypedError) => {
-  if (error.type !== FREIGHTER) return null;
-  if (error instanceof EOF) return { type: EOF.TYPE, data: "EOF" };
-  if (error instanceof StreamClosed)
+  if (!error.type.startsWith(FREIGHTER)) return null;
+  if (EOF.matches(error)) return { type: EOF.TYPE, data: "EOF" };
+  if (StreamClosed.matches(error))
     return { type: StreamClosed.TYPE, data: "StreamClosed" };
-  if (error instanceof Unreachable)
+  if (Unreachable.matches(error))
     return { type: Unreachable.TYPE, data: "Unreachable" };
   throw new Error(`Unknown error type: ${error.type}: ${error.message}`);
 };

package/src/index.ts

@@ -7,12 +7,13 @@
 // License, use of this software will be governed by the Apache License, Version 2.0,
 // included in the file licenses/APL.txt.
 
-export type { ErrorPayload, TypedError } from "@/errors";
+export type { ErrorPayload, MatchableErrorType, TypedError } from "@/errors";
 export {
   BaseTypedError,
   decodeError,
   encodeError,
   EOF,
+  errorMatcher,
   errorZ,
   registerError,
   StreamClosed,

package/src/websocket.spec.ts

@@ -35,9 +35,10 @@ const client = new WebSocketClient(url, new binary.JSONEncoderDecoder());
 
 class MyCustomError extends BaseTypedError {
   code: number;
+  type = "integration.error";
 
   constructor(message: string, code: number) {
-    super(message, "integration.error");
+    super(message);
     this.code = code;
   }
 }