@hatchet-dev/typescript-sdk 0.6.1 → 0.7.1

package/clients/rest/generated/data-contracts.d.ts

@@ -1,5 +1,11 @@
 export interface APIMeta {
     auth?: APIMetaAuth;
+    /**
+     * the Pylon app ID for usepylon.com chat support
+     * @example "12345678-1234-1234-1234-123456789012"
+     */
+    pylonAppId?: string;
+    posthog?: APIMetaPosthog;
 }
 export interface APIMetaAuth {
     /**
@@ -8,6 +14,18 @@ export interface APIMetaAuth {
      */
     schemes?: string[];
 }
+export interface APIMetaPosthog {
+    /**
+     * the PostHog API key
+     * @example "phk_1234567890abcdef"
+     */
+    apiKey?: string;
+    /**
+     * the PostHog API host
+     * @example "https://posthog.example.com"
+     */
+    apiHost?: string;
+}
 export type ListAPIMetaIntegration = APIMetaIntegration[];
 export interface APIMetaIntegration {
     /**
@@ -100,6 +118,8 @@ export interface User {
     emailVerified: boolean;
     /** Whether the user has a password set. */
     hasPassword?: boolean;
+    /** A hash of the user's email address for use with Pylon Support Chat */
+    emailHash?: string;
 }
 export interface UserTenantPublic {
     /**
@@ -146,6 +166,8 @@ export interface Tenant {
     name: string;
     /** The slug of the tenant. */
     slug: string;
+    /** Whether the tenant has opted out of analytics. */
+    analyticsOptOut?: boolean;
 }
 export interface TenantMember {
     metadata: APIResourceMeta;
@@ -175,6 +197,33 @@ export interface UpdateTenantInviteRequest {
     /** The role of the user in the tenant. */
     role: TenantMemberRole;
 }
+export interface TenantAlertingSettings {
+    metadata: APIResourceMeta;
+    /** The max frequency at which to alert. */
+    maxAlertingFrequency: string;
+    /**
+     * The last time an alert was sent.
+     * @format date-time
+     */
+    lastAlertedAt?: string;
+}
+export interface TenantAlertEmailGroup {
+    metadata: APIResourceMeta;
+    /** A list of emails for users */
+    emails: string[];
+}
+export interface TenantAlertEmailGroupList {
+    pagination?: PaginationResponse;
+    rows?: TenantAlertEmailGroup[];
+}
+export interface CreateTenantAlertEmailGroupRequest {
+    /** A list of emails for users */
+    emails: string[];
+}
+export interface UpdateTenantAlertEmailGroupRequest {
+    /** A list of emails for users */
+    emails: string[];
+}
 export interface TenantInvite {
     metadata: APIResourceMeta;
     /** The email of the user to invite. */
@@ -221,6 +270,14 @@ export interface CreateTenantRequest {
     /** The slug of the tenant. */
     slug: string;
 }
+export interface UpdateTenantRequest {
+    /** The name of the tenant. */
+    name?: string;
+    /** Whether the tenant has opted out of analytics. */
+    analyticsOptOut?: boolean;
+    /** The max frequency at which to alert. */
+    maxAlertingFrequency?: string;
+}
 export interface Event {
     metadata: APIResourceMeta;
     /** The key for the event. */
@@ -231,6 +288,8 @@ export interface Event {
     tenantId: string;
     /** The workflow run summary for this event. */
     workflowRunSummary?: EventWorkflowRunSummary;
+    /** Additional metadata for the event. */
+    additionalMetadata?: object;
 }
 export interface EventData {
     /** The data for the event (JSON bytes). */
@@ -346,6 +405,7 @@ export interface WorkflowVersion {
     workflow?: Workflow;
     concurrency?: WorkflowConcurrency;
     triggers?: WorkflowTriggers;
+    scheduleTimeout?: string;
     jobs?: Job[];
 }
 export interface WorkflowVersionDefinition {
@@ -430,11 +490,22 @@ export interface WorkflowRun {
      * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
      */
     parentStepRunId?: string;
+    additionalMetadata?: Record<string, any>;
 }
 export interface WorkflowRunList {
     rows?: WorkflowRun[];
     pagination?: PaginationResponse;
 }
+export interface WorkflowRunsMetrics {
+    counts?: WorkflowRunsMetricsCounts;
+}
+export interface WorkflowRunsMetricsCounts {
+    PENDING?: number;
+    RUNNING?: number;
+    SUCCEEDED?: number;
+    FAILED?: number;
+    QUEUED?: number;
+}
 export declare enum WorkflowRunStatus {
     PENDING = "PENDING",
     RUNNING = "RUNNING",
@@ -444,6 +515,9 @@ export declare enum WorkflowRunStatus {
     QUEUED = "QUEUED"
 }
 export type WorkflowRunStatusList = WorkflowRunStatus[];
+export interface WorkflowRunsCancelRequest {
+    workflowRunIds: string[];
+}
 export declare enum JobRunStatus {
     PENDING = "PENDING",
     RUNNING = "RUNNING",
@@ -523,6 +597,44 @@ export interface StepRun {
     cancelledReason?: string;
     cancelledError?: string;
 }
+export declare enum StepRunEventReason {
+    REQUEUED_NO_WORKER = "REQUEUED_NO_WORKER",
+    REQUEUED_RATE_LIMIT = "REQUEUED_RATE_LIMIT",
+    SCHEDULING_TIMED_OUT = "SCHEDULING_TIMED_OUT",
+    ASSIGNED = "ASSIGNED",
+    STARTED = "STARTED",
+    FINISHED = "FINISHED",
+    FAILED = "FAILED",
+    RETRYING = "RETRYING",
+    CANCELLED = "CANCELLED",
+    TIMEOUT_REFRESHED = "TIMEOUT_REFRESHED",
+    REASSIGNED = "REASSIGNED",
+    TIMED_OUT = "TIMED_OUT",
+    SLOT_RELEASED = "SLOT_RELEASED",
+    RETRIED_BY_USER = "RETRIED_BY_USER"
+}
+export declare enum StepRunEventSeverity {
+    INFO = "INFO",
+    WARNING = "WARNING",
+    CRITICAL = "CRITICAL"
+}
+export interface StepRunEvent {
+    id: number;
+    /** @format date-time */
+    timeFirstSeen: string;
+    /** @format date-time */
+    timeLastSeen: string;
+    stepRunId: string;
+    reason: StepRunEventReason;
+    severity: StepRunEventSeverity;
+    message: string;
+    count: number;
+    data?: object;
+}
+export interface StepRunEventList {
+    pagination?: PaginationResponse;
+    rows?: StepRunEvent[];
+}
 export interface WorkerList {
     pagination?: PaginationResponse;
     rows?: Worker[];
@@ -537,10 +649,30 @@ export interface Worker {
      * @example "2022-12-13T20:06:48.888Z"
      */
     lastHeartbeatAt?: string;
+    /**
+     * The time this worker last sent a heartbeat.
+     * @format date-time
+     * @example "2022-12-13T20:06:48.888Z"
+     */
+    lastListenerEstablished?: string;
     /** The actions this worker can perform. */
     actions?: string[];
     /** The recent step runs for this worker. */
     recentStepRuns?: StepRun[];
+    /** The status of the worker. */
+    status?: 'ACTIVE' | 'INACTIVE';
+    /** The maximum number of runs this worker can execute concurrently. */
+    maxRuns?: number;
+    /** The number of runs this worker can execute concurrently. */
+    availableRuns?: number;
+    /**
+     * the id of the assigned dispatcher, in UUID format
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
+     */
+    dispatcherId?: string;
 }
 export interface APIToken {
     metadata: APIResourceMeta;
@@ -575,6 +707,7 @@ export interface RerunStepRunRequest {
 }
 export interface TriggerWorkflowRunRequest {
     input: object;
+    additionalMetadata?: object;
 }
 export interface LinkGithubRepositoryRequest {
     /**
@@ -684,6 +817,26 @@ export interface ListSNSIntegrations {
     pagination: PaginationResponse;
     rows: SNSIntegration[];
 }
+export interface SlackWebhook {
+    metadata: APIResourceMeta;
+    /**
+     * The unique identifier for the tenant that the SNS integration belongs to.
+     * @format uuid
+     */
+    tenantId: string;
+    /** The team name associated with this slack webhook. */
+    teamName: string;
+    /** The team id associated with this slack webhook. */
+    teamId: string;
+    /** The channel name associated with this slack webhook. */
+    channelName: string;
+    /** The channel id associated with this slack webhook. */
+    channelId: string;
+}
+export interface ListSlackWebhooks {
+    pagination: PaginationResponse;
+    rows: SlackWebhook[];
+}
 export interface CreateSNSIntegrationRequest {
     /** The Amazon Resource Name (ARN) of the SNS topic. */
     topicArn: string;

package/clients/rest/generated/data-contracts.js

@@ -10,7 +10,7 @@
  * ---------------------------------------------------------------
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLineOrderByDirection = exports.LogLineOrderByField = exports.LogLineLevel = exports.PullRequestState = exports.StepRunStatus = exports.JobRunStatus = exports.WorkflowRunStatus = exports.EventOrderByDirection = exports.EventOrderByField = exports.TenantMemberRole = void 0;
+exports.LogLineOrderByDirection = exports.LogLineOrderByField = exports.LogLineLevel = exports.PullRequestState = exports.StepRunEventSeverity = exports.StepRunEventReason = exports.StepRunStatus = exports.JobRunStatus = exports.WorkflowRunStatus = exports.EventOrderByDirection = exports.EventOrderByField = exports.TenantMemberRole = void 0;
 var TenantMemberRole;
 (function (TenantMemberRole) {
     TenantMemberRole["OWNER"] = "OWNER";
@@ -53,6 +53,29 @@ var StepRunStatus;
     StepRunStatus["FAILED"] = "FAILED";
     StepRunStatus["CANCELLED"] = "CANCELLED";
 })(StepRunStatus || (exports.StepRunStatus = StepRunStatus = {}));
+var StepRunEventReason;
+(function (StepRunEventReason) {
+    StepRunEventReason["REQUEUED_NO_WORKER"] = "REQUEUED_NO_WORKER";
+    StepRunEventReason["REQUEUED_RATE_LIMIT"] = "REQUEUED_RATE_LIMIT";
+    StepRunEventReason["SCHEDULING_TIMED_OUT"] = "SCHEDULING_TIMED_OUT";
+    StepRunEventReason["ASSIGNED"] = "ASSIGNED";
+    StepRunEventReason["STARTED"] = "STARTED";
+    StepRunEventReason["FINISHED"] = "FINISHED";
+    StepRunEventReason["FAILED"] = "FAILED";
+    StepRunEventReason["RETRYING"] = "RETRYING";
+    StepRunEventReason["CANCELLED"] = "CANCELLED";
+    StepRunEventReason["TIMEOUT_REFRESHED"] = "TIMEOUT_REFRESHED";
+    StepRunEventReason["REASSIGNED"] = "REASSIGNED";
+    StepRunEventReason["TIMED_OUT"] = "TIMED_OUT";
+    StepRunEventReason["SLOT_RELEASED"] = "SLOT_RELEASED";
+    StepRunEventReason["RETRIED_BY_USER"] = "RETRIED_BY_USER";
+})(StepRunEventReason || (exports.StepRunEventReason = StepRunEventReason = {}));
+var StepRunEventSeverity;
+(function (StepRunEventSeverity) {
+    StepRunEventSeverity["INFO"] = "INFO";
+    StepRunEventSeverity["WARNING"] = "WARNING";
+    StepRunEventSeverity["CRITICAL"] = "CRITICAL";
+})(StepRunEventSeverity || (exports.StepRunEventSeverity = StepRunEventSeverity = {}));
 var PullRequestState;
 (function (PullRequestState) {
     PullRequestState["Open"] = "open";

package/clients/rest/generated/http-client.d.ts

@@ -37,5 +37,5 @@ export declare class HttpClient<SecurityDataType = unknown> {
     protected mergeRequestParams(params1: AxiosRequestConfig, params2?: AxiosRequestConfig): AxiosRequestConfig;
     protected stringifyFormItem(formItem: unknown): string;
     protected createFormData(input: Record<string, unknown>): FormData;
-    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T, any>>;
+    request: <T = any, _E = any>({ secure, path, type, query, format, body, ...params }: FullRequestParams) => Promise<AxiosResponse<T>>;
 }

package/clients/worker/worker.js

@@ -49,8 +49,8 @@ class Worker {
         });
     }
     register_workflow(initWorkflow) {
-        var _a, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c;
             const workflow = Object.assign(Object.assign({}, initWorkflow), { id: this.client.config.namespace + initWorkflow.id });
             try {
                 const concurrency = ((_a = workflow.concurrency) === null || _a === void 0 ? void 0 : _a.name)
@@ -301,8 +301,8 @@ class Worker {
         });
     }
     exitGracefully(handleKill) {
-        var _a;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a;
             this.killing = true;
             this.logger.info('Starting to exit...');
             try {
@@ -322,8 +322,8 @@ class Worker {
         });
     }
     start() {
-        var _a, e_1, _b, _c;
         return __awaiter(this, void 0, void 0, function* () {
+            var _a, e_1, _b, _c;
             // ensure all workflows are registered
             yield Promise.all(this.registeredWorkflowPromises);
             try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.6.1",
+  "version": "0.7.1",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -85,7 +85,7 @@
     "ts-node": "^10.9.2",
     "ts-proto": "^1.167.0",
     "typedoc": "^0.25.7",
-    "typedoc-plugin-markdown": "^3.17.1",
+    "typedoc-plugin-markdown": "^4.0.2",
     "typescript": "^5.3.3"
   },
   "dependencies": {

package/protoc/dispatcher/dispatcher.d.ts

@@ -211,6 +211,20 @@ export interface HeartbeatRequest {
 }
 export interface HeartbeatResponse {
 }
+export interface RefreshTimeoutRequest {
+    /** the id of the step run to release */
+    stepRunId: string;
+    incrementTimeoutBy: string;
+}
+export interface RefreshTimeoutResponse {
+    timeoutAt: Date | undefined;
+}
+export interface ReleaseSlotRequest {
+    /** the id of the step run to release */
+    stepRunId: string;
+}
+export interface ReleaseSlotResponse {
+}
 export declare const WorkerRegisterRequest: {
     encode(message: WorkerRegisterRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): WorkerRegisterRequest;
@@ -355,6 +369,38 @@ export declare const HeartbeatResponse: {
     create(base?: DeepPartial<HeartbeatResponse>): HeartbeatResponse;
     fromPartial(_: DeepPartial<HeartbeatResponse>): HeartbeatResponse;
 };
+export declare const RefreshTimeoutRequest: {
+    encode(message: RefreshTimeoutRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutRequest;
+    fromJSON(object: any): RefreshTimeoutRequest;
+    toJSON(message: RefreshTimeoutRequest): unknown;
+    create(base?: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+    fromPartial(object: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+};
+export declare const RefreshTimeoutResponse: {
+    encode(message: RefreshTimeoutResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutResponse;
+    fromJSON(object: any): RefreshTimeoutResponse;
+    toJSON(message: RefreshTimeoutResponse): unknown;
+    create(base?: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+    fromPartial(object: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+};
+export declare const ReleaseSlotRequest: {
+    encode(message: ReleaseSlotRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotRequest;
+    fromJSON(object: any): ReleaseSlotRequest;
+    toJSON(message: ReleaseSlotRequest): unknown;
+    create(base?: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+    fromPartial(object: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+};
+export declare const ReleaseSlotResponse: {
+    encode(_: ReleaseSlotResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotResponse;
+    fromJSON(_: any): ReleaseSlotResponse;
+    toJSON(_: ReleaseSlotResponse): unknown;
+    create(base?: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+    fromPartial(_: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+};
 export type DispatcherDefinition = typeof DispatcherDefinition;
 export declare const DispatcherDefinition: {
     readonly name: "Dispatcher";
@@ -585,6 +631,50 @@ export declare const DispatcherDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        readonly refreshTimeout: {
+            readonly name: "RefreshTimeout";
+            readonly requestType: {
+                encode(message: RefreshTimeoutRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutRequest;
+                fromJSON(object: any): RefreshTimeoutRequest;
+                toJSON(message: RefreshTimeoutRequest): unknown;
+                create(base?: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+                fromPartial(object: DeepPartial<RefreshTimeoutRequest>): RefreshTimeoutRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(message: RefreshTimeoutResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): RefreshTimeoutResponse;
+                fromJSON(object: any): RefreshTimeoutResponse;
+                toJSON(message: RefreshTimeoutResponse): unknown;
+                create(base?: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+                fromPartial(object: DeepPartial<RefreshTimeoutResponse>): RefreshTimeoutResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        readonly releaseSlot: {
+            readonly name: "ReleaseSlot";
+            readonly requestType: {
+                encode(message: ReleaseSlotRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotRequest;
+                fromJSON(object: any): ReleaseSlotRequest;
+                toJSON(message: ReleaseSlotRequest): unknown;
+                create(base?: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+                fromPartial(object: DeepPartial<ReleaseSlotRequest>): ReleaseSlotRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(_: ReleaseSlotResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): ReleaseSlotResponse;
+                fromJSON(_: any): ReleaseSlotResponse;
+                toJSON(_: ReleaseSlotResponse): unknown;
+                create(base?: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+                fromPartial(_: DeepPartial<ReleaseSlotResponse>): ReleaseSlotResponse;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
     };
 };
 export interface DispatcherServiceImplementation<CallContextExt = {}> {
@@ -603,6 +693,8 @@ export interface DispatcherServiceImplementation<CallContextExt = {}> {
     sendGroupKeyActionEvent(request: GroupKeyActionEvent, context: CallContext & CallContextExt): Promise<DeepPartial<ActionEventResponse>>;
     putOverridesData(request: OverridesData, context: CallContext & CallContextExt): Promise<DeepPartial<OverridesDataResponse>>;
     unsubscribe(request: WorkerUnsubscribeRequest, context: CallContext & CallContextExt): Promise<DeepPartial<WorkerUnsubscribeResponse>>;
+    refreshTimeout(request: RefreshTimeoutRequest, context: CallContext & CallContextExt): Promise<DeepPartial<RefreshTimeoutResponse>>;
+    releaseSlot(request: ReleaseSlotRequest, context: CallContext & CallContextExt): Promise<DeepPartial<ReleaseSlotResponse>>;
 }
 export interface DispatcherClient<CallOptionsExt = {}> {
     register(request: DeepPartial<WorkerRegisterRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkerRegisterResponse>;
@@ -620,6 +712,8 @@ export interface DispatcherClient<CallOptionsExt = {}> {
     sendGroupKeyActionEvent(request: DeepPartial<GroupKeyActionEvent>, options?: CallOptions & CallOptionsExt): Promise<ActionEventResponse>;
     putOverridesData(request: DeepPartial<OverridesData>, options?: CallOptions & CallOptionsExt): Promise<OverridesDataResponse>;
     unsubscribe(request: DeepPartial<WorkerUnsubscribeRequest>, options?: CallOptions & CallOptionsExt): Promise<WorkerUnsubscribeResponse>;
+    refreshTimeout(request: DeepPartial<RefreshTimeoutRequest>, options?: CallOptions & CallOptionsExt): Promise<RefreshTimeoutResponse>;
+    releaseSlot(request: DeepPartial<ReleaseSlotRequest>, options?: CallOptions & CallOptionsExt): Promise<ReleaseSlotResponse>;
 }
 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 {} ? {