@enkaku/client 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024-present Paul Le Cam and contributors
+
+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,7 @@
+# Enkaku client
+
+## Installation
+
+```sh
+npm install @enkaku/client
+```

package/lib/index.d.ts

@@ -0,0 +1,54 @@
+import type { AnyActionDefinitions, ChannelActionDefinition, ClientTransportOf, EventActionDefinition, OptionalRecord, RequestActionDefinition, StreamActionDefinition } from '@enkaku/protocol';
+export type InvokeReturn<Result> = {
+    abort: (reason?: any) => void;
+    result: Promise<Result>;
+};
+export type InvokeStreamReturn<Receive, Result> = InvokeReturn<Result> & {
+    receive: AsyncIterable<Receive>;
+};
+export type InvokeChannelReturn<Send, Receive, Result> = InvokeStreamReturn<Receive, Result> & {
+    send: (value: Send) => Promise<void>;
+};
+export type EventDefinitionsType<Definitions extends AnyActionDefinitions, Names extends keyof Definitions & string = keyof Definitions & string> = {
+    [Name in Names]: Definitions[Name] extends EventActionDefinition<infer Data> ? {
+        Argument: Data extends undefined ? never : Data;
+        Return: undefined;
+    } : never;
+};
+export type RequestDefinitionsType<Definitions extends AnyActionDefinitions, Names extends keyof Definitions & string = keyof Definitions & string> = {
+    [Name in Names]: Definitions[Name] extends RequestActionDefinition<infer Params, infer Result> ? {
+        Argument: Params extends undefined ? never : Params;
+        Return: InvokeReturn<Result>;
+    } : never;
+};
+export type StreamDefinitionsType<Definitions extends AnyActionDefinitions, Names extends keyof Definitions & string = keyof Definitions & string> = {
+    [Name in Names]: Definitions[Name] extends StreamActionDefinition<infer Params, infer Receive, infer Result> ? {
+        Argument: Params extends undefined ? never : Params;
+        Return: InvokeStreamReturn<Receive, Result>;
+    } : never;
+};
+export type ChannelDefinitionsType<Definitions extends AnyActionDefinitions, Names extends keyof Definitions & string = keyof Definitions & string> = {
+    [Name in Names]: Definitions[Name] extends ChannelActionDefinition<infer Params, infer Send, infer Receive, infer Result> ? {
+        Argument: Params extends undefined ? never : Params;
+        Return: InvokeChannelReturn<Send, Receive, Result>;
+    } : never;
+};
+export type ClientDefinitionsType<Definitions extends AnyActionDefinitions> = {
+    Channels: ChannelDefinitionsType<Definitions>;
+    Events: EventDefinitionsType<Definitions>;
+    Requests: RequestDefinitionsType<Definitions>;
+    Streams: StreamDefinitionsType<Definitions>;
+};
+export type InvokeArgumentType<Definitions extends AnyActionDefinitions, Name extends keyof Definitions & string = keyof Definitions & string> = Definitions[Name] extends EventActionDefinition<infer Data> ? Data : Definitions[Name] extends RequestActionDefinition<infer Params> ? Params : Definitions[Name] extends StreamActionDefinition<infer Params> ? Params : Definitions[Name] extends ChannelActionDefinition<infer Params> ? Params : never;
+export type InvokeReturnType<Definitions extends AnyActionDefinitions, Name extends keyof Definitions & string> = Definitions[Name] extends EventActionDefinition<infer Data> ? undefined : Definitions[Name] extends RequestActionDefinition<infer Params, infer Result> ? InvokeReturn<Result> : Definitions[Name] extends StreamActionDefinition<infer Params, infer Receive, infer Result> ? InvokeStreamReturn<Receive, Result> : Definitions[Name] extends ChannelActionDefinition<infer Params, infer Send, infer Receive, infer Result> ? InvokeChannelReturn<Send, Receive, Result> : never;
+export type ClientParams<Definitions extends AnyActionDefinitions, Meta extends OptionalRecord = undefined> = {
+    transport: ClientTransportOf<Definitions, Meta>;
+    meta?: Meta;
+};
+export declare class Client<Definitions extends AnyActionDefinitions, Meta extends OptionalRecord, ClientDefinitions extends ClientDefinitionsType<Definitions> = ClientDefinitionsType<Definitions>> {
+    #private;
+    constructor(params: ClientParams<Definitions, Meta>);
+    sendEvent<Name extends keyof ClientDefinitions['Events'] & string, T extends ClientDefinitions['Events'][Name] = ClientDefinitions['Events'][Name]>(name: Name, ...args: T['Argument'] extends never ? [] : [T['Argument']]): Promise<void>;
+    request<Name extends keyof ClientDefinitions['Requests'] & string, T extends ClientDefinitions['Requests'][Name] = ClientDefinitions['Requests'][Name]>(name: Name, ...args: T['Argument'] extends never ? [] : [T['Argument']]): Promise<T['Return']>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EAEpB,uBAAuB,EACvB,iBAAiB,EACjB,qBAAqB,EACrB,cAAc,EACd,uBAAuB,EACvB,sBAAsB,EACvB,MAAM,kBAAkB,CAAA;AAGzB,MAAM,MAAM,YAAY,CAAC,MAAM,IAAI;IAEjC,KAAK,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,IAAI,CAAA;IAC7B,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,kBAAkB,CAAC,OAAO,EAAE,MAAM,IAAI,YAAY,CAAC,MAAM,CAAC,GAAG;IACvE,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,IAAI,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG;IAC7F,IAAI,EAAE,CAAC,KAAK,EAAE,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;CACrC,CAAA;AAED,MAAM,MAAM,oBAAoB,CAC9B,WAAW,SAAS,oBAAoB,EACxC,KAAK,SAAS,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,WAAW,GAAG,MAAM,IACnE;KACD,IAAI,IAAI,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,qBAAqB,CAAC,MAAM,IAAI,CAAC,GACxE;QACE,QAAQ,EAAE,IAAI,SAAS,SAAS,GAAG,KAAK,GAAG,IAAI,CAAA;QAC/C,MAAM,EAAE,SAAS,CAAA;KAClB,GACD,KAAK;CACV,CAAA;AAED,MAAM,MAAM,sBAAsB,CAChC,WAAW,SAAS,oBAAoB,EACxC,KAAK,SAAS,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,WAAW,GAAG,MAAM,IACnE;KACD,IAAI,IAAI,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,uBAAuB,CAAC,MAAM,MAAM,EAAE,MAAM,MAAM,CAAC,GAC1F;QACE,QAAQ,EAAE,MAAM,SAAS,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;QACnD,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,CAAA;KAC7B,GACD,KAAK;CACV,CAAA;AAED,MAAM,MAAM,qBAAqB,CAC/B,WAAW,SAAS,oBAAoB,EACxC,KAAK,SAAS,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,WAAW,GAAG,MAAM,IACnE;KACD,IAAI,IAAI,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,sBAAsB,CAC/D,MAAM,MAAM,EACZ,MAAM,OAAO,EACb,MAAM,MAAM,CACb,GACG;QACE,QAAQ,EAAE,MAAM,SAAS,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;QACnD,MAAM,EAAE,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;KAC5C,GACD,KAAK;CACV,CAAA;AAED,MAAM,MAAM,sBAAsB,CAChC,WAAW,SAAS,oBAAoB,EACxC,KAAK,SAAS,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,WAAW,GAAG,MAAM,IACnE;KACD,IAAI,IAAI,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,SAAS,uBAAuB,CAChE,MAAM,MAAM,EACZ,MAAM,IAAI,EACV,MAAM,OAAO,EACb,MAAM,MAAM,CACb,GACG;QACE,QAAQ,EAAE,MAAM,SAAS,SAAS,GAAG,KAAK,GAAG,MAAM,CAAA;QACnD,MAAM,EAAE,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;KACnD,GACD,KAAK;CACV,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,WAAW,SAAS,oBAAoB,IAAI;IAC5E,QAAQ,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAC7C,MAAM,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAA;IACzC,QAAQ,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAA;IAC7C,OAAO,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAA;CAC5C,CAAA;AAED,MAAM,MAAM,kBAAkB,CAC5B,WAAW,SAAS,oBAAoB,EACxC,IAAI,SAAS,MAAM,WAAW,GAAG,MAAM,GAAG,MAAM,WAAW,GAAG,MAAM,IAClE,WAAW,CAAC,IAAI,CAAC,SAAS,qBAAqB,CAAC,MAAM,IAAI,CAAC,GAC3D,IAAI,GACJ,WAAW,CAAC,IAAI,CAAC,SAAS,uBAAuB,CAAC,MAAM,MAAM,CAAC,GAC7D,MAAM,GACN,WAAW,CAAC,IAAI,CAAC,SAAS,sBAAsB,CAAC,MAAM,MAAM,CAAC,GAC5D,MAAM,GACN,WAAW,CAAC,IAAI,CAAC,SAAS,uBAAuB,CAAC,MAAM,MAAM,CAAC,GAC7D,MAAM,GACN,KAAK,CAAA;AAEf,MAAM,MAAM,gBAAgB,CAC1B,WAAW,SAAS,oBAAoB,EACxC,IAAI,SAAS,MAAM,WAAW,GAAG,MAAM,IACrC,WAAW,CAAC,IAAI,CAAC,SAAS,qBAAqB,CAAC,MAAM,IAAI,CAAC,GAC3D,SAAS,GACT,WAAW,CAAC,IAAI,CAAC,SAAS,uBAAuB,CAAC,MAAM,MAAM,EAAE,MAAM,MAAM,CAAC,GAC3E,YAAY,CAAC,MAAM,CAAC,GACpB,WAAW,CAAC,IAAI,CAAC,SAAS,sBAAsB,CAAC,MAAM,MAAM,EAAE,MAAM,OAAO,EAAE,MAAM,MAAM,CAAC,GACzF,kBAAkB,CAAC,OAAO,EAAE,MAAM,CAAC,GACnC,WAAW,CAAC,IAAI,CAAC,SAAS,uBAAuB,CAC7C,MAAM,MAAM,EACZ,MAAM,IAAI,EACV,MAAM,OAAO,EACb,MAAM,MAAM,CACb,GACD,mBAAmB,CAAC,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,GAC1C,KAAK,CAAA;AAoBf,MAAM,MAAM,YAAY,CACtB,WAAW,SAAS,oBAAoB,EACxC,IAAI,SAAS,cAAc,GAAG,SAAS,IACrC;IACF,SAAS,EAAE,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAA;IAC/C,IAAI,CAAC,EAAE,IAAI,CAAA;CACZ,CAAA;AAED,qBAAa,MAAM,CACjB,WAAW,SAAS,oBAAoB,EACxC,IAAI,SAAS,cAAc,EAC3B,iBAAiB,SAAS,qBAAqB,CAAC,WAAW,CAAC,GAAG,qBAAqB,CAAC,WAAW,CAAC;;gBAMrF,MAAM,EAAE,YAAY,CAAC,WAAW,EAAE,IAAI,CAAC;IAyC7C,SAAS,CACb,IAAI,SAAS,MAAM,iBAAiB,CAAC,QAAQ,CAAC,GAAG,MAAM,EACvD,CAAC,SAAS,iBAAiB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,EAC/E,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKnF,OAAO,CACX,IAAI,SAAS,MAAM,iBAAiB,CAAC,UAAU,CAAC,GAAG,MAAM,EACzD,CAAC,SAAS,iBAAiB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,EACnF,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,KAAK,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;CAsBjG"}

package/lib/index.js

@@ -0,0 +1,74 @@
+import { defer } from '@enkaku/util';
+export class Client {
+    #meta;
+    #transport;
+    #controllers = {};
+    constructor(params){
+        this.#meta = params.meta;
+        this.#transport = params.transport;
+        this.#read();
+    }
+    async #read() {
+        while(true){
+            const next = await this.#transport.read();
+            if (next.done) {
+                break;
+            }
+            const msg = next.value;
+            const controller = this.#controllers[msg.action.id];
+            if (controller == null) {
+                console.warn(`No controller for action ${msg.action.id}`);
+                continue;
+            }
+            switch(msg.action.type){
+                case 'error':
+                    // TODO: cast to Error instance
+                    controller.result.reject(msg.action.error);
+                    delete this.#controllers[msg.action.id];
+                    break;
+                case 'receive':
+                    break;
+                case 'result':
+                    controller.result.resolve(msg.action.value);
+                    delete this.#controllers[msg.action.id];
+                    break;
+            }
+        }
+    }
+    async #write(action) {
+        await this.#transport.write({
+            action,
+            meta: this.#meta
+        });
+    }
+    async sendEvent(name, ...args) {
+        const action = args.length ? {
+            type: 'event',
+            name,
+            data: args[0]
+        } : {
+            type: 'event',
+            name
+        };
+        await this.#write(action);
+    }
+    async request(name, ...args) {
+        const id = globalThis.crypto.randomUUID();
+        const controller = Object.assign(new AbortController(), {
+            result: defer()
+        });
+        this.#controllers[id] = controller;
+        const action = args.length ? {
+            type: 'request',
+            id,
+            name,
+            params: args[0]
+        } : {
+            type: 'request',
+            id,
+            name
+        };
+        await this.#write(action);
+        return controller.result.promise;
+    }
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@enkaku/client",
+  "version": "0.1.0",
+  "license": "MIT",
+  "keywords": [],
+  "type": "module",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "exports": {
+    ".": "./lib/index.js"
+  },
+  "files": [
+    "lib/*"
+  ],
+  "sideEffects": false,
+  "dependencies": {
+    "@enkaku/util": "^0.1.0"
+  },
+  "devDependencies": {
+    "@enkaku/protocol": "^0.1.0",
+    "@enkaku/transport": "^0.1.0"
+  },
+  "scripts": {
+    "build:clean": "del lib",
+    "build:js": "swc src -d ./lib --config-file ../../swc.json --strip-leading-paths",
+    "build:types": "tsc --emitDeclarationOnly --skipLibCheck",
+    "build:types:ci": "tsc --emitDeclarationOnly --declarationMap false",
+    "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:types",
+    "test:types": "tsc --noEmit",
+    "test:unit": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js",
+    "test": "pnpm run test:types && pnpm run test:unit"
+  }
+}