@synnaxlabs/freighter 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 emiliano bonilla
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

package/README.md

@@ -0,0 +1,3 @@
+# freighter
+
+a modular transport abstraction

package/build/main/index.d.ts

@@ -0,0 +1,7 @@
+export { WebSocketClient } from './lib/websocket';
+export { MsgpackEncoderDecoder, JSONEncoderDecoder, registerCustomTypeEncoder, ENCODERS, } from './lib/encoder';
+export { StreamClient, Stream } from './lib/stream';
+export { UnaryClient } from './lib/unary';
+export { HTTPClientFactory } from './lib/http';
+export { default as URL } from './lib/url';
+export { encodeError, decodeError, registerError, BaseTypedError, TypedError, ErrorPayload, ErrorPayloadSchema, EOF, StreamClosed, Unreachable, } from './lib/errors';

package/build/main/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Unreachable = exports.StreamClosed = exports.EOF = exports.ErrorPayloadSchema = exports.BaseTypedError = exports.registerError = exports.decodeError = exports.encodeError = exports.URL = exports.HTTPClientFactory = exports.ENCODERS = exports.registerCustomTypeEncoder = exports.JSONEncoderDecoder = exports.MsgpackEncoderDecoder = exports.WebSocketClient = void 0;
+var websocket_1 = require("./lib/websocket");
+Object.defineProperty(exports, "WebSocketClient", { enumerable: true, get: function () { return websocket_1.WebSocketClient; } });
+var encoder_1 = require("./lib/encoder");
+Object.defineProperty(exports, "MsgpackEncoderDecoder", { enumerable: true, get: function () { return encoder_1.MsgpackEncoderDecoder; } });
+Object.defineProperty(exports, "JSONEncoderDecoder", { enumerable: true, get: function () { return encoder_1.JSONEncoderDecoder; } });
+Object.defineProperty(exports, "registerCustomTypeEncoder", { enumerable: true, get: function () { return encoder_1.registerCustomTypeEncoder; } });
+Object.defineProperty(exports, "ENCODERS", { enumerable: true, get: function () { return encoder_1.ENCODERS; } });
+var http_1 = require("./lib/http");
+Object.defineProperty(exports, "HTTPClientFactory", { enumerable: true, get: function () { return http_1.HTTPClientFactory; } });
+var url_1 = require("./lib/url");
+Object.defineProperty(exports, "URL", { enumerable: true, get: function () { return __importDefault(url_1).default; } });
+var errors_1 = require("./lib/errors");
+Object.defineProperty(exports, "encodeError", { enumerable: true, get: function () { return errors_1.encodeError; } });
+Object.defineProperty(exports, "decodeError", { enumerable: true, get: function () { return errors_1.decodeError; } });
+Object.defineProperty(exports, "registerError", { enumerable: true, get: function () { return errors_1.registerError; } });
+Object.defineProperty(exports, "BaseTypedError", { enumerable: true, get: function () { return errors_1.BaseTypedError; } });
+Object.defineProperty(exports, "ErrorPayloadSchema", { enumerable: true, get: function () { return errors_1.ErrorPayloadSchema; } });
+Object.defineProperty(exports, "EOF", { enumerable: true, get: function () { return errors_1.EOF; } });
+Object.defineProperty(exports, "StreamClosed", { enumerable: true, get: function () { return errors_1.StreamClosed; } });
+Object.defineProperty(exports, "Unreachable", { enumerable: true, get: function () { return errors_1.Unreachable; } });
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBQUEsNkNBQWtEO0FBQXpDLDRHQUFBLGVBQWUsT0FBQTtBQUN4Qix5Q0FLdUI7QUFKckIsZ0hBQUEscUJBQXFCLE9BQUE7QUFDckIsNkdBQUEsa0JBQWtCLE9BQUE7QUFDbEIsb0hBQUEseUJBQXlCLE9BQUE7QUFDekIsbUdBQUEsUUFBUSxPQUFBO0FBSVYsbUNBQStDO0FBQXRDLHlHQUFBLGlCQUFpQixPQUFBO0FBQzFCLGlDQUEyQztBQUFsQywyR0FBQSxPQUFPLE9BQU87QUFDdkIsdUNBV3NCO0FBVnBCLHFHQUFBLFdBQVcsT0FBQTtBQUNYLHFHQUFBLFdBQVcsT0FBQTtBQUNYLHVHQUFBLGFBQWEsT0FBQTtBQUNiLHdHQUFBLGNBQWMsT0FBQTtBQUdkLDRHQUFBLGtCQUFrQixPQUFBO0FBQ2xCLDZGQUFBLEdBQUcsT0FBQTtBQUNILHNHQUFBLFlBQVksT0FBQTtBQUNaLHFHQUFBLFdBQVcsT0FBQSJ9

package/build/main/lib/caseconv.d.ts

@@ -0,0 +1,2 @@
+export declare const snakeKeys: (entity: unknown) => object | null;
+export declare const camelKeys: (entity: unknown) => object | null;

package/build/main/lib/caseconv.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.camelKeys = exports.snakeKeys = void 0;
+const js_convert_case_1 = require("js-convert-case");
+const options = {
+    recursive: true,
+    recursiveInArray: true,
+    keepTypesOnRecursion: [Number, String, Uint8Array],
+};
+const snakeKeys = (entity) => (0, js_convert_case_1.snakeKeys)(entity, options);
+exports.snakeKeys = snakeKeys;
+const camelKeys = (entity) => (0, js_convert_case_1.camelKeys)(entity, options);
+exports.camelKeys = camelKeys;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2FzZWNvbnYuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2Nhc2Vjb252LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7OztBQUFBLHFEQUd5QjtBQUV6QixNQUFNLE9BQU8sR0FBRztJQUNkLFNBQVMsRUFBRSxJQUFJO0lBQ2YsZ0JBQWdCLEVBQUUsSUFBSTtJQUN0QixvQkFBb0IsRUFBRSxDQUFDLE1BQU0sRUFBRSxNQUFNLEVBQUUsVUFBVSxDQUFDO0NBQ25ELENBQUM7QUFFSyxNQUFNLFNBQVMsR0FBRyxDQUFDLE1BQWUsRUFBRSxFQUFFLENBQUMsSUFBQSwyQkFBVSxFQUFDLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQztBQUE3RCxRQUFBLFNBQVMsYUFBb0Q7QUFDbkUsTUFBTSxTQUFTLEdBQUcsQ0FBQyxNQUFlLEVBQUUsRUFBRSxDQUFDLElBQUEsMkJBQVUsRUFBQyxNQUFNLEVBQUUsT0FBTyxDQUFDLENBQUM7QUFBN0QsUUFBQSxTQUFTLGFBQW9EIn0=

package/build/main/lib/encoder.d.ts

@@ -0,0 +1,60 @@
+import { ZodSchema } from 'zod';
+/**
+ * CustomTypeEncoder is an interface for a class that needs to transform its
+ * value before encoding.
+ */
+interface CustomTypeEncoder {
+    /** The Class the custom encoder is set for */
+    Class: Function;
+    /**
+     * The function that transforms the value before encoding;
+     * @param instance - The instance of the class to transform.
+     * @returns The transformed value.
+     */
+    write<P>(instance: P): unknown;
+}
+/**
+ * EncoderDecoder is an entity that encodes and decodes messages to and from
+ * a binary format.
+ */
+export interface EncoderDecoder {
+    /** The HTTP content type of the encoder */
+    contentType: string;
+    /**
+     * Encodes the given payload into a binary representation.
+     * @param payload - The payload to encode.
+     * @returns an ArrayBuffer containing the encoded payload.
+     */
+    encode(payload: unknown): ArrayBuffer;
+    /**
+     * Decodes the given binary representation into a type checked payload.
+     * @param data - The data to decode.
+     * @param schema - The schema to decode the data with.
+     */
+    decode<P>(data: Uint8Array | ArrayBuffer, schema: ZodSchema<P>): P;
+}
+interface StaticEncoderDecoder {
+    registerCustomType(encoder: CustomTypeEncoder): void;
+}
+/***
+ * MsgpackEncoderDecoder is a msgpack implementation of EncoderDecoder.
+ */
+export declare class MsgpackEncoderDecoder implements EncoderDecoder {
+    contentType: string;
+    encode(payload: unknown): ArrayBuffer;
+    decode<P>(data: Uint8Array, schema: ZodSchema<P>): P;
+    static registerCustomType(encoder: CustomTypeEncoder): void;
+}
+/**
+ * JSONEncoderDecoder is a JSON implementation of EncoderDecoder.
+ */
+export declare class JSONEncoderDecoder implements EncoderDecoder {
+    contentType: string;
+    encode(payload: unknown): ArrayBuffer;
+    decode<P>(data: Uint8Array, schema: ZodSchema<P>): P;
+    static registerCustomType(): void;
+}
+export declare const ENCODERS: EncoderDecoder[];
+export declare const ENCODER_CLASSES: StaticEncoderDecoder[];
+export declare const registerCustomTypeEncoder: (encoder: CustomTypeEncoder) => void;
+export {};

package/build/main/lib/encoder.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerCustomTypeEncoder = exports.ENCODER_CLASSES = exports.ENCODERS = exports.JSONEncoderDecoder = exports.MsgpackEncoderDecoder = void 0;
+const msgpackr_1 = require("msgpackr");
+const caseconv_1 = require("./caseconv");
+/***
+ * MsgpackEncoderDecoder is a msgpack implementation of EncoderDecoder.
+ */
+class MsgpackEncoderDecoder {
+    constructor() {
+        this.contentType = 'application/msgpack';
+    }
+    encode(payload) {
+        return (0, msgpackr_1.pack)((0, caseconv_1.snakeKeys)(payload));
+    }
+    decode(data, schema) {
+        return schema.parse((0, caseconv_1.camelKeys)((0, msgpackr_1.unpack)(new Uint8Array(data))));
+    }
+    static registerCustomType(encoder) {
+        (0, msgpackr_1.addExtension)(Object.assign({ type: 0 }, encoder));
+    }
+}
+exports.MsgpackEncoderDecoder = MsgpackEncoderDecoder;
+/**
+ * JSONEncoderDecoder is a JSON implementation of EncoderDecoder.
+ */
+class JSONEncoderDecoder {
+    constructor() {
+        this.contentType = 'application/json';
+    }
+    encode(payload) {
+        const json = JSON.stringify((0, caseconv_1.snakeKeys)(payload), (_, v) => {
+            if (ArrayBuffer.isView(v))
+                return Array.from(v);
+            return v;
+        });
+        return new TextEncoder().encode(json);
+    }
+    decode(data, schema) {
+        return schema.parse((0, caseconv_1.camelKeys)(JSON.parse(new TextDecoder().decode(data))));
+    }
+    static registerCustomType() {
+        return;
+    }
+}
+exports.JSONEncoderDecoder = JSONEncoderDecoder;
+exports.ENCODERS = [
+    new MsgpackEncoderDecoder(),
+    new JSONEncoderDecoder(),
+];
+exports.ENCODER_CLASSES = [
+    MsgpackEncoderDecoder,
+    JSONEncoderDecoder,
+];
+const registerCustomTypeEncoder = (encoder) => {
+    exports.ENCODER_CLASSES.forEach((encoderClass) => {
+        encoderClass.registerCustomType(encoder);
+    });
+};
+exports.registerCustomTypeEncoder = registerCustomTypeEncoder;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jb2Rlci5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uL3NyYy9saWIvZW5jb2Rlci50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7QUFBQSx1Q0FBc0Q7QUFHdEQseUNBQWtEO0FBOENsRDs7R0FFRztBQUNILE1BQWEscUJBQXFCO0lBQWxDO1FBQ0UsZ0JBQVcsR0FBRyxxQkFBcUIsQ0FBQztJQWF0QyxDQUFDO0lBWEMsTUFBTSxDQUFDLE9BQWdCO1FBQ3JCLE9BQU8sSUFBQSxlQUFJLEVBQUMsSUFBQSxvQkFBUyxFQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7SUFDbEMsQ0FBQztJQUVELE1BQU0sQ0FBSSxJQUFnQixFQUFFLE1BQW9CO1FBQzlDLE9BQU8sTUFBTSxDQUFDLEtBQUssQ0FBQyxJQUFBLG9CQUFTLEVBQUMsSUFBQSxpQkFBTSxFQUFDLElBQUksVUFBVSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQy9ELENBQUM7SUFFRCxNQUFNLENBQUMsa0JBQWtCLENBQUMsT0FBMEI7UUFDbEQsSUFBQSx1QkFBWSxrQkFBRyxJQUFJLEVBQUUsQ0FBQyxJQUFLLE9BQU8sRUFBRyxDQUFDO0lBQ3hDLENBQUM7Q0FDRjtBQWRELHNEQWNDO0FBRUQ7O0dBRUc7QUFDSCxNQUFhLGtCQUFrQjtJQUEvQjtRQUNFLGdCQUFXLEdBQUcsa0JBQWtCLENBQUM7SUFpQm5DLENBQUM7SUFmQyxNQUFNLENBQUMsT0FBZ0I7UUFDckIsTUFBTSxJQUFJLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxJQUFBLG9CQUFTLEVBQUMsT0FBTyxDQUFDLEVBQUUsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUU7WUFDdkQsSUFBSSxXQUFXLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQztnQkFBRSxPQUFPLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBZSxDQUFDLENBQUM7WUFDOUQsT0FBTyxDQUFDLENBQUM7UUFDWCxDQUFDLENBQUMsQ0FBQztRQUNILE9BQU8sSUFBSSxXQUFXLEVBQUUsQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDeEMsQ0FBQztJQUVELE1BQU0sQ0FBSSxJQUFnQixFQUFFLE1BQW9CO1FBQzlDLE9BQU8sTUFBTSxDQUFDLEtBQUssQ0FBQyxJQUFBLG9CQUFTLEVBQUMsSUFBSSxDQUFDLEtBQUssQ0FBQyxJQUFJLFdBQVcsRUFBRSxDQUFDLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUM3RSxDQUFDO0lBRUQsTUFBTSxDQUFDLGtCQUFrQjtRQUN2QixPQUFPO0lBQ1QsQ0FBQztDQUNGO0FBbEJELGdEQWtCQztBQUVZLFFBQUEsUUFBUSxHQUFxQjtJQUN4QyxJQUFJLHFCQUFxQixFQUFFO0lBQzNCLElBQUksa0JBQWtCLEVBQUU7Q0FDekIsQ0FBQztBQUVXLFFBQUEsZUFBZSxHQUEyQjtJQUNyRCxxQkFBcUI7SUFDckIsa0JBQWtCO0NBQ25CLENBQUM7QUFFSyxNQUFNLHlCQUF5QixHQUFHLENBQUMsT0FBMEIsRUFBUSxFQUFFO0lBQzVFLHVCQUFlLENBQUMsT0FBTyxDQUFDLENBQUMsWUFBWSxFQUFFLEVBQUU7UUFDdkMsWUFBWSxDQUFDLGtCQUFrQixDQUFDLE9BQU8sQ0FBQyxDQUFDO0lBQzNDLENBQUMsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyxDQUFDO0FBSlcsUUFBQSx5QkFBeUIsNkJBSXBDIn0=

package/build/main/lib/encoder.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/main/lib/encoder.spec.js

@@ -0,0 +1,26 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const zod_1 = require("zod");
+const encoder_1 = require("./encoder");
+const SampleSchema = zod_1.z.object({
+    channelKey: zod_1.z.string(),
+    timeStamp: zod_1.z.number(),
+    value: zod_1.z.unknown(),
+});
+encoder_1.ENCODERS.forEach((encoder) => {
+    (0, ava_1.default)(`encoder ${encoder.contentType}`, (t) => {
+        const sample = {
+            channelKey: 'test',
+            timeStamp: 123,
+            value: new Uint8Array([1, 2, 3]),
+        };
+        const encoded = encoder.encode(sample);
+        const decoded = encoder.decode(encoded, SampleSchema);
+        t.deepEqual(decoded, decoded);
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZW5jb2Rlci5zcGVjLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lbmNvZGVyLnNwZWMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSw4Q0FBdUI7QUFDdkIsNkJBQXdCO0FBRXhCLHVDQUFxQztBQUVyQyxNQUFNLFlBQVksR0FBRyxPQUFDLENBQUMsTUFBTSxDQUFDO0lBQzVCLFVBQVUsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0lBQ3RCLFNBQVMsRUFBRSxPQUFDLENBQUMsTUFBTSxFQUFFO0lBQ3JCLEtBQUssRUFBRSxPQUFDLENBQUMsT0FBTyxFQUFFO0NBQ25CLENBQUMsQ0FBQztBQUVILGtCQUFRLENBQUMsT0FBTyxDQUFDLENBQUMsT0FBTyxFQUFFLEVBQUU7SUFDM0IsSUFBQSxhQUFJLEVBQUMsV0FBVyxPQUFPLENBQUMsV0FBVyxFQUFFLEVBQUUsQ0FBQyxDQUFDLEVBQUUsRUFBRTtRQUMzQyxNQUFNLE1BQU0sR0FBRztZQUNiLFVBQVUsRUFBRSxNQUFNO1lBQ2xCLFNBQVMsRUFBRSxHQUFHO1lBQ2QsS0FBSyxFQUFFLElBQUksVUFBVSxDQUFDLENBQUMsQ0FBQyxFQUFFLENBQUMsRUFBRSxDQUFDLENBQUMsQ0FBQztTQUNqQyxDQUFDO1FBQ0YsTUFBTSxPQUFPLEdBQUcsT0FBTyxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQztRQUN2QyxNQUFNLE9BQU8sR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLE9BQU8sRUFBRSxZQUFZLENBQUMsQ0FBQztRQUN0RCxDQUFDLENBQUMsU0FBUyxDQUFDLE9BQU8sRUFBRSxPQUFPLENBQUMsQ0FBQztJQUNoQyxDQUFDLENBQUMsQ0FBQztBQUNMLENBQUMsQ0FBQyxDQUFDIn0=

package/build/main/lib/errors.d.ts

@@ -0,0 +1,77 @@
+import { z } from 'zod';
+export interface TypedError extends Error {
+    discriminator: 'FreighterError';
+    /**
+     * @description Returns a unique type identifier for the error. Freighter uses this to
+     * determine the correct decoder to use on the other end of the freighter.
+     */
+    type: string;
+}
+export declare class BaseTypedError extends Error implements TypedError {
+    discriminator: 'FreighterError';
+    type: string;
+    constructor(message: string, type: string);
+}
+declare type ErrorDecoder = (encoded: string) => Error | undefined;
+declare type ErrorEncoder = (error: TypedError) => string;
+export declare const isTypedError: (error: unknown) => error is TypedError;
+export declare const assertErrorType: <T>(type: string, error?: Error) => T;
+export declare const UNKNOWN = "unknown";
+export declare const NONE = "nil";
+export declare const FREIGHTER = "freighter";
+export declare const ErrorPayloadSchema: z.ZodObject<{
+    type: z.ZodString;
+    data: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: string;
+    data: string;
+}, {
+    type: string;
+    data: string;
+}>;
+export declare type ErrorPayload = z.infer<typeof ErrorPayloadSchema>;
+/**
+ * Registers a custom error type with the error registry, which allows it to be
+ * encoded/decoded and sent over the network.
+ *
+ * @param type - A unique string identifier for the error type.
+ * @param encode - A function that encodes the error into a string.
+ * @param decode - A function that decodes the error from a string.
+ */
+export declare const registerError: ({ type, encode, decode, }: {
+    type: string;
+    encode: ErrorEncoder;
+    decode: ErrorDecoder;
+}) => void;
+/**
+ * Encodes an error into a payload that can be sent between a freighter server
+ * and client.
+ * @param error - The error to encode.
+ * @returns The encoded error.
+ */
+export declare const encodeError: (error: unknown) => ErrorPayload;
+/**
+ * Decodes an error payload into an exception. If a custom decoder can be found
+ * for the error type, it will be used. Otherwise, a generic Error containing
+ * the error data is returned.
+ *
+ * @param payload - The encoded error payload.
+ * @returns The decoded error.
+ */
+export declare const decodeError: (payload: ErrorPayload) => Error | undefined;
+export declare class UnknownError extends BaseTypedError implements TypedError {
+    constructor(message: string);
+}
+/** Thrown/returned when a stream closed normally. */
+export declare class EOF extends BaseTypedError implements TypedError {
+    constructor();
+}
+/** Thrown/returned when a stream is closed abnormally. */
+export declare class StreamClosed extends BaseTypedError implements TypedError {
+    constructor();
+}
+/** Thrown when a target is unreachable. */
+export declare class Unreachable extends BaseTypedError implements TypedError {
+    constructor();
+}
+export {};

package/build/main/lib/errors.js

@@ -0,0 +1,171 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Unreachable = exports.StreamClosed = exports.EOF = exports.UnknownError = exports.decodeError = exports.encodeError = exports.registerError = exports.ErrorPayloadSchema = exports.FREIGHTER = exports.NONE = exports.UNKNOWN = exports.assertErrorType = exports.isTypedError = exports.BaseTypedError = void 0;
+const zod_1 = require("zod");
+class BaseTypedError extends Error {
+    constructor(message, type) {
+        super(message);
+        this.discriminator = 'FreighterError';
+        this.type = type;
+    }
+}
+exports.BaseTypedError = BaseTypedError;
+const isTypedError = (error) => {
+    if (!error || typeof error !== 'object') {
+        return false;
+    }
+    const typedError = error;
+    if (typedError.discriminator !== 'FreighterError') {
+        return false;
+    }
+    if (!('type' in typedError)) {
+        throw new Error(`Freighter error is missing its type property: ${typedError}`);
+    }
+    return true;
+};
+exports.isTypedError = isTypedError;
+const assertErrorType = (type, error) => {
+    if (!error) {
+        throw new Error(`Expected error of type ${type} but got nothing instead`);
+    }
+    if (!(0, exports.isTypedError)(error)) {
+        throw new Error(`Expected a typed error, got: ${error}`);
+    }
+    if (error.type !== type) {
+        throw new Error(`Expected error of type ${type}, got ${error.type}: ${error}`);
+    }
+    return error;
+};
+exports.assertErrorType = assertErrorType;
+exports.UNKNOWN = 'unknown';
+exports.NONE = 'nil';
+exports.FREIGHTER = 'freighter';
+exports.ErrorPayloadSchema = zod_1.z.object({
+    type: zod_1.z.string(),
+    data: zod_1.z.string(),
+});
+class Registry {
+    constructor() {
+        this.entries = {};
+    }
+    register(_type, provider) {
+        if (this.entries[_type]) {
+            throw new Error(`Error type ${_type} is already registered`);
+        }
+        this.entries[_type] = provider;
+    }
+    encode(error) {
+        if (!error) {
+            return { type: exports.NONE, data: '' };
+        }
+        if ((0, exports.isTypedError)(error) && this.entries[error.type]) {
+            return { type: error.type, data: this.entries[error.type].encode(error) };
+        }
+        return { type: exports.UNKNOWN, data: JSON.stringify(error) };
+    }
+    decode(payload) {
+        if (payload.type === exports.NONE) {
+            return undefined;
+        }
+        if (payload.type === exports.UNKNOWN) {
+            return new UnknownError(payload.data);
+        }
+        const provider = this.entries[payload.type];
+        if (!provider) {
+            return new UnknownError(payload.data);
+        }
+        return provider.decode(payload.data);
+    }
+}
+const REGISTRY = new Registry();
+/**
+ * Registers a custom error type with the error registry, which allows it to be
+ * encoded/decoded and sent over the network.
+ *
+ * @param type - A unique string identifier for the error type.
+ * @param encode - A function that encodes the error into a string.
+ * @param decode - A function that decodes the error from a string.
+ */
+const registerError = ({ type, encode, decode, }) => {
+    REGISTRY.register(type, { encode, decode });
+};
+exports.registerError = registerError;
+/**
+ * Encodes an error into a payload that can be sent between a freighter server
+ * and client.
+ * @param error - The error to encode.
+ * @returns The encoded error.
+ */
+const encodeError = (error) => {
+    return REGISTRY.encode(error);
+};
+exports.encodeError = encodeError;
+/**
+ * Decodes an error payload into an exception. If a custom decoder can be found
+ * for the error type, it will be used. Otherwise, a generic Error containing
+ * the error data is returned.
+ *
+ * @param payload - The encoded error payload.
+ * @returns The decoded error.
+ */
+const decodeError = (payload) => {
+    return REGISTRY.decode(payload);
+};
+exports.decodeError = decodeError;
+class UnknownError extends BaseTypedError {
+    constructor(message) {
+        super(message, exports.UNKNOWN);
+    }
+}
+exports.UnknownError = UnknownError;
+/** Thrown/returned when a stream closed normally. */
+class EOF extends BaseTypedError {
+    constructor() {
+        super('EOF', exports.FREIGHTER);
+    }
+}
+exports.EOF = EOF;
+/** Thrown/returned when a stream is closed abnormally. */
+class StreamClosed extends BaseTypedError {
+    constructor() {
+        super('StreamClosed', exports.FREIGHTER);
+    }
+}
+exports.StreamClosed = StreamClosed;
+/** Thrown when a target is unreachable. */
+class Unreachable extends BaseTypedError {
+    constructor() {
+        super('Unreachable', exports.FREIGHTER);
+    }
+}
+exports.Unreachable = Unreachable;
+const freighterErrorEncoder = (error) => {
+    if (error instanceof EOF) {
+        return 'EOF';
+    }
+    if (error instanceof StreamClosed) {
+        return 'StreamClosed';
+    }
+    if (error instanceof Unreachable) {
+        return 'Unreachable';
+    }
+    throw new Error(`Unknown error type: ${error}`);
+};
+const freighterErrorDecoder = (encoded) => {
+    switch (encoded) {
+        case 'EOF':
+            return new EOF();
+        case 'StreamClosed':
+            return new StreamClosed();
+        case 'Unreachable':
+            return new Unreachable();
+        default:
+            throw new Error(`Unknown error type: ${encoded}`);
+    }
+};
+(0, exports.registerError)({
+    type: exports.FREIGHTER,
+    encode: freighterErrorEncoder,
+    decode: freighterErrorDecoder,
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2xpYi9lcnJvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBQUEsNkJBQXdCO0FBV3hCLE1BQWEsY0FBZSxTQUFRLEtBQUs7SUFJdkMsWUFBWSxPQUFlLEVBQUUsSUFBWTtRQUN2QyxLQUFLLENBQUMsT0FBTyxDQUFDLENBQUM7UUFKakIsa0JBQWEsR0FBcUIsZ0JBQWdCLENBQUM7UUFLakQsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7SUFDbkIsQ0FBQztDQUNGO0FBUkQsd0NBUUM7QUFLTSxNQUFNLFlBQVksR0FBRyxDQUFDLEtBQWMsRUFBdUIsRUFBRTtJQUNsRSxJQUFJLENBQUMsS0FBSyxJQUFJLE9BQU8sS0FBSyxLQUFLLFFBQVEsRUFBRTtRQUN2QyxPQUFPLEtBQUssQ0FBQztLQUNkO0lBQ0QsTUFBTSxVQUFVLEdBQUcsS0FBbUIsQ0FBQztJQUN2QyxJQUFJLFVBQVUsQ0FBQyxhQUFhLEtBQUssZ0JBQWdCLEVBQUU7UUFDakQsT0FBTyxLQUFLLENBQUM7S0FDZDtJQUNELElBQUksQ0FBQyxDQUFDLE1BQU0sSUFBSSxVQUFVLENBQUMsRUFBRTtRQUMzQixNQUFNLElBQUksS0FBSyxDQUNiLGlEQUFpRCxVQUFVLEVBQUUsQ0FDOUQsQ0FBQztLQUNIO0lBQ0QsT0FBTyxJQUFJLENBQUM7QUFDZCxDQUFDLENBQUM7QUFkVyxRQUFBLFlBQVksZ0JBY3ZCO0FBRUssTUFBTSxlQUFlLEdBQUcsQ0FBSSxJQUFZLEVBQUUsS0FBYSxFQUFLLEVBQUU7SUFDbkUsSUFBSSxDQUFDLEtBQUssRUFBRTtRQUNWLE1BQU0sSUFBSSxLQUFLLENBQUMsMEJBQTBCLElBQUksMEJBQTBCLENBQUMsQ0FBQztLQUMzRTtJQUNELElBQUksQ0FBQyxJQUFBLG9CQUFZLEVBQUMsS0FBSyxDQUFDLEVBQUU7UUFDeEIsTUFBTSxJQUFJLEtBQUssQ0FBQyxnQ0FBZ0MsS0FBSyxFQUFFLENBQUMsQ0FBQztLQUMxRDtJQUNELElBQUksS0FBSyxDQUFDLElBQUksS0FBSyxJQUFJLEVBQUU7UUFDdkIsTUFBTSxJQUFJLEtBQUssQ0FDYiwwQkFBMEIsSUFBSSxTQUFTLEtBQUssQ0FBQyxJQUFJLEtBQUssS0FBSyxFQUFFLENBQzlELENBQUM7S0FDSDtJQUNELE9BQU8sS0FBcUIsQ0FBQztBQUMvQixDQUFDLENBQUM7QUFiVyxRQUFBLGVBQWUsbUJBYTFCO0FBRVcsUUFBQSxPQUFPLEdBQUcsU0FBUyxDQUFDO0FBQ3BCLFFBQUEsSUFBSSxHQUFHLEtBQUssQ0FBQztBQUNiLFFBQUEsU0FBUyxHQUFHLFdBQVcsQ0FBQztBQUV4QixRQUFBLGtCQUFrQixHQUFHLE9BQUMsQ0FBQyxNQUFNLENBQUM7SUFDekMsSUFBSSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7SUFDaEIsSUFBSSxFQUFFLE9BQUMsQ0FBQyxNQUFNLEVBQUU7Q0FDakIsQ0FBQyxDQUFDO0FBU0gsTUFBTSxRQUFRO0lBR1o7UUFDRSxJQUFJLENBQUMsT0FBTyxHQUFHLEVBQUUsQ0FBQztJQUNwQixDQUFDO0lBRUQsUUFBUSxDQUFDLEtBQWEsRUFBRSxRQUF1QjtRQUM3QyxJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEVBQUU7WUFDdkIsTUFBTSxJQUFJLEtBQUssQ0FBQyxjQUFjLEtBQUssd0JBQXdCLENBQUMsQ0FBQztTQUM5RDtRQUNELElBQUksQ0FBQyxPQUFPLENBQUMsS0FBSyxDQUFDLEdBQUcsUUFBUSxDQUFDO0lBQ2pDLENBQUM7SUFFRCxNQUFNLENBQUMsS0FBYztRQUNuQixJQUFJLENBQUMsS0FBSyxFQUFFO1lBQ1YsT0FBTyxFQUFFLElBQUksRUFBRSxZQUFJLEVBQUUsSUFBSSxFQUFFLEVBQUUsRUFBRSxDQUFDO1NBQ2pDO1FBQ0QsSUFBSSxJQUFBLG9CQUFZLEVBQUMsS0FBSyxDQUFDLElBQUksSUFBSSxDQUFDLE9BQU8sQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLEVBQUU7WUFDbkQsT0FBTyxFQUFFLElBQUksRUFBRSxLQUFLLENBQUMsSUFBSSxFQUFFLElBQUksRUFBRSxJQUFJLENBQUMsT0FBTyxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQztTQUMzRTtRQUNELE9BQU8sRUFBRSxJQUFJLEVBQUUsZUFBTyxFQUFFLElBQUksRUFBRSxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUM7SUFDeEQsQ0FBQztJQUVELE1BQU0sQ0FBQyxPQUFxQjtRQUMxQixJQUFJLE9BQU8sQ0FBQyxJQUFJLEtBQUssWUFBSSxFQUFFO1lBQ3pCLE9BQU8sU0FBUyxDQUFDO1NBQ2xCO1FBRUQsSUFBSSxPQUFPLENBQUMsSUFBSSxLQUFLLGVBQU8sRUFBRTtZQUM1QixPQUFPLElBQUksWUFBWSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUN2QztRQUVELE1BQU0sUUFBUSxHQUFHLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzVDLElBQUksQ0FBQyxRQUFRLEVBQUU7WUFDYixPQUFPLElBQUksWUFBWSxDQUFDLE9BQU8sQ0FBQyxJQUFJLENBQUMsQ0FBQztTQUN2QztRQUNELE9BQU8sUUFBUSxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDdkMsQ0FBQztDQUNGO0FBRUQsTUFBTSxRQUFRLEdBQUcsSUFBSSxRQUFRLEVBQUUsQ0FBQztBQUVoQzs7Ozs7OztHQU9HO0FBQ0ksTUFBTSxhQUFhLEdBQUcsQ0FBQyxFQUM1QixJQUFJLEVBQ0osTUFBTSxFQUNOLE1BQU0sR0FLUCxFQUFFLEVBQUU7SUFDSCxRQUFRLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsQ0FBQyxDQUFDO0FBQzlDLENBQUMsQ0FBQztBQVZXLFFBQUEsYUFBYSxpQkFVeEI7QUFFRjs7Ozs7R0FLRztBQUNJLE1BQU0sV0FBVyxHQUFHLENBQUMsS0FBYyxFQUFnQixFQUFFO0lBQzFELE9BQU8sUUFBUSxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQztBQUNoQyxDQUFDLENBQUM7QUFGVyxRQUFBLFdBQVcsZUFFdEI7QUFFRjs7Ozs7OztHQU9HO0FBQ0ksTUFBTSxXQUFXLEdBQUcsQ0FBQyxPQUFxQixFQUFxQixFQUFFO0lBQ3RFLE9BQU8sUUFBUSxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUMsQ0FBQztBQUNsQyxDQUFDLENBQUM7QUFGVyxRQUFBLFdBQVcsZUFFdEI7QUFFRixNQUFhLFlBQWEsU0FBUSxjQUFjO0lBQzlDLFlBQVksT0FBZTtRQUN6QixLQUFLLENBQUMsT0FBTyxFQUFFLGVBQU8sQ0FBQyxDQUFDO0lBQzFCLENBQUM7Q0FDRjtBQUpELG9DQUlDO0FBRUQscURBQXFEO0FBQ3JELE1BQWEsR0FBSSxTQUFRLGNBQWM7SUFDckM7UUFDRSxLQUFLLENBQUMsS0FBSyxFQUFFLGlCQUFTLENBQUMsQ0FBQztJQUMxQixDQUFDO0NBQ0Y7QUFKRCxrQkFJQztBQUVELDBEQUEwRDtBQUMxRCxNQUFhLFlBQWEsU0FBUSxjQUFjO0lBQzlDO1FBQ0UsS0FBSyxDQUFDLGNBQWMsRUFBRSxpQkFBUyxDQUFDLENBQUM7SUFDbkMsQ0FBQztDQUNGO0FBSkQsb0NBSUM7QUFFRCwyQ0FBMkM7QUFDM0MsTUFBYSxXQUFZLFNBQVEsY0FBYztJQUM3QztRQUNFLEtBQUssQ0FBQyxhQUFhLEVBQUUsaUJBQVMsQ0FBQyxDQUFDO0lBQ2xDLENBQUM7Q0FDRjtBQUpELGtDQUlDO0FBRUQsTUFBTSxxQkFBcUIsR0FBaUIsQ0FBQyxLQUFpQixFQUFFLEVBQUU7SUFDaEUsSUFBSSxLQUFLLFlBQVksR0FBRyxFQUFFO1FBQ3hCLE9BQU8sS0FBSyxDQUFDO0tBQ2Q7SUFDRCxJQUFJLEtBQUssWUFBWSxZQUFZLEVBQUU7UUFDakMsT0FBTyxjQUFjLENBQUM7S0FDdkI7SUFDRCxJQUFJLEtBQUssWUFBWSxXQUFXLEVBQUU7UUFDaEMsT0FBTyxhQUFhLENBQUM7S0FDdEI7SUFDRCxNQUFNLElBQUksS0FBSyxDQUFDLHVCQUF1QixLQUFLLEVBQUUsQ0FBQyxDQUFDO0FBQ2xELENBQUMsQ0FBQztBQUVGLE1BQU0scUJBQXFCLEdBQWlCLENBQUMsT0FBZSxFQUFFLEVBQUU7SUFDOUQsUUFBUSxPQUFPLEVBQUU7UUFDZixLQUFLLEtBQUs7WUFDUixPQUFPLElBQUksR0FBRyxFQUFFLENBQUM7UUFDbkIsS0FBSyxjQUFjO1lBQ2pCLE9BQU8sSUFBSSxZQUFZLEVBQUUsQ0FBQztRQUM1QixLQUFLLGFBQWE7WUFDaEIsT0FBTyxJQUFJLFdBQVcsRUFBRSxDQUFDO1FBQzNCO1lBQ0UsTUFBTSxJQUFJLEtBQUssQ0FBQyx1QkFBdUIsT0FBTyxFQUFFLENBQUMsQ0FBQztLQUNyRDtBQUNILENBQUMsQ0FBQztBQUVGLElBQUEscUJBQWEsRUFBQztJQUNaLElBQUksRUFBRSxpQkFBUztJQUNmLE1BQU0sRUFBRSxxQkFBcUI7SUFDN0IsTUFBTSxFQUFFLHFCQUFxQjtDQUM5QixDQUFDLENBQUMifQ==

package/build/main/lib/errors.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/main/lib/errors.spec.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const ava_1 = __importDefault(require("ava"));
+const errors_1 = require("./errors");
+class MyCustomError extends errors_1.BaseTypedError {
+    constructor(message) {
+        super(message, 'MyCustomError');
+    }
+}
+const myCustomErrorEncoder = (error) => {
+    return error.message;
+};
+const myCustomErrorDecoder = (encoded) => {
+    return new MyCustomError(encoded);
+};
+(0, ava_1.default)('isTypedError', (t) => {
+    const error = new MyCustomError('test');
+    const fError = (0, errors_1.isTypedError)(error);
+    t.is(fError, true);
+    t.is(error.type, 'MyCustomError');
+});
+(0, ava_1.default)('encoding and decoding a custom error through registry', (t) => {
+    (0, errors_1.registerError)({
+        type: 'MyCustomError',
+        encode: myCustomErrorEncoder,
+        decode: myCustomErrorDecoder,
+    });
+    const error = new MyCustomError('test');
+    const encoded = (0, errors_1.encodeError)(error);
+    t.is(encoded.type, 'MyCustomError');
+    t.is(encoded.data, 'test');
+    const decoded = (0, errors_1.assertErrorType)('MyCustomError', (0, errors_1.decodeError)(encoded));
+    t.is(decoded.message, 'test');
+});
+(0, ava_1.default)('encoding and decoding a null error', (t) => {
+    const encoded = (0, errors_1.encodeError)(null);
+    t.is(encoded.type, errors_1.NONE);
+    t.is(encoded.data, '');
+    const decoded = (0, errors_1.decodeError)(encoded);
+    t.is(decoded, undefined);
+});
+(0, ava_1.default)('encoding and decoding an unrecognized error', (t) => {
+    const error = new Error('test');
+    const encoded = (0, errors_1.encodeError)(error);
+    t.is(encoded.type, errors_1.UNKNOWN);
+    t.is(encoded.data, '{}');
+    const decoded = (0, errors_1.decodeError)(encoded);
+    t.deepEqual(decoded, new errors_1.UnknownError('{}'));
+});
+(0, ava_1.default)('registering duplicate error should throw', (t) => {
+    (0, errors_1.registerError)({
+        type: 'MyDuplicateError',
+        encode: myCustomErrorEncoder,
+        decode: myCustomErrorDecoder,
+    });
+    t.throws(() => {
+        (0, errors_1.registerError)({
+            type: 'MyDuplicateError',
+            encode: myCustomErrorEncoder,
+            decode: myCustomErrorDecoder,
+        });
+    });
+});
+(0, ava_1.default)('encoding and decoding freighter errors', (t) => {
+    [new errors_1.EOF(), new errors_1.StreamClosed(), new errors_1.Unreachable()].forEach((error) => {
+        const encoded = (0, errors_1.encodeError)(error);
+        t.is(encoded.type, errors_1.FREIGHTER);
+        t.is(encoded.data, error.message);
+        const decoded = (0, errors_1.decodeError)(encoded);
+        t.deepEqual(decoded, error);
+    });
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZXJyb3JzLnNwZWMuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvbGliL2Vycm9ycy5zcGVjLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsOENBQXVCO0FBRXZCLHFDQWVrQjtBQUVsQixNQUFNLGFBQWMsU0FBUSx1QkFBYztJQUN4QyxZQUFZLE9BQWU7UUFDekIsS0FBSyxDQUFDLE9BQU8sRUFBRSxlQUFlLENBQUMsQ0FBQztJQUNsQyxDQUFDO0NBQ0Y7QUFFRCxNQUFNLG9CQUFvQixHQUFHLENBQUMsS0FBb0IsRUFBVSxFQUFFO0lBQzVELE9BQU8sS0FBSyxDQUFDLE9BQU8sQ0FBQztBQUN2QixDQUFDLENBQUM7QUFFRixNQUFNLG9CQUFvQixHQUFHLENBQUMsT0FBZSxFQUFjLEVBQUU7SUFDM0QsT0FBTyxJQUFJLGFBQWEsQ0FBQyxPQUFPLENBQUMsQ0FBQztBQUNwQyxDQUFDLENBQUM7QUFFRixJQUFBLGFBQUksRUFBQyxjQUFjLEVBQUUsQ0FBQyxDQUFDLEVBQUUsRUFBRTtJQUN6QixNQUFNLEtBQUssR0FBRyxJQUFJLGFBQWEsQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUN4QyxNQUFNLE1BQU0sR0FBRyxJQUFBLHFCQUFZLEVBQUMsS0FBSyxDQUFDLENBQUM7SUFDbkMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxNQUFNLEVBQUUsSUFBSSxDQUFDLENBQUM7SUFDbkIsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxLQUFLLENBQUMsSUFBSSxFQUFFLGVBQWUsQ0FBQyxDQUFDO0FBQ3BDLENBQUMsQ0FBQyxDQUFDO0FBRUgsSUFBQSxhQUFJLEVBQUMsdURBQXVELEVBQUUsQ0FBQyxDQUFDLEVBQUUsRUFBRTtJQUNsRSxJQUFBLHNCQUFhLEVBQUM7UUFDWixJQUFJLEVBQUUsZUFBZTtRQUNyQixNQUFNLEVBQUUsb0JBQW9CO1FBQzVCLE1BQU0sRUFBRSxvQkFBb0I7S0FDN0IsQ0FBQyxDQUFDO0lBQ0gsTUFBTSxLQUFLLEdBQUcsSUFBSSxhQUFhLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDeEMsTUFBTSxPQUFPLEdBQUcsSUFBQSxvQkFBVyxFQUFDLEtBQUssQ0FBQyxDQUFDO0lBQ25DLENBQUMsQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxlQUFlLENBQUMsQ0FBQztJQUNwQyxDQUFDLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsTUFBTSxDQUFDLENBQUM7SUFDM0IsTUFBTSxPQUFPLEdBQUcsSUFBQSx3QkFBZSxFQUM3QixlQUFlLEVBQ2YsSUFBQSxvQkFBVyxFQUFDLE9BQU8sQ0FBQyxDQUNyQixDQUFDO0lBQ0YsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFLE1BQU0sQ0FBQyxDQUFDO0FBQ2hDLENBQUMsQ0FBQyxDQUFDO0FBRUgsSUFBQSxhQUFJLEVBQUMsb0NBQW9DLEVBQUUsQ0FBQyxDQUFDLEVBQUUsRUFBRTtJQUMvQyxNQUFNLE9BQU8sR0FBRyxJQUFBLG9CQUFXLEVBQUMsSUFBSSxDQUFDLENBQUM7SUFDbEMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLGFBQUksQ0FBQyxDQUFDO0lBQ3pCLENBQUMsQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQztJQUN2QixNQUFNLE9BQU8sR0FBRyxJQUFBLG9CQUFXLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDckMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxPQUFPLEVBQUUsU0FBUyxDQUFDLENBQUM7QUFDM0IsQ0FBQyxDQUFDLENBQUM7QUFFSCxJQUFBLGFBQUksRUFBQyw2Q0FBNkMsRUFBRSxDQUFDLENBQUMsRUFBRSxFQUFFO0lBQ3hELE1BQU0sS0FBSyxHQUFHLElBQUksS0FBSyxDQUFDLE1BQU0sQ0FBQyxDQUFDO0lBQ2hDLE1BQU0sT0FBTyxHQUFHLElBQUEsb0JBQVcsRUFBQyxLQUFLLENBQUMsQ0FBQztJQUNuQyxDQUFDLENBQUMsRUFBRSxDQUFDLE9BQU8sQ0FBQyxJQUFJLEVBQUUsZ0JBQU8sQ0FBQyxDQUFDO0lBQzVCLENBQUMsQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxJQUFJLENBQUMsQ0FBQztJQUN6QixNQUFNLE9BQU8sR0FBRyxJQUFBLG9CQUFXLEVBQUMsT0FBTyxDQUFDLENBQUM7SUFDckMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxPQUFPLEVBQUUsSUFBSSxxQkFBWSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUM7QUFDL0MsQ0FBQyxDQUFDLENBQUM7QUFFSCxJQUFBLGFBQUksRUFBQywwQ0FBMEMsRUFBRSxDQUFDLENBQUMsRUFBRSxFQUFFO0lBQ3JELElBQUEsc0JBQWEsRUFBQztRQUNaLElBQUksRUFBRSxrQkFBa0I7UUFDeEIsTUFBTSxFQUFFLG9CQUFvQjtRQUM1QixNQUFNLEVBQUUsb0JBQW9CO0tBQzdCLENBQUMsQ0FBQztJQUNILENBQUMsQ0FBQyxNQUFNLENBQUMsR0FBRyxFQUFFO1FBQ1osSUFBQSxzQkFBYSxFQUFDO1lBQ1osSUFBSSxFQUFFLGtCQUFrQjtZQUN4QixNQUFNLEVBQUUsb0JBQW9CO1lBQzVCLE1BQU0sRUFBRSxvQkFBb0I7U0FDN0IsQ0FBQyxDQUFDO0lBQ0wsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDLENBQUMsQ0FBQztBQUVILElBQUEsYUFBSSxFQUFDLHdDQUF3QyxFQUFFLENBQUMsQ0FBQyxFQUFFLEVBQUU7SUFDbkQsQ0FBQyxJQUFJLFlBQUcsRUFBRSxFQUFFLElBQUkscUJBQVksRUFBRSxFQUFFLElBQUksb0JBQVcsRUFBRSxDQUFDLENBQUMsT0FBTyxDQUFDLENBQUMsS0FBSyxFQUFFLEVBQUU7UUFDbkUsTUFBTSxPQUFPLEdBQUcsSUFBQSxvQkFBVyxFQUFDLEtBQUssQ0FBQyxDQUFDO1FBQ25DLENBQUMsQ0FBQyxFQUFFLENBQUMsT0FBTyxDQUFDLElBQUksRUFBRSxrQkFBUyxDQUFDLENBQUM7UUFDOUIsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxPQUFPLENBQUMsSUFBSSxFQUFFLEtBQUssQ0FBQyxPQUFPLENBQUMsQ0FBQztRQUNsQyxNQUFNLE9BQU8sR0FBRyxJQUFBLG9CQUFXLEVBQUMsT0FBTyxDQUFDLENBQUM7UUFDckMsQ0FBQyxDQUFDLFNBQVMsQ0FBQyxPQUFPLEVBQUUsS0FBSyxDQUFDLENBQUM7SUFDOUIsQ0FBQyxDQUFDLENBQUM7QUFDTCxDQUFDLENBQUMsQ0FBQyJ9

package/build/main/lib/http.d.ts

@@ -0,0 +1,46 @@
+import { AxiosRequestConfig } from 'axios';
+import { ZodSchema } from 'zod';
+import { EncoderDecoder } from './encoder';
+import { UnaryClient } from './unary';
+import URL from './url';
+/**
+ * HTTPClientFactory provides a POST and GET implementation of the Unary protocol.
+ *
+ * @param url - The base URL of the API.
+ * @param encoder - The encoder/decoder to use for the request/response.
+ */
+export declare class HTTPClientFactory {
+    endpoint: URL;
+    encoder: EncoderDecoder;
+    constructor(endpoint: URL, encoder: EncoderDecoder);
+    getClient(): GETClient;
+    postClient(): POSTClient;
+}
+declare class Core {
+    endpoint: URL;
+    encoder: EncoderDecoder;
+    private static ERROR_ENCODING_HEADER_KEY;
+    private static ERROR_ENCODING_HEADER_VALUE;
+    private static CONTENT_TYPE_HEADER_KEY;
+    constructor(endpoint: URL, encoder: EncoderDecoder);
+    get headers(): {
+        [x: string]: string;
+    };
+    requestConfig(): AxiosRequestConfig;
+    execute<RS>(request: AxiosRequestConfig, resSchema: ZodSchema<RS>): Promise<[RS | undefined, Error | undefined]>;
+}
+/**
+ * Implementation of the UnaryClient protocol backed by HTTP GET requests. It
+ * should not be instantiated directly, but through the HTTPClientFactory.
+ */
+export declare class GETClient extends Core implements UnaryClient {
+    send<RQ, RS>(target: string, req: RQ, resSchema: ZodSchema<RS>): Promise<[RS | undefined, Error | undefined]>;
+}
+/**
+ * Implementation of the UnaryClient protocol backed by HTTP POST requests. It
+ * should not be instantiated directly, but through the HTTPClientFactory.
+ */
+export declare class POSTClient extends Core implements UnaryClient {
+    send<RQ, RS>(target: string, req: RQ, resSchema: ZodSchema<RS>): Promise<[RS | undefined, Error | undefined]>;
+}
+export {};