@nice-code/action 0.1.1 → 0.1.2

package/build/index.js

@@ -3393,6 +3393,7 @@ var EErrId_NiceTransport;
 ((EErrId_NiceTransport2) => {
   EErrId_NiceTransport2["timeout"] = "timeout";
   EErrId_NiceTransport2["not_found"] = "not_found";
+  EErrId_NiceTransport2["not_available"] = "not_available";
   EErrId_NiceTransport2["initialization_failed"] = "initialization_failed";
   EErrId_NiceTransport2["send_failed"] = "send_failed";
   EErrId_NiceTransport2["invalid_action_response"] = "invalid_action_response";
@@ -3406,6 +3407,9 @@ var err_nice_transport = err_nice_connect.createChildDomain({
     ["not_found" /* not_found */]: err({
       message: ({ actionId, routeKey, tag }) => `No connected transport found for action "${actionId}"${routeKey ? ` with route key "${routeKey}"` : ``}${tag ? ` and action tag "${tag}"` : ""}.`
     }),
+    ["not_available" /* not_available */]: err({
+      message: ({ transportCount }) => `${transportCount} Transport(s) found but were filtered out via filterUsage().`
+    }),
     ["initialization_failed" /* initialization_failed */]: err({
       message: ({ actionId, routeKey, tag }) => `Transports found for action "${actionId}"${routeKey ? ` with route key "${routeKey}"` : ""}${tag ? ` and action tag "${tag}"` : ""}, but none are ready.`
     }),
@@ -3487,13 +3491,21 @@ class Transport {
   def;
   type;
   requestResolvers = new Map;
+  _filterUsage;
   constructor(def) {
     this.def = def;
     this.type = def.type;
+    this._filterUsage = def.filterUsage;
   }
   get status() {
     return this._status;
   }
+  filterUsage(primed) {
+    if (this._filterUsage == null) {
+      return true;
+    }
+    return this._filterUsage(primed);
+  }
   checkAndPrepare() {
     return this._status;
   }
@@ -3533,6 +3545,7 @@ var ETransportType;
 ((ETransportType2) => {
   ETransportType2["ws"] = "ws";
   ETransportType2["http"] = "http";
+  ETransportType2["custom"] = "custom";
 })(ETransportType ||= {});
 var ETransportStatus;
 ((ETransportStatus2) => {
@@ -3621,6 +3634,7 @@ var err_nice_transport_ws = err_nice_transport.createChildDomain({
 class TransportWebSocket extends Transport {
   websocket;
   _status = { status: "uninitialized" /* uninitialized */ };
+  _customMessageSerde;
   constructor(def) {
     super(def);
   }
@@ -3642,21 +3656,24 @@ class TransportWebSocket extends Transport {
       waitForInitialization
     };
   }
-  handleMessage(data) {
+  handlePureActionResponseMessage(message) {
     let json;
     try {
-      json = JSON.parse(data);
+      json = JSON.parse(message);
     } catch {
       return;
     }
     if (!isActionResponseJsonObject(json)) {
       return;
     }
-    const pending = this.requestResolvers.get(json.cuid);
+    return json;
+  }
+  handleResponse(response) {
+    const pending = this.requestResolvers.get(response.cuid);
     if (pending == null) {
       return;
     }
-    this.respond(pending.primed.coreAction.actionDomain.hydrateResponse(json));
+    this.respond(pending.primed.coreAction.actionDomain.hydrateResponse(response));
   }
   rejectPendingWebSocketRequests(error) {
     for (const [, pending] of this.requestResolvers) {
@@ -3676,7 +3693,9 @@ class TransportWebSocket extends Transport {
       }
     };
     try {
-      this.websocket = await this.def.createWebSocket();
+      const { ws, customMessageSerde } = await this.def.createWebSocket();
+      this.websocket = ws;
+      this._customMessageSerde = customMessageSerde;
     } catch (e2) {
       console.error("Failed to create WebSocket:", e2);
       const error = err_nice_transport_ws.fromId("ws_create_failed" /* ws_create_failed */, {
@@ -3701,7 +3720,10 @@ class TransportWebSocket extends Transport {
     });
     this.websocket.addEventListener("message", (event) => {
       if (typeof event.data === "string") {
-        this.handleMessage(event.data);
+        const response = this._customMessageSerde?.deserialize?.(event.data) ?? this.handlePureActionResponseMessage(event.data);
+        if (response) {
+          this.handleResponse(response);
+        }
       }
     });
     this.websocket.addEventListener("close", (event) => {
@@ -3773,7 +3795,23 @@ class ConnectionConfig {
   async dispatch(primed, defaultTimeout) {
     const timeout = this.config.defaultTimeout ?? defaultTimeout;
     const initializingWaiters = [];
+    const unavailableTransports = [];
     for (const transport of this._transports) {
+      const isAvailable = transport.filterUsage(primed);
+      if (isAvailable instanceof Promise) {
+        try {
+          if (!await isAvailable) {
+            unavailableTransports.push(transport);
+            continue;
+          }
+        } catch {
+          unavailableTransports.push(transport);
+          continue;
+        }
+      } else if (!isAvailable) {
+        unavailableTransports.push(transport);
+        continue;
+      }
       const statusInfo = transport.checkAndPrepare();
       if (statusInfo.status === "ready" /* ready */) {
         return transport.makeRequest(primed, timeout);
@@ -3788,6 +3826,11 @@ class ConnectionConfig {
       }
     }
     if (initializingWaiters.length === 0) {
+      if (unavailableTransports.length > 0) {
+        throw err_nice_transport.fromId("not_available" /* not_available */, {
+          transportCount: unavailableTransports.length
+        });
+      }
       throw err_nice_transport.fromId("not_found" /* not_found */, {
         actionId: primed.id
       });

package/build/types/ActionDomain/NiceActionDomain.types.d.ts

@@ -1,6 +1,5 @@
 import type { NiceActionSchema } from "../ActionSchema/NiceActionSchema";
 import type { INiceActionErrorDeclaration, TTransportedValue } from "../ActionSchema/NiceActionSchema.types";
-export type MaybePromise<T> = T | Promise<T>;
 export type TPossibleDomainId = string;
 export type TPossibleDomainIdList = [TPossibleDomainId, ...TPossibleDomainId[]];
 export type TNiceActionDomainSchema = Record<string, NiceActionSchema<TTransportedValue<any, any>, TTransportedValue<any, any>, readonly INiceActionErrorDeclaration<any, any>[]>>;

package/build/types/ActionRuntimeEnvironment/ActionConnect/Transport/Transport.d.ts

@@ -1,3 +1,4 @@
+import type { MaybePromise } from "../../..";
 import type { NiceActionPrimed } from "../../../NiceAction/NiceActionPrimed";
 import type { NiceActionResponse } from "../../../NiceAction/NiceActionResponse";
 import { type ITransportPendingRequest, type TActionTransportDef, type TTransportStatusInfo } from "./Transport.types";
@@ -6,8 +7,10 @@ export declare abstract class Transport<DEF extends TActionTransportDef> {
     readonly type: DEF["type"];
     readonly requestResolvers: Map<string, ITransportPendingRequest>;
     protected abstract _status: TTransportStatusInfo;
+    protected _filterUsage?: (primed: NiceActionPrimed<any>) => MaybePromise<boolean>;
     constructor(def: DEF);
     get status(): TTransportStatusInfo;
+    filterUsage(primed: NiceActionPrimed<any>): MaybePromise<boolean>;
     checkAndPrepare(): TTransportStatusInfo;
     protected abstract send(primed: NiceActionPrimed<any>): Promise<void>;
     abstract disconnect(): void;

package/build/types/ActionRuntimeEnvironment/ActionConnect/Transport/Transport.types.d.ts

@@ -1,10 +1,12 @@
-import type { NiceError } from "@nice-code/error";
+import type { MaybePromise, NiceError } from "@nice-code/error";
+import type { INiceActionPrimed_JsonObject, TNiceActionResponse_JsonObject } from "../../../NiceAction/NiceAction.types";
 import type { NiceActionPrimed } from "../../../NiceAction/NiceActionPrimed";
 import type { NiceActionResponse } from "../../../NiceAction/NiceActionResponse";
 import type { Transport } from "./Transport";
 export declare enum ETransportType {
     ws = "ws",
-    http = "http"
+    http = "http",
+    custom = "custom"
 }
 export declare enum ETransportStatus {
     uninitialized = "uninitialized",
@@ -31,16 +33,34 @@ export type TTransportStatusInfo = ITransportStatusInfo_Base<ETransportStatus.un
 export interface IActionTransport_Base {
     /** Per-transport timeout override (ms) */
     timeout?: number;
+    filterUsage?: (primed: NiceActionPrimed<any>) => MaybePromise<boolean>;
+}
+export interface ICustomWebsocketMessageSerde {
+    serialize?: (primedJson: INiceActionPrimed_JsonObject<any>) => string;
+    deserialize?: (message: string) => TNiceActionResponse_JsonObject<any>;
 }
 export interface IActionTransportDef_Ws extends IActionTransport_Base {
     type: ETransportType.ws;
-    createWebSocket: () => Promise<WebSocket>;
+    createWebSocket: () => Promise<{
+        ws: WebSocket;
+        customMessageSerde?: ICustomWebsocketMessageSerde;
+    }>;
 }
 export interface IActionTransportDef_Http extends IActionTransport_Base {
     type: ETransportType.http;
     url: string;
 }
-export type TActionTransportDef = IActionTransportDef_Ws | IActionTransportDef_Http;
+export interface ICustomActionTransport {
+    checkAndPrepare: () => TTransportStatusInfo;
+    handleAction: (primed: NiceActionPrimed<any>, onResponse: (response: NiceActionResponse<any>) => void) => Promise<void>;
+    onDisconnect: () => void;
+}
+export interface IActionTransportDef_Custom extends IActionTransport_Base {
+    type: ETransportType.custom;
+    initialStatus: TTransportStatusInfo;
+    createTransport: () => ICustomActionTransport;
+}
+export type TActionTransportDef = IActionTransportDef_Ws | IActionTransportDef_Http | IActionTransportDef_Custom;
 export interface ITransportPendingRequest {
     type: ETransportType;
     resolve: (response: NiceActionResponse<any>) => void;

package/build/types/ActionRuntimeEnvironment/ActionConnect/Transport/TransportCustom.d.ts

@@ -0,0 +1,12 @@
+import type { NiceActionPrimed } from "../../../NiceAction/NiceActionPrimed";
+import { Transport } from "./Transport";
+import { type IActionTransportDef_Custom, type TTransportStatusInfo } from "./Transport.types";
+export declare class TransportCustom extends Transport<IActionTransportDef_Custom> {
+    readonly abortControllers: Map<string, AbortController>;
+    protected _status: TTransportStatusInfo;
+    private _customTransport;
+    constructor(def: IActionTransportDef_Custom);
+    checkAndPrepare(): TTransportStatusInfo;
+    send(primed: NiceActionPrimed<any>): Promise<void>;
+    disconnect(): void;
+}

package/build/types/ActionRuntimeEnvironment/ActionConnect/Transport/TransportWebSocket.d.ts

@@ -4,10 +4,12 @@ import { type IActionTransportDef_Ws, type TTransportStatusInfo } from "./Transp
 export declare class TransportWebSocket extends Transport<IActionTransportDef_Ws> {
     websocket?: WebSocket;
     protected _status: TTransportStatusInfo;
+    private _customMessageSerde?;
     constructor(def: IActionTransportDef_Ws);
     checkAndPrepare(): TTransportStatusInfo;
     private startInitializing;
-    private handleMessage;
+    private handlePureActionResponseMessage;
+    private handleResponse;
     private rejectPendingWebSocketRequests;
     private _connect;
     protected send(primed: NiceActionPrimed<any>): Promise<void>;

package/build/types/ActionRuntimeEnvironment/ActionConnect/Transport/err_nice_transport.d.ts

@@ -1,6 +1,7 @@
 export declare enum EErrId_NiceTransport {
     timeout = "timeout",
     not_found = "not_found",
+    not_available = "not_available",
     initialization_failed = "initialization_failed",
     send_failed = "send_failed",
     invalid_action_response = "invalid_action_response"
@@ -17,6 +18,9 @@ export declare const err_nice_transport: import("@nice-code/error").NiceErrorDom
             routeKey?: string;
             tag?: string;
         }, import("@nice-code/error").JSONSerializableValue>;
+        not_available: import("@nice-code/error").INiceErrorIdMetadata<{
+            transportCount: number;
+        }, import("@nice-code/error").JSONSerializableValue>;
         initialization_failed: import("@nice-code/error").INiceErrorIdMetadata<{
             actionId: string;
             routeKey?: string;

package/build/types/ActionRuntimeEnvironment/ActionHandler/ActionHandler.types.d.ts

@@ -1,8 +1,9 @@
-import type { INiceActionDomain, MaybePromise, TInferOutputFromSchema } from "../../ActionDomain/NiceActionDomain.types";
+import type { INiceActionDomain, TInferOutputFromSchema } from "../../ActionDomain/NiceActionDomain.types";
 import type { INiceAction, TNiceActionResponse_JsonObject } from "../../NiceAction/NiceAction.types";
 import type { TDistributedDomainActions } from "../../NiceAction/NiceActionCombined.types";
 import type { NiceActionPrimed } from "../../NiceAction/NiceActionPrimed";
 import type { NiceActionResponse } from "../../NiceAction/NiceActionResponse";
+import type { MaybePromise } from "../../utils/maybePromise";
 import type { IRuntimeEnvironmentMeta } from "../ActionRuntimeEnvironment.types";
 export type TAtLeastOne<T extends object> = {
     [K in keyof T]-?: Required<Pick<T, K>> & Partial<Omit<T, K>>;

package/build/types/NiceAction/MatchAction/MatchAction.d.ts

@@ -1,4 +1,5 @@
-import type { INiceActionDomain, MaybePromise } from "../../ActionDomain/NiceActionDomain.types";
+import type { INiceActionDomain } from "../../ActionDomain/NiceActionDomain.types";
+import type { MaybePromise } from "../../utils/maybePromise";
 import type { INiceAction } from "../NiceAction.types";
 import type { TNarrowActionType } from "../NiceActionCombined.types";
 type TMatchHandler<A extends INiceAction<any>> = (action: A) => MaybePromise<void>;

package/build/types/index.d.ts

@@ -1,6 +1,6 @@
 export { createActionRootDomain } from "./ActionDomain/helpers/createRootActionDomain";
 export { NiceActionDomain } from "./ActionDomain/NiceActionDomain";
-export type { INiceActionDomain, INiceActionDomainChildOptions, INiceActionRootDomain, MaybePromise, TDomainActionId, TInferInputFromSchema, TInferOutputFromSchema, TNiceActionDomainChildDef, TNiceActionDomainSchema, TPossibleDomainId, TPossibleDomainIdList, } from "./ActionDomain/NiceActionDomain.types";
+export type { INiceActionDomain, INiceActionDomainChildOptions, INiceActionRootDomain, TDomainActionId, TInferInputFromSchema, TInferOutputFromSchema, TNiceActionDomainChildDef, TNiceActionDomainSchema, TPossibleDomainId, TPossibleDomainIdList, } from "./ActionDomain/NiceActionDomain.types";
 export { NiceActionRootDomain } from "./ActionDomain/RootDomain/NiceActionRootDomain";
 export { ActionConnect } from "./ActionRuntimeEnvironment/ActionConnect/ActionConnect";
 export * from "./ActionRuntimeEnvironment/ActionConnect/ActionConnect.types";
@@ -30,3 +30,4 @@ export { NiceActionPrimed } from "./NiceAction/NiceActionPrimed";
 export { NiceActionResponse } from "./NiceAction/NiceActionResponse";
 export * from "./utils/isActionResponseJsonObject";
 export * from "./utils/isPrimedActionJsonObject";
+export * from "./utils/maybePromise";

package/build/types/utils/maybePromise.d.ts

@@ -0,0 +1 @@
+export type MaybePromise<T> = T | Promise<T>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nice-code/action",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "private": false,
   "type": "module",
   "exports": {
@@ -32,8 +32,8 @@
     "build-types": "tsc --project tsconfig.build.json"
   },
   "dependencies": {
-    "@nice-code/error": "0.1.1",
-    "@nice-code/common-errors": "0.1.1",
+    "@nice-code/error": "0.1.2",
+    "@nice-code/common-errors": "0.1.2",
     "@standard-schema/spec": "^1.1.0",
     "http-status-codes": "^2.3.0",
     "nanoid": "^5.1.9",