@temporalio/client - npm Package Compare versions

Comparing version 0.19.0 to 0.19.2

lib/index.d.ts

@@ -13,2 +13,3 @@ /**
 export { RetryPolicy } from '@temporalio/internal-workflow-common';
+export * from '@temporalio/internal-workflow-common/lib/interfaces';
 export * from './async-completion-client';
@@ -15,0 +16,0 @@ export * from './connection';

lib/index.js

@@ -38,2 +38,3 @@ "use strict";
 Object.defineProperty(exports, "TimeoutFailure", { enumerable: true, get: function () { return common_1.TimeoutFailure; } });
+__exportStar(require("@temporalio/internal-workflow-common/lib/interfaces"), exports);
 __exportStar(require("./async-completion-client"), exports);
@@ -40,0 +41,0 @@ __exportStar(require("./connection"), exports);

lib/workflow-client.d.ts

@@ -243,6 +243,18 @@ import { DataConverter, LoadedDataConverter } from '@temporalio/common';
     /**
-     * Creates a Workflow handle for existing Workflow using `workflowId` and optional `runId`.
+     * Create a handle to an existing Workflow.
      *
+     * - If only `workflowId` is passed, and there are multiple Workflow Executions with that ID, the handle will refer to
+     *   the most recent one.
+     * - If `workflowId` and `runId` are passed, the handle will refer to the specific Workflow Execution with that Run
+     *   ID.
+     * - If `workflowId` and {@link GetWorkflowHandleOptions.firstExecutionRunId} are passed, the handle will refer to the
+     *   most recent Workflow Execution in the *Chain* that started with `firstExecutionRunId`.
+     *
+     * A *Chain* is a series of Workflow Executions that share the same Workflow ID and are connected by:
+     * - Being part of the same [Cron](https://docs.temporal.io/docs/typescript/clients#scheduling-cron-workflows)
+     * - [Continue As New](https://docs.temporal.io/docs/typescript/workflows#continueasnew)
+     * - [Retries](https://typescript.temporal.io/api/interfaces/client.workflowoptions/#retry)
+     *
      * This method does not validate `workflowId`. If there is no Workflow Execution with the given `workflowId`, handle
-     * methods like `handle.describe()` will throw a `NOT_FOUND` error.
+     * methods like `handle.describe()` will throw a {@link WorkflowNotFoundError} error.
      */
@@ -249,0 +261,0 @@ getHandle<T extends Workflow>(workflowId: string, runId?: string, options?: GetWorkflowHandleOptions): WorkflowHandle<T>;

lib/workflow-client.js

@@ -335,3 +335,3 @@ "use strict";
                     ? {
-                        indexedFields: await (0, internal_non_workflow_common_1.encodeMapToPayloads)(common_1.defaultDataConverter, options.searchAttributes),
+                        indexedFields: (0, common_1.mapToPayloads)(common_1.searchAttributePayloadConverter, options.searchAttributes),
                     }
@@ -375,3 +375,3 @@ : undefined,
                 ? {
-                    indexedFields: await (0, internal_non_workflow_common_1.encodeMapToPayloads)(common_1.defaultDataConverter, opts.searchAttributes),
+                    indexedFields: (0, common_1.mapToPayloads)(common_1.searchAttributePayloadConverter, opts.searchAttributes),
                 }
@@ -496,3 +496,3 @@ : undefined,
                     memo: await (0, internal_non_workflow_common_1.decodeMapFromPayloads)(this.client.options.loadedDataConverter, raw.workflowExecutionInfo.memo?.fields),
-                    searchAttributes: await (0, internal_non_workflow_common_1.decodeMapFromPayloads)(common_1.defaultDataConverter, raw.workflowExecutionInfo.searchAttributes?.indexedFields),
+                    searchAttributes: (0, common_1.mapFromPayloads)(common_1.searchAttributePayloadConverter, raw.workflowExecutionInfo.searchAttributes?.indexedFields),
                     parentExecution: raw.workflowExecutionInfo.parentExecution
@@ -529,6 +529,18 @@ ? {
     /**
-     * Creates a Workflow handle for existing Workflow using `workflowId` and optional `runId`.
+     * Create a handle to an existing Workflow.
      *
+     * - If only `workflowId` is passed, and there are multiple Workflow Executions with that ID, the handle will refer to
+     *   the most recent one.
+     * - If `workflowId` and `runId` are passed, the handle will refer to the specific Workflow Execution with that Run
+     *   ID.
+     * - If `workflowId` and {@link GetWorkflowHandleOptions.firstExecutionRunId} are passed, the handle will refer to the
+     *   most recent Workflow Execution in the *Chain* that started with `firstExecutionRunId`.
+     *
+     * A *Chain* is a series of Workflow Executions that share the same Workflow ID and are connected by:
+     * - Being part of the same [Cron](https://docs.temporal.io/docs/typescript/clients#scheduling-cron-workflows)
+     * - [Continue As New](https://docs.temporal.io/docs/typescript/workflows#continueasnew)
+     * - [Retries](https://typescript.temporal.io/api/interfaces/client.workflowoptions/#retry)
+     *
      * This method does not validate `workflowId`. If there is no Workflow Execution with the given `workflowId`, handle
-     * methods like `handle.describe()` will throw a `NOT_FOUND` error.
+     * methods like `handle.describe()` will throw a {@link WorkflowNotFoundError} error.
      */
@@ -535,0 +547,0 @@ getHandle(workflowId, runId, options) {

lib/workflow-options.d.ts

 import { CommonWorkflowOptions, SignalDefinition, WithCompiledWorkflowDurationOptions } from '@temporalio/internal-workflow-common';
-export { compileWorkflowOptions, WithCompiledWorkflowDurationOptions } from '@temporalio/internal-workflow-common';
+export * from '@temporalio/internal-workflow-common/lib/workflow-options';
 export interface CompiledWorkflowOptions extends WithCompiledWorkflowDurationOptions<WorkflowOptions> {
@@ -4,0 +4,0 @@ args: unknown[];

lib/workflow-options.js

 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.compileWorkflowOptions = void 0;
-var internal_workflow_common_1 = require("@temporalio/internal-workflow-common");
-Object.defineProperty(exports, "compileWorkflowOptions", { enumerable: true, get: function () { return internal_workflow_common_1.compileWorkflowOptions; } });
+__exportStar(require("@temporalio/internal-workflow-common/lib/workflow-options"), exports);
 // export interface WorkflowOptionsWithDefaults<T extends Workflow> extends CommonWorkflowOptionsWithDefaults<T> {
@@ -7,0 +19,0 @@ //   /**

package.json

 {
   "name": "@temporalio/client",
-  "version": "0.19.0",
+  "version": "0.19.2",
   "description": "Temporal.io SDK Client sub-package",
@@ -17,4 +17,4 @@ "main": "lib/index.js",
     "@grpc/grpc-js": "^1.5.7",
-    "@temporalio/common": "^0.19.0",
-    "@temporalio/internal-non-workflow-common": "^0.19.0",
+    "@temporalio/common": "^0.19.2",
+    "@temporalio/internal-non-workflow-common": "^0.19.2",
     "@temporalio/internal-workflow-common": "^0.19.0",
@@ -36,3 +36,3 @@ "@temporalio/proto": "^0.19.0",
   },
-  "gitHead": "02748d3fc3f321669ffa09f0ca012b81900b0fc0"
+  "gitHead": "57172075a1eb3f2292a1188d260fab0ee155349f"
 }

No alert changes

Improved metrics

Total package byte prevSize

117682

2.02%

Lines of code

1911

2.03%

Dependency changes

• Updated

  @temporalio/common@^0.19.2

• Updated

  @temporalio/internal-non-workflow-common@^0.19.2