@liphium/neoroute-ts 0.1.0 → 0.2.0

package/dist/transporter/transporter_websocket.js

@@ -1,93 +0,0 @@
-import { logger } from '../logger.js';
-export class WebSocketTransporter {
-    conn = null;
-    receiver;
-    options;
-    connected = false;
-    queue = [];
-    constructor(receiver, options) {
-        this.receiver = receiver;
-        this.options = options;
-    }
-    /// Will start a connection to the server. Will not block until the connection is open.
-    ///
-    /// All things sent before the connection is open are queued, so feel free to send already after calling connect.
-    connect(url) {
-        if (this.connected || this.conn) {
-            return;
-        }
-        // Queue outgoing messages until connection is open
-        this.receiver.setSendFunc(async (data) => {
-            if (this.connected && this.conn?.readyState === WebSocket.OPEN) {
-                this.conn.send(data); // TODO: Find out if this is actually fine xd
-            }
-            else {
-                this.queue.push(data);
-            }
-        });
-        // Add a timeout to make sure the connection actually happens
-        const timeout = setTimeout(() => {
-            if (this.conn?.readyState !== WebSocket.OPEN) {
-                this.close('connection timeout');
-            }
-        }, this.options.connectionTimeout ?? 20000);
-        // Init WebSocket to open the actual connection
-        this.conn = new WebSocket(url);
-        this.conn.binaryType = 'arraybuffer';
-        this.conn.onopen = () => {
-            if (!this.conn)
-                return;
-            clearTimeout(timeout);
-            this.connected = true;
-            // Call onOpen callback
-            this.options.onOpen?.();
-            // Flush queue
-            while (this.queue.length > 0) {
-                const data = this.queue.shift();
-                if (data) {
-                    this.conn.send(data);
-                }
-            }
-        };
-        // When there is an error, we immediately disconnect
-        this.conn.onerror = () => {
-            if (this.conn) {
-                this.close('websocket error');
-            }
-        };
-        // Even on a close, we want to quickly close the thingy to notify the event handler for onError and update internal state
-        this.conn.onclose = (event) => {
-            if (this.conn) {
-                this.close(`websocket connection closed: ${event.code} ${event.reason}`);
-            }
-        };
-        // Forward messages to the receiver
-        this.conn.onmessage = (event) => {
-            if (event.data instanceof ArrayBuffer) {
-                this.receiver.handle(new Uint8Array(event.data));
-            }
-            else {
-                // If we get this, the browser is doing something weird
-                logger.error('wrong message type received:', typeof event.data);
-                this.close('wrong kind of message received');
-            }
-        };
-    }
-    /// Closes the connection to the server. Will not throw if the connection is already closed.
-    close(reason = 'Connection closed') {
-        const wasConnected = this.connected || !!this.conn;
-        this.connected = false;
-        if (this.conn) {
-            const c = this.conn;
-            this.conn = null;
-            c.close(1000, reason);
-        }
-        if (wasConnected) {
-            this.receiver.getConfig().errorHandler(new Error(reason));
-        }
-    }
-    isConnected() {
-        return this.connected;
-    }
-}
-//# sourceMappingURL=transporter_websocket.js.map

package/dist/transporter/transporter_websocket.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"transporter_websocket.js","sourceRoot":"","sources":["../../src/transporter/transporter_websocket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAWtC,MAAM,OAAO,oBAAoB;IACxB,IAAI,GAAqB,IAAI,CAAC;IAC9B,QAAQ,CAAW;IACnB,OAAO,CAAmB;IAC1B,SAAS,GAAY,KAAK,CAAC;IAC3B,KAAK,GAAiB,EAAE,CAAC;IAEjC,YAAY,QAAkB,EAAE,OAAyB;QACxD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACxB,CAAC;IAED,uFAAuF;IACvF,GAAG;IACH,iHAAiH;IAC1G,OAAO,CAAC,GAAW;QACzB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACjC,OAAO;QACR,CAAC;QAED,mDAAmD;QACnD,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,KAAK,EAAE,IAAgB,EAAiB,EAAE;YACnE,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,EAAE,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBAChE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAW,CAAC,CAAC,CAAC,6CAA6C;YAC3E,CAAC;iBAAM,CAAC;gBACP,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACvB,CAAC;QACF,CAAC,CAAC,CAAC;QAEH,6DAA6D;QAC7D,MAAM,OAAO,GAAG,UAAU,CAAC,GAAG,EAAE;YAC/B,IAAI,IAAI,CAAC,IAAI,EAAE,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBAC9C,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;YAClC,CAAC;QACF,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,KAAK,CAAC,CAAC;QAE5C,+CAA+C;QAC/C,IAAI,CAAC,IAAI,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC;QAErC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE;YACvB,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAO;YAEvB,YAAY,CAAC,OAAO,CAAC,CAAC;YACtB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;YAEtB,uBAAuB;YACvB,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC;YAExB,cAAc;YACd,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,IAAI,EAAE,CAAC;oBACV,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAW,CAAC,CAAC;gBAC7B,CAAC;YACF,CAAC;QACF,CAAC,CAAC;QAEF,oDAAoD;QACpD,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,EAAE;YACxB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACf,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAC/B,CAAC;QACF,CAAC,CAAC;QAEF,yHAAyH;QACzH,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE;YAC7B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBACf,IAAI,CAAC,KAAK,CACT,gCAAgC,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,EAAE,CAC5D,CAAC;YACH,CAAC;QACF,CAAC,CAAC;QAEF,mCAAmC;QACnC,IAAI,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,KAAK,EAAE,EAAE;YAC/B,IAAI,KAAK,CAAC,IAAI,YAAY,WAAW,EAAE,CAAC;gBACvC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACP,uDAAuD;gBACvD,MAAM,CAAC,KAAK,CAAC,8BAA8B,EAAE,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC;gBAChE,IAAI,CAAC,KAAK,CAAC,gCAAgC,CAAC,CAAC;YAC9C,CAAC;QACF,CAAC,CAAC;IACH,CAAC;IAED,4FAA4F;IACrF,KAAK,CAAC,SAAiB,mBAAmB;QAChD,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;QACnD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACvB,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC;YACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;YACjB,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvB,CAAC;QACD,IAAI,YAAY,EAAE,CAAC;YAClB,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,CAAC,YAAY,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;QAC3D,CAAC;IACF,CAAC;IAEM,WAAW;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACvB,CAAC;CACD"}

package/dist/user_error.d.ts

@@ -1,4 +0,0 @@
-export declare class UserError extends Error {
-    constructor(message: string);
-}
-//# sourceMappingURL=user_error.d.ts.map

package/dist/user_error.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"user_error.d.ts","sourceRoot":"","sources":["../src/user_error.ts"],"names":[],"mappings":"AAAA,qBAAa,SAAU,SAAQ,KAAK;gBACvB,OAAO,EAAE,MAAM;CAmB3B"}

package/dist/user_error.js

@@ -1,11 +0,0 @@
-export class UserError extends Error {
-    constructor(message) {
-        super(message);
-        this.name = 'UserError';
-        if (typeof Error
-            .captureStackTrace === 'function') {
-            Error.captureStackTrace(this, UserError);
-        }
-    }
-}
-//# sourceMappingURL=user_error.js.map

package/dist/user_error.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"user_error.js","sourceRoot":"","sources":["../src/user_error.ts"],"names":[],"mappings":"AAAA,MAAM,OAAO,SAAU,SAAQ,KAAK;IACnC,YAAY,OAAe;QAC1B,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC;QAExB,IACC,OAAQ,KAA4D;aAClE,iBAAiB,KAAK,UAAU,EACjC,CAAC;YAED,KAMA,CAAC,iBAAiB,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QACtC,CAAC;IACF,CAAC;CACD"}

package/dist/util.d.ts

@@ -1,9 +0,0 @@
-export declare function newPromiseWithResolver<T>(): {
-    resolve: (value: T | PromiseLike<T>) => void;
-    reject: (reason?: any) => void;
-    promise: Promise<T>;
-};
-export declare function withTimeout<T>(promise: Promise<T>, timeoutMs: number, onTimeout?: () => void): Promise<T>;
-export declare function marshalRequestData<RQ>(req: RQ): Uint8Array;
-export declare function unmarshalResponseData<RS>(respBytes: Uint8Array): RS;
-//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAGA,wBAAgB,sBAAsB,CAAC,CAAC,KAAK;IAC5C,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;IAC7C,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IAC/B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;CACpB,CAUA;AAGD,wBAAgB,WAAW,CAAC,CAAC,EAC5B,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EACnB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,IAAI,GACpB,OAAO,CAAC,CAAC,CAAC,CAiBZ;AAED,wBAAgB,kBAAkB,CAAC,EAAE,EAAE,GAAG,EAAE,EAAE,GAAG,UAAU,CAM1D;AAED,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,SAAS,EAAE,UAAU,GAAG,EAAE,CAMnE"}

package/dist/util.js

@@ -1,42 +0,0 @@
-import { decode, encode } from '@msgpack/msgpack';
-// Creates a promise that can be resolved or rejected externally. This is useful for creating a promise that can be resolved or rejected at a later time, such as when waiting for an event to occur.
-export function newPromiseWithResolver() {
-    let resolve;
-    let reject;
-    const promise = new Promise((res, rej) => {
-        resolve = res;
-        reject = rej;
-    });
-    return { resolve, reject, promise };
-}
-// Helper to create a timeout promise
-export function withTimeout(promise, timeoutMs, onTimeout) {
-    let timeoutId;
-    const timeoutPromise = new Promise((_, reject) => {
-        timeoutId = setTimeout(() => {
-            onTimeout?.();
-            reject(new Error(`waiting for response timed out after ${timeoutMs}ms`));
-        }, timeoutMs);
-    });
-    return Promise.race([
-        promise.finally(() => clearTimeout(timeoutId)),
-        timeoutPromise,
-    ]);
-}
-export function marshalRequestData(req) {
-    try {
-        return encode(req);
-    }
-    catch (error) {
-        throw new Error(`failed to marshal request data: ${error}`);
-    }
-}
-export function unmarshalResponseData(respBytes) {
-    try {
-        return decode(respBytes);
-    }
-    catch (error) {
-        throw new Error(`failed to unmarshal response data: ${error}`);
-    }
-}
-//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAElD,qMAAqM;AACrM,MAAM,UAAU,sBAAsB;IAKrC,IAAI,OAA6C,CAAC;IAClD,IAAI,MAA+B,CAAC;IAEpC,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC3C,OAAO,GAAG,GAAG,CAAC;QACd,MAAM,GAAG,GAAG,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AACrC,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,WAAW,CAC1B,OAAmB,EACnB,SAAiB,EACjB,SAAsB;IAEtB,IAAI,SAAwC,CAAC;IAC7C,MAAM,cAAc,GAAG,IAAI,OAAO,CAAI,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE;QACnD,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAC3B,SAAS,EAAE,EAAE,CAAC;YACd,MAAM,CACL,IAAI,KAAK,CACR,wCAAwC,SAAS,IAAI,CACrD,CACD,CAAC;QACH,CAAC,EAAE,SAAS,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,IAAI,CAAC;QACnB,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC9C,cAAc;KACd,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAK,GAAO;IAC7C,IAAI,CAAC;QACJ,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,mCAAmC,KAAK,EAAE,CAAC,CAAC;IAC7D,CAAC;AACF,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAK,SAAqB;IAC9D,IAAI,CAAC;QACJ,OAAO,MAAM,CAAC,SAAS,CAAO,CAAC;IAChC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,sCAAsC,KAAK,EAAE,CAAC,CAAC;IAChE,CAAC;AACF,CAAC"}

package/readme.md

@@ -1,49 +0,0 @@
-# Neoroute-TS
-
-## Examples
-
-This repository contains two interactive command-line examples to test the `@liphium/neoroute-client` TypeScript library. These clients are designed to communicate with a local Neoroute Go server running on port `6121`.
-
-### Prerequisites
-
-Before running the examples, ensure you have the following ready:
-
-1. **Node.js** (v18 or higher recommended).
-2. The corresponding **[Neoroute Example Server](https://github.com/Liphium/neoroute/tree/main/examples)** must be running locally (`go run .`).
-3. The main library (`@liphium/neoroute-ts-client`) must be built. If you make changes to the core library, simply run `npm run build` in the base directory. The examples use a local symlink and will automatically use the updated build.
-
----
-
-### 1. WebSocket Client (`examples/web_socket_client`)
-
-This client tests the persistent WebSocket connection, event listening, and basic request/response flows.
-
-#### Setup & Run
-
-Navigate to the WebSocket client directory and install the dependencies:
-
-```bash
-cd examples/web_socket_client
-npm install
-npx tsx src/main.ts
-```
-
----
-
-### 2. HTTP Client (`examples/http_client`)
-
-This client tests the stateless HTTP transporter, routing groups, and middleware authentication (token validation via URL parameters).
-
-#### Setup & Run
-
-Navigate to the WebSocket client directory and install the dependencies:
-
-```bash
-cd examples/http_client
-npm install
-npx tsx src/main.ts
-```
-
-## Development Note
-
-Both clients use `tsx` to execute the TypeScript files directly without a manual compilation step.