@hatchet-dev/typescript-sdk 1.16.0 → 1.17.0

package/protoc/v1/shared/trigger.d.ts

@@ -0,0 +1,89 @@
+import { BinaryReader, BinaryWriter } from '@bufbuild/protobuf/wire';
+export declare const protobufPackage = "v1";
+export declare enum WorkerLabelComparator {
+    EQUAL = 0,
+    NOT_EQUAL = 1,
+    GREATER_THAN = 2,
+    GREATER_THAN_OR_EQUAL = 3,
+    LESS_THAN = 4,
+    LESS_THAN_OR_EQUAL = 5,
+    UNRECOGNIZED = -1
+}
+export declare function workerLabelComparatorFromJSON(object: any): WorkerLabelComparator;
+export declare function workerLabelComparatorToJSON(object: WorkerLabelComparator): string;
+export interface DesiredWorkerLabels {
+    /** value of the affinity */
+    strValue?: string | undefined;
+    intValue?: number | undefined;
+    /**
+     * (optional) Specifies whether the affinity setting is required.
+     * If required, the worker will not accept actions that do not have a truthy affinity setting.
+     *
+     * Defaults to false.
+     */
+    required?: boolean | undefined;
+    /**
+     * (optional) Specifies the comparator for the affinity setting.
+     * If not set, the default is EQUAL.
+     */
+    comparator?: WorkerLabelComparator | undefined;
+    /**
+     * (optional) Specifies the weight of the affinity setting.
+     * If not set, the default is 100.
+     */
+    weight?: number | undefined;
+}
+export interface TriggerWorkflowRequest {
+    name: string;
+    /** (optional) the input data for the workflow */
+    input: string;
+    /** (optional) the parent workflow run id */
+    parentId?: string | undefined;
+    /** (optional) the parent task external run id */
+    parentTaskRunExternalId?: string | undefined;
+    /**
+     * (optional) the index of the child workflow. if this is set, matches on the index or the
+     * child key will return an existing workflow run if the parent id, parent task run id, and
+     * child index/key match an existing workflow run.
+     */
+    childIndex?: number | undefined;
+    /**
+     * (optional) the key for the child. if this is set, matches on the index or the
+     * child key will return an existing workflow run if the parent id, parent task run id, and
+     * child index/key match an existing workflow run.
+     */
+    childKey?: string | undefined;
+    /** (optional) additional metadata for the workflow */
+    additionalMetadata?: string | undefined;
+    /**
+     * (optional) desired worker id for the workflow run,
+     * requires the workflow definition to have a sticky strategy
+     */
+    desiredWorkerId?: string | undefined;
+    /** (optional) override for the priority of the workflow tasks, will set all tasks to this priority */
+    priority?: number | undefined;
+    /** (optional) the desired worker labels for the workflow run, which will be used to determine which workers can pick up the workflow's tasks. if not set, defaults to an empty set of labels, which means any worker can pick up the tasks. */
+    desiredWorkerLabels: {
+        [key: string]: DesiredWorkerLabels;
+    };
+}
+export interface TriggerWorkflowRequest_DesiredWorkerLabelsEntry {
+    key: string;
+    value: DesiredWorkerLabels | undefined;
+}
+export declare const DesiredWorkerLabels: MessageFns<DesiredWorkerLabels>;
+export declare const TriggerWorkflowRequest: MessageFns<TriggerWorkflowRequest>;
+export declare const TriggerWorkflowRequest_DesiredWorkerLabelsEntry: MessageFns<TriggerWorkflowRequest_DesiredWorkerLabelsEntry>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+export {};

package/protoc/v1/shared/trigger.js

@@ -0,0 +1,493 @@
+"use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.7
+//   protoc               v3.19.1
+// source: v1/shared/trigger.proto
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRequest = exports.DesiredWorkerLabels = exports.WorkerLabelComparator = exports.protobufPackage = void 0;
+exports.workerLabelComparatorFromJSON = workerLabelComparatorFromJSON;
+exports.workerLabelComparatorToJSON = workerLabelComparatorToJSON;
+/* eslint-disable */
+const wire_1 = require("@bufbuild/protobuf/wire");
+exports.protobufPackage = 'v1';
+var WorkerLabelComparator;
+(function (WorkerLabelComparator) {
+    WorkerLabelComparator[WorkerLabelComparator["EQUAL"] = 0] = "EQUAL";
+    WorkerLabelComparator[WorkerLabelComparator["NOT_EQUAL"] = 1] = "NOT_EQUAL";
+    WorkerLabelComparator[WorkerLabelComparator["GREATER_THAN"] = 2] = "GREATER_THAN";
+    WorkerLabelComparator[WorkerLabelComparator["GREATER_THAN_OR_EQUAL"] = 3] = "GREATER_THAN_OR_EQUAL";
+    WorkerLabelComparator[WorkerLabelComparator["LESS_THAN"] = 4] = "LESS_THAN";
+    WorkerLabelComparator[WorkerLabelComparator["LESS_THAN_OR_EQUAL"] = 5] = "LESS_THAN_OR_EQUAL";
+    WorkerLabelComparator[WorkerLabelComparator["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(WorkerLabelComparator || (exports.WorkerLabelComparator = WorkerLabelComparator = {}));
+function workerLabelComparatorFromJSON(object) {
+    switch (object) {
+        case 0:
+        case 'EQUAL':
+            return WorkerLabelComparator.EQUAL;
+        case 1:
+        case 'NOT_EQUAL':
+            return WorkerLabelComparator.NOT_EQUAL;
+        case 2:
+        case 'GREATER_THAN':
+            return WorkerLabelComparator.GREATER_THAN;
+        case 3:
+        case 'GREATER_THAN_OR_EQUAL':
+            return WorkerLabelComparator.GREATER_THAN_OR_EQUAL;
+        case 4:
+        case 'LESS_THAN':
+            return WorkerLabelComparator.LESS_THAN;
+        case 5:
+        case 'LESS_THAN_OR_EQUAL':
+            return WorkerLabelComparator.LESS_THAN_OR_EQUAL;
+        case -1:
+        case 'UNRECOGNIZED':
+        default:
+            return WorkerLabelComparator.UNRECOGNIZED;
+    }
+}
+function workerLabelComparatorToJSON(object) {
+    switch (object) {
+        case WorkerLabelComparator.EQUAL:
+            return 'EQUAL';
+        case WorkerLabelComparator.NOT_EQUAL:
+            return 'NOT_EQUAL';
+        case WorkerLabelComparator.GREATER_THAN:
+            return 'GREATER_THAN';
+        case WorkerLabelComparator.GREATER_THAN_OR_EQUAL:
+            return 'GREATER_THAN_OR_EQUAL';
+        case WorkerLabelComparator.LESS_THAN:
+            return 'LESS_THAN';
+        case WorkerLabelComparator.LESS_THAN_OR_EQUAL:
+            return 'LESS_THAN_OR_EQUAL';
+        case WorkerLabelComparator.UNRECOGNIZED:
+        default:
+            return 'UNRECOGNIZED';
+    }
+}
+function createBaseDesiredWorkerLabels() {
+    return {
+        strValue: undefined,
+        intValue: undefined,
+        required: undefined,
+        comparator: undefined,
+        weight: undefined,
+    };
+}
+exports.DesiredWorkerLabels = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.strValue !== undefined) {
+            writer.uint32(10).string(message.strValue);
+        }
+        if (message.intValue !== undefined) {
+            writer.uint32(16).int32(message.intValue);
+        }
+        if (message.required !== undefined) {
+            writer.uint32(24).bool(message.required);
+        }
+        if (message.comparator !== undefined) {
+            writer.uint32(32).int32(message.comparator);
+        }
+        if (message.weight !== undefined) {
+            writer.uint32(40).int32(message.weight);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseDesiredWorkerLabels();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.strValue = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.intValue = reader.int32();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 24) {
+                        break;
+                    }
+                    message.required = reader.bool();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 32) {
+                        break;
+                    }
+                    message.comparator = reader.int32();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.weight = reader.int32();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            strValue: isSet(object.strValue) ? globalThis.String(object.strValue) : undefined,
+            intValue: isSet(object.intValue) ? globalThis.Number(object.intValue) : undefined,
+            required: isSet(object.required) ? globalThis.Boolean(object.required) : undefined,
+            comparator: isSet(object.comparator)
+                ? workerLabelComparatorFromJSON(object.comparator)
+                : undefined,
+            weight: isSet(object.weight) ? globalThis.Number(object.weight) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.strValue !== undefined) {
+            obj.strValue = message.strValue;
+        }
+        if (message.intValue !== undefined) {
+            obj.intValue = Math.round(message.intValue);
+        }
+        if (message.required !== undefined) {
+            obj.required = message.required;
+        }
+        if (message.comparator !== undefined) {
+            obj.comparator = workerLabelComparatorToJSON(message.comparator);
+        }
+        if (message.weight !== undefined) {
+            obj.weight = Math.round(message.weight);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.DesiredWorkerLabels.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d, _e;
+        const message = createBaseDesiredWorkerLabels();
+        message.strValue = (_a = object.strValue) !== null && _a !== void 0 ? _a : undefined;
+        message.intValue = (_b = object.intValue) !== null && _b !== void 0 ? _b : undefined;
+        message.required = (_c = object.required) !== null && _c !== void 0 ? _c : undefined;
+        message.comparator = (_d = object.comparator) !== null && _d !== void 0 ? _d : undefined;
+        message.weight = (_e = object.weight) !== null && _e !== void 0 ? _e : undefined;
+        return message;
+    },
+};
+function createBaseTriggerWorkflowRequest() {
+    return {
+        name: '',
+        input: '',
+        parentId: undefined,
+        parentTaskRunExternalId: undefined,
+        childIndex: undefined,
+        childKey: undefined,
+        additionalMetadata: undefined,
+        desiredWorkerId: undefined,
+        priority: undefined,
+        desiredWorkerLabels: {},
+    };
+}
+exports.TriggerWorkflowRequest = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.name !== '') {
+            writer.uint32(10).string(message.name);
+        }
+        if (message.input !== '') {
+            writer.uint32(18).string(message.input);
+        }
+        if (message.parentId !== undefined) {
+            writer.uint32(26).string(message.parentId);
+        }
+        if (message.parentTaskRunExternalId !== undefined) {
+            writer.uint32(34).string(message.parentTaskRunExternalId);
+        }
+        if (message.childIndex !== undefined) {
+            writer.uint32(40).int32(message.childIndex);
+        }
+        if (message.childKey !== undefined) {
+            writer.uint32(50).string(message.childKey);
+        }
+        if (message.additionalMetadata !== undefined) {
+            writer.uint32(58).string(message.additionalMetadata);
+        }
+        if (message.desiredWorkerId !== undefined) {
+            writer.uint32(66).string(message.desiredWorkerId);
+        }
+        if (message.priority !== undefined) {
+            writer.uint32(72).int32(message.priority);
+        }
+        Object.entries(message.desiredWorkerLabels).forEach(([key, value]) => {
+            exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry.encode({ key: key, value }, writer.uint32(82).fork()).join();
+        });
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseTriggerWorkflowRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.name = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.input = reader.string();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.parentId = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.parentTaskRunExternalId = reader.string();
+                    continue;
+                }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.childIndex = reader.int32();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.childKey = reader.string();
+                    continue;
+                }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.additionalMetadata = reader.string();
+                    continue;
+                }
+                case 8: {
+                    if (tag !== 66) {
+                        break;
+                    }
+                    message.desiredWorkerId = reader.string();
+                    continue;
+                }
+                case 9: {
+                    if (tag !== 72) {
+                        break;
+                    }
+                    message.priority = reader.int32();
+                    continue;
+                }
+                case 10: {
+                    if (tag !== 82) {
+                        break;
+                    }
+                    const entry10 = exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry.decode(reader, reader.uint32());
+                    if (entry10.value !== undefined) {
+                        message.desiredWorkerLabels[entry10.key] = entry10.value;
+                    }
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            name: isSet(object.name) ? globalThis.String(object.name) : '',
+            input: isSet(object.input) ? globalThis.String(object.input) : '',
+            parentId: isSet(object.parentId) ? globalThis.String(object.parentId) : undefined,
+            parentTaskRunExternalId: isSet(object.parentTaskRunExternalId)
+                ? globalThis.String(object.parentTaskRunExternalId)
+                : undefined,
+            childIndex: isSet(object.childIndex) ? globalThis.Number(object.childIndex) : undefined,
+            childKey: isSet(object.childKey) ? globalThis.String(object.childKey) : undefined,
+            additionalMetadata: isSet(object.additionalMetadata)
+                ? globalThis.String(object.additionalMetadata)
+                : undefined,
+            desiredWorkerId: isSet(object.desiredWorkerId)
+                ? globalThis.String(object.desiredWorkerId)
+                : undefined,
+            priority: isSet(object.priority) ? globalThis.Number(object.priority) : undefined,
+            desiredWorkerLabels: isObject(object.desiredWorkerLabels)
+                ? Object.entries(object.desiredWorkerLabels).reduce((acc, [key, value]) => {
+                    acc[key] = exports.DesiredWorkerLabels.fromJSON(value);
+                    return acc;
+                }, {})
+                : {},
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.name !== '') {
+            obj.name = message.name;
+        }
+        if (message.input !== '') {
+            obj.input = message.input;
+        }
+        if (message.parentId !== undefined) {
+            obj.parentId = message.parentId;
+        }
+        if (message.parentTaskRunExternalId !== undefined) {
+            obj.parentTaskRunExternalId = message.parentTaskRunExternalId;
+        }
+        if (message.childIndex !== undefined) {
+            obj.childIndex = Math.round(message.childIndex);
+        }
+        if (message.childKey !== undefined) {
+            obj.childKey = message.childKey;
+        }
+        if (message.additionalMetadata !== undefined) {
+            obj.additionalMetadata = message.additionalMetadata;
+        }
+        if (message.desiredWorkerId !== undefined) {
+            obj.desiredWorkerId = message.desiredWorkerId;
+        }
+        if (message.priority !== undefined) {
+            obj.priority = Math.round(message.priority);
+        }
+        if (message.desiredWorkerLabels) {
+            const entries = Object.entries(message.desiredWorkerLabels);
+            if (entries.length > 0) {
+                obj.desiredWorkerLabels = {};
+                entries.forEach(([k, v]) => {
+                    obj.desiredWorkerLabels[k] = exports.DesiredWorkerLabels.toJSON(v);
+                });
+            }
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.TriggerWorkflowRequest.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        const message = createBaseTriggerWorkflowRequest();
+        message.name = (_a = object.name) !== null && _a !== void 0 ? _a : '';
+        message.input = (_b = object.input) !== null && _b !== void 0 ? _b : '';
+        message.parentId = (_c = object.parentId) !== null && _c !== void 0 ? _c : undefined;
+        message.parentTaskRunExternalId = (_d = object.parentTaskRunExternalId) !== null && _d !== void 0 ? _d : undefined;
+        message.childIndex = (_e = object.childIndex) !== null && _e !== void 0 ? _e : undefined;
+        message.childKey = (_f = object.childKey) !== null && _f !== void 0 ? _f : undefined;
+        message.additionalMetadata = (_g = object.additionalMetadata) !== null && _g !== void 0 ? _g : undefined;
+        message.desiredWorkerId = (_h = object.desiredWorkerId) !== null && _h !== void 0 ? _h : undefined;
+        message.priority = (_j = object.priority) !== null && _j !== void 0 ? _j : undefined;
+        message.desiredWorkerLabels = Object.entries((_k = object.desiredWorkerLabels) !== null && _k !== void 0 ? _k : {}).reduce((acc, [key, value]) => {
+            if (value !== undefined) {
+                acc[key] = exports.DesiredWorkerLabels.fromPartial(value);
+            }
+            return acc;
+        }, {});
+        return message;
+    },
+};
+function createBaseTriggerWorkflowRequest_DesiredWorkerLabelsEntry() {
+    return { key: '', value: undefined };
+}
+exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.key !== '') {
+            writer.uint32(10).string(message.key);
+        }
+        if (message.value !== undefined) {
+            exports.DesiredWorkerLabels.encode(message.value, writer.uint32(18).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseTriggerWorkflowRequest_DesiredWorkerLabelsEntry();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.value = exports.DesiredWorkerLabels.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : '',
+            value: isSet(object.value) ? exports.DesiredWorkerLabels.fromJSON(object.value) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.key !== '') {
+            obj.key = message.key;
+        }
+        if (message.value !== undefined) {
+            obj.value = exports.DesiredWorkerLabels.toJSON(message.value);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.TriggerWorkflowRequest_DesiredWorkerLabelsEntry.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseTriggerWorkflowRequest_DesiredWorkerLabelsEntry();
+        message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
+        message.value =
+            object.value !== undefined && object.value !== null
+                ? exports.DesiredWorkerLabels.fromPartial(object.value)
+                : undefined;
+        return message;
+    },
+};
+function isObject(value) {
+    return typeof value === 'object' && value !== null;
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}