@temporalio/client 1.2.0 → 1.4.0

package/lib/grpc-retry.js

@@ -23,17 +23,43 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeGrpcRetryInterceptor = exports.backOffAmount = exports.isRetryableError = exports.defaultGrpcRetryOptions = void 0;
+exports.makeGrpcRetryInterceptor = exports.isRetryableError = exports.defaultGrpcRetryOptions = void 0;
 const grpc_js_1 = require("@grpc/grpc-js");
 const grpc = __importStar(require("@grpc/grpc-js"));
-function defaultGrpcRetryOptions() {
+/**
+ * Add defaults as documented in {@link BackoffOptions}
+ */
+function withDefaultBackoffOptions({ maxAttempts, factor, maxJitter, initialIntervalMs, }) {
+    return {
+        maxAttempts: maxAttempts ?? 10,
+        factor: factor ?? 2,
+        maxJitter: maxJitter ?? 0.1,
+        initialIntervalMs: initialIntervalMs ?? defaultInitialIntervalMs,
+        maxIntervalMs() {
+            return 10000;
+        },
+    };
+}
+/**
+ * Generates the default retry behavior based on given backoff options
+ *
+ * @experimental
+ */
+function defaultGrpcRetryOptions(options = {}) {
+    const { maxAttempts, factor, maxJitter, initialIntervalMs, maxIntervalMs } = withDefaultBackoffOptions(options);
     return {
-        maxRetries: 10,
-        delayFunction: backOffAmount,
-        retryableDecider: isRetryableError,
+        delayFunction(attempt, status) {
+            return Math.min(maxIntervalMs(status), factor ** attempt * initialIntervalMs(status)) * jitter(maxJitter);
+        },
+        retryableDecider(attempt, status) {
+            return attempt < maxAttempts && isRetryableError(status);
+        },
     };
 }
 exports.defaultGrpcRetryOptions = defaultGrpcRetryOptions;
+/**
+ * Set of retryable gRPC status codes
+ */
 const retryableCodes = new Set([
     grpc.status.UNKNOWN,
     grpc.status.RESOURCE_EXHAUSTED,
@@ -46,71 +72,72 @@ function isRetryableError(status) {
     return retryableCodes.has(status.code);
 }
 exports.isRetryableError = isRetryableError;
-/** Return backoff amount in ms */
-function backOffAmount(attempt) {
-    return 2 ** attempt * 20;
+/**
+ * Calculates random amount of jitter between 0 and `max`
+ */
+function jitter(max) {
+    return 1 - max + Math.random() * max * 2;
+}
+/**
+ * Default implementation - backs off more on RESOURCE_EXHAUSTED errors
+ */
+function defaultInitialIntervalMs({ code }) {
+    // Backoff more on RESOURCE_EXHAUSTED
+    if (code === grpc.status.RESOURCE_EXHAUSTED) {
+        return 1000;
+    }
+    return 20;
 }
-exports.backOffAmount = backOffAmount;
 /**
  * Returns a GRPC interceptor that will perform automatic retries for some types of failed calls
  *
  * @param retryOptions Options for the retry interceptor
+ *
+ * @experimental
  */
 function makeGrpcRetryInterceptor(retryOptions) {
     return (options, nextCall) => {
-        let savedMetadata;
         let savedSendMessage;
         let savedReceiveMessage;
         let savedMessageNext;
         const requester = new grpc_js_1.RequesterBuilder()
             .withStart(function (metadata, _listener, next) {
-            savedMetadata = metadata;
-            const newListener = new grpc_js_1.ListenerBuilder()
+            // First attempt
+            let attempt = 1;
+            const listener = new grpc_js_1.ListenerBuilder()
                 .withOnReceiveMessage((message, next) => {
                 savedReceiveMessage = message;
                 savedMessageNext = next;
             })
                 .withOnReceiveStatus((status, next) => {
-                let retries = 0;
-                const retry = (message, metadata) => {
-                    retries++;
-                    const newCall = nextCall(options);
-                    newCall.start(metadata, {
-                        onReceiveMessage: (message) => {
+                const retry = () => {
+                    attempt++;
+                    const call = nextCall(options);
+                    call.start(metadata, {
+                        onReceiveMessage(message) {
                             savedReceiveMessage = message;
                         },
-                        onReceiveStatus: (status) => {
-                            if (retryOptions.retryableDecider(status)) {
-                                if (retries <= retryOptions.maxRetries) {
-                                    setTimeout(() => retry(message, metadata), retryOptions.delayFunction(retries));
-                                }
-                                else {
-                                    savedMessageNext(savedReceiveMessage);
-                                    next(status);
-                                }
-                            }
-                            else {
-                                savedMessageNext(savedReceiveMessage);
-                                // TODO: For reasons that are completely unclear to me, if you pass a handcrafted
-                                //   status object here, node will magically just exit at the end of this line.
-                                //   No warning, no nothing. Here be dragons.
-                                next(status);
-                            }
-                        },
+                        onReceiveStatus,
                     });
-                    newCall.sendMessage(message);
-                    newCall.halfClose();
+                    call.sendMessage(savedSendMessage);
+                    call.halfClose();
+                };
+                const onReceiveStatus = (status) => {
+                    if (retryOptions.retryableDecider(attempt, status)) {
+                        setTimeout(retry, retryOptions.delayFunction(attempt, status));
+                    }
+                    else {
+                        savedMessageNext(savedReceiveMessage);
+                        // TODO: For reasons that are completely unclear to me, if you pass a handcrafted
+                        // status object here, node will magically just exit at the end of this line.
+                        // No warning, no nothing. Here be dragons.
+                        next(status);
+                    }
                 };
-                if (retryOptions.retryableDecider(status)) {
-                    setTimeout(() => retry(savedSendMessage, savedMetadata), backOffAmount(retries));
-                }
-                else {
-                    savedMessageNext(savedReceiveMessage);
-                    next(status);
-                }
+                onReceiveStatus(status);
             })
                 .build();
-            next(metadata, newListener);
+            next(metadata, listener);
         })
             .withSendMessage((message, next) => {
             savedSendMessage = message;

package/lib/grpc-retry.js.map

@@ -1 +1 @@
-{"version":3,"file":"grpc-retry.js","sourceRoot":"","sources":["../src/grpc-retry.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAOuB;AACvB,oDAAsC;AAkBtC,SAAgB,uBAAuB;IACrC,OAAO;QACL,UAAU,EAAE,EAAE;QACd,aAAa,EAAE,aAAa;QAC5B,gBAAgB,EAAE,gBAAgB;KACnC,CAAC;AACJ,CAAC;AAND,0DAMC;AAED,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,OAAO;IACnB,IAAI,CAAC,MAAM,CAAC,kBAAkB;IAC9B,IAAI,CAAC,MAAM,CAAC,WAAW;IACvB,IAAI,CAAC,MAAM,CAAC,OAAO;IACnB,IAAI,CAAC,MAAM,CAAC,SAAS;IACrB,IAAI,CAAC,MAAM,CAAC,YAAY;CACzB,CAAC,CAAC;AAEH,SAAgB,gBAAgB,CAAC,MAAoB;IACnD,OAAO,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC;AAFD,4CAEC;AAED,kCAAkC;AAClC,SAAgB,aAAa,CAAC,OAAe;IAC3C,OAAO,CAAC,IAAI,OAAO,GAAG,EAAE,CAAC;AAC3B,CAAC;AAFD,sCAEC;AAED;;;;GAIG;AACH,SAAgB,wBAAwB,CAAC,YAA8B;IACrE,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;QAC3B,IAAI,aAAuB,CAAC;QAC5B,IAAI,gBAAqB,CAAC;QAC1B,IAAI,mBAAwB,CAAC;QAC7B,IAAI,gBAAqB,CAAC;QAC1B,MAAM,SAAS,GAAG,IAAI,0BAAgB,EAAE;aACrC,SAAS,CAAC,UAAU,QAAQ,EAAE,SAAS,EAAE,IAAI;YAC5C,aAAa,GAAG,QAAQ,CAAC;YACzB,MAAM,WAAW,GAAG,IAAI,yBAAe,EAAE;iBACtC,oBAAoB,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;gBACtC,mBAAmB,GAAG,OAAO,CAAC;gBAC9B,gBAAgB,GAAG,IAAI,CAAC;YAC1B,CAAC,CAAC;iBACD,mBAAmB,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;gBACpC,IAAI,OAAO,GAAG,CAAC,CAAC;gBAChB,MAAM,KAAK,GAAG,CAAC,OAAY,EAAE,QAAkB,EAAE,EAAE;oBACjD,OAAO,EAAE,CAAC;oBACV,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;oBAClC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE;wBACtB,gBAAgB,EAAE,CAAC,OAAO,EAAE,EAAE;4BAC5B,mBAAmB,GAAG,OAAO,CAAC;wBAChC,CAAC;wBACD,eAAe,EAAE,CAAC,MAAM,EAAE,EAAE;4BAC1B,IAAI,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;gCACzC,IAAI,OAAO,IAAI,YAAY,CAAC,UAAU,EAAE;oCACtC,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,YAAY,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;iCACjF;qCAAM;oCACL,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;oCACtC,IAAI,CAAC,MAAM,CAAC,CAAC;iCACd;6BACF;iCAAM;gCACL,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;gCACtC,iFAAiF;gCACjF,+EAA+E;gCAC/E,6CAA6C;gCAC7C,IAAI,CAAC,MAAM,CAAC,CAAC;6BACd;wBACH,CAAC;qBACF,CAAC,CAAC;oBACH,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;oBAC7B,OAAO,CAAC,SAAS,EAAE,CAAC;gBACtB,CAAC,CAAC;gBAEF,IAAI,YAAY,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE;oBACzC,UAAU,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,gBAAgB,EAAE,aAAa,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;iBAClF;qBAAM;oBACL,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;oBACtC,IAAI,CAAC,MAAM,CAAC,CAAC;iBACd;YACH,CAAC,CAAC;iBACD,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;QAC9B,CAAC,CAAC;aACD,eAAe,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;YACjC,gBAAgB,GAAG,OAAO,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,CAAC;QAChB,CAAC,CAAC;aACD,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,0BAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC,CAAC;AACJ,CAAC;AA7DD,4DA6DC"}
+{"version":3,"file":"grpc-retry.js","sourceRoot":"","sources":["../src/grpc-retry.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA+G;AAC/G,oDAAsC;AA0DtC;;GAEG;AACH,SAAS,yBAAyB,CAAC,EACjC,WAAW,EACX,MAAM,EACN,SAAS,EACT,iBAAiB,GACO;IACxB,OAAO;QACL,WAAW,EAAE,WAAW,IAAI,EAAE;QAC9B,MAAM,EAAE,MAAM,IAAI,CAAC;QACnB,SAAS,EAAE,SAAS,IAAI,GAAG;QAC3B,iBAAiB,EAAE,iBAAiB,IAAI,wBAAwB;QAChE,aAAa;YACX,OAAO,KAAM,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,UAAmC,EAAE;IAC3E,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,SAAS,EAAE,iBAAiB,EAAE,aAAa,EAAE,GAAG,yBAAyB,CAAC,OAAO,CAAC,CAAC;IAChH,OAAO;QACL,aAAa,CAAC,OAAO,EAAE,MAAM;YAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,MAAM,IAAI,OAAO,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;QAC5G,CAAC;QACD,gBAAgB,CAAC,OAAO,EAAE,MAAM;YAC9B,OAAO,OAAO,GAAG,WAAW,IAAI,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC3D,CAAC;KACF,CAAC;AACJ,CAAC;AAVD,0DAUC;AAED;;GAEG;AACH,MAAM,cAAc,GAAG,IAAI,GAAG,CAAC;IAC7B,IAAI,CAAC,MAAM,CAAC,OAAO;IACnB,IAAI,CAAC,MAAM,CAAC,kBAAkB;IAC9B,IAAI,CAAC,MAAM,CAAC,WAAW;IACvB,IAAI,CAAC,MAAM,CAAC,OAAO;IACnB,IAAI,CAAC,MAAM,CAAC,SAAS;IACrB,IAAI,CAAC,MAAM,CAAC,YAAY;CACzB,CAAC,CAAC;AAEH,SAAgB,gBAAgB,CAAC,MAAoB;IACnD,OAAO,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AACzC,CAAC;AAFD,4CAEC;AAED;;GAEG;AACH,SAAS,MAAM,CAAC,GAAW;IACzB,OAAO,CAAC,GAAG,GAAG,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,SAAS,wBAAwB,CAAC,EAAE,IAAI,EAAgB;IACtD,qCAAqC;IACrC,IAAI,IAAI,KAAK,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE;QAC3C,OAAO,IAAI,CAAC;KACb;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CAAC,YAA8B;IACrE,OAAO,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE;QAC3B,IAAI,gBAAqB,CAAC;QAC1B,IAAI,mBAAwB,CAAC;QAC7B,IAAI,gBAAwC,CAAC;QAE7C,MAAM,SAAS,GAAG,IAAI,0BAAgB,EAAE;aACrC,SAAS,CAAC,UAAU,QAAQ,EAAE,SAAS,EAAE,IAAI;YAC5C,gBAAgB;YAChB,IAAI,OAAO,GAAG,CAAC,CAAC;YAEhB,MAAM,QAAQ,GAAG,IAAI,yBAAe,EAAE;iBACnC,oBAAoB,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;gBACtC,mBAAmB,GAAG,OAAO,CAAC;gBAC9B,gBAAgB,GAAG,IAAI,CAAC;YAC1B,CAAC,CAAC;iBACD,mBAAmB,CAAC,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;gBACpC,MAAM,KAAK,GAAG,GAAG,EAAE;oBACjB,OAAO,EAAE,CAAC;oBACV,MAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC;oBAC/B,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE;wBACnB,gBAAgB,CAAC,OAAO;4BACtB,mBAAmB,GAAG,OAAO,CAAC;wBAChC,CAAC;wBACD,eAAe;qBAChB,CAAC,CAAC;oBACH,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;oBACnC,IAAI,CAAC,SAAS,EAAE,CAAC;gBACnB,CAAC,CAAC;gBAEF,MAAM,eAAe,GAAG,CAAC,MAAoB,EAAE,EAAE;oBAC/C,IAAI,YAAY,CAAC,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;wBAClD,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;qBAChE;yBAAM;wBACL,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;wBACtC,iFAAiF;wBACjF,6EAA6E;wBAC7E,2CAA2C;wBAC3C,IAAI,CAAC,MAAM,CAAC,CAAC;qBACd;gBACH,CAAC,CAAC;gBAEF,eAAe,CAAC,MAAM,CAAC,CAAC;YAC1B,CAAC,CAAC;iBACD,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAC3B,CAAC,CAAC;aACD,eAAe,CAAC,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE;YACjC,gBAAgB,GAAG,OAAO,CAAC;YAC3B,IAAI,CAAC,OAAO,CAAC,CAAC;QAChB,CAAC,CAAC;aACD,KAAK,EAAE,CAAC;QACX,OAAO,IAAI,0BAAgB,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,CAAC;IAC5D,CAAC,CAAC;AACJ,CAAC;AAtDD,4DAsDC"}

package/lib/index.d.ts

@@ -8,13 +8,13 @@
  * <!--SNIPEND-->
  * @module
  */
-export { ActivityFailure, ApplicationFailure, CancelledFailure, ChildWorkflowFailure, DataConverter, defaultPayloadConverter, ProtoFailure, ServerFailure, TemporalFailure, TerminatedFailure, TimeoutFailure, } from '@temporalio/common';
-export { TLSConfig } from '@temporalio/internal-non-workflow-common';
-export { RetryPolicy } from '@temporalio/internal-workflow-common';
-export * from '@temporalio/internal-workflow-common/lib/errors';
-export * from '@temporalio/internal-workflow-common/lib/interfaces';
-export * from '@temporalio/internal-workflow-common/lib/workflow-handle';
+export { ActivityFailure, ApplicationFailure, CancelledFailure, ChildWorkflowFailure, DataConverter, defaultPayloadConverter, ProtoFailure, RetryPolicy, ServerFailure, TemporalFailure, TerminatedFailure, TimeoutFailure, } from '@temporalio/common';
+export { TLSConfig } from '@temporalio/common/lib/internal-non-workflow';
+export * from '@temporalio/common/lib/errors';
+export * from '@temporalio/common/lib/interfaces';
+export * from '@temporalio/common/lib/workflow-handle';
 export * from './async-completion-client';
+export * from './client';
 export { Connection, ConnectionOptions, ConnectionOptionsWithDefaults, LOCAL_TARGET } from './connection';
 export * from './errors';
 export * from './grpc-retry';

package/lib/index.js

@@ -35,10 +35,11 @@ Object.defineProperty(exports, "ServerFailure", { enumerable: true, get: functio
 Object.defineProperty(exports, "TemporalFailure", { enumerable: true, get: function () { return common_1.TemporalFailure; } });
 Object.defineProperty(exports, "TerminatedFailure", { enumerable: true, get: function () { return common_1.TerminatedFailure; } });
 Object.defineProperty(exports, "TimeoutFailure", { enumerable: true, get: function () { return common_1.TimeoutFailure; } });
-__exportStar(require("@temporalio/internal-workflow-common/lib/errors"), exports);
-__exportStar(require("@temporalio/internal-workflow-common/lib/interfaces"), exports);
-__exportStar(require("@temporalio/internal-workflow-common/lib/workflow-handle"), exports);
+__exportStar(require("@temporalio/common/lib/errors"), exports);
+__exportStar(require("@temporalio/common/lib/interfaces"), exports);
+__exportStar(require("@temporalio/common/lib/workflow-handle"), exports);
 __exportStar(require("./async-completion-client"), exports);
+__exportStar(require("./client"), exports);
 var connection_1 = require("./connection");
 Object.defineProperty(exports, "Connection", { enumerable: true, get: function () { return connection_1.Connection; } });
 Object.defineProperty(exports, "LOCAL_TARGET", { enumerable: true, get: function () { return connection_1.LOCAL_TARGET; } });

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;;AAEH,6CAY4B;AAX1B,yGAAA,eAAe,OAAA;AACf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AAEpB,iHAAA,uBAAuB,OAAA;AAEvB,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AAIhB,kFAAgE;AAChE,sFAAoE;AACpE,2FAAyE;AACzE,4DAA0C;AAC1C,2CAA0G;AAAjG,wGAAA,UAAU,OAAA;AAAoD,0GAAA,YAAY,OAAA;AACnF,2CAAyB;AACzB,+CAA6B;AAC7B,iDAA+B;AAC/B,0CAAwB;AACxB,oDAAkC;AAClC,qDAAmC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;;;;;;;;;;;;AAEH,6CAa4B;AAZ1B,yGAAA,eAAe,OAAA;AACf,4GAAA,kBAAkB,OAAA;AAClB,0GAAA,gBAAgB,OAAA;AAChB,8GAAA,oBAAoB,OAAA;AAEpB,iHAAA,uBAAuB,OAAA;AAGvB,uGAAA,aAAa,OAAA;AACb,yGAAA,eAAe,OAAA;AACf,2GAAA,iBAAiB,OAAA;AACjB,wGAAA,cAAc,OAAA;AAGhB,gEAA8C;AAC9C,oEAAkD;AAClD,yEAAuD;AACvD,4DAA0C;AAC1C,2CAAyB;AACzB,2CAA0G;AAAjG,wGAAA,UAAU,OAAA;AAAoD,0GAAA,YAAY,OAAA;AACnF,2CAAyB;AACzB,+CAA6B;AAC7B,iDAA+B;AAC/B,0CAAwB;AACxB,oDAAkC;AAClC,qDAAmC"}

package/lib/interceptors.d.ts

@@ -3,7 +3,7 @@
  *
  * @module
  */
-import { Headers, Next } from '@temporalio/internal-workflow-common';
+import { Headers, Next } from '@temporalio/common';
 import { temporal } from '@temporalio/proto';
 import { DescribeWorkflowExecutionResponse, RequestCancelWorkflowExecutionResponse, TerminateWorkflowExecutionResponse, WorkflowExecution } from './types';
 import { CompiledWorkflowOptions } from './workflow-options';
@@ -93,7 +93,7 @@ export interface WorkflowClientCallsInterceptor {
      */
     describe?: (input: WorkflowDescribeInput, next: Next<this, 'describe'>) => Promise<DescribeWorkflowExecutionResponse>;
 }
-interface WorkflowClientCallsInterceptorFactoryInput {
+export interface WorkflowClientCallsInterceptorFactoryInput {
     workflowId: string;
     runId?: string;
 }
@@ -109,3 +109,11 @@ export interface WorkflowClientCallsInterceptorFactory {
 export interface WorkflowClientInterceptors {
     calls?: WorkflowClientCallsInterceptorFactory[];
 }
+/**
+ * Interceptors for any high-level SDK client.
+ *
+ * NOTE: Currently only for {@link WorkflowClient}. More will be added later as needed.
+ */
+export interface ClientInterceptors {
+    workflow?: WorkflowClientInterceptors;
+}

package/lib/types.d.ts

@@ -1,16 +1,15 @@
-import type { SearchAttributes } from '@temporalio/internal-workflow-common';
-import { temporal } from '@temporalio/proto';
+import type { SearchAttributes } from '@temporalio/common';
+import * as proto from '@temporalio/proto';
 import type * as grpc from '@grpc/grpc-js';
-import Long from 'long';
 export interface WorkflowExecution {
     workflowId: string;
     runId?: string;
 }
-export declare type StartWorkflowExecutionRequest = temporal.api.workflowservice.v1.IStartWorkflowExecutionRequest;
-export declare type GetWorkflowExecutionHistoryRequest = temporal.api.workflowservice.v1.IGetWorkflowExecutionHistoryRequest;
-export declare type DescribeWorkflowExecutionResponse = temporal.api.workflowservice.v1.IDescribeWorkflowExecutionResponse;
-export declare type TerminateWorkflowExecutionResponse = temporal.api.workflowservice.v1.ITerminateWorkflowExecutionResponse;
-export declare type RequestCancelWorkflowExecutionResponse = temporal.api.workflowservice.v1.IRequestCancelWorkflowExecutionResponse;
+export declare type StartWorkflowExecutionRequest = proto.temporal.api.workflowservice.v1.IStartWorkflowExecutionRequest;
+export declare type GetWorkflowExecutionHistoryRequest = proto.temporal.api.workflowservice.v1.IGetWorkflowExecutionHistoryRequest;
+export declare type DescribeWorkflowExecutionResponse = proto.temporal.api.workflowservice.v1.IDescribeWorkflowExecutionResponse;
+export declare type TerminateWorkflowExecutionResponse = proto.temporal.api.workflowservice.v1.ITerminateWorkflowExecutionResponse;
+export declare type RequestCancelWorkflowExecutionResponse = proto.temporal.api.workflowservice.v1.IRequestCancelWorkflowExecutionResponse;
 export declare type WorkflowExecutionStatusName = 'UNSPECIFIED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELLED' | 'TERMINATED' | 'CONTINUED_AS_NEW' | 'TIMED_OUT' | 'UNKNOWN';
 export interface WorkflowExecutionDescription {
     type: string;
@@ -18,22 +17,24 @@ export interface WorkflowExecutionDescription {
     runId: string;
     taskQueue: string;
     status: {
-        code: temporal.api.enums.v1.WorkflowExecutionStatus;
+        code: proto.temporal.api.enums.v1.WorkflowExecutionStatus;
         name: WorkflowExecutionStatusName;
     };
-    historyLength: Long;
+    historyLength: number;
     startTime: Date;
     executionTime?: Date;
     closeTime?: Date;
     memo?: Record<string, unknown>;
     searchAttributes: SearchAttributes;
-    parentExecution?: Required<temporal.api.common.v1.IWorkflowExecution>;
+    parentExecution?: Required<proto.temporal.api.common.v1.IWorkflowExecution>;
     raw: DescribeWorkflowExecutionResponse;
 }
-export declare type WorkflowService = temporal.api.workflowservice.v1.WorkflowService;
-export declare const WorkflowService: typeof temporal.api.workflowservice.v1.WorkflowService;
-export declare type OperatorService = temporal.api.operatorservice.v1.OperatorService;
-export declare const OperatorService: typeof temporal.api.operatorservice.v1.OperatorService;
+export declare type WorkflowService = proto.temporal.api.workflowservice.v1.WorkflowService;
+export declare const WorkflowService: typeof proto.temporal.api.workflowservice.v1.WorkflowService;
+export declare type OperatorService = proto.temporal.api.operatorservice.v1.OperatorService;
+export declare const OperatorService: typeof proto.temporal.api.operatorservice.v1.OperatorService;
+export declare type HealthService = proto.grpc.health.v1.Health;
+export declare const HealthService: typeof proto.grpc.health.v1.Health;
 /**
  * Mapping of string to valid gRPC metadata value
  */

package/lib/types.js

@@ -1,7 +1,31 @@
 "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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OperatorService = exports.WorkflowService = void 0;
-const proto_1 = require("@temporalio/proto");
-exports.WorkflowService = proto_1.temporal.api.workflowservice.v1.WorkflowService;
-exports.OperatorService = proto_1.temporal.api.operatorservice.v1.OperatorService;
+exports.HealthService = exports.OperatorService = exports.WorkflowService = void 0;
+const proto = __importStar(require("@temporalio/proto"));
+exports.WorkflowService = proto.temporal.api.workflowservice.v1.WorkflowService;
+exports.OperatorService = proto.temporal.api.operatorservice.v1.OperatorService;
+exports.HealthService = proto.grpc.health.v1.Health;
 //# sourceMappingURL=types.js.map

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AACA,6CAA6C;AA2C9B,uBAAe,GAAK,gBAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,iBAAC;AAEpD,uBAAe,GAAK,gBAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,EAAE,iBAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,yDAA2C;AA6C5B,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"}

package/lib/workflow-client.d.ts

@@ -1,6 +1,7 @@
 import { status as grpcStatus } from '@grpc/grpc-js';
 import { DataConverter, LoadedDataConverter } from '@temporalio/common';
-import { BaseWorkflowHandle, QueryDefinition, Replace, WithWorkflowArgs, Workflow, WorkflowResultType } from '@temporalio/internal-workflow-common';
+import { BaseWorkflowHandle, QueryDefinition, WithWorkflowArgs, Workflow, WorkflowResultType } from '@temporalio/common';
+import { Replace } from '@temporalio/common/lib/type-helpers';
 import { temporal } from '@temporalio/proto';
 import { WorkflowCancelInput, WorkflowClientCallsInterceptor, WorkflowClientInterceptors, WorkflowDescribeInput, WorkflowQueryInput, WorkflowSignalInput, WorkflowSignalWithStartInput, WorkflowStartInput, WorkflowTerminateInput } from './interceptors';
 import { ConnectionLike, DescribeWorkflowExecutionResponse, Metadata, RequestCancelWorkflowExecutionResponse, TerminateWorkflowExecutionResponse, WorkflowExecution, WorkflowExecutionDescription, WorkflowService } from './types';
@@ -49,7 +50,17 @@ export interface WorkflowHandle<T extends Workflow = Workflow> extends BaseWorkf
      */
     terminate(reason?: string): Promise<TerminateWorkflowExecutionResponse>;
     /**
-     * Cancel a running Workflow
+     * Cancel a running Workflow.
+     *
+     * When a Workflow is cancelled, the root scope throws {@link CancelledFailure} with `message: 'Workflow canceled'`.
+     * That means that all cancellable scopes will throw `CancelledFailure`.
+     *
+     * Cancellation may be propagated to Activities depending on {@link ActivityOptions#cancellationType}, after which
+     * Activity calls may throw an {@link ActivityFailure}, and `isCancellation(error)` will be true (see {@link isCancellation}).
+     *
+     * Cancellation may be propagated to Child Workflows depending on {@link ChildWorkflowOptions#cancellationType}, after
+     * which calls to {@link executeChild} and {@link ChildWorkflowHandle#result} will throw, and `isCancellation(error)`
+     * will be true (see {@link isCancellation}).
      */
     cancel(): Promise<RequestCancelWorkflowExecutionResponse>;
     /**
@@ -86,9 +97,9 @@ export interface WorkflowHandleWithSignaledRunId<T extends Workflow = Workflow>
 }
 export interface WorkflowClientOptions {
     /**
-     * {@link DataConverter} to use for serializing and deserializing payloads
+     * {@link DataConverter} or {@link LoadedDataConverter} to use for serializing and deserializing payloads
      */
-    dataConverter?: DataConverter;
+    dataConverter?: DataConverter | LoadedDataConverter;
     /**
      * Used to override and extend default Connection functionality
      *
@@ -171,7 +182,10 @@ interface WorkflowHandleOptions extends GetWorkflowHandleOptions {
  */
 export declare type WorkflowStartOptions<T extends Workflow = Workflow> = WithWorkflowArgs<T, WorkflowOptions>;
 /**
- * Client for starting Workflow executions and creating Workflow handles
+ * Client for starting Workflow executions and creating Workflow handles.
+ *
+ * Typically this client should not be instantiated directly, instead create the high level {@link Client} and use
+ * {@link Client.workflow} to interact with Workflows.
  */
 export declare class WorkflowClient {
     readonly options: LoadedWorkflowClientOptions;
@@ -180,9 +194,11 @@ export declare class WorkflowClient {
     /**
      * Raw gRPC access to the Temporal service.
      *
-     * **NOTE**: The namespace provided in {@link options} is **not** automatically set on requests made to the service.
+     * **NOTE**: The namespace provided in {@link options} is **not** automatically set on requests made via this service
+     * object.
      */
     get workflowService(): WorkflowService;
+    protected get dataConverter(): LoadedDataConverter;
     /**
      * Set the deadline for any service requests executed in `fn`'s scope.
      */
@@ -215,12 +231,12 @@ export declare class WorkflowClient {
      */
     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 Workflows' run state.
+     * 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.
      *
-     * @returns a WorkflowHandle to the started Workflow
+     * @returns a {@link WorkflowHandle} to the started Workflow
      */
-    signalWithStart<T extends Workflow, SA extends any[] = []>(workflowTypeOrFunc: string | T, options: WithWorkflowArgs<T, WorkflowSignalWithStartOptions<SA>>): Promise<WorkflowHandleWithSignaledRunId<T>>;
+    signalWithStart<WorkflowFn extends Workflow, SignalArgs extends any[] = []>(workflowTypeOrFunc: string | WorkflowFn, options: WithWorkflowArgs<WorkflowFn, WorkflowSignalWithStartOptions<SignalArgs>>): Promise<WorkflowHandleWithSignaledRunId<WorkflowFn>>;
     /**
      * Starts a new Workflow execution and awaits its completion.
      *