@temporal-contract/contract 0.0.6 → 0.1.0

package/dist/index.d.mts

@@ -1,7 +1,6 @@
 import { StandardSchemaV1 } from "@standard-schema/spec";
 
 //#region src/types.d.ts
-
 /**
  * Base types for validation schemas
  * Any schema that implements the Standard Schema specification
@@ -88,235 +87,199 @@ type InferActivityNames<TContract extends ContractDefinition> = TContract["activ
 type InferContractWorkflows<TContract extends ContractDefinition> = TContract["workflows"];
 //#endregion
 //#region src/builder.d.ts
-declare function defineActivity<TActivity extends ActivityDefinition>(definition: TActivity): TActivity;
-declare function defineSignal<TSignal extends SignalDefinition>(definition: TSignal): TSignal;
-declare function defineQuery<TQuery extends QueryDefinition>(definition: TQuery): TQuery;
-declare function defineUpdate<TUpdate extends UpdateDefinition>(definition: TUpdate): TUpdate;
-declare function defineWorkflow<TWorkflow extends WorkflowDefinition>(definition: TWorkflow): TWorkflow;
-declare function defineContract<TContract extends ContractDefinition>(definition: TContract): TContract;
-//#endregion
-//#region src/nexus-types.d.ts
 /**
- * Definition of a Nexus operation
- * Similar to ActivityDefinition but for cross-namespace operations
+ * Define a Temporal activity with type-safe input and output schemas.
  *
- * @example
- * ```typescript
- * const processPayment = {
- *   input: z.object({ amount: z.number(), customerId: z.string() }),
- *   output: z.object({ transactionId: z.string(), status: z.enum(['success', 'failed']) }),
- * };
- * ```
- */
-interface NexusOperationDefinition<TInput extends AnySchema = AnySchema, TOutput extends AnySchema = AnySchema> {
-  readonly input: TInput;
-  readonly output: TOutput;
-}
-/**
- * Definition of a Nexus service containing multiple operations
+ * Activities are the building blocks of Temporal workflows that execute business logic
+ * and interact with external services. This function preserves TypeScript types while
+ * providing a consistent structure for activity definitions.
  *
- * @example
- * ```typescript
- * const PaymentService = {
- *   operations: {
- *     processPayment: { input: ..., output: ... },
- *     refundPayment: { input: ..., output: ... },
- *   },
- * };
- * ```
- */
-interface NexusServiceDefinition<TOperations extends Record<string, NexusOperationDefinition> = Record<string, NexusOperationDefinition>> {
-  readonly operations: TOperations;
-}
-/**
- * Extended ContractDefinition that includes Nexus services
- * This would replace the current ContractDefinition when Nexus support is added
+ * @template TActivity - The activity definition type with input/output schemas
+ * @param definition - The activity definition containing input and output schemas
+ * @returns The same definition with preserved types for type inference
  *
  * @example
  * ```typescript
- * const contract = defineContract({
- *   taskQueue: 'payments',
- *   workflows: { ... },
- *   activities: { ... },
- *   nexusServices: {
- *     PaymentService: {
- *       operations: {
- *         processPayment: { input: ..., output: ... },
- *       },
- *     },
- *   },
+ * import { defineActivity } from '@temporal-contract/contract';
+ * import { z } from 'zod';
+ *
+ * export const sendEmail = defineActivity({
+ *   input: z.object({
+ *     to: z.string().email(),
+ *     subject: z.string(),
+ *     body: z.string(),
+ *   }),
+ *   output: z.object({
+ *     messageId: z.string(),
+ *     sentAt: z.date(),
+ *   }),
  * });
  * ```
  */
-interface ContractDefinitionWithNexus<TWorkflows extends Record<string, WorkflowDefinition> = Record<string, WorkflowDefinition>, TActivities extends Record<string, ActivityDefinition> = Record<string, ActivityDefinition>, TNexusServices extends Record<string, NexusServiceDefinition> = Record<string, NexusServiceDefinition>> {
-  readonly taskQueue: string;
-  readonly workflows: TWorkflows;
-  readonly activities?: TActivities;
-  readonly nexusServices?: TNexusServices;
-}
-/**
- * WORKER PERSPECTIVE - Nexus operation handler type inference
- * Worker receives the parsed input and returns the raw output
- */
-/**
- * Infer input type from a Nexus operation definition (worker perspective)
- */
-type WorkerInferNexusOperationInput<T extends NexusOperationDefinition> = StandardSchemaV1.InferOutput<T["input"]>;
-/**
- * Infer output type from a Nexus operation definition (worker perspective)
- */
-type WorkerInferNexusOperationOutput<T extends NexusOperationDefinition> = StandardSchemaV1.InferInput<T["output"]>;
+declare function defineActivity<TActivity extends ActivityDefinition>(definition: TActivity): TActivity;
 /**
- * Infer the handler function signature for a Nexus operation (worker perspective)
+ * Define a Temporal signal with type-safe input schema.
  *
- * @example
- * ```typescript
- * type ProcessPaymentHandler = WorkerInferNexusOperationHandler<typeof processPaymentOperation>;
- * // (args: { amount: number; customerId: string }) => Promise<{ transactionId: string; status: 'success' | 'failed' }>
- * ```
- */
-type WorkerInferNexusOperationHandler<TOperation extends NexusOperationDefinition> = (args: WorkerInferNexusOperationInput<TOperation>) => Promise<WorkerInferNexusOperationOutput<TOperation>>;
-/**
- * Infer all operation handlers for a Nexus service (worker perspective)
+ * Signals are asynchronous messages sent to running workflows to update their state
+ * or trigger certain behaviors. This function ensures type safety for signal payloads.
  *
- * @example
- * ```typescript
- * type PaymentServiceHandlers = WorkerInferNexusServiceHandlers<typeof PaymentService>;
- * // {
- * //   processPayment: (args: { ... }) => Promise<{ ... }>;
- * //   refundPayment: (args: { ... }) => Promise<{ ... }>;
- * // }
- * ```
- */
-type WorkerInferNexusServiceHandlers<T extends NexusServiceDefinition> = { [K in keyof T["operations"]]: WorkerInferNexusOperationHandler<T["operations"][K]> };
-/**
- * Infer all Nexus service handlers from a contract (worker perspective)
+ * @template TSignal - The signal definition type with input schema
+ * @param definition - The signal definition containing input schema
+ * @returns The same definition with preserved types for type inference
  *
  * @example
  * ```typescript
- * type AllNexusHandlers = WorkerInferNexusServices<typeof myContract>;
- * // {
- * //   PaymentService: { processPayment: ..., refundPayment: ... };
- * //   InventoryService: { reserveItems: ..., releaseItems: ... };
- * // }
- * ```
- */
-type WorkerInferNexusServices<TContract extends ContractDefinitionWithNexus> = TContract["nexusServices"] extends Record<string, NexusServiceDefinition> ? { [K in keyof TContract["nexusServices"]]: WorkerInferNexusServiceHandlers<TContract["nexusServices"][K]> } : {};
-/**
- * CLIENT PERSPECTIVE - Nexus operation client type inference
- * Client sends the raw input and receives the parsed output
- */
-/**
- * Infer input type from a Nexus operation definition (client perspective)
- */
-type ClientInferNexusOperationInput<T extends NexusOperationDefinition> = StandardSchemaV1.InferInput<T["input"]>;
-/**
- * Infer output type from a Nexus operation definition (client perspective)
- */
-type ClientInferNexusOperationOutput<T extends NexusOperationDefinition> = StandardSchemaV1.InferOutput<T["output"]>;
-/**
- * Infer the client function signature for a Nexus operation (client perspective)
+ * import { defineSignal } from '@temporal-contract/contract';
+ * import { z } from 'zod';
  *
- * @example
- * ```typescript
- * type ProcessPaymentClient = ClientInferNexusOperationInvoker<typeof processPaymentOperation>;
- * // (args: { amount: number; customerId: string }) => Promise<{ transactionId: string; status: 'success' | 'failed' }>
+ * export const approveOrder = defineSignal({
+ *   input: z.object({
+ *     orderId: z.string(),
+ *     approvedBy: z.string(),
+ *   }),
+ * });
  * ```
  */
-type ClientInferNexusOperationInvoker<TOperation extends NexusOperationDefinition> = (args: ClientInferNexusOperationInput<TOperation>) => Promise<ClientInferNexusOperationOutput<TOperation>>;
-/**
- * Infer all operation invokers for a Nexus service (client perspective)
- */
-type ClientInferNexusServiceOperations<T extends NexusServiceDefinition> = { [K in keyof T["operations"]]: ClientInferNexusOperationInvoker<T["operations"][K]> };
+declare function defineSignal<TSignal extends SignalDefinition>(definition: TSignal): TSignal;
 /**
- * Infer all Nexus service operations from a contract (client perspective)
+ * Define a Temporal query with type-safe input and output schemas.
  *
- * @example
- * ```typescript
- * type AllNexusOperations = ClientInferNexusServices<typeof myContract>;
- * // {
- * //   PaymentService: { processPayment: ..., refundPayment: ... };
- * //   InventoryService: { reserveItems: ..., releaseItems: ... };
- * // }
- * ```
- */
-type ClientInferNexusServices<TContract extends ContractDefinitionWithNexus> = TContract["nexusServices"] extends Record<string, NexusServiceDefinition> ? { [K in keyof TContract["nexusServices"]]: ClientInferNexusServiceOperations<TContract["nexusServices"][K]> } : {};
-/**
- * UTILITY TYPES
- */
-/**
- * Extract service names from a contract as a union type
+ * Queries allow you to read the current state of a running workflow without
+ * modifying it. They are synchronous and should not perform any mutations.
  *
- * @example
- * ```typescript
- * type MyServiceNames = InferNexusServiceNames<typeof myContract>;
- * // "PaymentService" | "InventoryService"
- * ```
- */
-type InferNexusServiceNames<TContract extends ContractDefinitionWithNexus> = TContract["nexusServices"] extends Record<string, NexusServiceDefinition> ? keyof TContract["nexusServices"] & string : never;
-/**
- * Extract operation names from a service as a union type
+ * @template TQuery - The query definition type with input/output schemas
+ * @param definition - The query definition containing input and output schemas
+ * @returns The same definition with preserved types for type inference
  *
  * @example
  * ```typescript
- * type PaymentOperations = InferNexusOperationNames<typeof myContract, "PaymentService">;
- * // "processPayment" | "refundPayment"
+ * import { defineQuery } from '@temporal-contract/contract';
+ * import { z } from 'zod';
+ *
+ * export const getOrderStatus = defineQuery({
+ *   input: z.object({ orderId: z.string() }),
+ *   output: z.object({
+ *     status: z.enum(['pending', 'processing', 'completed', 'failed']),
+ *     updatedAt: z.date(),
+ *   }),
+ * });
  * ```
  */
-type InferNexusOperationNames<TContract extends ContractDefinitionWithNexus, TServiceName extends InferNexusServiceNames<TContract>> = TContract["nexusServices"] extends Record<string, NexusServiceDefinition> ? keyof TContract["nexusServices"][TServiceName]["operations"] & string : never;
+declare function defineQuery<TQuery extends QueryDefinition>(definition: TQuery): TQuery;
 /**
- * Infer the handler type for a specific Nexus operation (worker perspective)
+ * Define a Temporal update with type-safe input and output schemas.
+ *
+ * Updates are similar to signals but return a value and wait for the workflow
+ * to process them before completing. They provide a synchronous way to modify
+ * workflow state and get immediate feedback.
+ *
+ * @template TUpdate - The update definition type with input/output schemas
+ * @param definition - The update definition containing input and output schemas
+ * @returns The same definition with preserved types for type inference
  *
  * @example
  * ```typescript
- * const processPayment: NexusOperationHandler<
- *   typeof myContract,
- *   "PaymentService",
- *   "processPayment"
- * > = async ({ amount, customerId }) => {
- *   // Implementation
- *   return { transactionId: 'tx-123', status: 'success' };
- * };
+ * import { defineUpdate } from '@temporal-contract/contract';
+ * import { z } from 'zod';
+ *
+ * export const updateOrderQuantity = defineUpdate({
+ *   input: z.object({
+ *     orderId: z.string(),
+ *     newQuantity: z.number().positive(),
+ *   }),
+ *   output: z.object({
+ *     success: z.boolean(),
+ *     totalPrice: z.number(),
+ *   }),
+ * });
  * ```
  */
-type NexusOperationHandler<TContract extends ContractDefinitionWithNexus, TServiceName extends InferNexusServiceNames<TContract>, TOperationName extends InferNexusOperationNames<TContract, TServiceName>> = TContract["nexusServices"] extends Record<string, NexusServiceDefinition> ? (args: WorkerInferNexusOperationInput<TContract["nexusServices"][TServiceName]["operations"][TOperationName]>) => Promise<WorkerInferNexusOperationOutput<TContract["nexusServices"][TServiceName]["operations"][TOperationName]>> : never;
-/**
- * BUILDER FUNCTIONS (Proposed API)
- * These would be added to builder.ts when Nexus support is implemented
- */
+declare function defineUpdate<TUpdate extends UpdateDefinition>(definition: TUpdate): TUpdate;
 /**
- * Builder for creating Nexus operation definitions
+ * Define a Temporal workflow with type-safe input, output, and associated operations.
+ *
+ * Workflows are durable functions that orchestrate activities, handle timeouts,
+ * and manage long-running processes. This function provides type safety for the
+ * entire workflow definition including activities, signals, queries, and updates.
  *
- * @template TOperation - A NexusOperationDefinition containing input and output schemas
- * @param definition - The Nexus operation definition with typed input/output schemas
- * @returns The same definition with preserved types
+ * @template TWorkflow - The workflow definition type with all associated schemas
+ * @param definition - The workflow definition containing input, output, and operations
+ * @returns The same definition with preserved types for type inference
  *
  * @example
  * ```typescript
- * const processPayment = defineNexusOperation({
- *   input: z.object({ amount: z.number(), customerId: z.string() }),
- *   output: z.object({ transactionId: z.string(), status: z.enum(['success', 'failed']) }),
+ * import { defineWorkflow, defineActivity, defineSignal } from '@temporal-contract/contract';
+ * import { z } from 'zod';
+ *
+ * export const processOrder = defineWorkflow({
+ *   input: z.object({ orderId: z.string() }),
+ *   output: z.object({ success: z.boolean() }),
+ *   activities: {
+ *     validatePayment: defineActivity({
+ *       input: z.object({ orderId: z.string() }),
+ *       output: z.object({ valid: z.boolean() }),
+ *     }),
+ *   },
+ *   signals: {
+ *     cancel: defineSignal({
+ *       input: z.object({ reason: z.string() }),
+ *     }),
+ *   },
  * });
  * ```
  */
-declare function defineNexusOperation<TOperation extends NexusOperationDefinition>(definition: TOperation): TOperation;
+declare function defineWorkflow<TWorkflow extends WorkflowDefinition>(definition: TWorkflow): TWorkflow;
 /**
- * Builder for creating Nexus service definitions
+ * Define a complete Temporal contract with type-safe workflows and activities.
+ *
+ * A contract is the central definition that ties together your Temporal application's
+ * workflows and activities. It provides:
+ * - Type safety across client, worker, and workflow code
+ * - Automatic validation at runtime
+ * - Compile-time verification of implementations
+ * - Clear API boundaries and documentation
+ *
+ * The contract validates the structure and ensures:
+ * - Task queue is specified
+ * - At least one workflow is defined
+ * - Valid JavaScript identifiers are used
+ * - No conflicts between global and workflow-specific activities
+ * - All schemas implement the Standard Schema specification
  *
- * @template TService - A NexusServiceDefinition containing a record of operations
- * @param definition - The Nexus service definition with typed operations
- * @returns The same definition with preserved types
+ * @template TContract - The contract definition type
+ * @param definition - The complete contract definition
+ * @returns The same definition with preserved types for type inference
+ * @throws {Error} If the contract structure is invalid
  *
  * @example
  * ```typescript
- * const PaymentService = defineNexusService({
- *   operations: {
- *     processPayment: defineNexusOperation({ ... }),
- *     refundPayment: defineNexusOperation({ ... }),
+ * import { defineContract } from '@temporal-contract/contract';
+ * import { z } from 'zod';
+ *
+ * export const myContract = defineContract({
+ *   taskQueue: 'orders',
+ *   workflows: {
+ *     processOrder: {
+ *       input: z.object({ orderId: z.string() }),
+ *       output: z.object({ success: z.boolean() }),
+ *       activities: {
+ *         chargePayment: {
+ *           input: z.object({ amount: z.number() }),
+ *           output: z.object({ transactionId: z.string() }),
+ *         },
+ *       },
+ *     },
+ *   },
+ *   // Optional global activities shared across workflows
+ *   activities: {
+ *     logEvent: {
+ *       input: z.object({ message: z.string() }),
+ *       output: z.void(),
+ *     },
  *   },
  * });
  * ```
  */
-declare function defineNexusService<TService extends NexusServiceDefinition>(definition: TService): TService;
+declare function defineContract<TContract extends ContractDefinition>(definition: TContract): TContract;
 //#endregion
-export { type ActivityDefinition, type AnySchema, type ClientInferNexusOperationInput, type ClientInferNexusOperationInvoker, type ClientInferNexusOperationOutput, type ClientInferNexusServiceOperations, type ClientInferNexusServices, type ContractDefinition, type ContractDefinitionWithNexus, type InferActivityNames, type InferContractWorkflows, type InferNexusOperationNames, type InferNexusServiceNames, type InferWorkflowNames, type NexusOperationDefinition, type NexusOperationHandler, type NexusServiceDefinition, type QueryDefinition, type SignalDefinition, type UpdateDefinition, type WorkerInferNexusOperationHandler, type WorkerInferNexusOperationInput, type WorkerInferNexusOperationOutput, type WorkerInferNexusServiceHandlers, type WorkerInferNexusServices, type WorkflowDefinition, defineActivity, defineContract, defineNexusOperation, defineNexusService, defineQuery, defineSignal, defineUpdate, defineWorkflow };
+export { type ActivityDefinition, type AnySchema, type ContractDefinition, type InferActivityNames, type InferContractWorkflows, type InferWorkflowNames, type QueryDefinition, type SignalDefinition, type UpdateDefinition, type WorkflowDefinition, defineActivity, defineContract, defineQuery, defineSignal, defineUpdate, defineWorkflow };