@temporalio/common 0.17.1 → 0.19.0-rc.0

package/lib/type-helpers.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasOwnProperties = exports.hasOwnProperty = exports.isRecord = exports.checkExtends = void 0;
+exports.hasOwnProperties = exports.isRecord = exports.checkExtends = void 0;
 /** Verify that an type _Copy extends _Orig */
 function checkExtends() {
     // noop, just type check
@@ -10,10 +10,6 @@ function isRecord(value) {
     return typeof value === 'object' && value !== null;
 }
 exports.isRecord = isRecord;
-function hasOwnProperty(record, prop) {
-    return prop in record;
-}
-exports.hasOwnProperty = hasOwnProperty;
 function hasOwnProperties(record, props) {
     return props.every((prop) => prop in record);
 }

package/lib/type-helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"type-helpers.js","sourceRoot":"","sources":["../src/type-helpers.ts"],"names":[],"mappings":";;;AAOA,8CAA8C;AAC9C,SAAgB,YAAY;IAC1B,wBAAwB;AAC1B,CAAC;AAFD,oCAEC;AAED,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAFD,4BAEC;AAED,SAAgB,cAAc,CAC5B,MAAS,EACT,IAAO;IAEP,OAAO,IAAI,IAAI,MAAM,CAAC;AACxB,CAAC;AALD,wCAKC;AAED,SAAgB,gBAAgB,CAC9B,MAAS,EACT,KAAU;IAEV,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC;AAC/C,CAAC;AALD,4CAKC"}
+{"version":3,"file":"type-helpers.js","sourceRoot":"","sources":["../src/type-helpers.ts"],"names":[],"mappings":";;;AAOA,8CAA8C;AAC9C,SAAgB,YAAY;IAC1B,wBAAwB;AAC1B,CAAC;AAFD,oCAEC;AAMD,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC;AACrD,CAAC;AAFD,4BAEC;AAED,SAAgB,gBAAgB,CAC9B,MAAS,EACT,KAAU;IAEV,OAAO,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,MAAM,CAAC,CAAC;AAC/C,CAAC;AALD,4CAKC"}

package/lib/workflow-options.d.ts

@@ -1,5 +1,6 @@
 import type { google } from '@temporalio/proto/lib/coresdk';
 import { Workflow } from './interfaces';
+import { Replace } from './type-helpers';
 import { RetryPolicy } from './retry-policy';
 export declare enum WorkflowIdReusePolicy {
     WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED = 0,
@@ -19,10 +20,10 @@ export interface BaseWorkflowOptions {
      */
     workflowIdReusePolicy?: WorkflowIdReusePolicy;
     /**
-     * Controls how a Workflow is retried.
+     * Controls how a Workflow Execution is retried.
      *
-     * Workflows should typically use the system default, do not set this unless
-     * you know what you're doing.
+     * By default, Workflow Executions are not retried. Do not override this behavior unless you know what you're doing.
+     * [More information](https://docs.temporal.io/docs/concepts/what-is-a-retry-policy/).
      */
     retry?: RetryPolicy;
     /**
@@ -83,9 +84,9 @@ export interface WorkflowDurationOptions {
     workflowTaskTimeout?: string | number;
 }
 export declare type CommonWorkflowOptions = BaseWorkflowOptions & WorkflowDurationOptions;
-export declare type WithCompiledWorkflowDurationOptions<T extends WorkflowDurationOptions> = Omit<T, 'workflowExecutionTimeout' | 'workflowRunTimeout' | 'workflowTaskTimeout'> & {
+export declare type WithCompiledWorkflowDurationOptions<T extends WorkflowDurationOptions> = Replace<T, {
     workflowExecutionTimeout?: google.protobuf.IDuration;
     workflowRunTimeout?: google.protobuf.IDuration;
     workflowTaskTimeout?: google.protobuf.IDuration;
-};
+}>;
 export declare function compileWorkflowOptions<T extends WorkflowDurationOptions>(options: T): WithCompiledWorkflowDurationOptions<T>;

package/lib/workflow-options.js

@@ -17,9 +17,9 @@ function compileWorkflowOptions(options) {
     const { workflowExecutionTimeout, workflowRunTimeout, workflowTaskTimeout, ...rest } = options;
     return {
         ...rest,
-        workflowExecutionTimeout: workflowExecutionTimeout ? (0, time_1.msToTs)(workflowExecutionTimeout) : undefined,
-        workflowRunTimeout: workflowRunTimeout ? (0, time_1.msToTs)(workflowRunTimeout) : undefined,
-        workflowTaskTimeout: workflowTaskTimeout ? (0, time_1.msToTs)(workflowTaskTimeout) : undefined,
+        workflowExecutionTimeout: (0, time_1.falsyMsToTs)(workflowExecutionTimeout),
+        workflowRunTimeout: (0, time_1.falsyMsToTs)(workflowRunTimeout),
+        workflowTaskTimeout: (0, time_1.falsyMsToTs)(workflowTaskTimeout),
     };
 }
 exports.compileWorkflowOptions = compileWorkflowOptions;

package/lib/workflow-options.js.map

@@ -1 +1 @@
-{"version":3,"file":"workflow-options.js","sourceRoot":"","sources":["../src/workflow-options.ts"],"names":[],"mappings":";;;AAGA,iCAAgC;AAChC,iDAA8C;AAE9C,0EAA0E;AAC1E,mDAAmD;AACnD,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,iIAAwC,CAAA;IACxC,yIAA4C,CAAA;IAC5C,iKAAwD,CAAA;IACxD,2IAA6C,CAAA;AAC/C,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAED,IAAA,2BAAY,GAA+D,CAAC;AAoG5E,SAAgB,sBAAsB,CACpC,OAAU;IAEV,MAAM,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAE/F,OAAO;QACL,GAAG,IAAI;QACP,wBAAwB,EAAE,wBAAwB,CAAC,CAAC,CAAC,IAAA,aAAM,EAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC,SAAS;QACjG,kBAAkB,EAAE,kBAAkB,CAAC,CAAC,CAAC,IAAA,aAAM,EAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,SAAS;QAC/E,mBAAmB,EAAE,mBAAmB,CAAC,CAAC,CAAC,IAAA,aAAM,EAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,SAAS;KACnF,CAAC;AACJ,CAAC;AAXD,wDAWC"}
+{"version":3,"file":"workflow-options.js","sourceRoot":"","sources":["../src/workflow-options.ts"],"names":[],"mappings":";;;AAEA,iCAAqC;AAGrC,iDAA8C;AAE9C,0EAA0E;AAC1E,mDAAmD;AACnD,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,iIAAwC,CAAA;IACxC,yIAA4C,CAAA;IAC5C,iKAAwD,CAAA;IACxD,2IAA6C,CAAA;AAC/C,CAAC,EALW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAKhC;AAED,IAAA,2BAAY,GAA+D,CAAC;AAoG5E,SAAgB,sBAAsB,CACpC,OAAU;IAEV,MAAM,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAE/F,OAAO;QACL,GAAG,IAAI;QACP,wBAAwB,EAAE,IAAA,kBAAW,EAAC,wBAAwB,CAAC;QAC/D,kBAAkB,EAAE,IAAA,kBAAW,EAAC,kBAAkB,CAAC;QACnD,mBAAmB,EAAE,IAAA,kBAAW,EAAC,mBAAmB,CAAC;KACtD,CAAC;AACJ,CAAC;AAXD,wDAWC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/common",
-  "version": "0.17.1",
+  "version": "0.19.0-rc.0",
   "description": "Temporal.io SDK common library for use in Workflow and normal code",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
@@ -13,9 +13,8 @@
   "author": "Roey Berman <roey@temporal.io>",
   "license": "MIT",
   "dependencies": {
-    "@temporalio/proto": "^0.17.1",
-    "ms": "^2.1.3",
-    "proto3-json-serializer": "^0.1.6"
+    "@temporalio/proto": "^0.18.0",
+    "ms": "^2.1.3"
   },
   "bugs": {
     "url": "https://github.com/temporalio/sdk-typescript/issues"
@@ -24,8 +23,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "devDependencies": {
-    "protobufjs": "^6.11.2"
-  },
-  "gitHead": "3ee26c92e9c18500f919654a402237a86e69652e"
+  "gitHead": "f55f02d343ac6db5d556fc1c7316013a8974c559"
 }

package/src/converter/data-converter.ts

@@ -5,15 +5,13 @@ import {
   UndefinedPayloadConverter,
   BinaryPayloadConverter,
   JsonPayloadConverter,
-  ProtobufJsonPayloadConverter,
-  ProtobufBinaryPayloadConverter,
 } from './payload-converter';
 
 /**
  * Used by the framework to serialize/deserialize method parameters that need to be sent over the
  * wire.
  *
- * Implement this in order to customize worker data serialization or use the default data converter which supports `Uint8Array`, Protobuf, and JSON serializables.
+ * Implement this in order to customize worker data serialization or use the default data converter which supports `Uint8Array` and JSON serializables.
  */
 export interface DataConverter {
   toPayload<T>(value: T): Promise<Payload>;
@@ -68,13 +66,6 @@ export interface DataConverter {
   fromPayloadsSync<T>(index: number, content?: Payload[] | null): T;
 }
 
-export const isValidDataConverter = (dataConverter: unknown): dataConverter is DataConverter =>
-  typeof dataConverter === 'object' &&
-  dataConverter !== null &&
-  ['toPayload', 'toPayloads', 'fromPayload', 'fromPayloads'].every(
-    (method) => typeof (dataConverter as Record<string, unknown>)[method] === 'function'
-  );
-
 export class CompositeDataConverter implements DataConverter {
   readonly converters: PayloadConverter[];
   readonly converterByEncoding: Map<string, PayloadConverter> = new Map();
@@ -191,22 +182,8 @@ export function mapToPayloadsSync<K extends string>(
   ) as Record<K, Payload>;
 }
 
-export interface DefaultDataConverterOptions {
-  root?: Record<string, unknown>;
-}
-
-export class DefaultDataConverter extends CompositeDataConverter {
-  constructor({ root }: DefaultDataConverterOptions = {}) {
-    // Match the order used in other SDKs
-    // Go SDK: https://github.com/temporalio/sdk-go/blob/5e5645f0c550dcf717c095ae32c76a7087d2e985/converter/default_data_converter.go#L28
-    super(
-      new UndefinedPayloadConverter(),
-      new BinaryPayloadConverter(),
-      new ProtobufJsonPayloadConverter(root),
-      new ProtobufBinaryPayloadConverter(root),
-      new JsonPayloadConverter()
-    );
-  }
-}
-
-export const defaultDataConverter = new DefaultDataConverter();
+export const defaultDataConverter = new CompositeDataConverter(
+  new UndefinedPayloadConverter(),
+  new BinaryPayloadConverter(),
+  new JsonPayloadConverter()
+);

package/src/converter/payload-converter.ts

@@ -1,17 +1,5 @@
-import { ValueError, DataConverterError } from '../errors';
-import {
-  u8,
-  str,
-  Payload,
-  encodingTypes,
-  encodingKeys,
-  METADATA_ENCODING_KEY,
-  METADATA_MESSAGE_TYPE_KEY,
-} from './types';
-import { isRecord, hasOwnProperty, hasOwnProperties } from '../type-helpers';
-import { errorMessage } from '../errors';
-import * as protoJsonSerializer from 'proto3-json-serializer';
-import type { Root, Type, Namespace, Message } from 'protobufjs';
+import { ValueError } from '../errors';
+import { u8, str, Payload, encodingTypes, encodingKeys, METADATA_ENCODING_KEY } from './types';
 
 /**
  * Used by the framework to serialize/deserialize method parameters that need to be sent over the
@@ -27,7 +15,7 @@ export interface PayloadConverter {
    * Implements conversion of value to payload
    *
    * @param value JS value to convert.
-   * @return converted value or `undefined` if unable to convert.
+   * @return converted value
    * @throws DataConverterException if conversion of the value passed as parameter failed for any
    *     reason.
    */
@@ -50,7 +38,7 @@ export interface PayloadConverter {
    * Implements conversion of value to payload
    *
    * @param value JS value to convert.
-   * @return converted value or `undefined` if unable to convert.
+   * @return converted value
    * @throws DataConverterException if conversion of the value passed as parameter failed for any
    *     reason.
    */
@@ -152,142 +140,3 @@ export class BinaryPayloadConverter extends AsyncFacadePayloadConverter {
     return content.data as any;
   }
 }
-
-abstract class ProtobufPayloadConverter extends AsyncFacadePayloadConverter {
-  protected readonly root: Root | undefined;
-
-  // Don't use type Root here because root.d.ts doesn't export Root, so users would have to type assert
-  constructor(root?: unknown) {
-    super();
-
-    if (root) {
-      if (!isRoot(root)) {
-        throw new TypeError('root must be an instance of a protobufjs Root');
-      }
-
-      this.root = root;
-    }
-  }
-
-  protected validatePayload(content: Payload): { messageType: Type; data: Uint8Array } {
-    if (content.data === undefined || content.data === null) {
-      throw new ValueError('Got payload with no data');
-    }
-    if (!content.metadata || !(METADATA_MESSAGE_TYPE_KEY in content.metadata)) {
-      throw new ValueError(`Got protobuf payload without metadata.${METADATA_MESSAGE_TYPE_KEY}`);
-    }
-    if (!this.root) {
-      throw new DataConverterError('Unable to deserialize protobuf message without `root` being provided');
-    }
-
-    const messageTypeName = str(content.metadata[METADATA_MESSAGE_TYPE_KEY]);
-    let messageType;
-    try {
-      messageType = this.root.lookupType(messageTypeName);
-    } catch (e) {
-      if (errorMessage(e)?.includes('no such type')) {
-        throw new DataConverterError(
-          `Got a \`${messageTypeName}\` protobuf message but cannot find corresponding message class in \`root\``
-        );
-      }
-
-      throw e;
-    }
-
-    return { messageType, data: content.data };
-  }
-
-  protected constructPayload({ messageTypeName, message }: { messageTypeName: string; message: Uint8Array }): Payload {
-    return {
-      metadata: {
-        [METADATA_ENCODING_KEY]: u8(this.encodingType),
-        [METADATA_MESSAGE_TYPE_KEY]: u8(messageTypeName),
-      },
-      data: message,
-    };
-  }
-}
-
-/**
- * Converts between protobufjs Message instances and serialized Protobuf Payload
- */
-export class ProtobufBinaryPayloadConverter extends ProtobufPayloadConverter {
-  public encodingType = encodingTypes.METADATA_ENCODING_PROTOBUF;
-
-  constructor(root?: unknown) {
-    super(root);
-  }
-
-  public toDataSync(value: unknown): Payload | undefined {
-    if (!isProtobufMessage(value)) {
-      return undefined;
-    }
-
-    return this.constructPayload({
-      messageTypeName: getNamespacedTypeName(value.$type),
-      message: value.$type.encode(value).finish(),
-    });
-  }
-
-  public fromDataSync<T>(content: Payload): T {
-    const { messageType, data } = this.validatePayload(content);
-    return messageType.decode(data) as unknown as T;
-  }
-}
-
-/**
- * Converts between protobufjs Message instances and serialized JSON Payload
- */
-export class ProtobufJsonPayloadConverter extends ProtobufPayloadConverter {
-  public encodingType = encodingTypes.METADATA_ENCODING_PROTOBUF_JSON;
-
-  constructor(root?: unknown) {
-    super(root);
-  }
-
-  public toDataSync(value: unknown): Payload | undefined {
-    if (!isProtobufMessage(value)) {
-      return undefined;
-    }
-
-    const jsonValue = protoJsonSerializer.toProto3JSON(value);
-
-    return this.constructPayload({
-      messageTypeName: getNamespacedTypeName(value.$type),
-      message: u8(JSON.stringify(jsonValue)),
-    });
-  }
-
-  public fromDataSync<T>(content: Payload): T {
-    const { messageType, data } = this.validatePayload(content);
-    return protoJsonSerializer.fromProto3JSON(messageType, JSON.parse(str(data))) as unknown as T;
-  }
-}
-
-function isProtobufType(type: unknown): type is Type {
-  return (
-    isRecord(type) &&
-    type.constructor.name === 'Type' &&
-    hasOwnProperties(type, ['parent', 'name', 'create', 'encode', 'decode']) &&
-    typeof type.name === 'string' &&
-    typeof type.create === 'function' &&
-    typeof type.encode === 'function' &&
-    typeof type.decode === 'function'
-  );
-}
-
-function isProtobufMessage(value: unknown): value is Message {
-  return isRecord(value) && hasOwnProperty(value, '$type') && isProtobufType(value.$type);
-}
-
-function getNamespacedTypeName(node: Type | Namespace): string {
-  if (node.parent && !isRoot(node.parent)) {
-    return getNamespacedTypeName(node.parent) + '.' + node.name;
-  } else {
-    return node.name;
-  }
-}
-
-function isRoot(root: unknown): root is Root {
-  return isRecord(root) && root.constructor.name === 'Root';
-}

package/src/converter/types.ts

@@ -30,5 +30,3 @@ export const encodingKeys = {
   METADATA_ENCODING_PROTOBUF_JSON: u8(encodingTypes.METADATA_ENCODING_PROTOBUF_JSON),
   METADATA_ENCODING_PROTOBUF: u8(encodingTypes.METADATA_ENCODING_PROTOBUF),
 } as const;
-
-export const METADATA_MESSAGE_TYPE_KEY = 'messageType';

package/src/errors.ts

@@ -13,6 +13,39 @@ export class IllegalStateError extends Error {
   public readonly name: string = 'IllegalStateError';
 }
 
+/**
+ * This exception is thrown in the following cases:
+ *  - Workflow with the same WorkflowId is currently running
+ *  - There is a closed workflow with the same ID and the {@link WorkflowOptions.workflowIdReusePolicy}
+ *    is `WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE`
+ *  - There is successfully closed workflow with the same ID and the {@link WorkflowOptions.workflowIdReusePolicy}
+ *    is `WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY`
+ *  - {@link Workflow.execute} is called *more than once* on a handle created through {@link createChildWorkflowHandle} and the
+ *    {@link WorkflowOptions.workflowIdReusePolicy} is `WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE`
+ */
+export class WorkflowExecutionAlreadyStartedError extends Error {
+  public readonly name: string = 'WorkflowExecutionAlreadyStartedError';
+
+  constructor(message: string, public readonly workflowId: string, public readonly workflowType: string) {
+    super(message);
+  }
+}
+
+/**
+ * Thrown when workflow with the given id is not known to the Temporal service.
+ * It could be because:
+ * - ID passed is incorrect
+ * - Workflow execution is complete (for some calls e.g. terminate),
+ * - workflow was purged from the service after reaching its retention limit.
+ */
+export class WorkflowNotFoundError extends Error {
+  public readonly name: string = 'WorkflowNotFoundError';
+
+  constructor(message: string, public readonly workflowId: string, public readonly runId: string | undefined) {
+    super(message);
+  }
+}
+
 /**
  * Get error message from an Error or string or return undefined
  */
@@ -25,21 +58,3 @@ export function errorMessage(err: unknown): string | undefined {
   }
   return undefined;
 }
-
-interface ErrorWithCode {
-  code: string;
-}
-/**
- * Get error code from an Error or return undefined
- */
-export function errorCode(error: unknown): string | undefined {
-  if (
-    typeof error === 'object' &&
-    (error as ErrorWithCode).code !== undefined &&
-    typeof (error as ErrorWithCode).code === 'string'
-  ) {
-    return (error as ErrorWithCode).code;
-  }
-
-  return undefined;
-}

package/src/failure.ts

@@ -1,6 +1,6 @@
 import type { temporal } from '@temporalio/proto/lib/coresdk';
 import { DataConverter, arrayFromPayloads } from './converter/data-converter';
-import { checkExtends } from './type-helpers';
+import { checkExtends, hasOwnProperties, isRecord } from './type-helpers';
 
 export const FAILURE_SOURCE = 'TypeScriptSDK';
 export type ProtoFailure = temporal.api.failure.v1.IFailure;
@@ -220,7 +220,7 @@ export async function optionalErrorToOptionalFailure(
 /**
  * Stack traces will be cutoff when on of these patterns is matched
  */
-const CUTTOFF_STACK_PATTERNS = [
+const CUTOFF_STACK_PATTERNS = [
   /** Activity execution */
   /\s+at Activity\.execute \(.*[\\/]worker[\\/](?:src|lib)[\\/]activity\.[jt]s:\d+:\d+\)/,
   /** Workflow activation */
@@ -234,7 +234,7 @@ export function cutoffStackTrace(stack?: string): string {
   const lines = (stack ?? '').split(/\r?\n/);
   const acc = Array<string>();
   lineLoop: for (const line of lines) {
-    for (const pattern of CUTTOFF_STACK_PATTERNS) {
+    for (const pattern of CUTOFF_STACK_PATTERNS) {
       if (pattern.test(line)) break lineLoop;
     }
     acc.push(line);
@@ -329,15 +329,22 @@ export async function errorToFailure(err: unknown, dataConverter: DataConverter)
     source: FAILURE_SOURCE,
   };
 
-  if (err instanceof Error) {
-    return { ...base, message: err.message ?? '', stackTrace: cutoffStackTrace(err.stack) };
+  if (isRecord(err) && hasOwnProperties(err, ['message', 'stack'])) {
+    return {
+      ...base,
+      message: String(err.message) ?? '',
+      stackTrace: cutoffStackTrace(String(err.stack)),
+      cause: await optionalErrorToOptionalFailure(err.cause, dataConverter),
+    };
   }
 
+  const recommendation = ` [A non-Error value was thrown from your code. We recommend throwing Error objects so that we can provide a stack trace.]`;
+
   if (typeof err === 'string') {
-    return { ...base, message: err };
+    return { ...base, message: err + recommendation };
   }
 
-  return { ...base, message: String(err) };
+  return { ...base, message: JSON.stringify(err) + recommendation };
 }
 
 /**

package/src/index.ts

@@ -5,7 +5,6 @@
  */
 export * from './activity-options';
 export * from './converter/data-converter';
-export * from './converter/helpers';
 export * from './errors';
 export * from './failure';
 export * from './interceptors';

package/src/time.ts

@@ -44,6 +44,10 @@ export function msNumberToTs(millis: number): Timestamp {
   return { seconds: Long.fromNumber(seconds), nanos };
 }
 
+export function falsyMsToTs(str: string | number | undefined): Timestamp | undefined {
+  return str ? msToTs(str) : undefined;
+}
+
 export function msToTs(str: string | number): Timestamp {
   if (typeof str === 'number') {
     return msNumberToTs(str);

package/src/type-helpers.ts

@@ -10,17 +10,14 @@ export function checkExtends<_Orig, _Copy extends _Orig>(): void {
   // noop, just type check
 }
 
+export type Replace<Base, New> = Omit<Base, keyof New> & New;
+
+export type MakeOptional<Base, Keys extends keyof Base> = Omit<Base, Keys> & Partial<Pick<Base, Keys>>;
+
 export function isRecord(value: unknown): value is Record<string, unknown> {
   return typeof value === 'object' && value !== null;
 }
 
-export function hasOwnProperty<X extends Record<string, unknown>, Y extends PropertyKey>(
-  record: X,
-  prop: Y
-): record is X & Record<Y, unknown> {
-  return prop in record;
-}
-
 export function hasOwnProperties<X extends Record<string, unknown>, Y extends PropertyKey>(
   record: X,
   props: Y[]

package/src/workflow-options.ts

@@ -1,7 +1,8 @@
 import type { coresdk, google } from '@temporalio/proto/lib/coresdk';
 import { Workflow } from './interfaces';
+import { falsyMsToTs } from './time';
+import { Replace } from './type-helpers';
 import { RetryPolicy } from './retry-policy';
-import { msToTs } from './time';
 import { checkExtends } from './type-helpers';
 
 // Avoid importing the proto implementation to reduce workflow bundle size
@@ -28,10 +29,10 @@ export interface BaseWorkflowOptions {
   workflowIdReusePolicy?: WorkflowIdReusePolicy;
 
   /**
-   * Controls how a Workflow is retried.
+   * Controls how a Workflow Execution is retried.
    *
-   * Workflows should typically use the system default, do not set this unless
-   * you know what you're doing.
+   * By default, Workflow Executions are not retried. Do not override this behavior unless you know what you're doing.
+   * [More information](https://docs.temporal.io/docs/concepts/what-is-a-retry-policy/).
    */
   retry?: RetryPolicy;
 
@@ -104,14 +105,14 @@ export interface WorkflowDurationOptions {
 
 export type CommonWorkflowOptions = BaseWorkflowOptions & WorkflowDurationOptions;
 
-export type WithCompiledWorkflowDurationOptions<T extends WorkflowDurationOptions> = Omit<
+export type WithCompiledWorkflowDurationOptions<T extends WorkflowDurationOptions> = Replace<
   T,
-  'workflowExecutionTimeout' | 'workflowRunTimeout' | 'workflowTaskTimeout'
-> & {
-  workflowExecutionTimeout?: google.protobuf.IDuration;
-  workflowRunTimeout?: google.protobuf.IDuration;
-  workflowTaskTimeout?: google.protobuf.IDuration;
-};
+  {
+    workflowExecutionTimeout?: google.protobuf.IDuration;
+    workflowRunTimeout?: google.protobuf.IDuration;
+    workflowTaskTimeout?: google.protobuf.IDuration;
+  }
+>;
 
 export function compileWorkflowOptions<T extends WorkflowDurationOptions>(
   options: T
@@ -120,8 +121,8 @@ export function compileWorkflowOptions<T extends WorkflowDurationOptions>(
 
   return {
     ...rest,
-    workflowExecutionTimeout: workflowExecutionTimeout ? msToTs(workflowExecutionTimeout) : undefined,
-    workflowRunTimeout: workflowRunTimeout ? msToTs(workflowRunTimeout) : undefined,
-    workflowTaskTimeout: workflowTaskTimeout ? msToTs(workflowTaskTimeout) : undefined,
+    workflowExecutionTimeout: falsyMsToTs(workflowExecutionTimeout),
+    workflowRunTimeout: falsyMsToTs(workflowRunTimeout),
+    workflowTaskTimeout: falsyMsToTs(workflowTaskTimeout),
   };
 }