@4players/odin-common 1.1.0 → 1.2.0

package/lib/utility/json.spec.d.ts

@@ -1,4 +1,4 @@
-export declare class ToRawFunctionTestSuite {
+export declare class JsonTestSuite {
     handleString(): void;
     handleNumber(): void;
     handleBoolean(): void;

package/lib/utility/result.spec.d.ts

@@ -0,0 +1,4 @@
+export declare class ResultTestSuite {
+    isSuccess(): void;
+    isFailure(): void;
+}

package/lib/utility/rpc.d.ts

@@ -1,6 +1,8 @@
 import * as z from 'zod';
+import { WebSocket } from 'ws';
 import { MessagePackRpc } from '../schema/serialization';
-import { Result } from './result';
+import { Accept, Result } from './result';
+import { Commands } from '../rpc/commands';
 import { Notifications } from '../rpc/notifications';
 export declare function msgpackEncode(value: unknown): ArrayBuffer;
 export declare function msgpackDecode(buffer: ArrayBuffer): unknown;
@@ -8,6 +10,33 @@ export interface RpcMessage {
     name: string;
     properties: unknown;
 }
+export interface RpcRequest {
+    resolve: Accept<Result<unknown> | 'closed' | 'timeout'>;
+    timeoutId: ReturnType<typeof setTimeout> | undefined;
+}
+export declare class RpcConnection {
+    readonly webSocket: WebSocket;
+    private readonly _SendQueue;
+    private readonly _RecvQueue;
+    private readonly _Requests;
+    private readonly _Close;
+    private _NextId;
+    get closed(): boolean;
+    get closeSignal(): AbortSignal;
+    constructor(webSocket: WebSocket);
+    request(name: string, properties: unknown): Promise<Result<unknown> | 'closed'>;
+    request(name: string, properties: unknown, timeout: number): Promise<Result<unknown> | 'closed' | 'timeout'>;
+    notify(name: string, properties: unknown): void;
+    recv(): Promise<RpcMessage | 'closed'>;
+    close(): void;
+    private _TimeoutRequest;
+    private _Send;
+    private _OnWebSocketOpen;
+    private _OnWebSocketMessage;
+    private _OnResponse;
+    private _OnEvent;
+    private _Cleanup;
+}
 export interface TypedRpcMessage<Name extends string, Properties> extends RpcMessage {
     name: Name;
     properties: Properties;
@@ -15,5 +44,15 @@ export interface TypedRpcMessage<Name extends string, Properties> extends RpcMes
 export type RealizedEvents<E extends Notifications> = {
     [Name in Extract<keyof E, string>]: TypedRpcMessage<Name, z.infer<E[Name]>>;
 }[Extract<keyof E, string>];
+export declare class TypedRpcConnection<C extends Commands, E extends Notifications> extends RpcConnection {
+    readonly _Commands: C;
+    readonly _Events: E;
+    constructor(webSocket: WebSocket, _Commands: C, _Events: E);
+    request<Name extends Extract<keyof C, string>>(name: Name, properties: z.infer<C[Name]['request']>): Promise<Result<z.infer<C[Name]['response']>> | 'closed'>;
+    request<Name extends Extract<keyof C, string>>(name: Name, properties: z.infer<C[Name]['request']>, timeout: number): Promise<Result<z.infer<C[Name]['response']>> | 'closed' | 'timeout'>;
+    notify<Name extends Extract<keyof C, string>>(name: Name, properties: z.infer<C[Name]['request']>): void;
+    recv(): Promise<RealizedEvents<E> | 'closed'>;
+}
 export declare function parseRpc(buffer: ArrayBuffer): Result<MessagePackRpc>;
 export declare function parseRpcMessage<E extends Notifications>(events: E, rpc: RpcMessage): RealizedEvents<E> | undefined;
+export declare function isKnownRpcMessage<E extends Notifications>(events: E, name: string): name is Extract<keyof E, string>;

package/lib/utility/rpc.spec.d.ts

@@ -0,0 +1,7 @@
+export declare class RpcTestSuite {
+    sendRequest(): Promise<void>;
+    resetWebSocketServer(): void;
+    closeWebSocketServer(): void;
+    resetWebSocketClient(): void;
+    closeWebSocketClient(): void;
+}

package/lib/utility/selector.d.ts

@@ -1,7 +1,7 @@
 export declare class Selector<T extends Array<() => PromiseLike<unknown>>> {
-    private readonly generators;
-    private readonly futures;
-    constructor(generators: T);
+    private readonly _Generators;
+    private readonly _Futures;
+    constructor(_Generators: T);
     next(): Promise<Awaited<ReturnType<T[number]>>>;
     static addIndex(generator: () => PromiseLike<unknown>, index: number): Promise<[unknown, number]>;
 }

package/lib/utility/selector.spec.d.ts

@@ -0,0 +1,4 @@
+export declare class SelectorTestSuite {
+    nextSingle(): Promise<void>;
+    setup(): void;
+}

package/lib/utility/strand.d.ts

@@ -1,6 +1,6 @@
 export declare class Strand {
-    private readonly tasks;
-    private running;
+    private readonly _Tasks;
+    private _Running;
     enqueue<T>(task: () => Promise<T>): Promise<T>;
     private execute;
 }

package/lib/utility/strand.spec.d.ts

@@ -0,0 +1,4 @@
+export declare class StrandTestSuite {
+    enqueueAndExecute(): Promise<void>;
+    setup(): void;
+}

package/lib/utility/url.spec.d.ts

@@ -0,0 +1,4 @@
+export declare class UrlTestSuite {
+    urlNormalization(): Promise<void>;
+    urlExtension(): Promise<void>;
+}

package/lib/utility/validation.spec.d.ts

@@ -0,0 +1,3 @@
+export declare class ValidationTestSuite {
+    hasProperty(): Promise<void>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4players/odin-common",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A collection of commonly used type definitions and utility functions across ODIN web projects",
   "author": "Josho Bleicker <josho.bleicker@4players.io> (https://www.4players.io)",
   "homepage": "https://www.4players.io",

package/testy.json

@@ -1,4 +0,0 @@
-{
-    "include": ["src/**/*.spec.ts"],
-    "timeout": 30000
-}