Skip to content

@temporal-contract/contract@7.0.0

Choose a tag to compare

View all tags
@btravers btravers released this 11 Jul 21:15
@temporal-contract/contract@7.0.0
c72552b

Minor Changes

  • dc4a0cd: Cross-project DNA alignment with amqp-contract (#301, #302, #303, #304).

    Breaking — AsyncResult-returning creation (#301). The runtime factories now model creation failures on the Err channel instead of throwing, matching the org-wide Typed*.create() shape:

    • TypedClient.create({ contract, client, interceptors? }) → AsyncResult<TypedClient, TechnicalError> (single options object; surfaces a missing Schedule API and eager-connection failures via connection.ensureConnected).
    • createWorker(options) → AsyncResult<Worker, TechnicalError> (bundling/connection failures modeled).
    • TechnicalError (tag @temporal-contract/TechnicalError) is exported from @temporal-contract/contract/errors and re-exported by client and worker.
    • Migration: deprecated throwing aliases TypedClient.createOrThrow(contract, client) and createWorkerOrThrow(options) preserve the old behavior and will be removed in a future major.

    Breaking — unified context model (#302). declareActivitiesHandler's middleware option now takes a single middleware (compose chains with composeActivityMiddleware(...), outermost-first) instead of an array, and next takes an object patch:

    • next({ context }) extends the typed context flowing downstream (shallow-merged; bounded generics TContextOut extends TContextIn accumulate across composeActivityMiddleware's overloads — amqp-contract's model). defineActivityMiddleware pins a middleware's context types; EmptyContext is the empty seed.
    • next({ input }) replaces the positional next(input) substitution (still re-validated against the contract schema).
    • createContext now seeds the accumulated context; helpers.context is the seed plus every middleware injection (an empty object when unconfigured, no longer undefined).
    • Client interceptors: TypedClient.create({ interceptors }) wraps startWorkflow / executeWorkflow / signalWithStart and handle-level signal / query / update, outermost-first, outside validation — patch args via next({ input }), retry by calling next again, short-circuit by returning without calling next.
    • The demesne Layer.forkScope recipe is documented as the recommended createContext engine for scoped, resource-releasing contexts.

    Testing — in-process story (#303). New @temporal-contract/testing/time-skipping entry point: a Vitest fixture (it with a worker-scoped testEnv) plus createTimeSkippingEnvironment() wrapping Temporal's time-skipping TestWorkflowEnvironment — full contract-pipeline tests (validation, middleware, typed errors, rehydration) without Docker. @temporalio/testing ^1 is a new peer dependency of the testing package.

    Consistency cleanup (#304). activityOptions on declareWorkflow is now optional when every reachable activity carries contract-level defaultOptions (or an activityOptionsByName entry) — a descriptive declaration-time error lists uncovered activities otherwise. The direction-aware inference primitives (ClientInferInput / ClientInferOutput / WorkerInferInput / WorkerInferOutput) are centralized in @temporal-contract/contract (worker/client re-export them unchanged). The obsolete migrating-to-neverthrow guide is removed, stale JSDoc fixed, and docs/examples adopt the composition-first rule (define resources first, then reference them in defineContract).

  • 52d4c01: Contract-declared typed domain errors, activity middleware + typed dependency context, and contract-level default activity options.

    • Typed domain errors — defineActivity / defineWorkflow accept an errors map ({ data?: StandardSchema, message?, nonRetryable? } per name). Activity implementations receive typed constructors via a new helpers argument ((args, { errors }) => Err(errors.PaymentDeclined({ reason }))); the worker serializes them as ApplicationFailure (type = error name, details[0] = validated payload, nonRetryable from the contract). On the workflow side, errors-declaring activities now return AsyncResult<Output, ContractError union | ActivityError | ActivityCancelledError> (mirroring the child-workflow API); activities without declared errors keep the throwing Promise shape. Workflows can declare their own errors and fail with throw context.errors.X(data); the typed client rehydrates matching failures into ContractError on executeWorkflow and handle.result(). New @temporal-contract/contract/errors entry point exports ContractError and the supporting types.
    • Activity middleware + typed context — declareActivitiesHandler accepts createContext (typed dependency injection, surfaced to implementations as helpers.context) and middleware (contract-aware chain running inside the validation boundary, operating on the unthrown AsyncResult).
    • Contract-level activity option defaults — defineActivity accepts defaultOptions (timeouts, retry policy). Merge precedence at the worker: declareWorkflow activityOptions < contract defaultOptions < activityOptionsByName.

Patch Changes

  • 1ec704a: Require unthrown >= 4.1.0 (peer range ^4 → ^4.1.0).

    unthrown 4.1 renames several operators and deprecates the old aliases (orElse → flatMapErr, recover → recoverErr, unwrap/unwrapErr/unwrapOr/unwrapOrElse → get/getErr/getOr/getOrElse). The packages' own code never used the deprecated names, so no runtime behavior changes — the docs and guides now reference the new names, and raising the peer minimum guarantees the renamed operators exist for consumers following them.

Assets 2
Loading