@temporalio/common 1.6.0 → 1.7.1

package/lib/errors.d.ts

@@ -1,3 +1,4 @@
+import { TemporalFailure } from './failure';
 /**
  * Thrown from code that receives a value that is unexpected or that it's unable to handle.
  */
@@ -26,7 +27,7 @@ export declare class IllegalStateError extends Error {
  *  - There is closed Workflow in the `Completed` state with the same Workflow Id and the {@link WorkflowOptions.workflowIdReusePolicy}
  *    is `WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY`
  */
-export declare class WorkflowExecutionAlreadyStartedError extends Error {
+export declare class WorkflowExecutionAlreadyStartedError extends TemporalFailure {
     readonly workflowId: string;
     readonly workflowType: string;
     readonly name: string;

package/lib/errors.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowNotFoundError = exports.WorkflowExecutionAlreadyStartedError = exports.IllegalStateError = exports.PayloadConverterError = exports.ValueError = void 0;
+const failure_1 = require("./failure");
 /**
  * Thrown from code that receives a value that is unexpected or that it's unable to handle.
  */
@@ -40,7 +41,7 @@ exports.IllegalStateError = IllegalStateError;
  *  - There is closed Workflow in the `Completed` state with the same Workflow Id and the {@link WorkflowOptions.workflowIdReusePolicy}
  *    is `WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY`
  */
-class WorkflowExecutionAlreadyStartedError extends Error {
+class WorkflowExecutionAlreadyStartedError extends failure_1.TemporalFailure {
     constructor(message, workflowId, workflowType) {
         super(message);
         this.workflowId = workflowId;

package/lib/errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,MAAa,UAAW,SAAQ,KAAK;IAGnC,YAAY,OAA2B,EAAkB,KAAe;QACtE,KAAK,CAAC,OAAO,IAAI,SAAS,CAAC,CAAC;QAD2B,UAAK,GAAL,KAAK,CAAU;QAFxD,SAAI,GAAW,YAAY,CAAC;IAI5C,CAAC;CACF;AAND,gCAMC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,UAAU;IAArD;;QACkB,SAAI,GAAW,uBAAuB,CAAC;IACzD,CAAC;CAAA;AAFD,sDAEC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,KAAK;IAA5C;;QACkB,SAAI,GAAW,mBAAmB,CAAC;IACrD,CAAC;CAAA;AAFD,8CAEC;AAED;;;;;;;GAOG;AACH,MAAa,oCAAqC,SAAQ,KAAK;IAG7D,YAAY,OAAe,EAAkB,UAAkB,EAAkB,YAAoB;QACnG,KAAK,CAAC,OAAO,CAAC,CAAC;QAD4B,eAAU,GAAV,UAAU,CAAQ;QAAkB,iBAAY,GAAZ,YAAY,CAAQ;QAFrF,SAAI,GAAW,sCAAsC,CAAC;IAItE,CAAC;CACF;AAND,oFAMC;AAED;;;;;;GAMG;AACH,MAAa,qBAAsB,SAAQ,KAAK;IAG9C,YAAY,OAAe,EAAkB,UAAkB,EAAkB,KAAyB;QACxG,KAAK,CAAC,OAAO,CAAC,CAAC;QAD4B,eAAU,GAAV,UAAU,CAAQ;QAAkB,UAAK,GAAL,KAAK,CAAoB;QAF1F,SAAI,GAAW,uBAAuB,CAAC;IAIvD,CAAC;CACF;AAND,sDAMC"}
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":";;;AAAA,uCAA4C;AAE5C;;GAEG;AACH,MAAa,UAAW,SAAQ,KAAK;IAGnC,YAAY,OAA2B,EAAkB,KAAe;QACtE,KAAK,CAAC,OAAO,IAAI,SAAS,CAAC,CAAC;QAD2B,UAAK,GAAL,KAAK,CAAU;QAFxD,SAAI,GAAW,YAAY,CAAC;IAI5C,CAAC;CACF;AAND,gCAMC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,UAAU;IAArD;;QACkB,SAAI,GAAW,uBAAuB,CAAC;IACzD,CAAC;CAAA;AAFD,sDAEC;AAED;;GAEG;AACH,MAAa,iBAAkB,SAAQ,KAAK;IAA5C;;QACkB,SAAI,GAAW,mBAAmB,CAAC;IACrD,CAAC;CAAA;AAFD,8CAEC;AAED;;;;;;;GAOG;AACH,MAAa,oCAAqC,SAAQ,yBAAe;IAGvE,YAAY,OAAe,EAAkB,UAAkB,EAAkB,YAAoB;QACnG,KAAK,CAAC,OAAO,CAAC,CAAC;QAD4B,eAAU,GAAV,UAAU,CAAQ;QAAkB,iBAAY,GAAZ,YAAY,CAAQ;QAFrF,SAAI,GAAW,sCAAsC,CAAC;IAItE,CAAC;CACF;AAND,oFAMC;AAED;;;;;;GAMG;AACH,MAAa,qBAAsB,SAAQ,KAAK;IAG9C,YAAY,OAAe,EAAkB,UAAkB,EAAkB,KAAyB;QACxG,KAAK,CAAC,OAAO,CAAC,CAAC;QAD4B,eAAU,GAAV,UAAU,CAAQ;QAAkB,UAAK,GAAL,KAAK,CAAoB;QAF1F,SAAI,GAAW,uBAAuB,CAAC;IAIvD,CAAC;CACF;AAND,sDAMC"}

package/lib/interfaces.d.ts

@@ -11,23 +11,42 @@ export declare type WorkflowQueryType = (...args: any[]) => any;
  * ```
  */
 export declare type Workflow = (...args: any[]) => WorkflowReturnType;
+declare const argsBrand: unique symbol;
 /**
  * An interface representing a Workflow signal definition, as returned from {@link defineSignal}
  *
- * @remarks `_Args` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * @remarks `Args` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * `Name` can optionally be specified with a string literal type to preserve type-level knowledge of the signal name.
  */
-export interface SignalDefinition<_Args extends any[] = []> {
+export interface SignalDefinition<Args extends any[] = [], Name extends string = string> {
     type: 'signal';
-    name: string;
+    name: Name;
+    /**
+     * Virtual type brand to maintain a distinction between {@link SignalDefinition} types with different args.
+     * This field is not present at run-time.
+     */
+    [argsBrand]: Args;
 }
+declare const retBrand: unique symbol;
 /**
  * An interface representing a Workflow query definition as returned from {@link defineQuery}
  *
- * @remarks `_Args` and `_Ret` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * @remarks `Args` and `Ret` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * `Name` can optionally be specified with a string literal type to preserve type-level knowledge of the query name.
  */
-export interface QueryDefinition<_Ret, _Args extends any[] = []> {
+export interface QueryDefinition<Ret, Args extends any[] = [], Name extends string = string> {
     type: 'query';
-    name: string;
+    name: Name;
+    /**
+     * Virtual type brand to maintain a distinction between {@link QueryDefinition} types with different args.
+     * This field is not present at run-time.
+     */
+    [argsBrand]: Args;
+    /**
+     * Virtual type brand to maintain a distinction between {@link QueryDefinition} types with different return types.
+     * This field is not present at run-time.
+     */
+    [retBrand]: Ret;
 }
 /** Get the "unwrapped" return type (without Promise) of the execute handler from Workflow type `W` */
 export declare type WorkflowResultType<W extends Workflow> = ReturnType<W> extends Promise<infer R> ? R : never;
@@ -36,7 +55,7 @@ export declare type WorkflowResultType<W extends Workflow> = ReturnType<W> exten
  *
  * Dates are serialized as ISO strings.
  */
-export declare type SearchAttributes = Record<string, SearchAttributeValue | undefined>;
+export declare type SearchAttributes = Record<string, SearchAttributeValue | Readonly<SearchAttributeValue> | undefined>;
 export declare type SearchAttributeValue = string[] | number[] | boolean[] | Date[];
 export interface ActivityFunction<P extends any[] = any[], R = any> {
     (...args: P): Promise<R>;
@@ -57,3 +76,4 @@ export interface HistoryAndWorkflowId {
     workflowId: string;
     history: temporal.api.history.v1.History | unknown | undefined;
 }
+export {};

package/lib/workflow-handle.d.ts

@@ -19,7 +19,7 @@ export interface BaseWorkflowHandle<T extends Workflow> {
      * await handle.signal(incrementSignal, 3);
      * ```
      */
-    signal<Args extends any[] = []>(def: SignalDefinition<Args> | string, ...args: Args): Promise<void>;
+    signal<Args extends any[] = [], Name extends string = string>(def: SignalDefinition<Args, Name> | string, ...args: Args): Promise<void>;
     /**
      * The workflowId of the current Workflow
      */

package/lib/workflow-options.d.ts

@@ -77,12 +77,12 @@ export declare type WithWorkflowArgs<W extends Workflow, T> = T & (Parameters<W>
     /**
      * Arguments to pass to the Workflow
      */
-    args: Parameters<W>;
+    args: Parameters<W> | Readonly<Parameters<W>>;
 } : {
     /**
      * Arguments to pass to the Workflow
      */
-    args?: Parameters<W>;
+    args?: Parameters<W> | Readonly<Parameters<W>>;
 });
 export interface WorkflowDurationOptions {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/common",
-  "version": "1.6.0",
+  "version": "1.7.1",
   "description": "Common library for code that's used across the Client, Worker, and/or Workflow",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
@@ -13,7 +13,7 @@
   "license": "MIT",
   "dependencies": {
     "@opentelemetry/api": "^1.3.0",
-    "@temporalio/proto": "1.6.0",
+    "@temporalio/proto": "1.7.1",
     "long": "^5.2.0",
     "ms": "^2.1.3",
     "proto3-json-serializer": "^1.0.3",
@@ -22,6 +22,11 @@
   "bugs": {
     "url": "https://github.com/temporalio/sdk-typescript/issues"
   },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/temporalio/sdk-typescript.git",
+    "directory": "packages/common"
+  },
   "homepage": "https://github.com/temporalio/sdk-typescript/tree/main/packages/common",
   "publishConfig": {
     "access": "public"
@@ -30,5 +35,5 @@
     "src",
     "lib"
   ],
-  "gitHead": "49c6b1341daef2b94a0a989d515cbf97b8b02fa7"
+  "gitHead": "368aa83c631555fc31cff25f4af8817d069878d8"
 }

package/src/errors.ts

@@ -1,3 +1,5 @@
+import { TemporalFailure } from './failure';
+
 /**
  * Thrown from code that receives a value that is unexpected or that it's unable to handle.
  */
@@ -31,7 +33,7 @@ export class IllegalStateError extends Error {
  *  - There is closed Workflow in the `Completed` state with the same Workflow Id and the {@link WorkflowOptions.workflowIdReusePolicy}
  *    is `WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY`
  */
-export class WorkflowExecutionAlreadyStartedError extends Error {
+export class WorkflowExecutionAlreadyStartedError extends TemporalFailure {
   public readonly name: string = 'WorkflowExecutionAlreadyStartedError';
 
   constructor(message: string, public readonly workflowId: string, public readonly workflowType: string) {

package/src/interfaces.ts

@@ -15,26 +15,43 @@ export type WorkflowQueryType = (...args: any[]) => any;
  */
 export type Workflow = (...args: any[]) => WorkflowReturnType;
 
+declare const argsBrand: unique symbol;
 /**
  * An interface representing a Workflow signal definition, as returned from {@link defineSignal}
  *
- * @remarks `_Args` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * @remarks `Args` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * `Name` can optionally be specified with a string literal type to preserve type-level knowledge of the signal name.
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export interface SignalDefinition<_Args extends any[] = []> {
+export interface SignalDefinition<Args extends any[] = [], Name extends string = string> {
   type: 'signal';
-  name: string;
+  name: Name;
+  /**
+   * Virtual type brand to maintain a distinction between {@link SignalDefinition} types with different args.
+   * This field is not present at run-time.
+   */
+  [argsBrand]: Args;
 }
 
+declare const retBrand: unique symbol;
 /**
  * An interface representing a Workflow query definition as returned from {@link defineQuery}
  *
- * @remarks `_Args` and `_Ret` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * @remarks `Args` and `Ret` can be used for parameter type inference in handler functions and *WorkflowHandle methods.
+ * `Name` can optionally be specified with a string literal type to preserve type-level knowledge of the query name.
  */
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-export interface QueryDefinition<_Ret, _Args extends any[] = []> {
+export interface QueryDefinition<Ret, Args extends any[] = [], Name extends string = string> {
   type: 'query';
-  name: string;
+  name: Name;
+  /**
+   * Virtual type brand to maintain a distinction between {@link QueryDefinition} types with different args.
+   * This field is not present at run-time.
+   */
+  [argsBrand]: Args;
+  /**
+   * Virtual type brand to maintain a distinction between {@link QueryDefinition} types with different return types.
+   * This field is not present at run-time.
+   */
+  [retBrand]: Ret;
 }
 
 /** Get the "unwrapped" return type (without Promise) of the execute handler from Workflow type `W` */
@@ -45,7 +62,7 @@ export type WorkflowResultType<W extends Workflow> = ReturnType<W> extends Promi
  *
  * Dates are serialized as ISO strings.
  */
-export type SearchAttributes = Record<string, SearchAttributeValue | undefined>;
+export type SearchAttributes = Record<string, SearchAttributeValue | Readonly<SearchAttributeValue> | undefined>;
 export type SearchAttributeValue = string[] | number[] | boolean[] | Date[];
 
 export interface ActivityFunction<P extends any[] = any[], R = any> {

package/src/workflow-handle.ts

@@ -21,7 +21,10 @@ export interface BaseWorkflowHandle<T extends Workflow> {
    * await handle.signal(incrementSignal, 3);
    * ```
    */
-  signal<Args extends any[] = []>(def: SignalDefinition<Args> | string, ...args: Args): Promise<void>;
+  signal<Args extends any[] = [], Name extends string = string>(
+    def: SignalDefinition<Args, Name> | string,
+    ...args: Args
+  ): Promise<void>;
 
   /**
    * The workflowId of the current Workflow

package/src/workflow-options.ts

@@ -96,13 +96,13 @@ export type WithWorkflowArgs<W extends Workflow, T> = T &
         /**
          * Arguments to pass to the Workflow
          */
-        args: Parameters<W>;
+        args: Parameters<W> | Readonly<Parameters<W>>;
       }
     : {
         /**
          * Arguments to pass to the Workflow
          */
-        args?: Parameters<W>;
+        args?: Parameters<W> | Readonly<Parameters<W>>;
       });
 
 export interface WorkflowDurationOptions {