@temporalio/client 1.11.5 → 1.11.7

package/lib/base-client.d.ts

@@ -37,8 +37,8 @@ export declare class BaseClient {
     /**
      * The underlying {@link Connection | connection} used by this client.
      *
-     * Clients are cheap to create, but connections are expensive. Where that make sense,
-     * a single connection may and should be reused by multiple `Client`.
+     * Clients are cheap to create, but connections are expensive. Where it makes sense,
+     * a single connection may and should be reused by multiple `Client`s.
      */
     readonly connection: ConnectionLike;
     private readonly loadedDataConverter;

package/lib/helpers.d.ts

@@ -1,10 +1,12 @@
 import { ServiceError as GrpcServiceError } from '@grpc/grpc-js';
 import { LoadedDataConverter } from '@temporalio/common';
 import { Replace } from '@temporalio/common/lib/type-helpers';
-import { RawWorkflowExecutionInfo, WorkflowExecutionInfo } from './types';
+import { temporal } from '@temporalio/proto';
+import { CountWorkflowExecution, RawWorkflowExecutionInfo, WorkflowExecutionInfo } from './types';
 export declare function executionInfoFromRaw<T>(raw: RawWorkflowExecutionInfo, dataConverter: LoadedDataConverter, rawDataToEmbed: T): Promise<Replace<WorkflowExecutionInfo, {
     raw: T;
 }>>;
+export declare function decodeCountWorkflowExecutionsResponse(raw: temporal.api.workflowservice.v1.ICountWorkflowExecutionsResponse): CountWorkflowExecution;
 /**
  * If the error type can be determined based on embedded grpc error details,
  * then rethrow the appropriate TypeScript error. Otherwise do nothing.

package/lib/helpers.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.executionInfoFromRaw = executionInfoFromRaw;
+exports.decodeCountWorkflowExecutionsResponse = decodeCountWorkflowExecutionsResponse;
 exports.rethrowKnownErrorTypes = rethrowKnownErrorTypes;
+const grpc_js_1 = require("@grpc/grpc-js");
 const common_1 = require("@temporalio/common");
 const time_1 = require("@temporalio/common/lib/time");
 const codec_helpers_1 = require("@temporalio/common/lib/internal-non-workflow/codec-helpers");
@@ -63,6 +65,19 @@ async function executionInfoFromRaw(raw, dataConverter, rawDataToEmbed) {
         raw: rawDataToEmbed,
     };
 }
+function decodeCountWorkflowExecutionsResponse(raw) {
+    return {
+        // Note: lossy conversion of Long to number
+        count: raw.count.toNumber(),
+        groups: raw.groups.map((group) => {
+            return {
+                // Note: lossy conversion of Long to number
+                count: group.count.toNumber(),
+                groupValues: group.groupValues.map((value) => common_1.searchAttributePayloadConverter.fromPayload(value)),
+            };
+        }),
+    };
+}
 /**
  * If the error type can be determined based on embedded grpc error details,
  * then rethrow the appropriate TypeScript error. Otherwise do nothing.
@@ -82,6 +97,26 @@ function rethrowKnownErrorTypes(err) {
                 const { namespace } = proto_1.temporal.api.errordetails.v1.NamespaceNotFoundFailure.decode(entry.value);
                 throw new common_1.NamespaceNotFoundError(namespace);
             }
+            case 'temporal.api.errordetails.v1.MultiOperationExecutionFailure': {
+                // MultiOperationExecutionFailure contains error statuses for multiple
+                // operations. A MultiOperationExecutionAborted error status means that
+                // the corresponding operation was aborted due to an error in one of the
+                // other operations. We rethrow the first operation error that is not
+                // MultiOperationExecutionAborted.
+                const { statuses } = proto_1.temporal.api.errordetails.v1.MultiOperationExecutionFailure.decode(entry.value);
+                for (const status of statuses) {
+                    const detail = status.details?.[0];
+                    const statusType = detail?.type_url?.replace(/^type.googleapis.com\//, '');
+                    if (statusType === 'temporal.api.failure.v1.MultiOperationExecutionAborted' ||
+                        status.code === grpc_js_1.status.OK) {
+                        continue;
+                    }
+                    err.message = status.message ?? err.message;
+                    err.code = status.code || err.code;
+                    err.details = detail?.value?.toString() || err.details;
+                    throw err;
+                }
+            }
         }
     }
 }

package/lib/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;AA4CA,oDAqCC;AAYD,wDAaC;AAzGD,+CAM4B;AAE5B,sDAAiF;AACjF,8FAAmG;AACnG,6CAAqD;AAGrD,SAAS,wBAAwB,CAAC,IAAmD;IACnF,OAAO,gCAAgC,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,SAAS,gCAAgC,CACvC,IAAmD;IAEnD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,qCAAqC;YACtF,OAAO,aAAa,CAAC;QACvB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,iCAAiC;YAClF,OAAO,SAAS,CAAC;QACnB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,gCAAgC;YACjF,OAAO,QAAQ,CAAC;QAClB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,mCAAmC;YACpF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,kCAAkC;YACnF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,oCAAoC;YACrF,OAAO,YAAY,CAAC;QACtB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,mCAAmC;YACpF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,0CAA0C;YAC3F,OAAO,kBAAkB,CAAC;IAC9B,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,oBAAoB,CACxC,GAA6B,EAC7B,aAAkC,EAClC,cAAiB;IAEjB,OAAO;QACL,6DAA6D;QAC7D,IAAI,EAAE,GAAG,CAAC,IAAK,CAAC,IAAK;QACrB,UAAU,EAAE,GAAG,CAAC,SAAU,CAAC,UAAW;QACtC,KAAK,EAAE,GAAG,CAAC,SAAU,CAAC,KAAM;QAC5B,SAAS,EAAE,GAAG,CAAC,SAAU;QACzB,MAAM,EAAE;YACN,IAAI,EAAE,GAAG,CAAC,MAAO;YACjB,IAAI,EAAE,wBAAwB,CAAC,GAAG,CAAC,MAAO,CAAC;SAC5C;QACD,wGAAwG;QACxG,aAAa,EAAE,GAAG,CAAC,aAAc,CAAC,QAAQ,EAAE;QAC5C,gDAAgD;QAChD,kGAAkG;QAClG,WAAW,EAAE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,SAAS;QAC1D,SAAS,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC;QACvD,aAAa,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,aAAa,CAAC;QAClD,SAAS,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,SAAS,CAAC;QAC1C,IAAI,EAAE,MAAM,IAAA,qCAAqB,EAAC,aAAa,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;QAClE,gBAAgB,EAAE,MAAM,CAAC,WAAW,CAClC,MAAM,CAAC,OAAO,CACZ,IAAA,wBAAe,EAAC,wCAA+B,EAAE,GAAG,CAAC,gBAAgB,EAAE,aAAa,IAAI,EAAE,CAAqB,CAChH,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,uDAAuD;SAChG;QACD,eAAe,EAAE,GAAG,CAAC,eAAe;YAClC,CAAC,CAAC;gBACE,UAAU,EAAE,GAAG,CAAC,eAAe,CAAC,UAAW;gBAC3C,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC,KAAM;aAClC;YACH,CAAC,CAAC,SAAS;QACb,GAAG,EAAE,cAAc;KACpB,CAAC;AACJ,CAAC;AAID;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,GAAqB;IAC1D,iGAAiG;IACjG,KAAK,MAAM,KAAK,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,SAAS;QAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAqB,CAAC;QAEtF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,uDAAuD,CAAC,CAAC,CAAC;gBAC7D,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAChG,MAAM,IAAI,+BAAsB,CAAC,SAAS,CAAC,CAAC;YAC9C,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,GAAqB;IACjD,MAAM,YAAY,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACtE,IAAI,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,cAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC;AACxD,CAAC"}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;AAiDA,oDAqCC;AAED,sFAcC;AAaD,wDAmCC;AAtJD,2CAAuF;AACvF,+CAM4B;AAE5B,sDAAiF;AACjF,8FAAmG;AACnG,6CAAqD;AAQrD,SAAS,wBAAwB,CAAC,IAAmD;IACnF,OAAO,gCAAgC,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,SAAS,gCAAgC,CACvC,IAAmD;IAEnD,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,qCAAqC;YACtF,OAAO,aAAa,CAAC;QACvB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,iCAAiC;YAClF,OAAO,SAAS,CAAC;QACnB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,gCAAgC;YACjF,OAAO,QAAQ,CAAC;QAClB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,mCAAmC;YACpF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,kCAAkC;YACnF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,oCAAoC;YACrF,OAAO,YAAY,CAAC;QACtB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,mCAAmC;YACpF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,0CAA0C;YAC3F,OAAO,kBAAkB,CAAC;IAC9B,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,oBAAoB,CACxC,GAA6B,EAC7B,aAAkC,EAClC,cAAiB;IAEjB,OAAO;QACL,6DAA6D;QAC7D,IAAI,EAAE,GAAG,CAAC,IAAK,CAAC,IAAK;QACrB,UAAU,EAAE,GAAG,CAAC,SAAU,CAAC,UAAW;QACtC,KAAK,EAAE,GAAG,CAAC,SAAU,CAAC,KAAM;QAC5B,SAAS,EAAE,GAAG,CAAC,SAAU;QACzB,MAAM,EAAE;YACN,IAAI,EAAE,GAAG,CAAC,MAAO;YACjB,IAAI,EAAE,wBAAwB,CAAC,GAAG,CAAC,MAAO,CAAC;SAC5C;QACD,wGAAwG;QACxG,aAAa,EAAE,GAAG,CAAC,aAAc,CAAC,QAAQ,EAAE;QAC5C,gDAAgD;QAChD,kGAAkG;QAClG,WAAW,EAAE,GAAG,CAAC,gBAAgB,EAAE,QAAQ,EAAE,IAAI,SAAS;QAC1D,SAAS,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC;QACvD,aAAa,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,aAAa,CAAC;QAClD,SAAS,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,SAAS,CAAC;QAC1C,IAAI,EAAE,MAAM,IAAA,qCAAqB,EAAC,aAAa,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;QAClE,gBAAgB,EAAE,MAAM,CAAC,WAAW,CAClC,MAAM,CAAC,OAAO,CACZ,IAAA,wBAAe,EAAC,wCAA+B,EAAE,GAAG,CAAC,gBAAgB,EAAE,aAAa,IAAI,EAAE,CAAqB,CAChH,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,uDAAuD;SAChG;QACD,eAAe,EAAE,GAAG,CAAC,eAAe;YAClC,CAAC,CAAC;gBACE,UAAU,EAAE,GAAG,CAAC,eAAe,CAAC,UAAW;gBAC3C,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC,KAAM;aAClC;YACH,CAAC,CAAC,SAAS;QACb,GAAG,EAAE,cAAc;KACpB,CAAC;AACJ,CAAC;AAED,SAAgB,qCAAqC,CACnD,GAAqE;IAErE,OAAO;QACL,2CAA2C;QAC3C,KAAK,EAAE,GAAG,CAAC,KAAM,CAAC,QAAQ,EAAE;QAC5B,MAAM,EAAE,GAAG,CAAC,MAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAChC,OAAO;gBACL,2CAA2C;gBAC3C,KAAK,EAAE,KAAK,CAAC,KAAM,CAAC,QAAQ,EAAE;gBAC9B,WAAW,EAAE,KAAK,CAAC,WAAY,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,wCAA+B,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;aACnG,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAKD;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,GAAqB;IAC1D,iGAAiG;IACjG,KAAK,MAAM,KAAK,IAAI,oBAAoB,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC;QACpD,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,KAAK;YAAE,SAAS;QAC9C,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAqB,CAAC;QAEtF,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,uDAAuD,CAAC,CAAC,CAAC;gBAC7D,MAAM,EAAE,SAAS,EAAE,GAAG,gBAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,wBAAwB,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAChG,MAAM,IAAI,+BAAsB,CAAC,SAAS,CAAC,CAAC;YAC9C,CAAC;YACD,KAAK,6DAA6D,CAAC,CAAC,CAAC;gBACnE,sEAAsE;gBACtE,uEAAuE;gBACvE,wEAAwE;gBACxE,qEAAqE;gBACrE,kCAAkC;gBAClC,MAAM,EAAE,QAAQ,EAAE,GAAG,gBAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC,8BAA8B,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACrG,KAAK,MAAM,MAAM,IAAI,QAAQ,EAAE,CAAC;oBAC9B,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;oBACnC,MAAM,UAAU,GAAG,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAA4B,CAAC;oBACtG,IACE,UAAU,KAAK,wDAAwD;wBACvE,MAAM,CAAC,IAAI,KAAK,gBAAU,CAAC,EAAE,EAC7B,CAAC;wBACD,SAAS;oBACX,CAAC;oBACD,GAAG,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC;oBAC5C,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,IAAI,GAAG,CAAC,IAAI,CAAC;oBACnC,GAAG,CAAC,OAAO,GAAG,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,GAAG,CAAC,OAAO,CAAC;oBACvD,MAAM,GAAG,CAAC;gBACZ,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,GAAqB;IACjD,MAAM,YAAY,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,yBAAyB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACtE,IAAI,CAAC,YAAY,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACtD,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,cAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC;AACxD,CAAC"}

package/lib/interceptors.d.ts

@@ -31,6 +31,30 @@ export interface WorkflowStartUpdateOutput {
     readonly workflowRunId: string;
     readonly outcome?: temporal.api.update.v1.IOutcome;
 }
+/**
+ * Input for WorkflowClientInterceptor.startUpdateWithStart
+ *
+ * @experimental Update-with-Start is an experimental feature and may be subject to change.
+ */
+export interface WorkflowStartUpdateWithStartInput {
+    readonly workflowType: string;
+    readonly workflowStartOptions: CompiledWorkflowOptions;
+    readonly workflowStartHeaders: Headers;
+    readonly updateName: string;
+    readonly updateArgs: unknown[];
+    readonly updateOptions: WorkflowUpdateOptions;
+    readonly updateHeaders: Headers;
+}
+/**
+ * Output for WorkflowClientInterceptor.startUpdateWithStart
+ *
+ * @experimental Update-with-Start is an experimental feature and may be subject to change.
+ */
+export interface WorkflowStartUpdateWithStartOutput {
+    readonly workflowExecution: WorkflowExecution;
+    readonly updateId: string;
+    readonly updateOutcome?: temporal.api.update.v1.IOutcome;
+}
 /** Input for WorkflowClientInterceptor.signal */
 export interface WorkflowSignalInput {
     readonly signalName: string;
@@ -83,10 +107,14 @@ export interface WorkflowClientInterceptor {
     start?: (input: WorkflowStartInput, next: Next<this, 'start'>) => Promise<string>;
     /**
      * Intercept a service call to updateWorkflowExecution
-     *
-     * @experimental Update is an experimental feature.
      */
     startUpdate?: (input: WorkflowStartUpdateInput, next: Next<this, 'startUpdate'>) => Promise<WorkflowStartUpdateOutput>;
+    /**
+     * Intercept a service call to startUpdateWithStart
+     *
+     * @experimental Update-with-Start is an experimental feature and may be subject to change.
+     */
+    startUpdateWithStart?: (input: WorkflowStartUpdateWithStartInput, next: Next<this, 'startUpdateWithStart'>) => Promise<WorkflowStartUpdateWithStartOutput>;
     /**
      * Intercept a service call to signalWorkflowExecution
      *

package/lib/types.d.ts

@@ -1,5 +1,5 @@
 import type * as grpc from '@grpc/grpc-js';
-import type { SearchAttributes } from '@temporalio/common';
+import type { SearchAttributes, SearchAttributeValue } from '@temporalio/common';
 import * as proto from '@temporalio/proto';
 import { Replace } from '@temporalio/common/lib/type-helpers';
 export interface WorkflowExecution {
@@ -37,6 +37,13 @@ export interface WorkflowExecutionInfo {
     parentExecution?: Required<proto.temporal.api.common.v1.IWorkflowExecution>;
     raw: RawWorkflowExecutionInfo;
 }
+export interface CountWorkflowExecution {
+    count: number;
+    groups: {
+        count: number;
+        groupValues: SearchAttributeValue[];
+    }[];
+}
 export type WorkflowExecutionDescription = Replace<WorkflowExecutionInfo, {
     raw: DescribeWorkflowExecutionResponse;
 }>;

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,gFAAmF;AACnF,yDAA2C;AA2D5B,uBAAe,GAAK,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,iBAAC;AAE1D,uBAAe,GAAK,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,iBAAC;AAElD,qBAAa,GAAK,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,QAAC;AAyEjD,QAAA,oBAAoB,GAAG;IAClC,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,qBAAqB,EAAE,uBAAuB;IAE9C,4CAA4C;IAC5C,2BAA2B,EAAE,MAAM,EAAE,8CAA8C;IAEnF,gDAAgD;IAChD,+BAA+B,EAAE,UAAU,EAAE,8CAA8C;IAE3F,6DAA6D;IAC7D,4CAA4C,EAAE,uBAAuB,EAAE,8CAA8C;IAErH,2CAA2C;IAC3C,kCAAkC,EAAE,SAAS,EAAE,8CAA8C;CACrF,CAAC;AAGE,KAA2D,IAAA,2CAAuB,EAO7F;IACE,CAAC,4BAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;IAC9B,CAAC,4BAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClC,CAAC,4BAAoB,CAAC,qBAAqB,CAAC,EAAE,CAAC;IAC/C,WAAW,EAAE,CAAC;CACN,EACV,yBAAyB,CAC1B,EAda,kCAA0B,UAAE,kCAA0B,SAclE"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,gFAAmF;AACnF,yDAA2C;AAmE5B,uBAAe,GAAK,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,iBAAC;AAE1D,uBAAe,GAAK,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,iBAAC;AAElD,qBAAa,GAAK,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,QAAC;AAyEjD,QAAA,oBAAoB,GAAG;IAClC,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,qBAAqB,EAAE,uBAAuB;IAE9C,4CAA4C;IAC5C,2BAA2B,EAAE,MAAM,EAAE,8CAA8C;IAEnF,gDAAgD;IAChD,+BAA+B,EAAE,UAAU,EAAE,8CAA8C;IAE3F,6DAA6D;IAC7D,4CAA4C,EAAE,uBAAuB,EAAE,8CAA8C;IAErH,2CAA2C;IAC3C,kCAAkC,EAAE,SAAS,EAAE,8CAA8C;CACrF,CAAC;AAGE,KAA2D,IAAA,2CAAuB,EAO7F;IACE,CAAC,4BAAoB,CAAC,IAAI,CAAC,EAAE,CAAC;IAC9B,CAAC,4BAAoB,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClC,CAAC,4BAAoB,CAAC,qBAAqB,CAAC,EAAE,CAAC;IAC/C,WAAW,EAAE,CAAC;CACN,EACV,yBAAyB,CAC1B,EAda,kCAA0B,UAAE,kCAA0B,SAclE"}

package/lib/workflow-client.d.ts

@@ -1,9 +1,9 @@
 import { status as grpcStatus } from '@grpc/grpc-js';
-import { BaseWorkflowHandle, HistoryAndWorkflowId, QueryDefinition, UpdateDefinition, WithWorkflowArgs, Workflow, WorkflowResultType } from '@temporalio/common';
+import { BaseWorkflowHandle, HistoryAndWorkflowId, QueryDefinition, UpdateDefinition, WithWorkflowArgs, Workflow, WorkflowResultType, WorkflowIdConflictPolicy } from '@temporalio/common';
 import { History } from '@temporalio/common/lib/proto-utils';
 import { temporal } from '@temporalio/proto';
-import { WorkflowCancelInput, WorkflowClientInterceptor, WorkflowClientInterceptors, WorkflowDescribeInput, WorkflowQueryInput, WorkflowSignalInput, WorkflowSignalWithStartInput, WorkflowStartInput, WorkflowTerminateInput, WorkflowStartUpdateInput, WorkflowStartUpdateOutput } from './interceptors';
-import { DescribeWorkflowExecutionResponse, QueryRejectCondition, RequestCancelWorkflowExecutionResponse, TerminateWorkflowExecutionResponse, WorkflowExecution, WorkflowExecutionDescription, WorkflowExecutionInfo, WorkflowService } from './types';
+import { WorkflowCancelInput, WorkflowClientInterceptor, WorkflowClientInterceptors, WorkflowDescribeInput, WorkflowQueryInput, WorkflowSignalInput, WorkflowSignalWithStartInput, WorkflowStartInput, WorkflowTerminateInput, WorkflowStartUpdateInput, WorkflowStartUpdateOutput, WorkflowStartUpdateWithStartInput, WorkflowStartUpdateWithStartOutput } from './interceptors';
+import { CountWorkflowExecution, DescribeWorkflowExecutionResponse, QueryRejectCondition, RequestCancelWorkflowExecutionResponse, StartWorkflowExecutionRequest, TerminateWorkflowExecutionResponse, WorkflowExecution, WorkflowExecutionDescription, WorkflowExecutionInfo, WorkflowService } from './types';
 import { WorkflowOptions, WorkflowSignalWithStartOptions, WorkflowStartOptions, WorkflowUpdateOptions } from './workflow-options';
 import { BaseClient, BaseClientOptions, LoadedWithDefaults } from './base-client';
 import { WorkflowUpdateStage } from './workflow-update-stage';
@@ -41,8 +41,6 @@ export interface WorkflowHandle<T extends Workflow = Workflow> extends BaseWorkf
     /**
      * Start an Update and wait for the result.
      *
-     * @experimental Update is an experimental feature.
-     *
      * @throws {@link WorkflowUpdateFailedError} if Update validation fails or if ApplicationFailure is thrown in the Update handler.
      * @throws {@link WorkflowUpdateRPCTimeoutOrCancelledError} if this Update call timed out or was cancelled. This doesn't
      *  mean the update itself was timed out or cancelled.
@@ -64,8 +62,6 @@ export interface WorkflowHandle<T extends Workflow = Workflow> extends BaseWorkf
      * Start an Update and receive a handle to the Update. The Update validator (if present) is run
      * before the handle is returned.
      *
-     * @experimental Update is an experimental feature.
-     *
      * @throws {@link WorkflowUpdateFailedError} if Update validation fails.
      * @throws {@link WorkflowUpdateRPCTimeoutOrCancelledError} if this Update call timed out or was cancelled. This doesn't
      *  mean the update itself was timed out or cancelled.
@@ -306,6 +302,29 @@ export interface IntoHistoriesOptions {
      */
     bufferLimit?: number;
 }
+declare const withStartWorkflowOperationResolve: unique symbol;
+declare const withStartWorkflowOperationReject: unique symbol;
+declare const withStartWorkflowOperationUsed: unique symbol;
+/**
+ * Define how to start a workflow when using {@link WorkflowClient.startUpdateWithStart} and
+ * {@link WorkflowClient.executeUpdateWithStart}. `workflowIdConflictPolicy` is required in the options.
+ *
+ * @experimental Update-with-Start is an experimental feature and may be subject to change.
+ */
+export declare class WithStartWorkflowOperation<T extends Workflow> {
+    workflowTypeOrFunc: string | T;
+    options: WorkflowStartOptions<T> & {
+        workflowIdConflictPolicy: WorkflowIdConflictPolicy;
+    };
+    private [withStartWorkflowOperationUsed];
+    private [withStartWorkflowOperationResolve];
+    private [withStartWorkflowOperationReject];
+    private workflowHandlePromise;
+    constructor(workflowTypeOrFunc: string | T, options: WorkflowStartOptions<T> & {
+        workflowIdConflictPolicy: WorkflowIdConflictPolicy;
+    });
+    workflowHandle(): Promise<WorkflowHandle<T>>;
+}
 /**
  * Client for starting Workflow executions and creating Workflow handles.
  *
@@ -322,58 +341,119 @@ export declare class WorkflowClient extends BaseClient {
      * object.
      */
     get workflowService(): WorkflowService;
+    protected _start<T extends Workflow>(workflowTypeOrFunc: string | T, options: WithWorkflowArgs<T, WorkflowOptions>, interceptors: WorkflowClientInterceptor[]): Promise<string>;
+    protected _signalWithStart<T extends Workflow, SA extends any[]>(workflowTypeOrFunc: string | T, options: WithWorkflowArgs<T, WorkflowSignalWithStartOptions<SA>>, interceptors: WorkflowClientInterceptor[]): Promise<string>;
     /**
      * Start a new Workflow execution.
      *
-     * @returns the execution's `runId`.
+     * @returns a {@link WorkflowHandle} to the started Workflow
      */
-    protected _start<T extends Workflow>(workflowTypeOrFunc: string | T, options: WithWorkflowArgs<T, WorkflowOptions>, interceptors: WorkflowClientInterceptor[]): Promise<string>;
+    start<T extends Workflow>(workflowTypeOrFunc: string | T, options: WorkflowStartOptions<T>): Promise<WorkflowHandleWithFirstExecutionRunId<T>>;
     /**
-     * Sends a signal to a running Workflow or starts a new one if not already running and immediately signals it.
-     * Useful when you're unsure of the Workflow's run state.
+     * Start a new Workflow Execution and immediately send a Signal to that Workflow.
      *
-     * @returns the runId of the Workflow
+     * The behavior of Signal-with-Start in the case where there is already a running Workflow with
+     * the given Workflow ID depends on the {@link WorkflowIDConflictPolicy}. That is, if the policy
+     * is `USE_EXISTING`, then the Signal is issued against the already existing Workflow Execution;
+     * however, if the policy is `FAIL`, then an error is thrown. If no policy is specified,
+     * Signal-with-Start defaults to `USE_EXISTING`.
+     *
+     * @returns a {@link WorkflowHandle} to the started Workflow
      */
-    protected _signalWithStart<T extends Workflow, SA extends any[]>(workflowTypeOrFunc: string | T, options: WithWorkflowArgs<T, WorkflowSignalWithStartOptions<SA>>, interceptors: WorkflowClientInterceptor[]): Promise<string>;
+    signalWithStart<WorkflowFn extends Workflow, SignalArgs extends any[] = []>(workflowTypeOrFunc: string | WorkflowFn, options: WithWorkflowArgs<WorkflowFn, WorkflowSignalWithStartOptions<SignalArgs>>): Promise<WorkflowHandleWithSignaledRunId<WorkflowFn>>;
     /**
-     * Start a new Workflow execution.
+     * Start a new Workflow Execution and immediately send an Update to that Workflow,
+     * then await and return the Update's result.
+     *
+     * The `updateOptions` object must contain a {@link WithStartWorkflowOperation}, which defines
+     * the options for the Workflow execution to start (e.g. the Workflow's type, task queue, input
+     * arguments, etc.)
      *
-     * @returns a WorkflowHandle to the started Workflow
+     * The behavior of Update-with-Start in the case where there is already a running Workflow with
+     * the given Workflow ID depends on the specified {@link WorkflowIDConflictPolicy}. That is, if
+     * the policy is `USE_EXISTING`, then the Update is issued against the already existing Workflow
+     * Execution; however, if the policy is `FAIL`, then an error is thrown. Caller MUST specify
+     * the desired WorkflowIDConflictPolicy.
+     *
+     * This call will block until the Update has completed. The Workflow handle can be retrieved by
+     * awaiting on {@link WithStartWorkflowOperation.workflowHandle}, whether or not the Update
+     * succeeds.
+     *
+     * @returns the Update result
+     *
+     * @experimental Update-with-Start is an experimental feature and may be subject to change.
      */
-    start<T extends Workflow>(workflowTypeOrFunc: string | T, options: WorkflowStartOptions<T>): Promise<WorkflowHandleWithFirstExecutionRunId<T>>;
+    executeUpdateWithStart<T extends Workflow, Ret, Args extends any[]>(updateDef: UpdateDefinition<Ret, Args> | string, updateOptions: WorkflowUpdateOptions & {
+        args?: Args;
+        startWorkflowOperation: WithStartWorkflowOperation<T>;
+    }): Promise<Ret>;
     /**
-     * Sends a Signal to a running Workflow or starts a new one if not already running and immediately Signals it.
-     * Useful when you're unsure whether the Workflow has been started.
+     * Start a new Workflow Execution and immediately send an Update to that Workflow,
+     * then return a {@link WorkflowUpdateHandle} for that Update.
      *
-     * @returns a {@link WorkflowHandle} to the started Workflow
+     * The `updateOptions` object must contain a {@link WithStartWorkflowOperation}, which defines
+     * the options for the Workflow execution to start (e.g. the Workflow's type, task queue, input
+     * arguments, etc.)
+     *
+     * The behavior of Update-with-Start in the case where there is already a running Workflow with
+     * the given Workflow ID depends on the specified {@link WorkflowIDConflictPolicy}. That is, if
+     * the policy is `USE_EXISTING`, then the Update is issued against the already existing Workflow
+     * Execution; however, if the policy is `FAIL`, then an error is thrown. Caller MUST specify
+     * the desired WorkflowIDConflictPolicy.
+     *
+     * This call will block until the Update has reached the specified {@link WorkflowUpdateStage}.
+     * Note that this means that the call will not return successfully until the Update has
+     * been delivered to a Worker. The Workflow handle can be retrieved by awaiting on
+     * {@link WithStartWorkflowOperation.workflowHandle}, whether or not the Update succeeds.
+     *
+     * @returns a {@link WorkflowUpdateHandle} to the started Update
+     *
+     * @experimental Update-with-Start is an experimental feature and may be subject to change.
      */
-    signalWithStart<WorkflowFn extends Workflow, SignalArgs extends any[] = []>(workflowTypeOrFunc: string | WorkflowFn, options: WithWorkflowArgs<WorkflowFn, WorkflowSignalWithStartOptions<SignalArgs>>): Promise<WorkflowHandleWithSignaledRunId<WorkflowFn>>;
+    startUpdateWithStart<T extends Workflow, Ret, Args extends any[]>(updateDef: UpdateDefinition<Ret, Args> | string, updateOptions: WorkflowUpdateOptions & {
+        args?: Args;
+        waitForStage: 'ACCEPTED';
+        startWorkflowOperation: WithStartWorkflowOperation<T>;
+    }): Promise<WorkflowUpdateHandle<Ret>>;
+    protected _startUpdateWithStart<T extends Workflow, Ret, Args extends any[]>(updateDef: UpdateDefinition<Ret, Args> | string, updateWithStartOptions: WorkflowUpdateOptions & {
+        args?: Args;
+        waitForStage: WorkflowUpdateStage;
+        startWorkflowOperation: WithStartWorkflowOperation<T>;
+    }): Promise<WorkflowUpdateHandle<Ret>>;
     /**
-     * Starts a new Workflow execution and awaits its completion.
+     * Start a new Workflow execution, then await for its completion and return that Workflow's result.
      *
      * @returns the result of the Workflow execution
      */
     execute<T extends Workflow>(workflowTypeOrFunc: string | T, options: WorkflowStartOptions<T>): Promise<WorkflowResultType<T>>;
     /**
-     * Gets the result of a Workflow execution.
+     * Get the result of a Workflow execution.
      *
-     * Follows the chain of execution in case Workflow continues as new, or has a cron schedule or retry policy.
+     * Follow the chain of execution in case Workflow continues as new, or has a cron schedule or retry policy.
      */
     result<T extends Workflow>(workflowId: string, runId?: string, opts?: WorkflowResultOptions): Promise<WorkflowResultType<T>>;
     protected rethrowUpdateGrpcError(err: unknown, fallbackMessage: string, workflowExecution?: WorkflowExecution): never;
     protected rethrowGrpcError(err: unknown, fallbackMessage: string, workflowExecution?: WorkflowExecution): never;
     /**
-     * Uses given input to make a queryWorkflow call to the service
+     * Use given input to make a queryWorkflow call to the service
      *
      * Used as the final function of the query interceptor chain
      */
     protected _queryWorkflowHandler(input: WorkflowQueryInput): Promise<unknown>;
+    protected _createUpdateWorkflowRequest(lifecycleStage: temporal.api.enums.v1.UpdateWorkflowExecutionLifecycleStage, input: WorkflowStartUpdateInput): Promise<temporal.api.workflowservice.v1.IUpdateWorkflowExecutionRequest>;
     /**
      * Start the Update.
      *
      * Used as the final function of the interceptor chain during startUpdate and executeUpdate.
      */
     protected _startUpdateHandler(waitForStage: WorkflowUpdateStage, input: WorkflowStartUpdateInput): Promise<WorkflowStartUpdateOutput>;
+    /**
+     * Send the Update-With-Start MultiOperation request.
+     *
+     * Used as the final function of the interceptor chain during
+     * startUpdateWithStart and executeUpdateWithStart.
+     */
+    protected _updateWithStartHandler(waitForStage: WorkflowUpdateStage, onStart: (startResponse: temporal.api.workflowservice.v1.IStartWorkflowExecutionResponse) => void, onStartError: (err: any) => void, input: WorkflowStartUpdateWithStartInput): Promise<WorkflowStartUpdateWithStartOutput>;
     protected createWorkflowUpdateHandle<Ret>(updateId: string, workflowId: string, workflowRunId?: string, outcome?: temporal.api.update.v1.IOutcome): WorkflowUpdateHandle<Ret>;
     /**
      * Poll Update until a response with an outcome is received; return that outcome.
@@ -381,25 +461,26 @@ export declare class WorkflowClient extends BaseClient {
      */
     protected _pollForUpdateOutcome(updateId: string, workflowExecution: temporal.api.common.v1.IWorkflowExecution): Promise<temporal.api.update.v1.IOutcome>;
     /**
-     * Uses given input to make a signalWorkflowExecution call to the service
+     * Use given input to make a signalWorkflowExecution call to the service
      *
      * Used as the final function of the signal interceptor chain
      */
     protected _signalWorkflowHandler(input: WorkflowSignalInput): Promise<void>;
     /**
-     * Uses given input to make a signalWithStartWorkflowExecution call to the service
+     * Use given input to make a signalWithStartWorkflowExecution call to the service
      *
      * Used as the final function of the signalWithStart interceptor chain
      */
     protected _signalWithStartWorkflowHandler(input: WorkflowSignalWithStartInput): Promise<string>;
     /**
-     * Uses given input to make startWorkflowExecution call to the service
+     * Use given input to make startWorkflowExecution call to the service
      *
      * Used as the final function of the start interceptor chain
      */
     protected _startWorkflowHandler(input: WorkflowStartInput): Promise<string>;
+    protected createStartWorkflowRequest(input: WorkflowStartInput): Promise<StartWorkflowExecutionRequest>;
     /**
-     * Uses given input to make terminateWorkflowExecution call to the service
+     * Use given input to make terminateWorkflowExecution call to the service
      *
      * Used as the final function of the terminate interceptor chain
      */
@@ -441,14 +522,24 @@ export declare class WorkflowClient extends BaseClient {
     getHandle<T extends Workflow>(workflowId: string, runId?: string, options?: GetWorkflowHandleOptions): WorkflowHandle<T>;
     protected _list(options?: ListOptions): AsyncIterable<WorkflowExecutionInfo>;
     /**
-     * List workflows by given `query`.
+     * Return a list of Workflow Executions matching the given `query`.
      *
-     * ⚠️ To use advanced query functionality, as of the 1.18 server release, you must use Elasticsearch based visibility.
+     * Note that the list of Workflow Executions returned is approximate and eventually consistent.
      *
      * More info on the concept of "visibility" and the query syntax on the Temporal documentation site:
      * https://docs.temporal.io/visibility
      */
     list(options?: ListOptions): AsyncWorkflowListIterable;
+    /**
+     * Return the number of Workflow Executions matching the given `query`. If no `query` is provided, then return the
+     * total number of Workflow Executions for this namespace.
+     *
+     * Note that the number of Workflow Executions returned is approximate and eventually consistent.
+     *
+     * More info on the concept of "visibility" and the query syntax on the Temporal documentation site:
+     * https://docs.temporal.io/visibility
+     */
+    count(query?: string): Promise<CountWorkflowExecution>;
     protected getOrMakeInterceptors(workflowId: string, runId?: string): WorkflowClientInterceptor[];
 }
 export declare class QueryRejectedError extends Error {