@temporalio/client 1.4.4 → 1.5.0

package/lib/helpers.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executionInfoFromRaw = void 0;
+const common_1 = require("@temporalio/common");
+const time_1 = require("@temporalio/common/lib/time");
+const codec_helpers_1 = require("@temporalio/common/lib/internal-non-workflow/codec-helpers");
+const proto_1 = require("@temporalio/proto");
+function workflowStatusCodeToName(code) {
+    return workflowStatusCodeToNameInternal(code) ?? 'UNKNOWN';
+}
+/**
+ * Intentionally leave out `default` branch to get compilation errors when new values are added
+ */
+function workflowStatusCodeToNameInternal(code) {
+    switch (code) {
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_UNSPECIFIED:
+            return 'UNSPECIFIED';
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_RUNNING:
+            return 'RUNNING';
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_FAILED:
+            return 'FAILED';
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_TIMED_OUT:
+            return 'TIMED_OUT';
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_CANCELED:
+            return 'CANCELLED';
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_TERMINATED:
+            return 'TERMINATED';
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_COMPLETED:
+            return 'COMPLETED';
+        case proto_1.temporal.api.enums.v1.WorkflowExecutionStatus.WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW:
+            return 'CONTINUED_AS_NEW';
+    }
+}
+async function executionInfoFromRaw(raw, dataConverter) {
+    return {
+        /* eslint-disable @typescript-eslint/no-non-null-assertion */
+        type: raw.type.name,
+        workflowId: raw.execution.workflowId,
+        runId: raw.execution.runId,
+        taskQueue: raw.taskQueue,
+        status: {
+            code: raw.status,
+            name: workflowStatusCodeToName(raw.status),
+        },
+        // Safe to convert to number, max history length is 50k, which is much less than Number.MAX_SAFE_INTEGER
+        historyLength: raw.historyLength.toNumber(),
+        startTime: (0, time_1.tsToDate)(raw.startTime),
+        executionTime: (0, time_1.optionalTsToDate)(raw.executionTime),
+        closeTime: (0, time_1.optionalTsToDate)(raw.closeTime),
+        memo: await (0, codec_helpers_1.decodeMapFromPayloads)(dataConverter, raw.memo?.fields),
+        searchAttributes: Object.fromEntries(Object.entries((0, common_1.mapFromPayloads)(common_1.searchAttributePayloadConverter, raw.searchAttributes?.indexedFields ?? {})).filter(([_, v]) => v && v.length > 0) // Filter out empty arrays returned by pre 1.18 servers
+        ),
+        parentExecution: raw.parentExecution
+            ? {
+                workflowId: raw.parentExecution.workflowId,
+                runId: raw.parentExecution.runId,
+            }
+            : undefined,
+        raw,
+    };
+}
+exports.executionInfoFromRaw = executionInfoFromRaw;
+//# sourceMappingURL=helpers.js.map

package/lib/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":";;;AAAA,+CAK4B;AAC5B,sDAAyE;AACzE,8FAAmG;AACnG,6CAA6C;AAG7C,SAAS,wBAAwB,CAAC,IAAmD;IACnF,OAAO,gCAAgC,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC;AAC7D,CAAC;AAED;;GAEG;AACH,SAAS,gCAAgC,CACvC,IAAmD;IAEnD,QAAQ,IAAI,EAAE;QACZ,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,qCAAqC;YACtF,OAAO,aAAa,CAAC;QACvB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,iCAAiC;YAClF,OAAO,SAAS,CAAC;QACnB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,gCAAgC;YACjF,OAAO,QAAQ,CAAC;QAClB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,mCAAmC;YACpF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,kCAAkC;YACnF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,oCAAoC;YACrF,OAAO,YAAY,CAAC;QACtB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,mCAAmC;YACpF,OAAO,WAAW,CAAC;QACrB,KAAK,gBAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,uBAAuB,CAAC,0CAA0C;YAC3F,OAAO,kBAAkB,CAAC;KAC7B;AACH,CAAC;AAEM,KAAK,UAAU,oBAAoB,CACxC,GAA6B,EAC7B,aAAkC;IAElC,OAAO;QACL,6DAA6D;QAC7D,IAAI,EAAE,GAAG,CAAC,IAAK,CAAC,IAAK;QACrB,UAAU,EAAE,GAAG,CAAC,SAAU,CAAC,UAAW;QACtC,KAAK,EAAE,GAAG,CAAC,SAAU,CAAC,KAAM;QAC5B,SAAS,EAAE,GAAG,CAAC,SAAU;QACzB,MAAM,EAAE;YACN,IAAI,EAAE,GAAG,CAAC,MAAO;YACjB,IAAI,EAAE,wBAAwB,CAAC,GAAG,CAAC,MAAO,CAAC;SAC5C;QACD,wGAAwG;QACxG,aAAa,EAAE,GAAG,CAAC,aAAc,CAAC,QAAQ,EAAE;QAC5C,SAAS,EAAE,IAAA,eAAQ,EAAC,GAAG,CAAC,SAAU,CAAC;QACnC,aAAa,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,aAAa,CAAC;QAClD,SAAS,EAAE,IAAA,uBAAgB,EAAC,GAAG,CAAC,SAAS,CAAC;QAC1C,IAAI,EAAE,MAAM,IAAA,qCAAqB,EAAC,aAAa,EAAE,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC;QAClE,gBAAgB,EAAE,MAAM,CAAC,WAAW,CAClC,MAAM,CAAC,OAAO,CACZ,IAAA,wBAAe,EAAC,wCAA+B,EAAE,GAAG,CAAC,gBAAgB,EAAE,aAAa,IAAI,EAAE,CAAqB,CAChH,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,uDAAuD;SAChG;QACD,eAAe,EAAE,GAAG,CAAC,eAAe;YAClC,CAAC,CAAC;gBACE,UAAU,EAAE,GAAG,CAAC,eAAe,CAAC,UAAW;gBAC3C,KAAK,EAAE,GAAG,CAAC,eAAe,CAAC,KAAM;aAClC;YACH,CAAC,CAAC,SAAS;QACb,GAAG;KACJ,CAAC;AACJ,CAAC;AAjCD,oDAiCC"}

package/lib/index.d.ts

@@ -22,3 +22,5 @@ export * from './interceptors';
 export * from './types';
 export * from './workflow-client';
 export * from './workflow-options';
+export * from './schedule-types';
+export * from './schedule-client';

package/lib/index.js

@@ -49,4 +49,6 @@ __exportStar(require("./interceptors"), exports);
 __exportStar(require("./types"), exports);
 __exportStar(require("./workflow-client"), exports);
 __exportStar(require("./workflow-options"), exports);
+__exportStar(require("./schedule-types"), exports);
+__exportStar(require("./schedule-client"), exports);
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"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"}
+{"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;AACnC,mDAAiC;AACjC,oDAAkC"}

package/lib/interceptors.d.ts

@@ -5,24 +5,25 @@
  */
 import { Headers, Next } from '@temporalio/common';
 import { temporal } from '@temporalio/proto';
+import { CompiledScheduleOptions } from './schedule-types';
 import { DescribeWorkflowExecutionResponse, RequestCancelWorkflowExecutionResponse, TerminateWorkflowExecutionResponse, WorkflowExecution } from './types';
 import { CompiledWorkflowOptions } from './workflow-options';
 export { Next, Headers };
-/** Input for WorkflowClientCallsInterceptor.start */
+/** Input for WorkflowClientInterceptor.start */
 export interface WorkflowStartInput {
     /** Name of Workflow to start */
     readonly workflowType: string;
     readonly headers: Headers;
     readonly options: CompiledWorkflowOptions;
 }
-/** Input for WorkflowClientCallsInterceptor.signal */
+/** Input for WorkflowClientInterceptor.signal */
 export interface WorkflowSignalInput {
     readonly signalName: string;
     readonly args: unknown[];
     readonly workflowExecution: WorkflowExecution;
     readonly headers: Headers;
 }
-/** Input for WorkflowClientCallsInterceptor.signalWithStart */
+/** Input for WorkflowClientInterceptor.signalWithStart */
 export interface WorkflowSignalWithStartInput {
     readonly workflowType: string;
     readonly signalName: string;
@@ -30,7 +31,7 @@ export interface WorkflowSignalWithStartInput {
     readonly headers: Headers;
     readonly options: CompiledWorkflowOptions;
 }
-/** Input for WorkflowClientCallsInterceptor.query */
+/** Input for WorkflowClientInterceptor.query */
 export interface WorkflowQueryInput {
     readonly queryType: string;
     readonly args: unknown[];
@@ -38,26 +39,26 @@ export interface WorkflowQueryInput {
     readonly queryRejectCondition?: temporal.api.enums.v1.QueryRejectCondition;
     readonly headers: Headers;
 }
-/** Input for WorkflowClientCallsInterceptor.terminate */
+/** Input for WorkflowClientInterceptor.terminate */
 export interface WorkflowTerminateInput {
     readonly workflowExecution: WorkflowExecution;
     readonly reason?: string;
     readonly details?: unknown[];
     readonly firstExecutionRunId?: string;
 }
-/** Input for WorkflowClientCallsInterceptor.cancel */
+/** Input for WorkflowClientInterceptor.cancel */
 export interface WorkflowCancelInput {
     readonly workflowExecution: WorkflowExecution;
     readonly firstExecutionRunId?: string;
 }
-/** Input for WorkflowClientCallsInterceptor.describe */
+/** Input for WorkflowClientInterceptor.describe */
 export interface WorkflowDescribeInput {
     readonly workflowExecution: WorkflowExecution;
 }
 /**
  * Implement any of these methods to intercept WorkflowClient outbound calls
  */
-export interface WorkflowClientCallsInterceptor {
+export interface WorkflowClientInterceptor {
     /**
      * Intercept a service call to startWorkflowExecution
      *
@@ -93,27 +94,62 @@ export interface WorkflowClientCallsInterceptor {
      */
     describe?: (input: WorkflowDescribeInput, next: Next<this, 'describe'>) => Promise<DescribeWorkflowExecutionResponse>;
 }
+/** @deprecated: Use WorkflowClientInterceptor instead */
+export declare type WorkflowClientCallsInterceptor = WorkflowClientInterceptor;
+/** @deprecated */
 export interface WorkflowClientCallsInterceptorFactoryInput {
     workflowId: string;
     runId?: string;
 }
 /**
  * A function that takes {@link CompiledWorkflowOptions} and returns an interceptor
+ *
+ * @deprecated: Please define interceptors directly, without factory
  */
 export interface WorkflowClientCallsInterceptorFactory {
     (input: WorkflowClientCallsInterceptorFactoryInput): WorkflowClientCallsInterceptor;
 }
 /**
  * A mapping of interceptor type of a list of factory functions
+ *
+ * @deprecated: Please define interceptors directly, without factory
  */
 export interface WorkflowClientInterceptors {
+    /** @deprecated */
     calls?: WorkflowClientCallsInterceptorFactory[];
 }
+/**
+ * Implement any of these methods to intercept ScheduleClient outbound calls
+ *
+ * @experimental
+ */
+export interface ScheduleClientInterceptor {
+    /**
+     * Intercept a service call to CreateSchedule
+     */
+    create?: (input: CreateScheduleInput, next: Next<this, 'create'>) => Promise<CreateScheduleOutput>;
+}
+/**
+ * Input for {@link ScheduleClientInterceptor.create}
+ *
+ * @experimental
+ */
+export interface CreateScheduleInput {
+    readonly headers: Headers;
+    readonly options: CompiledScheduleOptions;
+}
+export declare type CreateScheduleOutput = {
+    readonly conflictToken: Uint8Array;
+};
 /**
  * Interceptors for any high-level SDK client.
  *
- * NOTE: Currently only for {@link WorkflowClient}. More will be added later as needed.
+ * NOTE: Currently only for {@link WorkflowClient} and {@link ScheduleClient}. More will be added later as needed.
  */
 export interface ClientInterceptors {
-    workflow?: WorkflowClientInterceptors;
+    workflow?: WorkflowClientInterceptors | WorkflowClientInterceptor[];
+    /**
+     * @experimental
+     */
+    schedule?: ScheduleClientInterceptor[];
 }

package/lib/iterators-utils.d.ts

@@ -0,0 +1,31 @@
+export interface MapAsyncOptions {
+    /**
+     * How many items to map concurrently. If set to less than 2 (or not set), then items are not mapped concurrently.
+     *
+     * When items are mapped concurrently, mapped items are returned by the resulting iterator in the order they complete
+     * mapping, not the order in which the corresponding source items were obtained from the source iterator.
+     *
+     * @default 1 (ie. items are not mapped concurrently)
+     */
+    concurrency?: number;
+    /**
+     * Maximum number of mapped items to keep in buffer, ready for consumption.
+     *
+     * Ignored unless `concurrency > 1`. No limit applies if set to `undefined`.
+     *
+     * @default unlimited
+     */
+    bufferLimit?: number | undefined;
+}
+/**
+ * Return an async iterable that transforms items from a source iterable by mapping each item
+ * through a mapping function.
+ *
+ * If `concurrency > 1`, then up to `concurrency` items may be mapped concurrently. In that case,
+ * items are returned by the resulting iterator in the order they complete processing, not the order
+ * in which the corresponding source items were obtained from the source iterator.
+ *
+ * @param source the source async iterable
+ * @param mapFn a mapping function to apply on every item of the source iterable
+ */
+export declare function mapAsyncIterable<A, B>(source: AsyncIterable<A>, mapFn: (val: A) => Promise<B>, options?: MapAsyncOptions): AsyncIterable<B>;

package/lib/iterators-utils.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapAsyncIterable = void 0;
+const node_events_1 = require("node:events");
+const abort_controller_1 = require("abort-controller");
+function toAsyncIterator(iterable) {
+    return iterable[Symbol.asyncIterator]();
+}
+/**
+ * Return an async iterable that transforms items from a source iterable by mapping each item
+ * through a mapping function.
+ *
+ * If `concurrency > 1`, then up to `concurrency` items may be mapped concurrently. In that case,
+ * items are returned by the resulting iterator in the order they complete processing, not the order
+ * in which the corresponding source items were obtained from the source iterator.
+ *
+ * @param source the source async iterable
+ * @param mapFn a mapping function to apply on every item of the source iterable
+ */
+async function* mapAsyncIterable(source, mapFn, options) {
+    const { concurrency, bufferLimit } = options ?? {};
+    if (!concurrency || concurrency < 2) {
+        for await (const x of source) {
+            yield mapFn(x);
+        }
+        return;
+    }
+    const sourceIterator = toAsyncIterator(source);
+    const emitter = new node_events_1.EventEmitter();
+    const controller = new abort_controller_1.AbortController();
+    const emitterEventsIterable = (0, node_events_1.on)(emitter, 'result', { signal: controller.signal });
+    const emitterError = (0, node_events_1.once)(emitter, 'error');
+    const bufferLimitSemaphore = typeof bufferLimit === 'number'
+        ? (() => {
+            const releaseEvents = toAsyncIterator((0, node_events_1.on)(emitter, 'released', { signal: controller.signal }));
+            let value = bufferLimit + concurrency;
+            return {
+                acquire: async () => {
+                    while (value <= 0) {
+                        await Promise.race([releaseEvents.next(), emitterError]);
+                    }
+                    value--;
+                },
+                release: () => {
+                    value++;
+                    emitter.emit('released');
+                },
+            };
+        })()
+        : undefined;
+    const mapper = async () => {
+        for (;;) {
+            await bufferLimitSemaphore?.acquire();
+            const val = await Promise.race([sourceIterator.next(), emitterError]);
+            if (Array.isArray(val))
+                return;
+            if (val?.done)
+                return;
+            emitter.emit('result', await mapFn(val.value));
+        }
+    };
+    const mappers = Array(concurrency)
+        .fill(mapper)
+        .map((f) => f());
+    Promise.all(mappers).then(() => controller.abort(), (err) => emitter.emit('error', err));
+    try {
+        for await (const [res] of emitterEventsIterable) {
+            bufferLimitSemaphore?.release();
+            yield res;
+        }
+    }
+    catch (err) {
+        if (err?.name === 'AbortError') {
+            return;
+        }
+        throw err;
+    }
+}
+exports.mapAsyncIterable = mapAsyncIterable;
+//# sourceMappingURL=iterators-utils.js.map

package/lib/iterators-utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterators-utils.js","sourceRoot":"","sources":["../src/iterators-utils.ts"],"names":[],"mappings":";;;AAAA,6CAAqD;AACrD,uDAAmD;AAuBnD,SAAS,eAAe,CAAI,QAA0B;IACpD,OAAO,QAAQ,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,CAAC;AAC1C,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,SAAS,CAAC,CAAC,gBAAgB,CACrC,MAAwB,EACxB,KAA6B,EAC7B,OAAyB;IAEzB,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAEnD,IAAI,CAAC,WAAW,IAAI,WAAW,GAAG,CAAC,EAAE;QACnC,IAAI,KAAK,EAAE,MAAM,CAAC,IAAI,MAAM,EAAE;YAC5B,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC;SAChB;QACD,OAAO;KACR;IAED,MAAM,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IAE/C,MAAM,OAAO,GAAG,IAAI,0BAAY,EAAE,CAAC;IACnC,MAAM,UAAU,GAAG,IAAI,kCAAe,EAAE,CAAC;IACzC,MAAM,qBAAqB,GAAuB,IAAA,gBAAE,EAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;IACvG,MAAM,YAAY,GAAuB,IAAA,kBAAI,EAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEhE,MAAM,oBAAoB,GACxB,OAAO,WAAW,KAAK,QAAQ;QAC7B,CAAC,CAAC,CAAC,GAAG,EAAE;YACJ,MAAM,aAAa,GAAwB,eAAe,CACxD,IAAA,gBAAE,EAAC,OAAO,EAAE,UAAU,EAAE,EAAE,MAAM,EAAE,UAAU,CAAC,MAAM,EAAE,CAAC,CACvD,CAAC;YACF,IAAI,KAAK,GAAG,WAAW,GAAG,WAAW,CAAC;YAEtC,OAAO;gBACL,OAAO,EAAE,KAAK,IAAI,EAAE;oBAClB,OAAO,KAAK,IAAI,CAAC,EAAE;wBACjB,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC;qBAC1D;oBACD,KAAK,EAAE,CAAC;gBACV,CAAC;gBACD,OAAO,EAAE,GAAG,EAAE;oBACZ,KAAK,EAAE,CAAC;oBACR,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBAC3B,CAAC;aACF,CAAC;QACJ,CAAC,CAAC,EAAE;QACN,CAAC,CAAC,SAAS,CAAC;IAEhB,MAAM,MAAM,GAAG,KAAK,IAAI,EAAE;QACxB,SAAS;YACP,MAAM,oBAAoB,EAAE,OAAO,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,YAAY,CAAC,CAAC,CAAC;YAEtE,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC;gBAAE,OAAO;YAC/B,IAAK,GAA2B,EAAE,IAAI;gBAAE,OAAO;YAE/C,OAAO,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;SAChD;IACH,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,KAAK,CAAC,WAAW,CAAC;SAC/B,IAAI,CAAC,MAAM,CAAC;SACZ,GAAG,CAAC,CAAC,CAAgB,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAElC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CACvB,GAAG,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,EACxB,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CACpC,CAAC;IAEF,IAAI;QACF,IAAI,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,qBAAqB,EAAE;YAC/C,oBAAoB,EAAE,OAAO,EAAE,CAAC;YAChC,MAAM,GAAG,CAAC;SACX;KACF;IAAC,OAAO,GAAY,EAAE;QACrB,IAAK,GAAa,EAAE,IAAI,KAAK,YAAY,EAAE;YACzC,OAAO;SACR;QACD,MAAM,GAAG,CAAC;KACX;AACH,CAAC;AA5ED,4CA4EC"}

package/lib/schedule-client.d.ts

@@ -0,0 +1,175 @@
+import { Headers } from '@temporalio/common/lib/interceptors';
+import { temporal } from '@temporalio/proto';
+import { CreateScheduleInput, CreateScheduleOutput, ScheduleClientInterceptor } from './interceptors';
+import { WorkflowService } from './types';
+import { Backfill, CompiledScheduleUpdateOptions, ScheduleSummary, ScheduleDescription, ScheduleOptions, ScheduleOverlapPolicy, ScheduleUpdateOptions } from './schedule-types';
+import { BaseClient, BaseClientOptions, LoadedWithDefaults } from './base-client';
+/**
+ * Handle to a single Schedule
+ *
+ * @experimental
+ */
+export interface ScheduleHandle {
+    /**
+     * This Schedule's identifier
+     */
+    readonly scheduleId: string;
+    /**
+     * Fetch the Schedule's description from the Server
+     */
+    describe(): Promise<ScheduleDescription>;
+    /**
+     * Update the Schedule
+     *
+     * This function calls `.describe()`, provides the `Schedule` to the provided `updateFn`, and
+     * sends the returned `UpdatedSchedule` to the Server to update the Schedule definition. Note that,
+     * in the future, `updateFn` might be invoked multiple time, with identical or different input.
+     */
+    update(updateFn: (previous: ScheduleDescription) => ScheduleUpdateOptions): Promise<void>;
+    /**
+     * Delete the Schedule
+     */
+    delete(): Promise<void>;
+    /**
+     * Trigger an Action to be taken immediately
+     *
+     * @param overlap Override the Overlap Policy for this one trigger. Defaults to {@link ScheduleOverlapPolicy.ALLOW_ALL}.
+     */
+    trigger(overlap?: ScheduleOverlapPolicy): Promise<void>;
+    /**
+     * Run though the specified time period(s) and take Actions as if that time passed by right now, all at once.
+     * The Overlap Policy can be overridden for the scope of the Backfill.
+     */
+    backfill(options: Backfill | Backfill[]): Promise<void>;
+    /**
+     * Pause the Schedule
+     *
+     * @param note A new {@link ScheduleDescription.note}. Defaults to `"Paused via TypeScript SDK"`
+     */
+    pause(note?: string): Promise<void>;
+    /**
+     * Unpause the Schedule
+     *
+     * @param note A new {@link ScheduleDescription.note}. Defaults to `"Unpaused via TypeScript SDK"
+     */
+    unpause(note?: string): Promise<void>;
+    /**
+     * Readonly accessor to the underlying ScheduleClient
+     */
+    readonly client: ScheduleClient;
+}
+/**
+ * @experimental
+ */
+export interface ScheduleClientOptions extends BaseClientOptions {
+    /**
+     * Used to override and extend default Connection functionality
+     *
+     * Useful for injecting auth headers and tracing Workflow executions
+     */
+    interceptors?: ScheduleClientInterceptor[];
+}
+/** @experimental */
+export declare type LoadedScheduleClientOptions = LoadedWithDefaults<ScheduleClientOptions>;
+/** @experimental */
+export interface ListScheduleOptions {
+    /**
+     * How many results to fetch from the Server at a time.
+     * @default 1000
+     */
+    pageSize?: number;
+}
+/**
+ * Client for starting Workflow executions and creating Workflow handles
+ *
+ * @experimental
+ */
+export declare class ScheduleClient extends BaseClient {
+    readonly options: LoadedScheduleClientOptions;
+    constructor(options?: ScheduleClientOptions);
+    /**
+     * Raw gRPC access to the Temporal service. Schedule-related methods are included in {@link WorkflowService}.
+     *
+     * **NOTE**: The namespace provided in {@link options} is **not** automatically set on requests made to the service.
+     */
+    get workflowService(): WorkflowService;
+    /**
+     * Create a new Schedule.
+     *
+     * @throws {@link ScheduleAlreadyRunning} if there's a running (not deleted) Schedule with the given `id`
+     * @returns a ScheduleHandle to the created Schedule
+     */
+    create(options: ScheduleOptions): Promise<ScheduleHandle>;
+    /**
+     * Create a new Schedule.
+     */
+    protected _createSchedule(options: ScheduleOptions): Promise<void>;
+    /**
+     * Create a new Schedule.
+     */
+    protected _createScheduleHandler(input: CreateScheduleInput): Promise<CreateScheduleOutput>;
+    /**
+     * Describe a Schedule.
+     */
+    protected _describeSchedule(scheduleId: string): Promise<temporal.api.workflowservice.v1.IDescribeScheduleResponse>;
+    /**
+     * Update a Schedule.
+     */
+    protected _updateSchedule(scheduleId: string, opts: CompiledScheduleUpdateOptions, header: Headers): Promise<temporal.api.workflowservice.v1.IUpdateScheduleResponse>;
+    /**
+     * Patch a Schedule.
+     */
+    protected _patchSchedule(scheduleId: string, patch: temporal.api.schedule.v1.ISchedulePatch): Promise<temporal.api.workflowservice.v1.IPatchScheduleResponse>;
+    /**
+     * Delete a Schedule.
+     */
+    protected _deleteSchedule(scheduleId: string): Promise<temporal.api.workflowservice.v1.IDeleteScheduleResponse>;
+    /**
+     * List Schedules with an `AsyncIterator`:
+     *
+     * ```ts
+     * for await (const schedule: Schedule of client.list()) {
+     *   const { id, memo, searchAttributes } = schedule
+     *   // ...
+     * }
+     * ```
+     *
+     * To list one page at a time, instead use the raw gRPC method {@link WorkflowService.listSchedules}:
+     *
+     * ```ts
+     * await { schedules, nextPageToken } = client.scheduleService.listSchedules()
+     * ```
+     */
+    list(options?: ListScheduleOptions): AsyncIterable<ScheduleSummary>;
+    /**
+     * Get a handle to a Schedule
+     *
+     * This method does not validate `scheduleId`. If there is no Schedule with the given `scheduleId`, handle
+     * methods like `handle.describe()` will throw a {@link ScheduleNotFoundError} error.
+     */
+    getHandle(scheduleId: string): ScheduleHandle;
+    protected rethrowGrpcError(err: unknown, scheduleId: string, fallbackMessage: string): never;
+}
+/**
+ * Thrown from {@link ScheduleClient.create} if there's a running (not deleted) Schedule with the given `id`.
+ *
+ * @experimental
+ */
+export declare class ScheduleAlreadyRunning extends Error {
+    readonly scheduleId: string;
+    readonly name: string;
+    constructor(message: string, scheduleId: string);
+}
+/**
+ * Thrown when a Schedule with the given Id is not known to Temporal Server.
+ * It could be because:
+ * - Id passed is incorrect
+ * - Schedule was deleted
+ *
+ * @experimental
+ */
+export declare class ScheduleNotFoundError extends Error {
+    readonly scheduleId: string;
+    readonly name: string;
+    constructor(message: string, scheduleId: string);
+}