@nice-code/action 0.7.0 → 0.9.0

package/build/types/errors/err_nice_action.d.ts

@@ -1,96 +0,0 @@
-import type { IActionRuntimeManagerContext } from "../ActionRuntime/ActionRuntime.types";
-import type { RuntimeCoordinate, TRuntimeCoordinateStringId } from "../ActionRuntime/RuntimeCoordinate";
-export declare enum EErrId_NiceAction {
-    not_implemented = "not_implemented",
-    action_id_not_in_domain = "action_id_not_in_domain",
-    domain_already_exists_in_hierarchy = "domain_already_exists_in_hierarchy",
-    domain_no_handler = "domain_no_handler",
-    hydration_domain_mismatch = "hydration_domain_mismatch",
-    hydration_action_state_mismatch = "hydration_action_state_mismatch",
-    hydration_action_id_not_found = "hydration_action_id_not_found",
-    no_action_execution_handler = "no_action_execution_handler",
-    wire_action_not_payload = "wire_action_not_payload",
-    wire_not_action_data = "wire_not_action_data",
-    client_runtime_already_registered = "client_runtime_already_registered",
-    client_runtime_not_registered = "client_runtime_not_registered",
-    runtime_reset = "runtime_reset",
-    no_client_runtimes_registered = "no_client_runtimes_registered",
-    action_input_validation_failed = "action_input_validation_failed",
-    action_input_validation_promise = "action_input_validation_promise",
-    action_output_validation_failed = "action_output_validation_failed",
-    action_output_validation_promise = "action_output_validation_promise"
-}
-export declare const err_nice_action: import("@nice-code/error").NiceErrorDomain<{
-    domain: string;
-    allDomains: [string, "err_nice"];
-    schema: {
-        not_implemented: import("@nice-code/error").INiceErrorIdMetadata<{
-            label: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        action_id_not_in_domain: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        domain_already_exists_in_hierarchy: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            allParentDomains: string[];
-            parentDomain: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        domain_no_handler: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        hydration_domain_mismatch: import("@nice-code/error").INiceErrorIdMetadata<{
-            expected: string;
-            received: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        hydration_action_state_mismatch: import("@nice-code/error").INiceErrorIdMetadata<{
-            expected: string;
-            received: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        hydration_action_id_not_found: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        no_action_execution_handler: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-            specifiedClient?: RuntimeCoordinate;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        wire_action_not_payload: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-            actionState: string | undefined;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        wire_not_action_data: import("@nice-code/error").INiceErrorIdMetadata<any, import("@nice-code/error").JSONSerializableValue>;
-        runtime_reset: import("@nice-code/error").INiceErrorIdMetadata<any, import("@nice-code/error").JSONSerializableValue>;
-        client_runtime_already_registered: import("@nice-code/error").INiceErrorIdMetadata<{
-            context?: IActionRuntimeManagerContext;
-            client: RuntimeCoordinate;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        client_runtime_not_registered: import("@nice-code/error").INiceErrorIdMetadata<{
-            context?: IActionRuntimeManagerContext;
-            clientStringId: TRuntimeCoordinateStringId;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        no_client_runtimes_registered: import("@nice-code/error").INiceErrorIdMetadata<{
-            context?: IActionRuntimeManagerContext;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        action_input_validation_failed: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-            validationMessage: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        action_input_validation_promise: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        action_output_validation_failed: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-            validationMessage: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-        action_output_validation_promise: import("@nice-code/error").INiceErrorIdMetadata<{
-            domain: string;
-            actionId: string;
-        }, import("@nice-code/error").JSONSerializableValue>;
-    };
-}>;

package/build/types/index.d.ts

@@ -1,41 +0,0 @@
-export { ActionCore } from "./ActionDefinition/Action/Core/ActionCore";
-export * from "./ActionDefinition/Action/Core/ActionCore.types";
-export * from "./ActionDefinition/Action/Payload/ActionPayload.types";
-export type * from "./ActionDefinition/Action/Payload/ActionPayload_Progress";
-export type * from "./ActionDefinition/Action/Payload/ActionPayload_Request";
-export type * from "./ActionDefinition/Action/Payload/ActionPayload_Request";
-export type * from "./ActionDefinition/Action/Payload/ActionPayload_Result";
-export { RunningAction } from "./ActionDefinition/Action/RunningAction";
-export { ERunningActionFinishedType, ERunningActionState, ERunningActionUpdateType, type IRunningActionUpdate_Abort, type IRunningActionUpdate_Progress, type IRunningActionUpdate_Started, type IRunningActionUpdate_Success, type TRunningActionUpdate, type TRunningActionUpdateFinished, type TRunningActionUpdateListener, } from "./ActionDefinition/Action/RunningAction.types";
-export { ActionDomain } from "./ActionDefinition/Domain/ActionDomain";
-export type { IActionDomain, IActionDomainChildOptions, IActionRootDomain, TActionDomainChildDef, TActionDomainSchema, TDomainActionId, TInferInputFromSchema, TInferOutputFromSchema, TPossibleDomainId, TPossibleDomainIdList, } from "./ActionDefinition/Domain/ActionDomain.types";
-export { ActionRootDomain } from "./ActionDefinition/Domain/ActionRootDomain";
-export { createActionRootDomain } from "./ActionDefinition/Domain/helpers/createRootActionDomain";
-export { ActionSchema, actionSchema, type TInferActionError, } from "./ActionDefinition/Schema/ActionSchema";
-export type { TActionSchemaOptions, TActionSerializationDefinition, TTransportedValue, } from "./ActionDefinition/Schema/ActionSchema.types";
-export { ActionRuntime } from "./ActionRuntime/ActionRuntime";
-export { ActionExternalClientHandler, createExternalClientHandler, } from "./ActionRuntime/Handler/ExternalClient/ActionExternalClientHandler";
-export * from "./ActionRuntime/Handler/ExternalClient/err_nice_external_client";
-export * from "./ActionRuntime/Handler/ExternalClient/Transport/Custom/CustomTransport";
-export * from "./ActionRuntime/Handler/ExternalClient/Transport/err_nice_transport";
-export * from "./ActionRuntime/Handler/ExternalClient/Transport/err_nice_transport_ws";
-export { HttpTransport, type IHttpTransportOptions, } from "./ActionRuntime/Handler/ExternalClient/Transport/Http/HttpTransport";
-export { type ITransportConnectionContext, Transport, } from "./ActionRuntime/Handler/ExternalClient/Transport/Transport";
-export * from "./ActionRuntime/Handler/ExternalClient/Transport/Transport.types";
-export { createActionFrameCrypto, type IActionFrameCrypto, type IActionFrameCryptoConfig, } from "./ActionRuntime/Handler/ExternalClient/Transport/WebSocket/actionFrameCrypto";
-export { createClientHandshake, createInMemoryTofuVerifyKeyResolver, createServerHandshake, createStorageTofuVerifyKeyResolver, decodeHandshakeMessage, EHandshakeMessageType, ESecurityLevel, encodeHandshakeMessage, type IClientHandshakeConfig, type IClientVerifyKeyResolveInput, type IClientVerifyKeyResolver, type IHandshakeEncryptionKeyMaterial, type IHandshakeResult, type IServerHandshakeConfig, runtimeLinkId, type THandshakeMessage, } from "./ActionRuntime/Handler/ExternalClient/Transport/WebSocket/actionWsHandshake";
-export { createBinaryWsAdapter } from "./ActionRuntime/Handler/ExternalClient/Transport/WebSocket/createBinaryWsAdapter";
-export { createBinaryWsSessionFactory, type IBinaryWsSessionOptions, } from "./ActionRuntime/Handler/ExternalClient/Transport/WebSocket/createBinaryWsSessionFactory";
-export { createSecureWebSocketTransport, defineSecureWsChannel, type ISecureWebSocketTransportOptions, type ISecureWsChannel, } from "./ActionRuntime/Handler/ExternalClient/Transport/WebSocket/secureWsChannel";
-export type { IActionTransportDef_Ws, IActionTransportInitialized_Ws, IActionTransportReadyData_Ws, } from "./ActionRuntime/Handler/ExternalClient/Transport/WebSocket/TransportWebSocket.types";
-export { type IWebSocketTransportAdvancedOptions, type IWebSocketTransportSocketOptions, type TWebSocketTransportOptions, WebSocketTransport, } from "./ActionRuntime/Handler/ExternalClient/Transport/WebSocket/WebSocketTransport";
-export { ActionLocalHandler, createLocalHandler, } from "./ActionRuntime/Handler/Local/ActionLocalHandler";
-export { ActionServerHandler, createServerHandler, type IActionServerConnectionBinding, type IActionServerHandlerOptions, type TActionChannelFormatMessage, type TActionConnectionEncoding, } from "./ActionRuntime/Handler/Server/ActionServerHandler";
-export { createHibernatableWsServerAdapter, createSecureActionServerHandler, type IHibernatableWsServerAdapter, type IHibernatableWsServerAdapterOptions, type ISecureActionServerHandlerOptions, } from "./ActionRuntime/Handler/Server/createSecureActionServer";
-export * from "./ActionRuntime/RuntimeCoordinate";
-export { EErrId_NiceAction, err_nice_action } from "./errors/err_nice_action";
-export { decodeActionFrame, type IActionFrameDecoder } from "./utils/decodeActionFrame";
-export { isActionPayload_Any_JsonObject } from "./utils/isActionPayload_Any_JsonObject";
-export * from "./utils/isActionPayload_Request_JsonObject";
-export * from "./utils/isActionPayload_Result_JsonObject";
-export * from "./utils/typescript/MaybePromise";

package/build/types/nice_action.static.d.ts

@@ -1,3 +0,0 @@
-export declare const DEFAULT_TRANSPORT_TIMEOUT = 10000;
-export declare const UNSET_RUNTIME_ENV_ID = "_unset_";
-export declare const UNSET_RUNTIME_PER_ID = "_0_0_";

package/build/types/react-query/hooks/useActionMutation.d.ts

@@ -1,10 +0,0 @@
-import { type UseMutationOptions, type UseMutationResult } from "@tanstack/react-query";
-import type { ActionCore } from "../../ActionDefinition/Action/Core/ActionCore";
-import type { IActionDomain, TInferInputFromSchema, TInferOutputFromSchema } from "../../ActionDefinition/Domain/ActionDomain.types";
-import type { ActionSchema, TInferActionError } from "../../ActionDefinition/Schema/ActionSchema";
-/** When an action has no input schema (Input = never), use void so mutate() needs no arguments. */
-export type TActionMutationVars<SCH extends ActionSchema<any, any, any>> = [
-    TInferInputFromSchema<SCH>["Input"]
-] extends [never] ? void : TInferInputFromSchema<SCH>["Input"];
-export type TUseNiceMutationOptions<DOM extends IActionDomain, ID extends keyof DOM["actionSchema"] & string, SCH extends DOM["actionSchema"][ID] = DOM["actionSchema"][ID], TContext = unknown> = Omit<UseMutationOptions<TInferOutputFromSchema<SCH>["Output"], TInferActionError<SCH>, TActionMutationVars<SCH>, TContext>, "mutationFn">;
-export declare function useActionMutation<DOM extends IActionDomain, ID extends keyof DOM["actionSchema"] & string, SCH extends DOM["actionSchema"][ID], TContext = unknown>(action: ActionCore<DOM, ID>, options?: TUseNiceMutationOptions<DOM, ID, SCH, TContext>): UseMutationResult<TInferOutputFromSchema<SCH>["Output"], TInferActionError<SCH>, TActionMutationVars<SCH>, TContext>;

package/build/types/react-query/hooks/useActionQuery.d.ts

@@ -1,17 +0,0 @@
-import { type QueryKey, type UseQueryOptions, type UseQueryResult } from "@tanstack/react-query";
-import type { ActionCore } from "../../ActionDefinition/Action/Core/ActionCore";
-import type { IActionDomain, TInferInputFromSchema, TInferOutputFromSchema } from "../../ActionDefinition/Domain/ActionDomain.types";
-import type { TInferActionError } from "../../ActionDefinition/Schema/ActionSchema";
-export declare function actionQueryKey<DOM extends IActionDomain, ID extends keyof DOM["actionSchema"] & string>(action: ActionCore<DOM, ID>): readonly ["nice-action", DOM["domain"], DOM["allDomains"], ID];
-export declare function actionQueryKey<DOM extends IActionDomain, ID extends keyof DOM["actionSchema"] & string>(action: ActionCore<DOM, ID>, input: TInferInputFromSchema<DOM["actionSchema"][ID]>["Input"]): readonly [
-    "nice-action",
-    DOM["domain"],
-    DOM["allDomains"],
-    ID,
-    TInferInputFromSchema<DOM["actionSchema"][ID]>["Input"]
-];
-export type TUseActionQueryOptions<DOM extends IActionDomain, ID extends keyof DOM["actionSchema"] & string, SCH extends DOM["actionSchema"][ID] = DOM["actionSchema"][ID], TSelect = TInferOutputFromSchema<SCH>["Output"]> = Omit<UseQueryOptions<TInferOutputFromSchema<SCH>["Output"], TInferActionError<SCH>, TSelect, QueryKey>, "queryKey" | "queryFn">;
-export declare function useActionQuery<DOM extends IActionDomain, ID extends keyof DOM["actionSchema"] & string, SCH extends DOM["actionSchema"][ID], TSelect = TInferOutputFromSchema<SCH>["Output"]>(action: ActionCore<DOM, ID>, ...args: [TInferInputFromSchema<SCH>["Input"]] extends [never] ? [options?: TUseActionQueryOptions<DOM, ID, SCH, TSelect>] : [
-    input: TInferInputFromSchema<SCH>["Input"] | null | undefined,
-    options?: TUseActionQueryOptions<DOM, ID, SCH, TSelect>
-]): UseQueryResult<TSelect, TInferActionError<SCH>>;

package/build/types/react-query/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./hooks/useActionMutation";
-export * from "./hooks/useActionQuery";

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

@@ -1,2 +0,0 @@
-import type { IActionBase_JsonObject } from "../ActionDefinition/Action/ActionBase.types";
-export declare function assertIsActionJson(obj: unknown): asserts obj is IActionBase_JsonObject;

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

@@ -1,17 +0,0 @@
-import type { TActionPayload_Any_JsonObject } from "../ActionDefinition/Action/Payload/ActionPayload.types";
-/**
- * Minimal codec shape needed to turn an incoming channel frame back into action wire JSON. Matches
- * the `formatMessage` object the WebSocket transport (and `createBinaryWsAdapter`) provide.
- */
-export interface IActionFrameDecoder {
-    incoming?: (frame: string | ArrayBuffer | Uint8Array | Blob) => TActionPayload_Any_JsonObject<any, any> | undefined;
-}
-/**
- * Decode a single inbound channel frame (text or binary) into validated action wire JSON, or
- * `undefined` if it isn't a recognisable action payload.
- *
- * Shared by the WebSocket transport's message listener and the server-side `ActionServerHandler` so
- * both decode identically: a binary `decoder.incoming` (e.g. msgpackr) takes precedence, and plain
- * text frames fall back to JSON — keeping binary and JSON clients interoperable on one channel.
- */
-export declare function decodeActionFrame(frame: string | ArrayBuffer | Uint8Array, decoder?: IActionFrameDecoder): TActionPayload_Any_JsonObject<any, any> | undefined;

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

@@ -1,2 +0,0 @@
-import type { IRuntimeMeta } from "../ActionRuntime/ActionRuntime.types";
-export declare const getAssumedRuntimeInfo: () => IRuntimeMeta;

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

@@ -1,5 +0,0 @@
-/**
- * Produces a deterministic 8-char hex hash of any JSON-serializable value.
- * Useful for grouping/comparing action inputs, outputs, and progress payloads.
- */
-export declare function hashPayloadData(data: unknown): string;

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

@@ -1,2 +0,0 @@
-import type { TActionPayload_Any_JsonObject } from "../ActionDefinition/Action/Payload/ActionPayload.types";
-export declare function isActionPayload_Any_JsonObject(obj: unknown): obj is TActionPayload_Any_JsonObject;

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

@@ -1,2 +0,0 @@
-import type { IActionPayload_Progress_JsonObject } from "../ActionDefinition/Action/Payload/ActionPayload.types";
-export declare const isActionPayload_Progress_JsonObject: (obj: unknown) => obj is IActionPayload_Progress_JsonObject;

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

@@ -1,2 +0,0 @@
-import type { IActionPayload_Request_JsonObject } from "../ActionDefinition/Action/Payload/ActionPayload.types";
-export declare const isActionPayload_Request_JsonObject: (obj: unknown) => obj is IActionPayload_Request_JsonObject;

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

@@ -1,2 +0,0 @@
-import type { IActionPayload_Result_JsonObject } from "../ActionDefinition/Action/Payload/ActionPayload.types";
-export declare const isActionPayload_Result_JsonObject: (obj: unknown) => obj is IActionPayload_Result_JsonObject;

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

@@ -1,3 +0,0 @@
-import type { TAction_Any_Instance } from "../ActionDefinition/Action/Action.combined.types";
-import type { IActionBase } from "../ActionDefinition/Action/ActionBase.types";
-export declare function isAction_Any_Instance<ACT extends IActionBase<any, any>>(value: unknown | ACT): value is TAction_Any_Instance<any, any>;

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

@@ -1,2 +0,0 @@
-import type { TAction_Any_JsonObject } from "../ActionDefinition/Action/Action.combined.types";
-export declare function isAction_Any_JsonObject(obj: unknown): obj is TAction_Any_JsonObject;

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

@@ -1,2 +0,0 @@
-import type { IActionBase_JsonObject } from "../ActionDefinition/Action/ActionBase.types";
-export declare const isAction_Base_JsonObject: (obj: unknown) => obj is IActionBase_JsonObject;

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

@@ -1,2 +0,0 @@
-import type { IActionContext_JsonObject } from "../ActionDefinition/Action/Context/ActionContext.types";
-export declare const isAction_Context_JsonObject: (obj: unknown) => obj is IActionContext_JsonObject;

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

@@ -1,2 +0,0 @@
-import type { IActionCore_JsonObject } from "../ActionDefinition/Action/Core/ActionCore.types";
-export declare const isAction_Core_JsonObject: (obj: unknown) => obj is IActionCore_JsonObject;

package/build/types/utils/typescript/MaybePromise.d.ts

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

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

@@ -1,13 +0,0 @@
-declare function waitMillis(ms: number): Promise<unknown>;
-declare function waitSeconds(seconds: number): Promise<unknown>;
-declare function waitMinutes(minutes: number): Promise<unknown>;
-declare function waitRandomMillis(min: number, max: number): Promise<unknown>;
-declare function waitRandomSeconds(min: number, max: number): Promise<unknown>;
-export declare const wait_utils: {
-    waitMillis: typeof waitMillis;
-    waitSeconds: typeof waitSeconds;
-    waitMinutes: typeof waitMinutes;
-    waitRandomMillis: typeof waitRandomMillis;
-    waitRandomSeconds: typeof waitRandomSeconds;
-};
-export {};