@aikirun/client 0.8.0 → 0.9.1

package/README.md

@@ -1,6 +1,6 @@
 # @aikirun/client
 
-Client SDK for Aiki durable execution platform - connect to the Aiki server, start workflows, and manage execution.
+Client SDK for Aiki durable execution platform.
 
 ## Installation
 
@@ -10,110 +10,44 @@ npm install @aikirun/client
 
 ## Quick Start
 
-### Initialize the Client
-
 ```typescript
 import { client } from "@aikirun/client";
+import { orderWorkflowV1 } from "./workflows.ts";
 
 const aikiClient = await client({
 	url: "http://localhost:9876",
-	redis: {
-		host: "localhost",
-		port: 6379,
-	},
+	redis: { host: "localhost", port: 6379 },
 });
-```
-
-### Start a Workflow
 
-```typescript
-import { onboardingWorkflowV1 } from "./workflows.ts";
-
-const stateHandle = await onboardingWorkflowV1.start(aikiClient, {
-	email: "user@example.com",
+// Start a workflow
+const handle = await orderWorkflowV1.start(aikiClient, {
+	orderId: "order-123",
 });
-```
 
-### Wait for Workflow Completion
+// Wait for completion
+const result = await handle.waitForStatus("completed");
 
-```typescript
-const result = await stateHandle.wait(
-	{ type: "status", status: "completed" },
-	{ maxDurationMs: 60_000, pollIntervalMs: 5_000 },
-);
-
-if (result.success) {
-	console.log("Workflow completed!");
-} else {
-	console.log("Workflow did not complete:", result.cause);
-}
-```
-
-### Get Workflow State
-
-```typescript
-const state = await stateHandle.getState();
-console.log("Current status:", state.status);
+// Close when done
+await aikiClient.close();
 ```
 
 ## Features
 
-- **Reliable Connection** - HTTP client with automatic retry and connection pooling
+- **Server Connection** - Connect to the Aiki server via HTTP
 - **Workflow Management** - Start workflows with type-safe inputs
-- **State Polling** - Wait for workflow completion with configurable polling
-- **Logger** - Built-in logging for debugging
-- **Context Factory** - Pass application context through workflow execution
-- **Redis Integration** - Connect to Redis for distributed state management
+- **Redis Integration** - Distributed state and message streaming
+- **Context Injection** - Pass application context to workflows
+- **Custom Logging** - Plug in your own logger
 
-## Configuration
+## Documentation
 
-### Client Parameters
-
-```typescript
-interface ClientParams<AppContext> {
-	url: string; // Server URL
-	redis: {
-		host: string;
-		port: number;
-		password?: string;
-		db?: number;
-		maxRetriesPerRequest?: number;
-		retryDelayOnFailoverMs?: number;
-		connectTimeoutMs?: number;
-	};
-	contextFactory?: (run: WorkflowRun) => AppContext | Promise<AppContext>;
-	logger?: Logger;
-}
-```
-
-### Context Factory Example
-
-```typescript
-const aikiClient = await client({
-	url: "http://localhost:9876",
-	redis: { host: "localhost", port: 6379 },
-	contextFactory: (run) => ({
-		traceId: generateTraceId(),
-		workflowRunId: run.id,
-		userId: extractUserIdFromRun(run),
-	}),
-});
-```
-
-## API Reference
-
-See the [Aiki documentation](https://github.com/aikirun/aiki) for comprehensive API reference.
+For comprehensive documentation including configuration options and context injection, see the [Client Guide](https://aiki.run/docs/core-concepts/client).
 
 ## Related Packages
 
 - [@aikirun/workflow](https://www.npmjs.com/package/@aikirun/workflow) - Define workflows
 - [@aikirun/task](https://www.npmjs.com/package/@aikirun/task) - Define tasks
 - [@aikirun/worker](https://www.npmjs.com/package/@aikirun/worker) - Execute workflows
-- [@aikirun/types](https://www.npmjs.com/package/@aikirun/types) - Type definitions
-
-## Changelog
-
-See the [CHANGELOG](https://github.com/aikirun/aiki/blob/main/CHANGELOG.md) for version history.
 
 ## License
 

package/dist/index.d.ts

@@ -14,7 +14,7 @@ export { AdaptivePollingSubscriberStrategy, ApiClient, Client, ClientParams, Log
  * @param params.redis.host - Redis server hostname
  * @param params.redis.port - Redis server port
  * @param params.redis.password - Optional Redis password
- * @param params.contextFactory - Optional function to create context for each workflow run
+ * @param params.createContext - Optional function to create context for each workflow run
  * @param params.logger - Optional custom logger (defaults to ConsoleLogger)
  * @returns Promise resolving to a configured Client instance
  *
@@ -23,7 +23,7 @@ export { AdaptivePollingSubscriberStrategy, ApiClient, Client, ClientParams, Log
  * const aikiClient = await client({
  *   url: "http://localhost:9876",
  *   redis: { host: "localhost", port: 6379 },
- *   contextFactory: (run) => ({
+ *   createContext: (run) => ({
  *     traceId: generateTraceId(),
  *     userId: extractUserId(run),
  *   }),

package/dist/index.js

@@ -501,7 +501,7 @@ function resolveSubscriberStrategy(client2, strategy, workflows, workerShards) {
     // 	return createPollingStrategy(client, strategy);
     // case "adaptive_polling":
     // 	return createAdaptivePollingStrategy(client, strategy);
-    case "redis_streams":
+    case "redis":
       return createRedisStreamsStrategy(client2, strategy, workflows, workerShards);
     default:
       return strategy.type;
@@ -529,7 +529,7 @@ var ClientImpl = class {
         getConnection: () => this.getRedisConnection(),
         closeConnection: () => this.closeRedisConnection()
       },
-      contextFactory: this.params.contextFactory
+      createContext: this.params.createContext
     };
   }
   api;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aikirun/client",
-	"version": "0.8.0",
+	"version": "0.9.1",
 	"description": "Client SDK for Aiki - connect to the server, start workflows, and manage execution",
 	"type": "module",
 	"main": "./dist/index.js",
@@ -18,7 +18,7 @@
 		"build": "tsup"
 	},
 	"dependencies": {
-		"@aikirun/types": "0.8.0",
+		"@aikirun/types": "0.9.1",
 		"@orpc/client": "^1.9.3",
 		"ioredis": "^5.4.1",
 		"zod": "^4.1.12"