@temporalio/common 1.14.1 → 1.15.0

package/src/index.ts

@@ -30,8 +30,8 @@ export * from './workflow-handle';
 export * from './workflow-options';
 export * from './versioning-intent';
 export {
-  SearchAttributes, // eslint-disable-line deprecation/deprecation
-  SearchAttributeValue, // eslint-disable-line deprecation/deprecation
+  SearchAttributes, // eslint-disable-line @typescript-eslint/no-deprecated
+  SearchAttributeValue, // eslint-disable-line @typescript-eslint/no-deprecated
   SearchAttributeType,
   SearchAttributePair,
   SearchAttributeUpdatePair,

package/src/internal-workflow/enums-helpers.ts

@@ -10,12 +10,12 @@ import { Exact, RemovePrefix, UnionToIntersection } from '../type-helpers';
  * Newly introduced enums should follow the following pattern:
  *
  * ```ts
- *     type ParentClosePolicy = (typeof ParentClosePolicy)[keyof typeof ParentClosePolicy];
  *     const ParentClosePolicy = {
  *       TERMINATE: 'TERMINATE',
  *       ABANDON: 'ABANDON',
  *       REQUEST_CANCEL: 'REQUEST_CANCEL',
  *     } as const;
+ *     type ParentClosePolicy = (typeof ParentClosePolicy)[keyof typeof ParentClosePolicy];
  *
  *     const [encodeParentClosePolicy, decodeParentClosePolicy] = //
  *       makeProtoEnumConverters<

package/src/metrics.ts

@@ -69,8 +69,43 @@ export interface Metric {
    * The description of the metric, if any.
    */
   description?: string;
+
+  /**
+   * The kind of the metric (e.g. `counter`, `histogram`, `gauge`).
+   */
+  kind: MetricKind;
+
+  /**
+   * The type of value recorded by the metric. Either `int` or `float`.
+   */
+  valueType: NumericMetricValueType;
 }
 
+/**
+ * Tags to be attached to some metrics.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+export type MetricTags = Record<string, string | number | boolean>;
+
+/**
+ * Type of numerical values recorded by a metric.
+ *
+ * Note that this represents the _configuration_ of the metric; however, since JavaScript doesn't
+ * have different runtime representation for integers and floats, the actual value type is always
+ * a JS 'number'.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+export type NumericMetricValueType = 'int' | 'float';
+
+/**
+ * The kind of a metric.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+export type MetricKind = 'counter' | 'histogram' | 'gauge';
+
 /**
  * A metric that supports adding values as a counter.
  *
@@ -91,6 +126,9 @@ export interface MetricCounter extends Metric {
    * @param tags Tags to append to existing tags.
    */
   withTags(tags: MetricTags): MetricCounter;
+
+  kind: 'counter';
+  valueType: 'int';
 }
 
 /**
@@ -99,11 +137,6 @@ export interface MetricCounter extends Metric {
  * @experimental The Metric API is an experimental feature and may be subject to change.
  */
 export interface MetricHistogram extends Metric {
-  /**
-   * The type of value to record. Either `int` or `float`.
-   */
-  valueType: NumericMetricValueType;
-
   /**
    * Record the given value on the histogram.
    *
@@ -120,6 +153,8 @@ export interface MetricHistogram extends Metric {
    * @param tags Tags to append to existing tags.
    */
   withTags(tags: MetricTags): MetricHistogram;
+
+  kind: 'histogram';
 }
 
 /**
@@ -128,11 +163,6 @@ export interface MetricHistogram extends Metric {
  * @experimental The Metric API is an experimental feature and may be subject to change.
  */
 export interface MetricGauge extends Metric {
-  /**
-   * The type of value to set. Either `int` or `float`.
-   */
-  valueType: NumericMetricValueType;
-
   /**
    * Set the given value on the gauge.
    *
@@ -147,16 +177,9 @@ export interface MetricGauge extends Metric {
    * @param tags Tags to append to existing tags.
    */
   withTags(tags: MetricTags): MetricGauge;
-}
 
-/**
- * Tags to be attached to some metrics.
- *
- * @experimental The Metric API is an experimental feature and may be subject to change.
- */
-export type MetricTags = Record<string, string | number | boolean>;
-
-export type NumericMetricValueType = 'int' | 'float';
+  kind: 'gauge';
+}
 
 ////////////////////////////////////////////////////////////////////////////////////////////////////
 
@@ -170,6 +193,9 @@ class NoopMetricMeter implements MetricMeter {
       unit,
       description,
 
+      kind: 'counter',
+      valueType: 'int',
+
       add(_value, _extraTags) {},
 
       withTags(_extraTags) {
@@ -186,10 +212,12 @@ class NoopMetricMeter implements MetricMeter {
   ): MetricHistogram {
     return {
       name,
-      valueType,
       unit,
       description,
 
+      kind: 'histogram',
+      valueType,
+
       record(_value, _extraTags) {},
 
       withTags(_extraTags) {
@@ -198,13 +226,20 @@ class NoopMetricMeter implements MetricMeter {
     };
   }
 
-  createGauge(name: string, valueType?: NumericMetricValueType, unit?: string, description?: string): MetricGauge {
+  createGauge(
+    name: string,
+    valueType: NumericMetricValueType = 'int',
+    unit?: string,
+    description?: string
+  ): MetricGauge {
     return {
       name,
-      valueType: valueType ?? 'int',
       unit,
       description,
 
+      kind: 'gauge',
+      valueType,
+
       set(_value, _extraTags) {},
 
       withTags(_extraTags) {
@@ -300,6 +335,9 @@ export class MetricMeterWithComposedTags implements MetricMeter {
  * @experimental The Metric API is an experimental feature and may be subject to change.
  */
 class MetricCounterWithComposedTags implements MetricCounter {
+  public readonly kind = 'counter';
+  public readonly valueType = 'int';
+
   constructor(
     private parentCounter: MetricCounter,
     private contributors: MetricTagsOrFunc[]
@@ -332,6 +370,8 @@ class MetricCounterWithComposedTags implements MetricCounter {
  * @experimental The Metric API is an experimental feature and may be subject to change.
  */
 class MetricHistogramWithComposedTags implements MetricHistogram {
+  public readonly kind = 'histogram';
+
   constructor(
     private parentHistogram: MetricHistogram,
     private contributors: MetricTagsOrFunc[]
@@ -369,6 +409,8 @@ class MetricHistogramWithComposedTags implements MetricHistogram {
  * @hidden
  */
 class MetricGaugeWithComposedTags implements MetricGauge {
+  public readonly kind = 'gauge';
+
   constructor(
     private parentGauge: MetricGauge,
     private contributors: MetricTagsOrFunc[]

package/src/search-attributes.ts

@@ -2,11 +2,11 @@ import type { temporal } from '@temporalio/proto';
 import { makeProtoEnumConverters } from './internal-workflow';
 
 /** @deprecated: Use {@link TypedSearchAttributes} instead */
-export type SearchAttributeValueOrReadonly = SearchAttributeValue | Readonly<SearchAttributeValue> | undefined; // eslint-disable-line deprecation/deprecation
+export type SearchAttributeValueOrReadonly = SearchAttributeValue | Readonly<SearchAttributeValue> | undefined; // eslint-disable-line @typescript-eslint/no-deprecated
 /** @deprecated: Use {@link TypedSearchAttributes} instead */
-export type SearchAttributes = Record<string, SearchAttributeValueOrReadonly>; // eslint-disable-line deprecation/deprecation
+export type SearchAttributes = Record<string, SearchAttributeValueOrReadonly>; // eslint-disable-line @typescript-eslint/no-deprecated
 /** @deprecated: Use {@link TypedSearchAttributes} instead */
-export type SearchAttributeValue = string[] | number[] | boolean[] | Date[]; // eslint-disable-line deprecation/deprecation
+export type SearchAttributeValue = string[] | number[] | boolean[] | Date[];
 
 export const SearchAttributeType = {
   TEXT: 'TEXT',
@@ -17,7 +17,6 @@ export const SearchAttributeType = {
   DATETIME: 'DATETIME',
   KEYWORD_LIST: 'KEYWORD_LIST',
 } as const;
-
 export type SearchAttributeType = (typeof SearchAttributeType)[keyof typeof SearchAttributeType];
 
 // Note: encodeSearchAttributeIndexedValueType exported for use in tests to register search attributes
@@ -213,7 +212,7 @@ export class TypedSearchAttributes {
 
   static getKeyFromUntyped(
     key: string,
-    value: SearchAttributeValueOrReadonly // eslint-disable-line deprecation/deprecation
+    value: SearchAttributeValueOrReadonly // eslint-disable-line @typescript-eslint/no-deprecated
   ): SearchAttributeKey<SearchAttributeType> | undefined {
     if (value == null) {
       return;
@@ -270,20 +269,29 @@ export class TypedSearchAttributes {
   }
 
   static toSearchAttributeType(type: string): SearchAttributeType | undefined {
+    // The type metadata is usually in PascalCase (e.g. "KeywordList") but in
+    // rare cases may be in SCREAMING_SNAKE_CASE (e.g. "INDEXED_VALUE_TYPE_KEYWORD_LIST").
     switch (type) {
       case 'Text':
+      case 'INDEXED_VALUE_TYPE_TEXT':
         return SearchAttributeType.TEXT;
       case 'Keyword':
+      case 'INDEXED_VALUE_TYPE_KEYWORD':
         return SearchAttributeType.KEYWORD;
       case 'Int':
+      case 'INDEXED_VALUE_TYPE_INT':
         return SearchAttributeType.INT;
       case 'Double':
+      case 'INDEXED_VALUE_TYPE_DOUBLE':
         return SearchAttributeType.DOUBLE;
       case 'Bool':
+      case 'INDEXED_VALUE_TYPE_BOOL':
         return SearchAttributeType.BOOL;
       case 'Datetime':
+      case 'INDEXED_VALUE_TYPE_DATETIME':
         return SearchAttributeType.DATETIME;
       case 'KeywordList':
+      case 'INDEXED_VALUE_TYPE_KEYWORD_LIST':
         return SearchAttributeType.KEYWORD_LIST;
       default:
         return;

package/src/time.ts

@@ -1,4 +1,4 @@
-import Long from 'long'; // eslint-disable-line import/no-named-as-default
+import Long from 'long';
 import ms, { StringValue } from 'ms';
 import type { google } from '@temporalio/proto';
 import { ValueError } from './errors';

package/src/versioning-intent-enum.ts

@@ -2,15 +2,14 @@ import type { coresdk } from '@temporalio/proto';
 import type { VersioningIntent as VersioningIntentString } from './versioning-intent';
 import { assertNever, checkExtends } from './type-helpers';
 
-/* eslint-disable deprecation/deprecation */
+/* eslint-disable @typescript-eslint/no-deprecated */
 
 // Avoid importing the proto implementation to reduce workflow bundle size
 // Copied from coresdk.common.VersioningIntent
 /**
  * Protobuf enum representation of {@link VersioningIntentString}.
  *
- * @deprecated In favor of the new Worker Deployment API.
- * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export enum VersioningIntent {
   UNSPECIFIED = 0,
@@ -21,6 +20,9 @@ export enum VersioningIntent {
 checkExtends<coresdk.common.VersioningIntent, VersioningIntent>();
 checkExtends<VersioningIntent, coresdk.common.VersioningIntent>();
 
+/**
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
+ */
 export function versioningIntentToProto(intent: VersioningIntentString | undefined): VersioningIntent {
   switch (intent) {
     case 'DEFAULT':

package/src/versioning-intent.ts

@@ -11,7 +11,6 @@
  * current worker. The default behavior for starting Workflows is `DEFAULT`. The default behavior for Workflows starting
  * Activities, starting Child Workflows, or Continuing As New is `COMPATIBLE`.
  *
- * @deprecated In favor of the new Worker Deployment API.
- * @experimental The Worker Versioning API is still being designed. Major changes are expected.
+ * @deprecated Worker Versioning is now deprecated. Please use the Worker Deployment API instead: https://docs.temporal.io/worker-deployments
  */
 export type VersioningIntent = 'COMPATIBLE' | 'DEFAULT';

package/src/worker-deployments.ts

@@ -3,8 +3,6 @@ import { makeProtoEnumConverters } from './internal-workflow';
 
 /**
  * Represents the version of a specific worker deployment.
- *
- * @experimental Deployment based versioning is experimental and may change in the future.
  */
 export interface WorkerDeploymentVersion {
   readonly buildId: string;
@@ -25,8 +23,6 @@ export function toCanonicalString(version: WorkerDeploymentVersion): string {
  * * 'PINNED' - The workflow will be pinned to the current Build ID unless manually moved.
  * * 'AUTO_UPGRADE' - The workflow will automatically move to the latest version (default Build ID
  *    of the task queue) when the next task is dispatched.
- *
- * @experimental Deployment based versioning is experimental and may change in the future.
  */
 export const VersioningBehavior = {
   PINNED: 'PINNED',

package/src/workflow-options.ts

@@ -43,7 +43,7 @@ export const WorkflowIdReusePolicy = {
    *             {@link WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_TERMINATE_EXISTING}.
    *             When using this option, `WorkflowOptions.workflowIdConflictPolicy` must be left unspecified.
    */
-  TERMINATE_IF_RUNNING: 'TERMINATE_IF_RUNNING', // eslint-disable-line deprecation/deprecation
+  TERMINATE_IF_RUNNING: 'TERMINATE_IF_RUNNING',
 
   /// Anything below this line has been deprecated
 
@@ -52,19 +52,19 @@ export const WorkflowIdReusePolicy = {
    *
    * @deprecated Either leave property `undefined`, or use {@link ALLOW_DUPLICATE} instead.
    */
-  WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED: undefined, // eslint-disable-line deprecation/deprecation
+  WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED: undefined,
 
   /** @deprecated Use {@link ALLOW_DUPLICATE} instead. */
-  WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE: 'ALLOW_DUPLICATE', // eslint-disable-line deprecation/deprecation
+  WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE: 'ALLOW_DUPLICATE',
 
   /** @deprecated Use {@link ALLOW_DUPLICATE_FAILED_ONLY} instead. */
-  WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: 'ALLOW_DUPLICATE_FAILED_ONLY', // eslint-disable-line deprecation/deprecation
+  WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: 'ALLOW_DUPLICATE_FAILED_ONLY',
 
   /** @deprecated Use {@link REJECT_DUPLICATE} instead. */
-  WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE: 'REJECT_DUPLICATE', // eslint-disable-line deprecation/deprecation
+  WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE: 'REJECT_DUPLICATE',
 
   /** @deprecated Use {@link TERMINATE_IF_RUNNING} instead. */
-  WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING: 'TERMINATE_IF_RUNNING', // eslint-disable-line deprecation/deprecation
+  WORKFLOW_ID_REUSE_POLICY_TERMINATE_IF_RUNNING: 'TERMINATE_IF_RUNNING',
 } as const;
 export type WorkflowIdReusePolicy = (typeof WorkflowIdReusePolicy)[keyof typeof WorkflowIdReusePolicy];
 
@@ -79,7 +79,7 @@ export const [encodeWorkflowIdReusePolicy, decodeWorkflowIdReusePolicy] = makePr
     [WorkflowIdReusePolicy.ALLOW_DUPLICATE]: 1,
     [WorkflowIdReusePolicy.ALLOW_DUPLICATE_FAILED_ONLY]: 2,
     [WorkflowIdReusePolicy.REJECT_DUPLICATE]: 3,
-    [WorkflowIdReusePolicy.TERMINATE_IF_RUNNING]: 4, // eslint-disable-line deprecation/deprecation
+    [WorkflowIdReusePolicy.TERMINATE_IF_RUNNING]: 4, // eslint-disable-line @typescript-eslint/no-deprecated
     UNSPECIFIED: 0,
   } as const,
   'WORKFLOW_ID_REUSE_POLICY_'
@@ -93,7 +93,6 @@ export const [encodeWorkflowIdReusePolicy, decodeWorkflowIdReusePolicy] = makePr
  *
  * *Note: It is never possible to have two _actively running_ Workflows with the same ID.*
  */
-export type WorkflowIdConflictPolicy = (typeof WorkflowIdConflictPolicy)[keyof typeof WorkflowIdConflictPolicy];
 export const WorkflowIdConflictPolicy = {
   /**
    * Do not start a new Workflow. Instead raise a `WorkflowExecutionAlreadyStartedError`.
@@ -110,6 +109,7 @@ export const WorkflowIdConflictPolicy = {
    */
   TERMINATE_EXISTING: 'TERMINATE_EXISTING',
 } as const;
+export type WorkflowIdConflictPolicy = (typeof WorkflowIdConflictPolicy)[keyof typeof WorkflowIdConflictPolicy];
 
 export const [encodeWorkflowIdConflictPolicy, decodeWorkflowIdConflictPolicy] = makeProtoEnumConverters<
   temporal.api.enums.v1.WorkflowIdConflictPolicy,
@@ -133,7 +133,7 @@ export interface BaseWorkflowOptions {
    *
    * *Note: It is not possible to have two actively running Workflows with the same ID.*
    *
-   * @default {@link WorkflowIdReusePolicy.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE}
+   * @default WorkflowIdReusePolicy.WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE
    */
   workflowIdReusePolicy?: WorkflowIdReusePolicy;
 
@@ -142,7 +142,7 @@ export interface BaseWorkflowOptions {
    *
    * *Note: It is not possible to have two actively running Workflows with the same ID.*
    *
-   * @default {@link WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED}
+   * @default WorkflowIdConflictPolicy.WORKFLOW_ID_CONFLICT_POLICY_UNSPECIFIED
    */
   workflowIdConflictPolicy?: WorkflowIdConflictPolicy;
 
@@ -179,7 +179,7 @@ export interface BaseWorkflowOptions {
    *
    * @deprecated Use {@link typedSearchAttributes} instead.
    */
-  searchAttributes?: SearchAttributes; // eslint-disable-line deprecation/deprecation
+  searchAttributes?: SearchAttributes; // eslint-disable-line @typescript-eslint/no-deprecated
 
   /**
    * Specifies additional indexed information to attach to the Workflow Execution. More info: