@solidactions/sdk 0.1.1 → 0.2.0

package/README.md

@@ -165,11 +165,32 @@ await client.cancelWorkflow(workflowId);
 await client.resumeWorkflow(workflowId);
 ```
 
+## Deploying Workflows
+
+Use the [`@solidactions/cli`](https://www.npmjs.com/package/@solidactions/cli) to deploy your workflows:
+
+```bash
+npm install -g @solidactions/cli
+
+# Authenticate
+solidactions init <api-key>
+
+# Deploy your project
+solidactions deploy <project-name> <path>
+```
+
+The CLI handles project creation, source upload, Docker builds, environment variables, and scheduling. See the [CLI repo](https://github.com/SolidActions/solidactions-cli) for full documentation.
+
 ## Documentation
 
-See `solidactions-ai-prompt.md` for comprehensive SDK documentation including:
+See [`docs/sdk-reference.md`](docs/sdk-reference.md) for comprehensive SDK documentation including:
 
-- Workflow and step patterns
-- Durable sleep, messaging, and events
-- Queues and concurrency control
+- Lifecycle: `SolidActions.run()`, `setConfig()`/`launch()`/`shutdown()`, `getInput()`
+- Workflows: registration, determinism rules, IDs and idempotency, timeouts, child workflows
+- Steps: `runStep()`, configurable retries, parallel execution with `Promise.allSettled()`
+- Durable primitives: `sleep()`, `now()`, `randomUUID()`
+- Communication: `send()`/`recv()` messaging, `setEvent()`/`getEvent()` events, streaming, `respond()`
+- Workflow handles and management: `listWorkflows()`, `cancelWorkflow()`, `forkWorkflow()`
+- SolidActionsClient: standalone HTTP client for external workflow queries
+- Configuration, custom serialization, testing, and error classes
 - Recovery and versioning

package/dist/src/testing/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * SolidActions SDK Testing Utilities
+ *
+ * Import from '@solidactions/sdk/testing' to use the mock server
+ * for local development and testing without a real backend.
+ *
+ * Usage:
+ *   import { createMockServer } from '@solidactions/sdk/testing';
+ *   const server = await createMockServer();
+ *   console.log(server.baseUrl); // http://127.0.0.1:<port>
+ */
+export { MockHttpServer, MockStore, createMockServer } from './mock_server';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/testing/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC"}

package/dist/src/testing/index.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * SolidActions SDK Testing Utilities
+ *
+ * Import from '@solidactions/sdk/testing' to use the mock server
+ * for local development and testing without a real backend.
+ *
+ * Usage:
+ *   import { createMockServer } from '@solidactions/sdk/testing';
+ *   const server = await createMockServer();
+ *   console.log(server.baseUrl); // http://127.0.0.1:<port>
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMockServer = exports.MockStore = exports.MockHttpServer = void 0;
+var mock_server_1 = require("./mock_server");
+Object.defineProperty(exports, "MockHttpServer", { enumerable: true, get: function () { return mock_server_1.MockHttpServer; } });
+Object.defineProperty(exports, "MockStore", { enumerable: true, get: function () { return mock_server_1.MockStore; } });
+Object.defineProperty(exports, "createMockServer", { enumerable: true, get: function () { return mock_server_1.createMockServer; } });
+//# sourceMappingURL=index.js.map

package/dist/src/testing/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/testing/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;GAUG;;;AAEH,6CAA4E;AAAnE,6GAAA,cAAc,OAAA;AAAE,wGAAA,SAAS,OAAA;AAAE,+GAAA,gBAAgB,OAAA"}

package/dist/src/testing/mock_server.d.ts

@@ -0,0 +1,134 @@
+/**
+ * Mock HTTP Server for SolidActions SDK Testing & Local Development
+ *
+ * Provides an in-memory HTTP server that implements the SolidActions API
+ * for testing and running workflows locally without a real backend.
+ *
+ * Usage:
+ *   import { createMockServer } from '@solidactions/sdk/testing';
+ *   const server = await createMockServer();
+ *   // server.baseUrl is now available (e.g., http://127.0.0.1:12345)
+ */
+interface MockWorkflow {
+    workflowUUID: string;
+    status: string;
+    workflowName: string;
+    workflowClassName: string;
+    workflowConfigName: string;
+    authenticatedUser: string;
+    assumedRole: string;
+    authenticatedRoles: string[];
+    request: object;
+    executorId: string;
+    applicationVersion?: string;
+    applicationID: string;
+    input: string | null;
+    output: string | null;
+    error: string | null;
+    createdAt: number;
+    updatedAt: number;
+    queueName?: string;
+    recoveryAttempts: number;
+    timeoutMS?: number;
+    deadlineEpochMS?: number;
+    deduplicationID?: string;
+    priority: number;
+    queuePartitionKey?: string;
+    forkedFrom?: string;
+}
+interface MockOperation {
+    workflowUUID: string;
+    functionId?: number;
+    functionID?: number;
+    functionName: string;
+    output: string | null;
+    error: string | null;
+    childWorkflowId?: string | null;
+    childWorkflowID?: string | null;
+    startedAtEpochMs?: number;
+    startTimeEpochMs?: number;
+    completedAtEpochMs?: number;
+    endTimeEpochMs?: number;
+    checkConflict?: boolean;
+}
+interface MockMessage {
+    destinationUUID: string;
+    topic: string | null;
+    message: string | null;
+    consumed: boolean;
+}
+interface MockEvent {
+    workflowUUID: string;
+    key: string;
+    value: string | null;
+}
+interface MockStream {
+    workflowUUID: string;
+    key: string;
+    values: unknown[];
+    closed: boolean;
+}
+/**
+ * In-memory storage for mock server
+ */
+export declare class MockStore {
+    workflows: Map<string, MockWorkflow>;
+    operations: Map<string, MockOperation[]>;
+    messages: MockMessage[];
+    events: Map<string, MockEvent>;
+    streams: Map<string, MockStream>;
+    eventDispatch: Map<string, object>;
+    clear(): void;
+}
+/**
+ * Mock HTTP Server for testing
+ */
+export declare class MockHttpServer {
+    private server;
+    private port;
+    store: MockStore;
+    requestLog: Array<{
+        method: string;
+        path: string;
+        body?: unknown;
+    }>;
+    constructor(port?: number);
+    start(): Promise<number>;
+    stop(): Promise<void>;
+    get baseUrl(): string;
+    private handleRequest;
+    private readBody;
+    private route;
+    private createWorkflow;
+    private getWorkflow;
+    private listWorkflows;
+    private recordOutput;
+    private recordError;
+    private getResult;
+    private setWorkflowStatus;
+    private cancelWorkflow;
+    private resumeWorkflow;
+    private checkCancelled;
+    private getPendingWorkflows;
+    private forkWorkflow;
+    private getOperations;
+    private getOperation;
+    private recordOperation;
+    private sendMessage;
+    private receiveMessage;
+    private setEvent;
+    private getEvent;
+    private startQueuedWorkflows;
+    private getDeduplicatedWorkflow;
+    private writeStream;
+    private readStream;
+    private closeStream;
+    private getEventDispatch;
+    private upsertEventDispatch;
+}
+/**
+ * Helper function to create and start a mock server
+ */
+export declare function createMockServer(port?: number): Promise<MockHttpServer>;
+export {};
+//# sourceMappingURL=mock_server.d.ts.map

package/dist/src/testing/mock_server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mock_server.d.ts","sourceRoot":"","sources":["../../../src/testing/mock_server.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAKH,UAAU,YAAY;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,UAAU,aAAa;IACrB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,UAAU,WAAW;IACnB,eAAe,EAAE,MAAM,CAAC;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,UAAU,SAAS;IACjB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,UAAU,UAAU;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,OAAO,EAAE,CAAC;IAClB,MAAM,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB,SAAS,EAAE,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAa;IACjD,UAAU,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,EAAE,CAAC,CAAa;IACrD,QAAQ,EAAE,WAAW,EAAE,CAAM;IAC7B,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAa;IAC3C,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAa;IAC7C,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAa;IAE/C,KAAK,IAAI,IAAI;CAQd;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,IAAI,CAAS;IACd,KAAK,EAAE,SAAS,CAAC;IACjB,UAAU,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC,CAAM;gBAEpE,IAAI,GAAE,MAAU;IAKtB,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;IAkBxB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAU3B,IAAI,OAAO,IAAI,MAAM,CAEpB;YAEa,aAAa;YA0Bb,QAAQ;YAcR,KAAK;IAsNnB,OAAO,CAAC,cAAc;IAuDtB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,aAAa;IAgBrB,OAAO,CAAC,YAAY;IAcpB,OAAO,CAAC,WAAW;IAcnB,OAAO,CAAC,SAAS;IAkBjB,OAAO,CAAC,iBAAiB;IAgBzB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,cAAc;IAQtB,OAAO,CAAC,mBAAmB;IAY3B,OAAO,CAAC,YAAY;IA4BpB,OAAO,CAAC,aAAa;IAiBrB,OAAO,CAAC,YAAY;IAmBpB,OAAO,CAAC,eAAe;IAkCvB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,QAAQ;IAchB,OAAO,CAAC,QAAQ;IAUhB,OAAO,CAAC,oBAAoB;IAiB5B,OAAO,CAAC,uBAAuB;IAQ/B,OAAO,CAAC,WAAW;IAWnB,OAAO,CAAC,UAAU;IAYlB,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,gBAAgB;IAMxB,OAAO,CAAC,mBAAmB;CAM5B;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,IAAI,GAAE,MAAU,GAAG,OAAO,CAAC,cAAc,CAAC,CAIhF"}