nodestack-client 2.2.0 → 2.3.0

package/dist/services/FlowService.d.ts

@@ -0,0 +1,97 @@
+import { BaseService } from './BaseService';
+import type { SendOptions } from '../types';
+export interface FlowConfig {
+    id: string;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    triggerType: string;
+    eventTrigger?: string | null;
+    definition: any;
+    created: string;
+    updated: string;
+}
+export interface FlowExecution {
+    id: string;
+    flowId: string;
+    flowName: string;
+    status: 'running' | 'succeeded' | 'failed' | 'timeout' | 'cancelled' | 'aborted';
+    input: any;
+    output?: any;
+    error?: string;
+    durationMs: number;
+    stepLogs: Array<{
+        step: string;
+        type: string;
+        input: any;
+        output?: any;
+        status: string;
+        durationMs: number;
+        error?: string;
+        timestamp: string;
+    }>;
+    actorId?: string | null;
+    startedAt: string;
+    finishedAt?: string;
+    checkpoint?: {
+        currentStateName?: string | null;
+        currentPayload?: any;
+        stepCount?: number;
+        loopCounters?: Record<string, number>;
+        updatedAt: string;
+    } | null;
+}
+export interface FlowAsyncDispatchResponse {
+    executionId: string;
+    flowId: string;
+    flowName: string;
+    status: 'running';
+    pollUrl: string;
+}
+export declare class FlowService extends BaseService {
+    /**
+     * Triggers or executes a Flow state machine by ID or name.
+     * If wait is true (default), returns the finished FlowExecution object.
+     */
+    execute<TResponse = any, TInput = any>(flowIdOrName: string, input?: TInput, options?: {
+        wait?: boolean;
+    } & Omit<SendOptions, 'body'>): Promise<TResponse>;
+    /**
+     * Fetch all flows configured in the active application scope (requires admin auth).
+     */
+    getList(options?: {
+        search?: string;
+        enabled?: boolean;
+    }): Promise<FlowConfig[]>;
+    /**
+     * Fetch a single flow by ID or name (requires admin auth).
+     */
+    getOne(idOrName: string): Promise<FlowConfig>;
+    /**
+     * Fetch executions history for a specific flow or across all flows (requires admin auth).
+     */
+    getExecutions(options?: {
+        flowId?: string;
+        status?: string;
+        page?: number;
+        perPage?: number;
+    }): Promise<{
+        items: FlowExecution[];
+        totalItems: number;
+        page: number;
+        perPage: number;
+    }>;
+    /**
+     * Fetch a single execution record by ID (requires admin auth).
+     */
+    getExecution(executionId: string): Promise<FlowExecution>;
+    /**
+     * Resumes an orphaned or interrupted running flow from its last completed checkpoint.
+     */
+    resumeExecution(executionId: string): Promise<FlowExecution>;
+    /**
+     * Aborts an orphaned running flow gracefully with status: 'aborted'.
+     */
+    abortExecution(executionId: string, reason?: string): Promise<FlowExecution>;
+}
+//# sourceMappingURL=FlowService.d.ts.map

package/dist/services/FlowService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FlowService.d.ts","sourceRoot":"","sources":["../../src/services/FlowService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,UAAU,EAAE,GAAG,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC;IACjF,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,KAAK,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,GAAG,CAAC;QACX,MAAM,CAAC,EAAE,GAAG,CAAC;QACb,MAAM,EAAE,MAAM,CAAC;QACf,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;KACnB,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE;QACX,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACjC,cAAc,CAAC,EAAE,GAAG,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACtC,SAAS,EAAE,MAAM,CAAC;KACnB,GAAG,IAAI,CAAC;CACV;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;OAGG;IACU,OAAO,CAAC,SAAS,GAAG,GAAG,EAAE,MAAM,GAAG,GAAG,EAChD,YAAY,EAAE,MAAM,EACpB,KAAK,CAAC,EAAE,MAAM,EACd,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC,WAAW,EAAE,MAAM,CAAM,GAC3D,OAAO,CAAC,SAAS,CAAC,CAYpB;IAED;;OAEG;IACU,OAAO,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC,CAM5F;IAED;;OAEG;IACU,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAKzD;IAED;;OAEG;IACU,aAAa,CAAC,OAAO,CAAC,EAAE;QACnC,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,GAAG,OAAO,CAAC;QAAE,KAAK,EAAE,aAAa,EAAE,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAUzF;IAED;;OAEG;IACU,YAAY,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAMrE;IAED;;OAEG;IACU,eAAe,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAMxE;IAED;;OAEG;IACU,cAAc,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CASxF;CACF"}

package/dist/services/FunctionService.d.ts

@@ -0,0 +1,51 @@
+import { BaseService } from './BaseService';
+import type { SendOptions } from '../types';
+export interface FunctionConfig {
+    id: string;
+    name: string;
+    description?: string;
+    enabled: boolean;
+    authPolicy: string;
+    methods: string[];
+    eventTrigger?: string | null;
+    timeoutMs: number;
+    memoryLimitMb: number;
+    allowedDomains: string[];
+    elevated: boolean;
+    env: Record<string, string>;
+    created: string;
+    updated: string;
+}
+export interface FunctionExecutionResult<T = any> {
+    status: 'success' | 'error' | 'timeout';
+    statusCode: number;
+    body?: T;
+    headers?: Record<string, string>;
+    durationMs: number;
+    memoryUsedMb?: number;
+    logs: string[];
+    error?: string;
+}
+export declare class FunctionService extends BaseService {
+    /**
+     * Invokes a serverless function by name or ID.
+     * Scoped to the client's configured application if specified.
+     */
+    invoke<TResponse = any, TBody = any>(name: string, body?: TBody, options?: Omit<SendOptions, 'body'>): Promise<TResponse>;
+    /**
+     * Fetch all functions configured in the active application scope (requires admin auth).
+     */
+    getList(options?: {
+        search?: string;
+        enabled?: boolean;
+    }): Promise<FunctionConfig[]>;
+    /**
+     * Fetch a single function by ID or name (requires admin auth).
+     */
+    getOne(idOrName: string): Promise<FunctionConfig>;
+    /**
+     * Test execute a function in sandboxed runner (requires admin auth).
+     */
+    test(id: string, testPayload?: any): Promise<FunctionExecutionResult>;
+}
+//# sourceMappingURL=FunctionService.d.ts.map

package/dist/services/FunctionService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"FunctionService.d.ts","sourceRoot":"","sources":["../../src/services/FunctionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAE5C,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,uBAAuB,CAAC,CAAC,GAAG,GAAG;IAC9C,MAAM,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,qBAAa,eAAgB,SAAQ,WAAW;IAC9C;;;OAGG;IACU,MAAM,CAAC,SAAS,GAAG,GAAG,EAAE,KAAK,GAAG,GAAG,EAC9C,IAAI,EAAE,MAAM,EACZ,IAAI,CAAC,EAAE,KAAK,EACZ,OAAO,GAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAM,GACtC,OAAO,CAAC,SAAS,CAAC,CAUpB;IAED;;OAEG;IACU,OAAO,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC,CAMhG;IAED;;OAEG;IACU,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAK7D;IAED;;OAEG;IACU,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,WAAW,GAAE,GAAQ,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAMrF;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nodestack-client",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "First-party lightweight, type-safe client SDK for NodeStack",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",