@temporalio/common 1.7.4 → 1.8.1

package/src/type-helpers.ts

@@ -4,6 +4,11 @@ export type AnyFunc = (...args: any[]) => any;
 export type OmitLast<T> = T extends [...infer REST, any] ? REST : never;
 /** F with all arguments but the last */
 export type OmitLastParam<F extends AnyFunc> = (...args: OmitLast<Parameters<F>>) => ReturnType<F>;
+/** Require that T has at least one of the provided properties defined */
+export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> &
+  {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+  }[Keys];
 
 /** Verify that an type _Copy extends _Orig */
 export function checkExtends<_Orig, _Copy extends _Orig>(): void {
@@ -61,3 +66,10 @@ export function errorCode(error: unknown): string | undefined {
 
   return undefined;
 }
+
+/**
+ * Asserts that some type is the never type
+ */
+export function assertNever(msg: string, x: never): never {
+  throw new TypeError(msg + ': ' + x);
+}

package/src/versioning-intent.ts

@@ -0,0 +1,18 @@
+/**
+ * Indicates whether the user intends certain commands to be run on a compatible worker Build Id
+ * version or not.
+ *
+ * `COMPATIBLE` indicates that the command should run on a worker with compatible version if
+ * possible. It may not be possible if the target task queue does not also have knowledge of the
+ * current worker's Build Id.
+ *
+ * `DEFAULT` indicates that the command should run on the target task queue's current
+ * overall-default Build Id.
+ *
+ * Where this type is accepted optionally, an unset value indicates that the SDK should choose the
+ * most sensible default behavior for the type of command, accounting for whether the command will
+ * be run on the same task queue as the current worker.
+ *
+ * @experimental
+ */
+export type VersioningIntent = 'COMPATIBLE' | 'DEFAULT';

package/src/workflow-options.ts

@@ -1,7 +1,7 @@
 import type { temporal, google } from '@temporalio/proto';
 import { SearchAttributes, Workflow } from './interfaces';
 import { RetryPolicy } from './retry-policy';
-import { msOptionalToTs } from './time';
+import { Duration, msOptionalToTs } from './time';
 import { checkExtends, Replace } from './type-helpers';
 
 // Avoid importing the proto implementation to reduce workflow bundle size
@@ -113,7 +113,7 @@ export interface WorkflowDurationOptions {
    *
    * @format number of milliseconds or {@link https://www.npmjs.com/package/ms | ms-formatted string}
    */
-  workflowRunTimeout?: string | number;
+  workflowRunTimeout?: Duration;
 
   /**
    *
@@ -123,14 +123,14 @@ export interface WorkflowDurationOptions {
    *
    * @format number of milliseconds or {@link https://www.npmjs.com/package/ms | ms-formatted string}
    */
-  workflowExecutionTimeout?: string | number;
+  workflowExecutionTimeout?: Duration;
 
   /**
    * Maximum execution time of a single workflow task. Default is 10 seconds.
    *
    * @format number of milliseconds or {@link https://www.npmjs.com/package/ms | ms-formatted string}
    */
-  workflowTaskTimeout?: string | number;
+  workflowTaskTimeout?: Duration;
 }
 
 export type CommonWorkflowOptions = BaseWorkflowOptions & WorkflowDurationOptions;
@@ -154,3 +154,14 @@ export function compileWorkflowOptions<T extends CommonWorkflowOptions>(options:
     workflowTaskTimeout: msOptionalToTs(workflowTaskTimeout),
   };
 }
+
+export function extractWorkflowType<T extends Workflow>(workflowTypeOrFunc: string | T): string {
+  if (typeof workflowTypeOrFunc === 'string') return workflowTypeOrFunc as string;
+  if (typeof workflowTypeOrFunc === 'function') {
+    if (workflowTypeOrFunc?.name) return workflowTypeOrFunc.name;
+    throw new TypeError('Invalid workflow type: the workflow function is anonymous');
+  }
+  throw new TypeError(
+    `Invalid workflow type: expected either a string or a function, got '${typeof workflowTypeOrFunc}'`
+  );
+}