@temporalio/client 0.23.0 → 1.0.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Temporal TypeScript SDK
 
 MIT License
 
-Copyright (c) 2021 Temporal Technologies, Inc. All Rights Reserved
+Copyright (c) 2021 Temporal Technologies Inc. All Rights Reserved
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -2,8 +2,8 @@
 
 [![NPM](https://img.shields.io/npm/v/@temporalio/client?style=for-the-badge)](https://www.npmjs.com/package/@temporalio/client)
 
-Part of [Temporal](https://temporal.io)'s [TypeScript SDK](https://docs.temporal.io/docs/typescript/introduction/).
+Part of [Temporal](https://temporal.io)'s [TypeScript SDK](https://docs.temporal.io/typescript/introduction/).
 
-- [Client docs](https://docs.temporal.io/docs/typescript/clients)
+- [Client docs](https://docs.temporal.io/typescript/clients)
 - [API reference](https://typescript.temporal.io/api/namespaces/client)
 - [Sample projects](https://github.com/temporalio/samples-typescript)

package/lib/async-completion-client.d.ts

@@ -1,15 +1,16 @@
 import { DataConverter, LoadedDataConverter } from '@temporalio/common';
-import { WorkflowService } from './connection';
+import { Replace } from '@temporalio/internal-workflow-common';
+import { ConnectionLike, WorkflowService } from './types';
 /**
- * Thrown by {@link AsyncCompletionClient} when trying to complete or heartbeat
- * an Activity which does not exist in the system.
+ * Thrown by {@link AsyncCompletionClient} when trying to complete or heartbeat an Activity that does not exist in the
+ * system.
  */
 export declare class ActivityNotFoundError extends Error {
     readonly name = "ActivityNotFoundError";
 }
 /**
  * Thrown by {@link AsyncCompletionClient} when trying to complete or heartbeat
- * an Activity for any reason apart from "not found".
+ * an Activity for any reason apart from {@link ActivityNotFoundError}.
  */
 export declare class ActivityCompletionError extends Error {
     readonly name = "ActivityCompletionError";
@@ -35,6 +36,7 @@ export interface AsyncCompletionClientOptions {
      * @default `${process.pid}@${os.hostname()}`
      */
     identity?: string;
+    connection?: ConnectionLike;
     /**
      * Server namespace
      *
@@ -42,7 +44,9 @@ export interface AsyncCompletionClientOptions {
      */
     namespace?: string;
 }
-export declare type AsyncCompletionClientOptionsWithDefaults = Required<AsyncCompletionClientOptions>;
+export declare type AsyncCompletionClientOptionsWithDefaults = Replace<Required<AsyncCompletionClientOptions>, {
+    connection?: ConnectionLike;
+}>;
 export declare function defaultAsyncCompletionClientOptions(): AsyncCompletionClientOptionsWithDefaults;
 /**
  * A mostly unique Activity identifier including its scheduling workflow's ID
@@ -60,10 +64,11 @@ export interface FullActivityId {
  * A client for asynchronous completion and heartbeating of Activities.
  */
 export declare class AsyncCompletionClient {
-    readonly service: WorkflowService;
     readonly options: AsyncCompletionClientOptionsWithDefaults;
     protected readonly dataConverter: LoadedDataConverter;
-    constructor(service?: WorkflowService, options?: AsyncCompletionClientOptions);
+    readonly connection: ConnectionLike;
+    constructor(options?: AsyncCompletionClientOptions);
+    get workflowService(): WorkflowService;
     /**
      * Transforms grpc errors into well defined TS errors.
      */

package/lib/async-completion-client.js

@@ -11,8 +11,8 @@ const os_1 = __importDefault(require("os"));
 const connection_1 = require("./connection");
 const errors_1 = require("./errors");
 /**
- * Thrown by {@link AsyncCompletionClient} when trying to complete or heartbeat
- * an Activity which does not exist in the system.
+ * Thrown by {@link AsyncCompletionClient} when trying to complete or heartbeat an Activity that does not exist in the
+ * system.
  */
 class ActivityNotFoundError extends Error {
     constructor() {
@@ -23,7 +23,7 @@ class ActivityNotFoundError extends Error {
 exports.ActivityNotFoundError = ActivityNotFoundError;
 /**
  * Thrown by {@link AsyncCompletionClient} when trying to complete or heartbeat
- * an Activity for any reason apart from "not found".
+ * an Activity for any reason apart from {@link ActivityNotFoundError}.
  */
 class ActivityCompletionError extends Error {
     constructor() {
@@ -55,11 +55,14 @@ exports.defaultAsyncCompletionClientOptions = defaultAsyncCompletionClientOption
  * A client for asynchronous completion and heartbeating of Activities.
  */
 class AsyncCompletionClient {
-    constructor(service = new connection_1.Connection().service, options) {
-        this.service = service;
+    constructor(options) {
+        this.connection = options?.connection ?? connection_1.Connection.lazy();
         this.dataConverter = (0, internal_non_workflow_common_1.loadDataConverter)(options?.dataConverter);
         this.options = { ...defaultAsyncCompletionClientOptions(), ...(0, internal_non_workflow_common_1.filterNullAndUndefined)(options ?? {}) };
     }
+    get workflowService() {
+        return this.connection.workflowService;
+    }
     /**
      * Transforms grpc errors into well defined TS errors.
      */
@@ -75,7 +78,7 @@ class AsyncCompletionClient {
     async complete(taskTokenOrFullActivityId, result) {
         try {
             if (taskTokenOrFullActivityId instanceof Uint8Array) {
-                await this.service.respondActivityTaskCompleted({
+                await this.workflowService.respondActivityTaskCompleted({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     taskToken: taskTokenOrFullActivityId,
@@ -83,7 +86,7 @@ class AsyncCompletionClient {
                 });
             }
             else {
-                await this.service.respondActivityTaskCompletedById({
+                await this.workflowService.respondActivityTaskCompletedById({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     ...taskTokenOrFullActivityId,
@@ -98,7 +101,7 @@ class AsyncCompletionClient {
     async fail(taskTokenOrFullActivityId, err) {
         try {
             if (taskTokenOrFullActivityId instanceof Uint8Array) {
-                await this.service.respondActivityTaskFailed({
+                await this.workflowService.respondActivityTaskFailed({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     taskToken: taskTokenOrFullActivityId,
@@ -106,7 +109,7 @@ class AsyncCompletionClient {
                 });
             }
             else {
-                await this.service.respondActivityTaskFailedById({
+                await this.workflowService.respondActivityTaskFailedById({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     ...taskTokenOrFullActivityId,
@@ -121,7 +124,7 @@ class AsyncCompletionClient {
     async reportCancellation(taskTokenOrFullActivityId, details) {
         try {
             if (taskTokenOrFullActivityId instanceof Uint8Array) {
-                await this.service.respondActivityTaskCanceled({
+                await this.workflowService.respondActivityTaskCanceled({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     taskToken: taskTokenOrFullActivityId,
@@ -129,7 +132,7 @@ class AsyncCompletionClient {
                 });
             }
             else {
-                await this.service.respondActivityTaskCanceledById({
+                await this.workflowService.respondActivityTaskCanceledById({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     ...taskTokenOrFullActivityId,
@@ -144,7 +147,7 @@ class AsyncCompletionClient {
     async heartbeat(taskTokenOrFullActivityId, details) {
         try {
             if (taskTokenOrFullActivityId instanceof Uint8Array) {
-                const { cancelRequested } = await this.service.recordActivityTaskHeartbeat({
+                const { cancelRequested } = await this.workflowService.recordActivityTaskHeartbeat({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     taskToken: taskTokenOrFullActivityId,
@@ -155,7 +158,7 @@ class AsyncCompletionClient {
                 }
             }
             else {
-                const { cancelRequested } = await this.service.recordActivityTaskHeartbeatById({
+                const { cancelRequested } = await this.workflowService.recordActivityTaskHeartbeatById({
                     identity: this.options.identity,
                     namespace: this.options.namespace,
                     ...taskTokenOrFullActivityId,

package/lib/async-completion-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"async-completion-client.js","sourceRoot":"","sources":["../src/async-completion-client.ts"],"names":[],"mappings":";;;;;;AAAA,iEAA2D;AAC3D,+CAA+F;AAC/F,2FAKkD;AAClD,4CAAoB;AACpB,6CAA2D;AAC3D,qCAAiD;AAEjD;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,KAAK;IAAhD;;QACkB,SAAI,GAAG,uBAAuB,CAAC;IACjD,CAAC;CAAA;AAFD,sDAEC;AAED;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,KAAK;IAAlD;;QACkB,SAAI,GAAG,yBAAyB,CAAC;IACnD,CAAC;CAAA;AAFD,0DAEC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,KAAK;IAAjD;;QACkB,SAAI,GAAG,wBAAwB,CAAC;IAClD,CAAC;CAAA;AAFD,wDAEC;AA4BD,SAAgB,mCAAmC;IACjD,OAAO;QACL,aAAa,EAAE,EAAE;QACjB,QAAQ,EAAE,GAAG,OAAO,CAAC,GAAG,IAAI,YAAE,CAAC,QAAQ,EAAE,EAAE;QAC3C,SAAS,EAAE,SAAS;KACrB,CAAC;AACJ,CAAC;AAND,kFAMC;AAeD;;GAEG;AACH,MAAa,qBAAqB;IAIhC,YACkB,UAA2B,IAAI,uBAAU,EAAE,CAAC,OAAO,EACnE,OAAsC;QADtB,YAAO,GAAP,OAAO,CAA4C;QAGnE,IAAI,CAAC,aAAa,GAAG,IAAA,gDAAiB,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,mCAAmC,EAAE,EAAE,GAAG,IAAA,qDAAsB,EAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;IACxG,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,GAAY;QAChC,IAAI,IAAA,8BAAqB,EAAC,GAAG,CAAC,EAAE;YAC9B,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAM,CAAC,SAAS,EAAE;gBACjC,MAAM,IAAI,qBAAqB,CAAC,WAAW,CAAC,CAAC;aAC9C;YACD,MAAM,IAAI,uBAAuB,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;SAC/D;QACD,MAAM,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IAC1D,CAAC;IAWD,KAAK,CAAC,QAAQ,CAAC,yBAAsD,EAAE,MAAe;QACpF,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,IAAI,CAAC,OAAO,CAAC,4BAA4B,CAAC;oBAC9C,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE;iBACzE,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,IAAI,CAAC,OAAO,CAAC,gCAAgC,CAAC;oBAClD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE;iBACzE,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;IAWD,KAAK,CAAC,IAAI,CAAC,yBAAsD,EAAE,GAAY;QAC7E,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,IAAI,CAAC,OAAO,CAAC,yBAAyB,CAAC;oBAC3C,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,OAAO,EAAE,MAAM,IAAA,mDAAoB,EAAC,IAAI,CAAC,aAAa,EAAE,IAAA,8BAAqB,EAAC,GAAG,CAAC,CAAC;iBACpF,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC;oBAC/C,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,OAAO,EAAE,MAAM,IAAA,mDAAoB,EAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC;iBAC7D,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;IAWD,KAAK,CAAC,kBAAkB,CAAC,yBAAsD,EAAE,OAAiB;QAChG,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC;oBAC7C,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,IAAI,CAAC,OAAO,CAAC,+BAA+B,CAAC;oBACjD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;IAWD,KAAK,CAAC,SAAS,CAAC,yBAAsD,EAAE,OAAiB;QACvF,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,2BAA2B,CAAC;oBACzE,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;gBACH,IAAI,eAAe,EAAE;oBACnB,MAAM,IAAI,sBAAsB,CAAC,WAAW,CAAC,CAAC;iBAC/C;aACF;iBAAM;gBACL,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,+BAA+B,CAAC;oBAC7E,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;gBACH,IAAI,eAAe,EAAE;oBACnB,MAAM,IAAI,sBAAsB,CAAC,WAAW,CAAC,CAAC;iBAC/C;aACF;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,sBAAsB,EAAE;gBACzC,MAAM,GAAG,CAAC;aACX;YACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;CACF;AA7JD,sDA6JC"}
+{"version":3,"file":"async-completion-client.js","sourceRoot":"","sources":["../src/async-completion-client.ts"],"names":[],"mappings":";;;;;;AAAA,iEAA2D;AAC3D,+CAA+F;AAC/F,2FAKkD;AAElD,4CAAoB;AACpB,6CAA0C;AAC1C,qCAAiD;AAGjD;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,KAAK;IAAhD;;QACkB,SAAI,GAAG,uBAAuB,CAAC;IACjD,CAAC;CAAA;AAFD,sDAEC;AAED;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,KAAK;IAAlD;;QACkB,SAAI,GAAG,yBAAyB,CAAC;IACnD,CAAC;CAAA;AAFD,0DAEC;AAED;;;GAGG;AACH,MAAa,sBAAuB,SAAQ,KAAK;IAAjD;;QACkB,SAAI,GAAG,wBAAwB,CAAC;IAClD,CAAC;CAAA;AAFD,wDAEC;AAmCD,SAAgB,mCAAmC;IACjD,OAAO;QACL,aAAa,EAAE,EAAE;QACjB,QAAQ,EAAE,GAAG,OAAO,CAAC,GAAG,IAAI,YAAE,CAAC,QAAQ,EAAE,EAAE;QAC3C,SAAS,EAAE,SAAS;KACrB,CAAC;AACJ,CAAC;AAND,kFAMC;AAeD;;GAEG;AACH,MAAa,qBAAqB;IAKhC,YAAY,OAAsC;QAChD,IAAI,CAAC,UAAU,GAAG,OAAO,EAAE,UAAU,IAAI,uBAAU,CAAC,IAAI,EAAE,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAA,gDAAiB,EAAC,OAAO,EAAE,aAAa,CAAC,CAAC;QAC/D,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,mCAAmC,EAAE,EAAE,GAAG,IAAA,qDAAsB,EAAC,OAAO,IAAI,EAAE,CAAC,EAAE,CAAC;IACxG,CAAC;IAED,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IACzC,CAAC;IAED;;OAEG;IACO,WAAW,CAAC,GAAY;QAChC,IAAI,IAAA,8BAAqB,EAAC,GAAG,CAAC,EAAE;YAC9B,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAM,CAAC,SAAS,EAAE;gBACjC,MAAM,IAAI,qBAAqB,CAAC,WAAW,CAAC,CAAC;aAC9C;YACD,MAAM,IAAI,uBAAuB,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;SAC/D;QACD,MAAM,IAAI,uBAAuB,CAAC,oBAAoB,CAAC,CAAC;IAC1D,CAAC;IAWD,KAAK,CAAC,QAAQ,CAAC,yBAAsD,EAAE,MAAe;QACpF,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,IAAI,CAAC,eAAe,CAAC,4BAA4B,CAAC;oBACtD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE;iBACzE,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,IAAI,CAAC,eAAe,CAAC,gCAAgC,CAAC;oBAC1D,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE;iBACzE,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;IAWD,KAAK,CAAC,IAAI,CAAC,yBAAsD,EAAE,GAAY;QAC7E,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,IAAI,CAAC,eAAe,CAAC,yBAAyB,CAAC;oBACnD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,OAAO,EAAE,MAAM,IAAA,mDAAoB,EAAC,IAAI,CAAC,aAAa,EAAE,IAAA,8BAAqB,EAAC,GAAG,CAAC,CAAC;iBACpF,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,IAAI,CAAC,eAAe,CAAC,6BAA6B,CAAC;oBACvD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,OAAO,EAAE,MAAM,IAAA,mDAAoB,EAAC,IAAI,CAAC,aAAa,EAAE,GAAG,CAAC;iBAC7D,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;IAWD,KAAK,CAAC,kBAAkB,CAAC,yBAAsD,EAAE,OAAiB;QAChG,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,IAAI,CAAC,eAAe,CAAC,2BAA2B,CAAC;oBACrD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;aACJ;iBAAM;gBACL,MAAM,IAAI,CAAC,eAAe,CAAC,+BAA+B,CAAC;oBACzD,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;aACJ;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;IAWD,KAAK,CAAC,SAAS,CAAC,yBAAsD,EAAE,OAAiB;QACvF,IAAI;YACF,IAAI,yBAAyB,YAAY,UAAU,EAAE;gBACnD,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,2BAA2B,CAAC;oBACjF,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,SAAS,EAAE,yBAAyB;oBACpC,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;gBACH,IAAI,eAAe,EAAE;oBACnB,MAAM,IAAI,sBAAsB,CAAC,WAAW,CAAC,CAAC;iBAC/C;aACF;iBAAM;gBACL,MAAM,EAAE,eAAe,EAAE,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,+BAA+B,CAAC;oBACrF,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ;oBAC/B,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS;oBACjC,GAAG,yBAAyB;oBAC5B,OAAO,EAAE,EAAE,QAAQ,EAAE,MAAM,IAAA,+CAAgB,EAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,EAAE;iBAC3E,CAAC,CAAC;gBACH,IAAI,eAAe,EAAE;oBACnB,MAAM,IAAI,sBAAsB,CAAC,WAAW,CAAC,CAAC;iBAC/C;aACF;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,GAAG,YAAY,sBAAsB,EAAE;gBACzC,MAAM,GAAG,CAAC;aACX;YACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;SACvB;IACH,CAAC;CACF;AAhKD,sDAgKC"}

package/lib/connection.d.ts

@@ -1,13 +1,11 @@
 /// <reference types="node" />
 import * as grpc from '@grpc/grpc-js';
 import { TLSConfig } from '@temporalio/internal-non-workflow-common';
-import { temporal } from '@temporalio/proto';
 import { AsyncLocalStorage } from 'async_hooks';
 import type { RPCImpl } from 'protobufjs';
-export declare type WorkflowService = temporal.api.workflowservice.v1.WorkflowService;
-export declare const WorkflowService: typeof temporal.api.workflowservice.v1.WorkflowService;
+import { CallContext, Metadata, OperatorService, WorkflowService } from './types';
 /**
- * GRPC + Temporal server connection options
+ * gRPC and Temporal Server connection options
  */
 export interface ConnectionOptions {
     /**
@@ -44,32 +42,35 @@ export interface ConnectionOptions {
      * interceptors).
      */
     interceptors?: grpc.Interceptor[];
-}
-export declare type ConnectionOptionsWithDefaults = Required<Omit<ConnectionOptions, 'tls'>>;
-export declare const LOCAL_DOCKER_TARGET = "127.0.0.1:7233";
-export declare function defaultConnectionOpts(): ConnectionOptionsWithDefaults;
-/**
- * Mapping of string to valid gRPC metadata value
- */
-export declare type Metadata = Record<string, grpc.MetadataValue>;
-/**
- * User defined context for gRPC client calls
- */
-export interface CallContext {
     /**
-     * {@link Deadline | https://grpc.io/blog/deadlines/} for gRPC client calls
+     * Optional mapping of gRPC metadata (HTTP headers) to send with each request to the server.
+     *
+     * In order to dynamically set metadata, use {@link Connection.withMetadata}
      */
-    deadline?: number | Date;
+    metadata?: Metadata;
     /**
-     * Metadata to set on gRPC requests
+     * Milliseconds to wait until establishing a connection with the server.
+     *
+     * Used either when connecting eagerly with {@link Connection.connect} or
+     * calling {@link Connection.ensureConnected}.
+     *
+     * @format {@link https://www.npmjs.com/package/ms | ms} formatted string
+     * @default 10 seconds
      */
-    metadata?: Metadata;
+    connectTimeout?: number | string;
 }
-/**
- * Client connection to the Temporal Service
- */
-export declare class Connection {
-    static readonly Client: grpc.ServiceClientConstructor;
+export declare type ConnectionOptionsWithDefaults = Required<Omit<ConnectionOptions, 'tls' | 'connectTimeout'>> & {
+    connectTimeoutMs: number;
+};
+export declare const LOCAL_TARGET = "127.0.0.1:7233";
+export declare function defaultConnectionOpts(): ConnectionOptionsWithDefaults;
+export interface RPCImplOptions {
+    serviceName: string;
+    client: grpc.Client;
+    callContextStorage: AsyncLocalStorage<CallContext>;
+    interceptors?: grpc.Interceptor[];
+}
+export interface ConnectionCtorOptions {
     readonly options: ConnectionOptionsWithDefaults;
     readonly client: grpc.Client;
     /**
@@ -77,48 +78,97 @@ export declare class Connection {
      *
      * **NOTE**: The namespace provided in {@link options} is **not** automatically set on requests made to the service.
      */
-    readonly service: WorkflowService;
+    readonly workflowService: WorkflowService;
+    readonly operatorService: OperatorService;
     readonly callContextStorage: AsyncLocalStorage<CallContext>;
-    constructor(options?: ConnectionOptions);
-    protected generateRPCImplementation(serviceName: string): RPCImpl;
+}
+/**
+ * Client connection to the Temporal Server
+ *
+ * ⚠️ Connections are expensive to construct and should be reused. Make sure to {@link close} any unused connections to
+ * avoid leaking resources.
+ */
+export declare class Connection {
     /**
-     * Set the deadline for any service requests executed in `fn`'s scope.
+     * @internal
      */
-    withDeadline<R>(deadline: number | Date, fn: () => Promise<R>): Promise<R>;
+    static readonly Client: grpc.ServiceClientConstructor;
+    readonly options: ConnectionOptionsWithDefaults;
+    protected readonly client: grpc.Client;
     /**
-     * Set metadata for any service requests executed in `fn`'s scope.
+     * Used to ensure `ensureConnected` is called once.
+     */
+    protected connectPromise?: Promise<void>;
+    /**
+     * Raw gRPC access to Temporal Server's {@link
+     * https://github.com/temporalio/api/blob/master/temporal/api/workflowservice/v1/service.proto | Workflow service}
+     */
+    readonly workflowService: WorkflowService;
+    /**
+     * Raw gRPC access to Temporal Server's
+     * {@link https://github.com/temporalio/api/blob/master/temporal/api/operatorservice/v1/service.proto | Operator service}
+     */
+    readonly operatorService: OperatorService;
+    readonly callContextStorage: AsyncLocalStorage<CallContext>;
+    protected static createCtorOptions(options?: ConnectionOptions): ConnectionCtorOptions;
+    /**
+     * Ensure connection can be established.
+     *
+     * Does not need to be called if you use {@link connect}.
+     *
+     * This method's result is memoized to ensure it runs only once.
      *
-     * @returns returned value of `fn`
+     * Calls {@link proto.temporal.api.workflowservice.v1.WorkflowService.getSystemInfo} internally.
      */
-    withMetadata<R>(metadata: Metadata, fn: () => Promise<R>): Promise<R>;
+    ensureConnected(): Promise<void>;
     /**
-     * Set metadata for any service requests executed in `fn`'s scope.
+     * Create a lazy `Connection` instance.
      *
-     * @param metadataFn function that gets current context metadata and returns new metadata
+     * This method does not verify connectivity with the server. We recommend using {@link connect} instead.
+     */
+    static lazy(options?: ConnectionOptions): Connection;
+    /**
+     * Establish a connection with the server and return a `Connection` instance.
      *
-     * @returns returned value of `fn`
+     * This is the preferred method of creating connections as it verifies connectivity by calling
+     * {@link ensureConnected}.
      */
-    withMetadata<R>(metadataFn: (meta: Metadata) => Metadata, fn: () => Promise<R>): Promise<R>;
+    static connect(options?: ConnectionOptions): Promise<Connection>;
+    protected constructor({ options, client, workflowService, operatorService, callContextStorage, }: ConnectionCtorOptions);
+    protected static generateRPCImplementation({ serviceName, client, callContextStorage, interceptors, }: RPCImplOptions): RPCImpl;
     /**
-     * Set the {@link CallContext} for any service requests executed in `fn`'s scope.
+     * Set the deadline for any service requests executed in `fn`'s scope.
      *
-     * @returns returned value of `fn`
+     * @returns value returned from `fn`
      */
-    withCallContext<R>(cx: CallContext, fn: () => Promise<R>): Promise<R>;
+    withDeadline<ReturnType>(deadline: number | Date, fn: () => Promise<ReturnType>): Promise<ReturnType>;
     /**
-     * Set the {@link CallContext} for any service requests executed in `fn`'s scope.
+     * Set metadata for any service requests executed in `fn`'s scope.
+     *
+     * The provided metadata is merged on top of any existing metadata in current scope, including metadata provided in
+     * {@link ConnectionOptions.metadata}.
      *
-     * @param cxFn function that gets current context and returns new context
+     * @returns value returned from `fn`
      *
-     * @returns returned value of `fn`
+     * @example
+     *
+     *```ts
+     *const workflowHandle = await conn.withMetadata({ apiKey: 'secret' }, () =>
+     *  conn.withMetadata({ otherKey: 'set' }, () => client.start(options)))
+     *);
+     *```
      */
-    withCallContext<R>(cxFn: (cx?: CallContext) => CallContext, fn: () => Promise<R>): Promise<R>;
+    withMetadata<ReturnType>(metadata: Metadata, fn: () => Promise<ReturnType>): Promise<ReturnType>;
     /**
      * Wait for successful connection to the server.
      *
-     * @param waitTimeMs milliseconds to wait before giving up.
-     *
      * @see https://grpc.github.io/grpc/node/grpc.Client.html#waitForReady__anchor
      */
-    untilReady(waitTimeMs?: number): Promise<void>;
+    protected untilReady(deadline: number): Promise<void>;
+    /**
+     * Close the underlying gRPC client.
+     *
+     * Make sure to call this method to ensure proper resource cleanup.
+     */
+    close(): Promise<void>;
 }

package/lib/connection.js

@@ -22,21 +22,27 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Connection = exports.defaultConnectionOpts = exports.LOCAL_DOCKER_TARGET = exports.WorkflowService = void 0;
+exports.Connection = exports.defaultConnectionOpts = exports.LOCAL_TARGET = void 0;
 const grpc = __importStar(require("@grpc/grpc-js"));
 const internal_non_workflow_common_1 = require("@temporalio/internal-non-workflow-common");
-const proto_1 = require("@temporalio/proto");
 const async_hooks_1 = require("async_hooks");
+const errors_1 = require("./errors");
 const grpc_retry_1 = require("./grpc-retry");
-exports.WorkflowService = proto_1.temporal.api.workflowservice.v1.WorkflowService;
-exports.LOCAL_DOCKER_TARGET = '127.0.0.1:7233';
+const pkg_1 = __importDefault(require("./pkg"));
+const types_1 = require("./types");
+exports.LOCAL_TARGET = '127.0.0.1:7233';
 function defaultConnectionOpts() {
     return {
-        address: exports.LOCAL_DOCKER_TARGET,
+        address: exports.LOCAL_TARGET,
         credentials: grpc.credentials.createInsecure(),
         channelArgs: {},
         interceptors: [(0, grpc_retry_1.makeGrpcRetryInterceptor)((0, grpc_retry_1.defaultGrpcRetryOptions)())],
+        metadata: {},
+        connectTimeoutMs: 10000,
     };
 }
 exports.defaultConnectionOpts = defaultConnectionOpts;
@@ -77,57 +83,154 @@ function normalizeGRPCConfig(options) {
     }
 }
 /**
- * Client connection to the Temporal Service
+ * Client connection to the Temporal Server
+ *
+ * ⚠️ Connections are expensive to construct and should be reused. Make sure to {@link close} any unused connections to
+ * avoid leaking resources.
  */
 class Connection {
-    constructor(options) {
-        this.callContextStorage = new async_hooks_1.AsyncLocalStorage();
-        this.options = {
+    constructor({ options, client, workflowService, operatorService, callContextStorage, }) {
+        this.options = options;
+        this.client = client;
+        this.workflowService = workflowService;
+        this.operatorService = operatorService;
+        this.callContextStorage = callContextStorage;
+    }
+    static createCtorOptions(options) {
+        var _a, _b;
+        const optionsWithDefaults = {
             ...defaultConnectionOpts(),
-            ...normalizeGRPCConfig(options),
+            ...(0, internal_non_workflow_common_1.filterNullAndUndefined)(normalizeGRPCConfig(options)),
+        };
+        // Allow overriding this
+        (_a = optionsWithDefaults.metadata)['client-name'] ?? (_a['client-name'] = 'temporal-typescript');
+        (_b = optionsWithDefaults.metadata)['client-version'] ?? (_b['client-version'] = pkg_1.default.version);
+        const client = new this.Client(optionsWithDefaults.address, optionsWithDefaults.credentials, optionsWithDefaults.channelArgs);
+        const callContextStorage = new async_hooks_1.AsyncLocalStorage();
+        callContextStorage.enterWith({ metadata: optionsWithDefaults.metadata });
+        const workflowRpcImpl = this.generateRPCImplementation({
+            serviceName: 'temporal.api.workflowservice.v1.WorkflowService',
+            client,
+            callContextStorage,
+            interceptors: optionsWithDefaults?.interceptors,
+        });
+        const workflowService = types_1.WorkflowService.create(workflowRpcImpl, false, false);
+        const operatorRpcImpl = this.generateRPCImplementation({
+            serviceName: 'temporal.api.operatorservice.v1.OperatorService',
+            client,
+            callContextStorage,
+            interceptors: optionsWithDefaults?.interceptors,
+        });
+        const operatorService = types_1.OperatorService.create(operatorRpcImpl, false, false);
+        return {
+            client,
+            callContextStorage,
+            workflowService,
+            operatorService,
+            options: optionsWithDefaults,
         };
-        this.client = new Connection.Client(this.options.address, this.options.credentials, this.options.channelArgs);
-        const rpcImpl = this.generateRPCImplementation('temporal.api.workflowservice.v1.WorkflowService');
-        this.service = exports.WorkflowService.create(rpcImpl, false, false);
     }
-    generateRPCImplementation(serviceName) {
+    /**
+     * Ensure connection can be established.
+     *
+     * Does not need to be called if you use {@link connect}.
+     *
+     * This method's result is memoized to ensure it runs only once.
+     *
+     * Calls {@link proto.temporal.api.workflowservice.v1.WorkflowService.getSystemInfo} internally.
+     */
+    async ensureConnected() {
+        if (this.connectPromise == null) {
+            const deadline = Date.now() + this.options.connectTimeoutMs;
+            this.connectPromise = (async () => {
+                await this.untilReady(deadline);
+                try {
+                    await this.withDeadline(deadline, () => this.workflowService.getSystemInfo({}));
+                }
+                catch (err) {
+                    if ((0, errors_1.isServerErrorResponse)(err)) {
+                        // Ignore old servers
+                        if (err.code !== grpc.status.UNIMPLEMENTED) {
+                            throw new errors_1.ServiceError('Failed to connect to Temporal server', { cause: err });
+                        }
+                    }
+                    else {
+                        throw err;
+                    }
+                }
+            })();
+        }
+        return this.connectPromise;
+    }
+    /**
+     * Create a lazy `Connection` instance.
+     *
+     * This method does not verify connectivity with the server. We recommend using {@link connect} instead.
+     */
+    static lazy(options) {
+        return new this(this.createCtorOptions(options));
+    }
+    /**
+     * Establish a connection with the server and return a `Connection` instance.
+     *
+     * This is the preferred method of creating connections as it verifies connectivity by calling
+     * {@link ensureConnected}.
+     */
+    static async connect(options) {
+        const conn = this.lazy(options);
+        await conn.ensureConnected();
+        return conn;
+    }
+    static generateRPCImplementation({ serviceName, client, callContextStorage, interceptors, }) {
         return (method, requestData, callback) => {
             const metadataContainer = new grpc.Metadata();
-            const { metadata, deadline } = this.callContextStorage.getStore() ?? {};
+            const { metadata, deadline } = callContextStorage.getStore() ?? {};
             if (metadata != null) {
                 for (const [k, v] of Object.entries(metadata)) {
                     metadataContainer.set(k, v);
                 }
             }
-            return this.client.makeUnaryRequest(`/${serviceName}/${method.name}`, (arg) => arg, (arg) => arg, requestData, metadataContainer, { interceptors: this.options.interceptors, deadline }, callback);
+            return client.makeUnaryRequest(`/${serviceName}/${method.name}`, (arg) => arg, (arg) => arg, requestData, metadataContainer, { interceptors, deadline }, callback);
         };
     }
     /**
      * Set the deadline for any service requests executed in `fn`'s scope.
+     *
+     * @returns value returned from `fn`
      */
     async withDeadline(deadline, fn) {
         const cc = this.callContextStorage.getStore();
         return await this.callContextStorage.run({ deadline, metadata: cc?.metadata }, fn);
     }
+    /**
+     * Set metadata for any service requests executed in `fn`'s scope.
+     *
+     * The provided metadata is merged on top of any existing metadata in current scope, including metadata provided in
+     * {@link ConnectionOptions.metadata}.
+     *
+     * @returns value returned from `fn`
+     *
+     * @example
+     *
+     *```ts
+     *const workflowHandle = await conn.withMetadata({ apiKey: 'secret' }, () =>
+     *  conn.withMetadata({ otherKey: 'set' }, () => client.start(options)))
+     *);
+     *```
+     */
     async withMetadata(metadata, fn) {
         const cc = this.callContextStorage.getStore();
-        metadata = typeof metadata === 'function' ? metadata(cc?.metadata ?? {}) : metadata;
+        metadata = { ...cc?.metadata, ...metadata };
         return await this.callContextStorage.run({ metadata, deadline: cc?.deadline }, fn);
     }
-    async withCallContext(cx, fn) {
-        cx = typeof cx === 'function' ? cx(this.callContextStorage.getStore()) : cx;
-        return await this.callContextStorage.run(cx, fn);
-    }
     /**
      * Wait for successful connection to the server.
      *
-     * @param waitTimeMs milliseconds to wait before giving up.
-     *
      * @see https://grpc.github.io/grpc/node/grpc.Client.html#waitForReady__anchor
      */
-    async untilReady(waitTimeMs = 5000) {
+    async untilReady(deadline) {
         return new Promise((resolve, reject) => {
-            this.client.waitForReady(Date.now() + waitTimeMs, (err) => {
+            this.client.waitForReady(deadline, (err) => {
                 if (err) {
                     reject(err);
                 }
@@ -137,7 +240,19 @@ class Connection {
             });
         });
     }
+    // This method is async for uniformity with NativeConnection which could be used in the future to power clients
+    /**
+     * Close the underlying gRPC client.
+     *
+     * Make sure to call this method to ensure proper resource cleanup.
+     */
+    async close() {
+        this.client.close();
+    }
 }
 exports.Connection = Connection;
+/**
+ * @internal
+ */
 Connection.Client = grpc.makeGenericClientConstructor({}, 'WorkflowService', {});
 //# sourceMappingURL=connection.js.map