@temporalio/common 1.11.8 → 1.12.0-rc.0

package/lib/metrics.d.ts

@@ -0,0 +1,181 @@
+/**
+ * A meter for creating metrics to record values on.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+export interface MetricMeter {
+    /**
+     * Create a new counter metric that supports adding values.
+     *
+     * @param name Name for the counter metric.
+     * @param unit Unit for the counter metric. Optional.
+     * @param description Description for the counter metric. Optional.
+     */
+    createCounter(name: string, unit?: string, description?: string): MetricCounter;
+    /**
+     * Create a new histogram metric that supports recording values.
+     *
+     * @param name Name for the histogram metric.
+     * @param valueType Type of value to record. Defaults to `int`.
+     * @param unit Unit for the histogram metric. Optional.
+     * @param description Description for the histogram metric. Optional.
+     */
+    createHistogram(name: string, valueType?: NumericMetricValueType, unit?: string, description?: string): MetricHistogram;
+    /**
+     * Create a new gauge metric that supports setting values.
+     *
+     * @param name Name for the gauge metric.
+     * @param valueType Type of value to set. Defaults to `int`.
+     * @param unit Unit for the gauge metric. Optional.
+     * @param description Description for the gauge metric. Optional.
+     */
+    createGauge(name: string, valueType?: NumericMetricValueType, unit?: string, description?: string): MetricGauge;
+    /**
+     * Return a clone of this meter, with additional tags. All metrics created off the meter will
+     * have the tags.
+     *
+     * @param tags Tags to append.
+     */
+    withTags(tags: MetricTags): MetricMeter;
+}
+/**
+ * Base interface for all metrics.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+export interface Metric {
+    /**
+     * The name of the metric.
+     */
+    name: string;
+    /**
+     * The unit of the metric, if any.
+     */
+    unit?: string;
+    /**
+     * The description of the metric, if any.
+     */
+    description?: string;
+}
+/**
+ * A metric that supports adding values as a counter.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+export interface MetricCounter extends Metric {
+    /**
+     * Add the given value to the counter.
+     *
+     * @param value Value to add.
+     * @param extraTags Extra tags if any.
+     */
+    add(value: number, extraTags?: MetricTags): void;
+    /**
+     * Return a clone of this counter, with additional tags.
+     *
+     * @param tags Tags to append to existing tags.
+     */
+    withTags(tags: MetricTags): MetricCounter;
+}
+/**
+ * A metric that supports recording values on a histogram.
+ *
+ * @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.
+     *
+     * @param value Value to record. Must be a non-negative number. Value will be casted to the given
+     *              {@link valueType}. Loss of precision may occur if the value is not already of the
+     *              correct type.
+     * @param extraTags Extra tags if any.
+     */
+    record(value: number, extraTags?: MetricTags): void;
+    /**
+     * Return a clone of this histogram, with additional tags.
+     *
+     * @param tags Tags to append to existing tags.
+     */
+    withTags(tags: MetricTags): MetricHistogram;
+}
+/**
+ * A metric that supports setting values.
+ *
+ * @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.
+     *
+     * @param value Value to set.
+     * @param extraTags Extra tags if any.
+     */
+    set(value: number, extraTags?: MetricTags): void;
+    /**
+     * Return a clone of this gauge, with additional tags.
+     *
+     * @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';
+/**
+ * A meter implementation that does nothing.
+ */
+declare class NoopMetricMeter implements MetricMeter {
+    createCounter(name: string, unit?: string, description?: string): MetricCounter;
+    createHistogram(name: string, valueType?: NumericMetricValueType, unit?: string, description?: string): MetricHistogram;
+    createGauge(name: string, valueType?: NumericMetricValueType, unit?: string, description?: string): MetricGauge;
+    withTags(_extraTags: MetricTags): MetricMeter;
+}
+export declare const noopMetricMeter: NoopMetricMeter;
+export type MetricTagsOrFunc = MetricTags | (() => MetricTags);
+/**
+ * A meter implementation that adds tags before delegating calls to a parent meter.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ * @internal
+ * @hidden
+ */
+export declare class MetricMeterWithComposedTags implements MetricMeter {
+    private readonly parentMeter;
+    private readonly contributors;
+    /**
+     * Return a {@link MetricMeter} that adds tags before delegating calls to a parent meter.
+     *
+     * New tags may either be specified statically as a delta object, or as a function evaluated
+     * every time a metric is recorded that will return a delta object.
+     *
+     * Some optimizations are performed to avoid creating unnecessary objects and to keep runtime
+     * overhead associated with resolving tags as low as possible.
+     *
+     * @param meter The parent meter to delegate calls to.
+     * @param tagsOrFunc New tags may either be specified statically as a delta object, or as a function
+     *                   evaluated every time a metric is recorded that will return a delta object.
+     * @param force if `true`, then a `MetricMeterWithComposedTags` will be created even if there
+     *              is no tags to add. This is useful to add tags support to an underlying meter
+     *              implementation that does not support tags directly.
+     */
+    static compose(meter: MetricMeter, tagsOrFunc: MetricTagsOrFunc, force?: boolean): MetricMeter;
+    private constructor();
+    createCounter(name: string, unit?: string, description?: string): MetricCounter;
+    createHistogram(name: string, valueType?: NumericMetricValueType, unit?: string, description?: string): MetricHistogram;
+    createGauge(name: string, valueType?: NumericMetricValueType, unit?: string, description?: string): MetricGauge;
+    withTags(tags: MetricTags): MetricMeter;
+}
+export {};

package/lib/metrics.js

@@ -0,0 +1,240 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetricMeterWithComposedTags = exports.noopMetricMeter = void 0;
+const internal_workflow_1 = require("./internal-workflow");
+////////////////////////////////////////////////////////////////////////////////////////////////////
+/**
+ * A meter implementation that does nothing.
+ */
+class NoopMetricMeter {
+    createCounter(name, unit, description) {
+        return {
+            name,
+            unit,
+            description,
+            add(_value, _extraTags) { },
+            withTags(_extraTags) {
+                return this;
+            },
+        };
+    }
+    createHistogram(name, valueType = 'int', unit, description) {
+        return {
+            name,
+            valueType,
+            unit,
+            description,
+            record(_value, _extraTags) { },
+            withTags(_extraTags) {
+                return this;
+            },
+        };
+    }
+    createGauge(name, valueType, unit, description) {
+        return {
+            name,
+            valueType: valueType ?? 'int',
+            unit,
+            description,
+            set(_value, _extraTags) { },
+            withTags(_extraTags) {
+                return this;
+            },
+        };
+    }
+    withTags(_extraTags) {
+        return this;
+    }
+}
+exports.noopMetricMeter = new NoopMetricMeter();
+/**
+ * A meter implementation that adds tags before delegating calls to a parent meter.
+ *
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ * @internal
+ * @hidden
+ */
+class MetricMeterWithComposedTags {
+    parentMeter;
+    contributors;
+    /**
+     * Return a {@link MetricMeter} that adds tags before delegating calls to a parent meter.
+     *
+     * New tags may either be specified statically as a delta object, or as a function evaluated
+     * every time a metric is recorded that will return a delta object.
+     *
+     * Some optimizations are performed to avoid creating unnecessary objects and to keep runtime
+     * overhead associated with resolving tags as low as possible.
+     *
+     * @param meter The parent meter to delegate calls to.
+     * @param tagsOrFunc New tags may either be specified statically as a delta object, or as a function
+     *                   evaluated every time a metric is recorded that will return a delta object.
+     * @param force if `true`, then a `MetricMeterWithComposedTags` will be created even if there
+     *              is no tags to add. This is useful to add tags support to an underlying meter
+     *              implementation that does not support tags directly.
+     */
+    static compose(meter, tagsOrFunc, force = false) {
+        if (meter instanceof MetricMeterWithComposedTags) {
+            const contributors = appendToChain(meter.contributors, tagsOrFunc);
+            // If the new contributor results in no actual change to the chain, then we don't need a new meter
+            if (contributors === undefined && !force)
+                return meter;
+            return new MetricMeterWithComposedTags(meter.parentMeter, contributors ?? []);
+        }
+        else {
+            const contributors = appendToChain(undefined, tagsOrFunc);
+            if (contributors === undefined && !force)
+                return meter;
+            return new MetricMeterWithComposedTags(meter, contributors ?? []);
+        }
+    }
+    constructor(parentMeter, contributors) {
+        this.parentMeter = parentMeter;
+        this.contributors = contributors;
+    }
+    createCounter(name, unit, description) {
+        const parentCounter = this.parentMeter.createCounter(name, unit, description);
+        return new MetricCounterWithComposedTags(parentCounter, this.contributors);
+    }
+    createHistogram(name, valueType = 'int', unit, description) {
+        const parentHistogram = this.parentMeter.createHistogram(name, valueType, unit, description);
+        return new MetricHistogramWithComposedTags(parentHistogram, this.contributors);
+    }
+    createGauge(name, valueType = 'int', unit, description) {
+        const parentGauge = this.parentMeter.createGauge(name, valueType, unit, description);
+        return new MetricGaugeWithComposedTags(parentGauge, this.contributors);
+    }
+    withTags(tags) {
+        return MetricMeterWithComposedTags.compose(this, tags);
+    }
+}
+exports.MetricMeterWithComposedTags = MetricMeterWithComposedTags;
+/**
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+class MetricCounterWithComposedTags {
+    parentCounter;
+    contributors;
+    constructor(parentCounter, contributors) {
+        this.parentCounter = parentCounter;
+        this.contributors = contributors;
+    }
+    add(value, extraTags) {
+        this.parentCounter.add(value, resolveTags(this.contributors, extraTags));
+    }
+    withTags(extraTags) {
+        const contributors = appendToChain(this.contributors, extraTags);
+        if (contributors === undefined)
+            return this;
+        return new MetricCounterWithComposedTags(this.parentCounter, contributors);
+    }
+    get name() {
+        return this.parentCounter.name;
+    }
+    get unit() {
+        return this.parentCounter.unit;
+    }
+    get description() {
+        return this.parentCounter.description;
+    }
+}
+/**
+ * @experimental The Metric API is an experimental feature and may be subject to change.
+ */
+class MetricHistogramWithComposedTags {
+    parentHistogram;
+    contributors;
+    constructor(parentHistogram, contributors) {
+        this.parentHistogram = parentHistogram;
+        this.contributors = contributors;
+    }
+    record(value, extraTags) {
+        this.parentHistogram.record(value, resolveTags(this.contributors, extraTags));
+    }
+    withTags(extraTags) {
+        const contributors = appendToChain(this.contributors, extraTags);
+        if (contributors === undefined)
+            return this;
+        return new MetricHistogramWithComposedTags(this.parentHistogram, contributors);
+    }
+    get name() {
+        return this.parentHistogram.name;
+    }
+    get valueType() {
+        return this.parentHistogram.valueType;
+    }
+    get unit() {
+        return this.parentHistogram.unit;
+    }
+    get description() {
+        return this.parentHistogram.description;
+    }
+}
+/**
+ * @internal
+ * @hidden
+ */
+class MetricGaugeWithComposedTags {
+    parentGauge;
+    contributors;
+    constructor(parentGauge, contributors) {
+        this.parentGauge = parentGauge;
+        this.contributors = contributors;
+    }
+    set(value, extraTags) {
+        this.parentGauge.set(value, resolveTags(this.contributors, extraTags));
+    }
+    withTags(extraTags) {
+        const contributors = appendToChain(this.contributors, extraTags);
+        if (contributors === undefined)
+            return this;
+        return new MetricGaugeWithComposedTags(this.parentGauge, contributors);
+    }
+    get name() {
+        return this.parentGauge.name;
+    }
+    get valueType() {
+        return this.parentGauge.valueType;
+    }
+    get unit() {
+        return this.parentGauge.unit;
+    }
+    get description() {
+        return this.parentGauge.description;
+    }
+}
+function resolveTags(contributors, extraTags) {
+    const resolved = {};
+    for (const contributor of contributors) {
+        Object.assign(resolved, typeof contributor === 'function' ? contributor() : contributor);
+    }
+    Object.assign(resolved, extraTags);
+    return (0, internal_workflow_1.filterNullAndUndefined)(resolved);
+}
+/**
+ * Append a tags contributor to the chain, merging it with the former last contributor if possible.
+ *
+ * If appending the new contributor results in no actual change to the chain of contributors, return
+ * `existingContributors`; in that case, the caller should avoid creating a new object if possible.
+ */
+function appendToChain(existingContributors, newContributor) {
+    // If the new contributor is an empty object, then it results in no actual change to the chain
+    if (typeof newContributor === 'object' && Object.keys(newContributor).length === 0) {
+        return existingContributors;
+    }
+    // If existing chain is empty, then the new contributor is the chain
+    if (existingContributors == null || existingContributors.length === 0) {
+        return [newContributor];
+    }
+    // If both last contributor and new contributor are plain objects, merge them to a single object.
+    const last = existingContributors[existingContributors.length - 1];
+    if (typeof last === 'object' && typeof newContributor === 'object') {
+        const merged = (0, internal_workflow_1.mergeObjects)(last, newContributor);
+        if (merged === last)
+            return existingContributors;
+        return [...existingContributors.slice(0, -1), merged];
+    }
+    // Otherwise, just append the new contributor to the chain.
+    return [...existingContributors, newContributor];
+}
+//# sourceMappingURL=metrics.js.map

package/lib/metrics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metrics.js","sourceRoot":"","sources":["../src/metrics.ts"],"names":[],"mappings":";;;AAAA,2DAA2E;AAgK3E,oGAAoG;AAEpG;;GAEG;AACH,MAAM,eAAe;IACnB,aAAa,CAAC,IAAY,EAAE,IAAa,EAAE,WAAoB;QAC7D,OAAO;YACL,IAAI;YACJ,IAAI;YACJ,WAAW;YAEX,GAAG,CAAC,MAAM,EAAE,UAAU,IAAG,CAAC;YAE1B,QAAQ,CAAC,UAAU;gBACjB,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC;IACJ,CAAC;IAED,eAAe,CACb,IAAY,EACZ,YAAoC,KAAK,EACzC,IAAa,EACb,WAAoB;QAEpB,OAAO;YACL,IAAI;YACJ,SAAS;YACT,IAAI;YACJ,WAAW;YAEX,MAAM,CAAC,MAAM,EAAE,UAAU,IAAG,CAAC;YAE7B,QAAQ,CAAC,UAAU;gBACjB,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,IAAY,EAAE,SAAkC,EAAE,IAAa,EAAE,WAAoB;QAC/F,OAAO;YACL,IAAI;YACJ,SAAS,EAAE,SAAS,IAAI,KAAK;YAC7B,IAAI;YACJ,WAAW;YAEX,GAAG,CAAC,MAAM,EAAE,UAAU,IAAG,CAAC;YAE1B,QAAQ,CAAC,UAAU;gBACjB,OAAO,IAAI,CAAC;YACd,CAAC;SACF,CAAC;IACJ,CAAC;IAED,QAAQ,CAAC,UAAsB;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAEY,QAAA,eAAe,GAAG,IAAI,eAAe,EAAE,CAAC;AAMrD;;;;;;GAMG;AACH,MAAa,2BAA2B;IA+BnB;IACA;IA/BnB;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,OAAO,CAAC,KAAkB,EAAE,UAA4B,EAAE,QAAiB,KAAK;QAC5F,IAAI,KAAK,YAAY,2BAA2B,EAAE,CAAC;YACjD,MAAM,YAAY,GAAG,aAAa,CAAC,KAAK,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;YACnE,kGAAkG;YAClG,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,KAAK;gBAAE,OAAO,KAAK,CAAC;YACvD,OAAO,IAAI,2BAA2B,CAAC,KAAK,CAAC,WAAW,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC;QAChF,CAAC;aAAM,CAAC;YACN,MAAM,YAAY,GAAG,aAAa,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;YAC1D,IAAI,YAAY,KAAK,SAAS,IAAI,CAAC,KAAK;gBAAE,OAAO,KAAK,CAAC;YACvD,OAAO,IAAI,2BAA2B,CAAC,KAAK,EAAE,YAAY,IAAI,EAAE,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAED,YACmB,WAAwB,EACxB,YAAgC;QADhC,gBAAW,GAAX,WAAW,CAAa;QACxB,iBAAY,GAAZ,YAAY,CAAoB;IAChD,CAAC;IAEJ,aAAa,CAAC,IAAY,EAAE,IAAa,EAAE,WAAoB;QAC7D,MAAM,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QAC9E,OAAO,IAAI,6BAA6B,CAAC,aAAa,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7E,CAAC;IAED,eAAe,CACb,IAAY,EACZ,YAAoC,KAAK,EACzC,IAAa,EACb,WAAoB;QAEpB,MAAM,eAAe,GAAG,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QAC7F,OAAO,IAAI,+BAA+B,CAAC,eAAe,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACjF,CAAC;IAED,WAAW,CACT,IAAY,EACZ,YAAoC,KAAK,EACzC,IAAa,EACb,WAAoB;QAEpB,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,WAAW,CAAC,CAAC;QACrF,OAAO,IAAI,2BAA2B,CAAC,WAAW,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACzE,CAAC;IAED,QAAQ,CAAC,IAAgB;QACvB,OAAO,2BAA2B,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACzD,CAAC;CACF;AA/DD,kEA+DC;AAED;;GAEG;AACH,MAAM,6BAA6B;IAEvB;IACA;IAFV,YACU,aAA4B,EAC5B,YAAgC;QADhC,kBAAa,GAAb,aAAa,CAAe;QAC5B,iBAAY,GAAZ,YAAY,CAAoB;IACvC,CAAC;IAEJ,GAAG,CAAC,KAAa,EAAE,SAAkC;QACnD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,QAAQ,CAAC,SAAqB;QAC5B,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QACjE,IAAI,YAAY,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QAC5C,OAAO,IAAI,6BAA6B,CAAC,IAAI,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC;IAC7E,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;IACjC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;IACjC,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;IACxC,CAAC;CACF;AAED;;GAEG;AACH,MAAM,+BAA+B;IAEzB;IACA;IAFV,YACU,eAAgC,EAChC,YAAgC;QADhC,oBAAe,GAAf,eAAe,CAAiB;QAChC,iBAAY,GAAZ,YAAY,CAAoB;IACvC,CAAC;IAEJ,MAAM,CAAC,KAAa,EAAE,SAAsB;QAC1C,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IAChF,CAAC;IAED,QAAQ,CAAC,SAAqB;QAC5B,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QACjE,IAAI,YAAY,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QAC5C,OAAO,IAAI,+BAA+B,CAAC,IAAI,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IACjF,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;IACnC,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,CAAC;IACxC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC;IACnC,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC;IAC1C,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,2BAA2B;IAErB;IACA;IAFV,YACU,WAAwB,EACxB,YAAgC;QADhC,gBAAW,GAAX,WAAW,CAAa;QACxB,iBAAY,GAAZ,YAAY,CAAoB;IACvC,CAAC;IAEJ,GAAG,CAAC,KAAa,EAAE,SAAsB;QACvC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,QAAQ,CAAC,SAAqB;QAC5B,MAAM,YAAY,GAAG,aAAa,CAAC,IAAI,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QACjE,IAAI,YAAY,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QAC5C,OAAO,IAAI,2BAA2B,CAAC,IAAI,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACzE,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC;IACpC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IAC/B,CAAC;IAED,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC;IACtC,CAAC;CACF;AAED,SAAS,WAAW,CAAC,YAAgC,EAAE,SAAsB;IAC3E,MAAM,QAAQ,GAAG,EAAE,CAAC;IACpB,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,WAAW,KAAK,UAAU,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC;IAC3F,CAAC;IACD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;IACnC,OAAO,IAAA,0CAAsB,EAAC,QAAQ,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,SAAS,aAAa,CACpB,oBAAoD,EACpD,cAAgC;IAEhC,8FAA8F;IAC9F,IAAI,OAAO,cAAc,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnF,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAED,oEAAoE;IACpE,IAAI,oBAAoB,IAAI,IAAI,IAAI,oBAAoB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtE,OAAO,CAAC,cAAc,CAAC,CAAC;IAC1B,CAAC;IAED,iGAAiG;IACjG,MAAM,IAAI,GAAG,oBAAoB,CAAC,oBAAoB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IACnE,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,cAAc,KAAK,QAAQ,EAAE,CAAC;QACnE,MAAM,MAAM,GAAG,IAAA,gCAAY,EAAC,IAAI,EAAE,cAAc,CAAC,CAAC;QAClD,IAAI,MAAM,KAAK,IAAI;YAAE,OAAO,oBAAoB,CAAC;QACjD,OAAO,CAAC,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,MAAO,CAAC,CAAC;IACzD,CAAC;IAED,2DAA2D;IAC3D,OAAO,CAAC,GAAG,oBAAoB,EAAE,cAAc,CAAC,CAAC;AACnD,CAAC"}

package/lib/priority.d.ts

@@ -0,0 +1,36 @@
+import type { temporal } from '@temporalio/proto';
+/**
+ * Priority contains metadata that controls relative ordering of task processing when tasks are
+ * backlogged in a queue. Initially, Priority will be used in activity and workflow task queues,
+ * which are typically where backlogs exist.
+ * Priority is (for now) attached to workflows and activities. Activities and child workflows
+ * inherit Priority from the workflow that created them, but may override fields when they are
+ * started or modified. For each field of a Priority on an activity/workflow, not present or equal
+ * to zero/empty string means to inherit the value from the calling workflow, or if there is no
+ * calling workflow, then use the default (documented on the field).
+ * The overall semantics of Priority are:
+ * 1. First, consider "priority_key": lower number goes first.
+ * (more will be added here later)
+ */
+export interface Priority {
+    /**
+     * Priority key is a positive integer from 1 to n, where smaller integers
+     * correspond to higher priorities (tasks run sooner). In general, tasks in
+     * a queue should be processed in close to priority order, although small
+     * deviations are possible.
+     *
+     * The maximum priority value (minimum priority) is determined by server configuration, and
+     * defaults to 5.
+     *
+     * The default priority is (min+max)/2. With the default max of 5 and min of 1, that comes out to 3.
+     */
+    priorityKey?: number;
+}
+/**
+ * Turn a proto compatible Priority into a TS Priority
+ */
+export declare function decodePriority(priority?: temporal.api.common.v1.IPriority | null): Priority;
+/**
+ * Turn a TS Priority into a proto compatible Priority
+ */
+export declare function compilePriority(priority: Priority): temporal.api.common.v1.IPriority;

package/lib/priority.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodePriority = decodePriority;
+exports.compilePriority = compilePriority;
+/**
+ * Turn a proto compatible Priority into a TS Priority
+ */
+function decodePriority(priority) {
+    return { priorityKey: priority?.priorityKey ?? undefined };
+}
+/**
+ * Turn a TS Priority into a proto compatible Priority
+ */
+function compilePriority(priority) {
+    if (priority.priorityKey !== undefined && priority.priorityKey !== null) {
+        if (!Number.isInteger(priority.priorityKey)) {
+            throw new TypeError('priorityKey must be an integer');
+        }
+        if (priority.priorityKey < 0) {
+            throw new RangeError('priorityKey must be a positive integer');
+        }
+    }
+    return {
+        priorityKey: priority.priorityKey ?? 0,
+    };
+}
+//# sourceMappingURL=priority.js.map

package/lib/priority.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"priority.js","sourceRoot":"","sources":["../src/priority.ts"],"names":[],"mappings":";;AAiCA,wCAEC;AAKD,0CAaC;AAvBD;;GAEG;AACH,SAAgB,cAAc,CAAC,QAAkD;IAC/E,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,IAAI,SAAS,EAAE,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,QAAkB;IAChD,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,IAAI,QAAQ,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;QACxE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;YAC5C,MAAM,IAAI,SAAS,CAAC,gCAAgC,CAAC,CAAC;QACxD,CAAC;QACD,IAAI,QAAQ,CAAC,WAAW,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,UAAU,CAAC,wCAAwC,CAAC,CAAC;QACjE,CAAC;IACH,CAAC;IAED,OAAO;QACL,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,CAAC;KACvC,CAAC;AACJ,CAAC"}

package/lib/search-attributes.d.ts

@@ -0,0 +1,77 @@
+import type { temporal } from '@temporalio/proto';
+/** @deprecated: Use {@link TypedSearchAttributes} instead */
+export type SearchAttributeValueOrReadonly = SearchAttributeValue | Readonly<SearchAttributeValue> | undefined;
+/** @deprecated: Use {@link TypedSearchAttributes} instead */
+export type SearchAttributes = Record<string, SearchAttributeValueOrReadonly>;
+/** @deprecated: Use {@link TypedSearchAttributes} instead */
+export type SearchAttributeValue = string[] | number[] | boolean[] | Date[];
+export declare const SearchAttributeType: {
+    readonly TEXT: "TEXT";
+    readonly KEYWORD: "KEYWORD";
+    readonly INT: "INT";
+    readonly DOUBLE: "DOUBLE";
+    readonly BOOL: "BOOL";
+    readonly DATETIME: "DATETIME";
+    readonly KEYWORD_LIST: "KEYWORD_LIST";
+};
+export type SearchAttributeType = (typeof SearchAttributeType)[keyof typeof SearchAttributeType];
+export declare const encodeSearchAttributeIndexedValueType: (input: "TEXT" | "KEYWORD" | "INT" | "DOUBLE" | "BOOL" | "DATETIME" | "KEYWORD_LIST" | temporal.api.enums.v1.IndexedValueType | "INDEXED_VALUE_TYPE_TEXT" | "INDEXED_VALUE_TYPE_KEYWORD" | "INDEXED_VALUE_TYPE_INT" | "INDEXED_VALUE_TYPE_DOUBLE" | "INDEXED_VALUE_TYPE_BOOL" | "INDEXED_VALUE_TYPE_DATETIME" | "INDEXED_VALUE_TYPE_KEYWORD_LIST" | null | undefined) => temporal.api.enums.v1.IndexedValueType | undefined, _: (input: temporal.api.enums.v1.IndexedValueType | null | undefined) => "TEXT" | "KEYWORD" | "INT" | "DOUBLE" | "BOOL" | "DATETIME" | "KEYWORD_LIST" | undefined;
+interface IndexedValueTypeMapping {
+    TEXT: string;
+    KEYWORD: string;
+    INT: number;
+    DOUBLE: number;
+    BOOL: boolean;
+    DATETIME: Date;
+    KEYWORD_LIST: string[];
+}
+export declare function isValidValueForType<T extends SearchAttributeType>(type: T, value: unknown): value is IndexedValueTypeMapping[T];
+export interface SearchAttributeKey<T extends SearchAttributeType> {
+    name: string;
+    type: T;
+}
+export declare function defineSearchAttributeKey<T extends SearchAttributeType>(name: string, type: T): SearchAttributeKey<T>;
+declare class BaseSearchAttributeValue<T extends SearchAttributeType, V = IndexedValueTypeMapping[T]> {
+    private readonly _type;
+    private readonly _value;
+    constructor(type: T, value: V);
+    get type(): T;
+    get value(): V;
+}
+export declare class TypedSearchAttributeValue<T extends SearchAttributeType> extends BaseSearchAttributeValue<T> {
+}
+export declare class TypedSearchAttributeUpdateValue<T extends SearchAttributeType> extends BaseSearchAttributeValue<T, IndexedValueTypeMapping[T] | null> {
+}
+export type SearchAttributePair = {
+    [T in SearchAttributeType]: {
+        key: SearchAttributeKey<T>;
+        value: IndexedValueTypeMapping[T];
+    };
+}[SearchAttributeType];
+export type SearchAttributeUpdatePair = {
+    [T in SearchAttributeType]: {
+        key: SearchAttributeKey<T>;
+        value: IndexedValueTypeMapping[T] | null;
+    };
+}[SearchAttributeType];
+export declare class TypedSearchAttributes {
+    private searchAttributes;
+    constructor(initialAttributes?: SearchAttributePair[]);
+    get<T extends SearchAttributeType>(key: SearchAttributeKey<T>): IndexedValueTypeMapping[T] | undefined;
+    /** Returns a deep copy of the given TypedSearchAttributes instance */
+    copy(): TypedSearchAttributes;
+    /**
+     * @hidden
+     * Return JSON representation of this class as SearchAttributePair[]
+     * Default toJSON method is not used because it's JSON representation includes private state.
+     */
+    toJSON(): SearchAttributePair[];
+    /** Returns a copy of the current TypedSearchAttributes instance with the updated attributes. */
+    updateCopy(updates: SearchAttributeUpdatePair[]): TypedSearchAttributes;
+    private update;
+    getAll(): SearchAttributePair[];
+    static getKeyFromUntyped(key: string, value: SearchAttributeValueOrReadonly): SearchAttributeKey<SearchAttributeType> | undefined;
+    static toMetadataType(type: SearchAttributeType): string;
+    static toSearchAttributeType(type: string): SearchAttributeType | undefined;
+}
+export {};