@temporal-contract/client 0.0.1 → 0.0.3

package/README.md

@@ -2,96 +2,37 @@
 
 > Type-safe client for consuming Temporal workflows
 
+[![npm version](https://img.shields.io/npm/v/@temporal-contract/client.svg?logo=npm)](https://www.npmjs.com/package/@temporal-contract/client)
+
 ## Installation
 
 ```bash
 pnpm add @temporal-contract/client @temporal-contract/contract @temporalio/client zod
 ```
 
-## Quick Start
+## Quick Example
 
 ```typescript
-import { Connection } from '@temporalio/client';
 import { TypedClient } from '@temporal-contract/client';
-import { myContract } from './contract';
+import { Connection } from '@temporalio/client';
 
-// Connect to Temporal
 const connection = await Connection.connect({ address: 'localhost:7233' });
-
-// Create typed client
-const client = TypedClient.create(myContract, {
-  connection,
-  namespace: 'default',
-});
+const client = TypedClient.create(myContract, { connection });
 
 // Execute workflow (fully typed!)
 const result = await client.executeWorkflow('processOrder', {
   workflowId: 'order-123',
-  args: { orderId: 'ORD-123', customerId: 'CUST-456' },
+  args: { orderId: 'ORD-123' }
 });
-
-console.log(result.status);  // 'success' | 'failed' — typed!
-```
-
-## API
-
-### `TypedClient.create(contract, options)`
-
-Creates a type-safe Temporal client.
-
-**Returns:** Type-safe client with these methods:
-
-#### `executeWorkflow(name, options)`
-
-Execute and wait for result:
-
-```typescript
-const result = await client.executeWorkflow('processOrder', {
-  workflowId: 'order-123',
-  args: { orderId: 'ORD-123', customerId: 'CUST-456' },
-});
-```
-
-#### `startWorkflow(name, options)` / `getHandle(name, workflowId)`
-
-Get a typed workflow handle for signals/queries/updates:
-
-```typescript
-const handle = await client.startWorkflow('processOrder', {
-  workflowId: 'order-456',
-  args: { orderId: 'ORD-456' },
-});
-
-// Type-safe queries, signals, updates
-await handle.queries.getStatus();
-await handle.signals.cancel({ reason: 'Customer request' });
-await handle.updates.changeAmount({ newAmount: 150 });
-```
-
-## Error Handling
-
-Custom error classes with contextual information:
-
-```typescript
-import { WorkflowValidationError, WorkflowNotFoundError } from '@temporal-contract/client';
-
-try {
-  await client.executeWorkflow('processOrder', { args: invalidData });
-} catch (error) {
-  if (error instanceof WorkflowValidationError) {
-    console.error('Validation:', error.zodError.errors);
-  } else if (error instanceof WorkflowNotFoundError) {
-    console.error('Available:', error.availableWorkflows);
-  }
-}
 ```
 
----
+## Documentation
 
-## Learn More
+📖 **[Read the full documentation →](https://btravers.github.io/temporal-contract)**
 
-- [Main README](../../README.md) — Quick start guide
-- [Worker Implementation](../../docs/CONTRACT_HANDLER.md) — Implementing workers
+- [API Reference](https://btravers.github.io/temporal-contract/api/client)
+- [Getting Started](https://btravers.github.io/temporal-contract/guide/getting-started)
+- [Examples](https://btravers.github.io/temporal-contract/examples/)
 
 ## License
 

package/dist/index.cjs

@@ -1,5 +1,4 @@
 let __temporalio_client = require("@temporalio/client");
-let zod = require("zod");
 
 //#region src/errors.ts
 /**
@@ -16,9 +15,11 @@ var TypedClientError = class extends Error {
 * Error thrown when a workflow is not found in the contract
 */
 var WorkflowNotFoundError = class extends TypedClientError {
-	constructor(workflowName) {
-		super(`Workflow "${workflowName}" not found in contract`);
+	constructor(workflowName, availableWorkflows = []) {
+		const message = availableWorkflows.length > 0 ? `Workflow "${workflowName}" not found in contract. Available workflows: ${availableWorkflows.join(", ")}` : `Workflow "${workflowName}" not found in contract`;
+		super(message);
 		this.workflowName = workflowName;
+		this.availableWorkflows = availableWorkflows;
 		this.name = "WorkflowNotFoundError";
 	}
 };
@@ -26,11 +27,12 @@ var WorkflowNotFoundError = class extends TypedClientError {
 * Error thrown when workflow input or output validation fails
 */
 var WorkflowValidationError = class extends TypedClientError {
-	constructor(workflowName, phase, zodError) {
-		super(`Validation failed for workflow "${workflowName}" ${phase}: ${zodError.message}`);
+	constructor(workflowName, phase, issues) {
+		const message = issues.map((issue) => issue.message).join("; ");
+		super(`Validation failed for workflow "${workflowName}" ${phase}: ${message}`);
 		this.workflowName = workflowName;
 		this.phase = phase;
-		this.zodError = zodError;
+		this.issues = issues;
 		this.name = "WorkflowValidationError";
 	}
 };
@@ -38,11 +40,12 @@ var WorkflowValidationError = class extends TypedClientError {
 * Error thrown when query input or output validation fails
 */
 var QueryValidationError = class extends TypedClientError {
-	constructor(queryName, phase, zodError) {
-		super(`Validation failed for query "${queryName}" ${phase}: ${zodError.message}`);
+	constructor(queryName, phase, issues) {
+		const message = issues.map((issue) => issue.message).join("; ");
+		super(`Validation failed for query "${queryName}" ${phase}: ${message}`);
 		this.queryName = queryName;
 		this.phase = phase;
-		this.zodError = zodError;
+		this.issues = issues;
 		this.name = "QueryValidationError";
 	}
 };
@@ -50,10 +53,11 @@ var QueryValidationError = class extends TypedClientError {
 * Error thrown when signal input validation fails
 */
 var SignalValidationError = class extends TypedClientError {
-	constructor(signalName, zodError) {
-		super(`Validation failed for signal "${signalName}" input: ${zodError.message}`);
+	constructor(signalName, issues) {
+		const message = issues.map((issue) => issue.message).join("; ");
+		super(`Validation failed for signal "${signalName}" input: ${message}`);
 		this.signalName = signalName;
-		this.zodError = zodError;
+		this.issues = issues;
 		this.name = "SignalValidationError";
 	}
 };
@@ -61,11 +65,12 @@ var SignalValidationError = class extends TypedClientError {
 * Error thrown when update input or output validation fails
 */
 var UpdateValidationError = class extends TypedClientError {
-	constructor(updateName, phase, zodError) {
-		super(`Validation failed for update "${updateName}" ${phase}: ${zodError.message}`);
+	constructor(updateName, phase, issues) {
+		const message = issues.map((issue) => issue.message).join("; ");
+		super(`Validation failed for update "${updateName}" ${phase}: ${message}`);
 		this.updateName = updateName;
 		this.phase = phase;
-		this.zodError = zodError;
+		this.issues = issues;
 		this.name = "UpdateValidationError";
 	}
 };
@@ -120,14 +125,10 @@ var TypedClient = class TypedClient {
 	*/
 	async startWorkflow(workflowName, { args, ...temporalOptions }) {
 		const definition = this.contract.workflows[workflowName];
-		if (!definition) throw new WorkflowNotFoundError(String(workflowName));
-		let validatedInput;
-		try {
-			validatedInput = definition.input.parse(args);
-		} catch (error) {
-			if (error instanceof zod.ZodError) throw new WorkflowValidationError(String(workflowName), "input", error);
-			throw error;
-		}
+		if (!definition) throw new WorkflowNotFoundError(String(workflowName), Object.keys(this.contract.workflows));
+		const inputResult = await definition.input["~standard"].validate(args);
+		if (inputResult.issues) throw new WorkflowValidationError(String(workflowName), "input", inputResult.issues);
+		const validatedInput = inputResult.value;
 		const handle = await this.client.workflow.start(workflowName, {
 			...temporalOptions,
 			taskQueue: this.contract.taskQueue,
@@ -152,25 +153,18 @@ var TypedClient = class TypedClient {
 	*/
 	async executeWorkflow(workflowName, { args, ...temporalOptions }) {
 		const definition = this.contract.workflows[workflowName];
-		if (!definition) throw new WorkflowNotFoundError(String(workflowName));
-		let validatedInput;
-		try {
-			validatedInput = definition.input.parse(args);
-		} catch (error) {
-			if (error instanceof zod.ZodError) throw new WorkflowValidationError(String(workflowName), "input", error);
-			throw error;
-		}
+		if (!definition) throw new WorkflowNotFoundError(String(workflowName), Object.keys(this.contract.workflows));
+		const inputResult = await definition.input["~standard"].validate(args);
+		if (inputResult.issues) throw new WorkflowValidationError(String(workflowName), "input", inputResult.issues);
+		const validatedInput = inputResult.value;
 		const result = await this.client.workflow.execute(workflowName, {
 			...temporalOptions,
 			taskQueue: this.contract.taskQueue,
 			args: [validatedInput]
 		});
-		try {
-			return definition.output.parse(result);
-		} catch (error) {
-			if (error instanceof zod.ZodError) throw new WorkflowValidationError(String(workflowName), "output", error);
-			throw error;
-		}
+		const outputResult = await definition.output["~standard"].validate(result);
+		if (outputResult.issues) throw new WorkflowValidationError(String(workflowName), "output", outputResult.issues);
+		return outputResult.value;
 	}
 	/**
 	* Get a handle to an existing workflow
@@ -183,55 +177,34 @@ var TypedClient = class TypedClient {
 	*/
 	async getHandle(workflowName, workflowId) {
 		const definition = this.contract.workflows[workflowName];
-		if (!definition) throw new WorkflowNotFoundError(String(workflowName));
+		if (!definition) throw new WorkflowNotFoundError(String(workflowName), Object.keys(this.contract.workflows));
 		const handle = this.client.workflow.getHandle(workflowId);
 		return this.createTypedHandle(handle, definition);
 	}
 	createTypedHandle(handle, definition) {
 		const queries = {};
 		for (const [queryName, queryDef] of Object.entries(definition.queries ?? {})) queries[queryName] = async (args) => {
-			let validatedInput;
-			try {
-				validatedInput = queryDef.input.parse(args);
-			} catch (error) {
-				if (error instanceof zod.ZodError) throw new QueryValidationError(queryName, "input", error);
-				throw error;
-			}
-			const result = await handle.query(queryName, validatedInput);
-			try {
-				return queryDef.output.parse(result);
-			} catch (error) {
-				if (error instanceof zod.ZodError) throw new QueryValidationError(queryName, "output", error);
-				throw error;
-			}
+			const inputResult = await queryDef.input["~standard"].validate(args);
+			if (inputResult.issues) throw new QueryValidationError(queryName, "input", inputResult.issues);
+			const result = await handle.query(queryName, inputResult.value);
+			const outputResult = await queryDef.output["~standard"].validate(result);
+			if (outputResult.issues) throw new QueryValidationError(queryName, "output", outputResult.issues);
+			return outputResult.value;
 		};
 		const signals = {};
 		for (const [signalName, signalDef] of Object.entries(definition.signals ?? {})) signals[signalName] = async (args) => {
-			let validatedInput;
-			try {
-				validatedInput = signalDef.input.parse(args);
-			} catch (error) {
-				if (error instanceof zod.ZodError) throw new SignalValidationError(signalName, error);
-				throw error;
-			}
-			await handle.signal(signalName, validatedInput);
+			const inputResult = await signalDef.input["~standard"].validate(args);
+			if (inputResult.issues) throw new SignalValidationError(signalName, inputResult.issues);
+			await handle.signal(signalName, inputResult.value);
 		};
 		const updates = {};
 		for (const [updateName, updateDef] of Object.entries(definition.updates ?? {})) updates[updateName] = async (args) => {
-			let validatedInput;
-			try {
-				validatedInput = updateDef.input.parse(args);
-			} catch (error) {
-				if (error instanceof zod.ZodError) throw new UpdateValidationError(updateName, "input", error);
-				throw error;
-			}
-			const result = await handle.executeUpdate(updateName, { args: [validatedInput] });
-			try {
-				return updateDef.output.parse(result);
-			} catch (error) {
-				if (error instanceof zod.ZodError) throw new UpdateValidationError(updateName, "output", error);
-				throw error;
-			}
+			const inputResult = await updateDef.input["~standard"].validate(args);
+			if (inputResult.issues) throw new UpdateValidationError(updateName, "input", inputResult.issues);
+			const result = await handle.executeUpdate(updateName, { args: [inputResult.value] });
+			const outputResult = await updateDef.output["~standard"].validate(result);
+			if (outputResult.issues) throw new UpdateValidationError(updateName, "output", outputResult.issues);
+			return outputResult.value;
 		};
 		return {
 			workflowId: handle.workflowId,
@@ -240,12 +213,9 @@ var TypedClient = class TypedClient {
 			updates,
 			result: async () => {
 				const result = await handle.result();
-				try {
-					return definition.output.parse(result);
-				} catch (error) {
-					if (error instanceof zod.ZodError) throw new WorkflowValidationError(handle.workflowId, "output", error);
-					throw error;
-				}
+				const outputResult = await definition.output["~standard"].validate(result);
+				if (outputResult.issues) throw new WorkflowValidationError(handle.workflowId, "output", outputResult.issues);
+				return outputResult.value;
 			},
 			terminate: async (reason) => {
 				await handle.terminate(reason);

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { ClientOptions, WorkflowHandle, WorkflowOptions, WorkflowStartOptions } from "@temporalio/client";
 import { ClientInferInput, ClientInferOutput, ClientInferWorkflowQueries, ClientInferWorkflowSignals, ClientInferWorkflowUpdates, ContractDefinition, WorkflowDefinition } from "@temporal-contract/contract";
-import { z } from "zod";
+import { StandardSchemaV1 } from "@standard-schema/spec";
 
 //#region src/client.d.ts
 
@@ -149,7 +149,8 @@ declare class TypedClientError extends Error {
  */
 declare class WorkflowNotFoundError extends TypedClientError {
   readonly workflowName: string;
-  constructor(workflowName: string);
+  readonly availableWorkflows: readonly string[];
+  constructor(workflowName: string, availableWorkflows?: readonly string[]);
 }
 /**
  * Error thrown when workflow input or output validation fails
@@ -157,8 +158,8 @@ declare class WorkflowNotFoundError extends TypedClientError {
 declare class WorkflowValidationError extends TypedClientError {
   readonly workflowName: string;
   readonly phase: "input" | "output";
-  readonly zodError: z.ZodError;
-  constructor(workflowName: string, phase: "input" | "output", zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(workflowName: string, phase: "input" | "output", issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 /**
  * Error thrown when query input or output validation fails
@@ -166,16 +167,16 @@ declare class WorkflowValidationError extends TypedClientError {
 declare class QueryValidationError extends TypedClientError {
   readonly queryName: string;
   readonly phase: "input" | "output";
-  readonly zodError: z.ZodError;
-  constructor(queryName: string, phase: "input" | "output", zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(queryName: string, phase: "input" | "output", issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 /**
  * Error thrown when signal input validation fails
  */
 declare class SignalValidationError extends TypedClientError {
   readonly signalName: string;
-  readonly zodError: z.ZodError;
-  constructor(signalName: string, zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(signalName: string, issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 /**
  * Error thrown when update input or output validation fails
@@ -183,8 +184,8 @@ declare class SignalValidationError extends TypedClientError {
 declare class UpdateValidationError extends TypedClientError {
   readonly updateName: string;
   readonly phase: "input" | "output";
-  readonly zodError: z.ZodError;
-  constructor(updateName: string, phase: "input" | "output", zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(updateName: string, phase: "input" | "output", issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 //#endregion
 export { QueryValidationError, SignalValidationError, TypedClient, TypedClientError, type TypedWorkflowHandle, type TypedWorkflowStartOptions, UpdateValidationError, WorkflowNotFoundError, WorkflowValidationError };

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { ClientOptions, WorkflowHandle, WorkflowOptions, WorkflowStartOptions } from "@temporalio/client";
-import { z } from "zod";
 import { ClientInferInput, ClientInferOutput, ClientInferWorkflowQueries, ClientInferWorkflowSignals, ClientInferWorkflowUpdates, ContractDefinition, WorkflowDefinition } from "@temporal-contract/contract";
+import { StandardSchemaV1 } from "@standard-schema/spec";
 
 //#region src/client.d.ts
 
@@ -149,7 +149,8 @@ declare class TypedClientError extends Error {
  */
 declare class WorkflowNotFoundError extends TypedClientError {
   readonly workflowName: string;
-  constructor(workflowName: string);
+  readonly availableWorkflows: readonly string[];
+  constructor(workflowName: string, availableWorkflows?: readonly string[]);
 }
 /**
  * Error thrown when workflow input or output validation fails
@@ -157,8 +158,8 @@ declare class WorkflowNotFoundError extends TypedClientError {
 declare class WorkflowValidationError extends TypedClientError {
   readonly workflowName: string;
   readonly phase: "input" | "output";
-  readonly zodError: z.ZodError;
-  constructor(workflowName: string, phase: "input" | "output", zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(workflowName: string, phase: "input" | "output", issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 /**
  * Error thrown when query input or output validation fails
@@ -166,16 +167,16 @@ declare class WorkflowValidationError extends TypedClientError {
 declare class QueryValidationError extends TypedClientError {
   readonly queryName: string;
   readonly phase: "input" | "output";
-  readonly zodError: z.ZodError;
-  constructor(queryName: string, phase: "input" | "output", zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(queryName: string, phase: "input" | "output", issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 /**
  * Error thrown when signal input validation fails
  */
 declare class SignalValidationError extends TypedClientError {
   readonly signalName: string;
-  readonly zodError: z.ZodError;
-  constructor(signalName: string, zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(signalName: string, issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 /**
  * Error thrown when update input or output validation fails
@@ -183,8 +184,8 @@ declare class SignalValidationError extends TypedClientError {
 declare class UpdateValidationError extends TypedClientError {
   readonly updateName: string;
   readonly phase: "input" | "output";
-  readonly zodError: z.ZodError;
-  constructor(updateName: string, phase: "input" | "output", zodError: z.ZodError);
+  readonly issues: ReadonlyArray<StandardSchemaV1.Issue>;
+  constructor(updateName: string, phase: "input" | "output", issues: ReadonlyArray<StandardSchemaV1.Issue>);
 }
 //#endregion
 export { QueryValidationError, SignalValidationError, TypedClient, TypedClientError, type TypedWorkflowHandle, type TypedWorkflowStartOptions, UpdateValidationError, WorkflowNotFoundError, WorkflowValidationError };