@hatchet-dev/typescript-sdk 0.7.1 → 0.7.3

package/clients/admin/admin-client.js

@@ -81,9 +81,13 @@ class AdminClient {
      */
     run_workflow(workflowName, input, options) {
         return __awaiter(this, void 0, void 0, function* () {
+            let computedName = workflowName;
             try {
+                if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
+                    computedName = this.config.namespace + workflowName;
+                }
                 const inputStr = JSON.stringify(input);
-                const resp = yield this.client.triggerWorkflow(Object.assign(Object.assign({ name: workflowName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
+                const resp = yield this.client.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
                         ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
                         : undefined }));
                 return resp.workflowRunId;

package/clients/rest/generated/Api.d.ts

@@ -1,4 +1,4 @@
-import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, ListSNSIntegrations, ListSlackWebhooks, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, SNSIntegration, StepRun, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMemberList, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunStatus, WorkflowRunStatusList, WorkflowRunsCancelRequest, WorkflowRunsMetrics, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
+import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, ListSNSIntegrations, ListSlackWebhooks, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, SNSIntegration, StepRun, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantResourcePolicy, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunStatus, WorkflowRunStatusList, WorkflowRunsCancelRequest, WorkflowRunsMetrics, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -190,6 +190,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     alertEmailGroupList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<TenantAlertEmailGroupList, any>>;
+    /**
+     * @description Gets the resource policy for a tenant
+     *
+     * @tags Tenant
+     * @name TenantResourcePolicyGet
+     * @summary Create tenant alert email group
+     * @request GET:/api/v1/tenants/{tenant}/resource-policy
+     * @secure
+     */
+    tenantResourcePolicyGet: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<TenantResourcePolicy, any>>;
     /**
      * @description Updates a tenant alert email group
      *
@@ -475,6 +485,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     tenantMemberList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<TenantMemberList, any>>;
+    /**
+     * @description Delete a member from a tenant
+     *
+     * @tags Tenant
+     * @name TenantMemberDelete
+     * @summary Delete a tenant member
+     * @request DELETE:/api/v1/tenants/{tenant}/members/{member}
+     * @secure
+     */
+    tenantMemberDelete: (tenant: string, member: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<TenantMember, any>>;
     /**
      * @description Get the data for an event.
      *

package/clients/rest/generated/Api.js

@@ -204,6 +204,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.alertEmailGroupList = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/alerting-email-groups`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Gets the resource policy for a tenant
+         *
+         * @tags Tenant
+         * @name TenantResourcePolicyGet
+         * @summary Create tenant alert email group
+         * @request GET:/api/v1/tenants/{tenant}/resource-policy
+         * @secure
+         */
+        this.tenantResourcePolicyGet = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/resource-policy`, method: 'GET', secure: true, format: 'json' }, params));
         /**
          * @description Updates a tenant alert email group
          *
@@ -461,6 +471,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.tenantMemberList = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/members`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Delete a member from a tenant
+         *
+         * @tags Tenant
+         * @name TenantMemberDelete
+         * @summary Delete a tenant member
+         * @request DELETE:/api/v1/tenants/{tenant}/members/{member}
+         * @secure
+         */
+        this.tenantMemberDelete = (tenant, member, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/members/${member}`, method: 'DELETE', secure: true, format: 'json' }, params));
         /**
          * @description Get the data for an event.
          *

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

@@ -168,6 +168,8 @@ export interface Tenant {
     slug: string;
     /** Whether the tenant has opted out of analytics. */
     analyticsOptOut?: boolean;
+    /** Whether to alert tenant members. */
+    alertMemberEmails?: boolean;
 }
 export interface TenantMember {
     metadata: APIResourceMeta;
@@ -187,6 +189,35 @@ export declare enum TenantMemberRole {
     ADMIN = "ADMIN",
     MEMBER = "MEMBER"
 }
+export declare enum TenantResource {
+    WORKER = "WORKER",
+    EVENT = "EVENT",
+    WORKFLOW_RUN = "WORKFLOW_RUN",
+    CRON = "CRON",
+    SCHEDULE = "SCHEDULE"
+}
+export interface TenantResourceLimit {
+    metadata: APIResourceMeta;
+    /** The resource associated with this limit. */
+    resource: TenantResource;
+    /** The limit associated with this limit. */
+    limitValue: number;
+    /** The alarm value associated with this limit to warn of approaching limit value. */
+    alarmValue?: number;
+    /** The current value associated with this limit. */
+    value: number;
+    /** The meter window for the limit. (i.e. 1 day, 1 week, 1 month) */
+    window?: string;
+    /**
+     * The last time the limit was refilled.
+     * @format date-time
+     */
+    lastRefill?: string;
+}
+export interface TenantResourcePolicy {
+    /** A list of resource limits for the tenant. */
+    limits: TenantResourceLimit[];
+}
 export interface CreateTenantInviteRequest {
     /** The email of the user to invite. */
     email: string;
@@ -199,6 +230,14 @@ export interface UpdateTenantInviteRequest {
 }
 export interface TenantAlertingSettings {
     metadata: APIResourceMeta;
+    /** Whether to alert tenant members. */
+    alertMemberEmails?: boolean;
+    /** Whether to send alerts when workflow runs fail. */
+    enableWorkflowRunFailureAlerts?: boolean;
+    /** Whether to enable alerts when tokens are approaching expiration. */
+    enableExpiringTokenAlerts?: boolean;
+    /** Whether to enable alerts when tenant resources are approaching limits. */
+    enableTenantResourceLimitAlerts?: boolean;
     /** The max frequency at which to alert. */
     maxAlertingFrequency: string;
     /**
@@ -275,6 +314,14 @@ export interface UpdateTenantRequest {
     name?: string;
     /** Whether the tenant has opted out of analytics. */
     analyticsOptOut?: boolean;
+    /** Whether to alert tenant members. */
+    alertMemberEmails?: boolean;
+    /** Whether to send alerts when workflow runs fail. */
+    enableWorkflowRunFailureAlerts?: boolean;
+    /** Whether to enable alerts when tokens are approaching expiration. */
+    enableExpiringTokenAlerts?: boolean;
+    /** Whether to enable alerts when tenant resources are approaching limits. */
+    enableTenantResourceLimitAlerts?: boolean;
     /** The max frequency at which to alert. */
     maxAlertingFrequency?: string;
 }

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

@@ -10,13 +10,21 @@
  * ---------------------------------------------------------------
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.LogLineOrderByDirection = exports.LogLineOrderByField = exports.LogLineLevel = exports.PullRequestState = exports.StepRunEventSeverity = exports.StepRunEventReason = exports.StepRunStatus = exports.JobRunStatus = exports.WorkflowRunStatus = exports.EventOrderByDirection = exports.EventOrderByField = exports.TenantResource = exports.TenantMemberRole = void 0;
 var TenantMemberRole;
 (function (TenantMemberRole) {
     TenantMemberRole["OWNER"] = "OWNER";
     TenantMemberRole["ADMIN"] = "ADMIN";
     TenantMemberRole["MEMBER"] = "MEMBER";
 })(TenantMemberRole || (exports.TenantMemberRole = TenantMemberRole = {}));
+var TenantResource;
+(function (TenantResource) {
+    TenantResource["WORKER"] = "WORKER";
+    TenantResource["EVENT"] = "EVENT";
+    TenantResource["WORKFLOW_RUN"] = "WORKFLOW_RUN";
+    TenantResource["CRON"] = "CRON";
+    TenantResource["SCHEDULE"] = "SCHEDULE";
+})(TenantResource || (exports.TenantResource = TenantResource = {}));
 var EventOrderByField;
 (function (EventOrderByField) {
     EventOrderByField["CreatedAt"] = "createdAt";

package/clients/worker/worker.js

@@ -148,9 +148,14 @@ class Worker {
                 this.logger.info(`Step run ${action.stepRunId} succeeded`);
                 try {
                     // Send the action event to the dispatcher
-                    const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, result);
+                    const event = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_COMPLETED, result || null);
                     this.client.dispatcher.sendStepActionEvent(event).catch((e) => {
-                        this.logger.error(`Could not send action event: ${e.message}`);
+                        this.logger.error(`Could not send completed action event: ${e.message}`);
+                        // send a failure event
+                        const failureEvent = this.getStepActionEvent(action, dispatcher_1.StepActionEventType.STEP_EVENT_TYPE_FAILED, e.message);
+                        this.client.dispatcher.sendStepActionEvent(failureEvent).catch((err2) => {
+                            this.logger.error(`Could not send failed action event: ${err2.message}`);
+                        });
                     });
                     // delete the run from the futures
                     delete this.futures[action.stepRunId];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.7.1",
+  "version": "0.7.3",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [
@@ -64,12 +64,12 @@
     "autoprefixer": "^10.4.16",
     "dotenv-cli": "^7.3.0",
     "eslint": "^8.56.0",
-    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-config-airbnb-typescript": "^18.0.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-standard-with-typescript": "^43.0.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jest": "^27.6.3",
+    "eslint-plugin-jest": "^28.5.0",
     "eslint-plugin-n": "^15.0.0 || ^16.0.0 ",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-promise": "^6.0.0",

package/protoc/dispatcher/dispatcher.d.ts

@@ -1,4 +1,4 @@
-import type { CallContext, CallOptions } from 'nice-grpc-common';
+import { type CallContext, type CallOptions } from 'nice-grpc-common';
 import * as _m0 from 'protobufjs/minimal';
 export declare const protobufPackage = "";
 export declare enum ActionType {
@@ -96,6 +96,8 @@ export interface AssignedAction {
     actionPayload: string;
     /** the step name */
     stepName: string;
+    /** the count number of the retry attempt */
+    retryCount: number;
 }
 export interface WorkerListenRequest {
     /** the id of the worker */

package/protoc/dispatcher/dispatcher.js

@@ -1,4 +1,9 @@
 "use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.178.0
+//   protoc               v3.19.1
+// source: dispatcher/dispatcher.proto
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -480,6 +485,7 @@ function createBaseAssignedAction() {
         actionType: 0,
         actionPayload: '',
         stepName: '',
+        retryCount: 0,
     };
 }
 exports.AssignedAction = {
@@ -520,6 +526,9 @@ exports.AssignedAction = {
         if (message.stepName !== '') {
             writer.uint32(98).string(message.stepName);
         }
+        if (message.retryCount !== 0) {
+            writer.uint32(104).int32(message.retryCount);
+        }
         return writer;
     },
     decode(input, length) {
@@ -601,6 +610,12 @@ exports.AssignedAction = {
                     }
                     message.stepName = reader.string();
                     continue;
+                case 13:
+                    if (tag !== 104) {
+                        break;
+                    }
+                    message.retryCount = reader.int32();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -625,6 +640,7 @@ exports.AssignedAction = {
             actionType: isSet(object.actionType) ? actionTypeFromJSON(object.actionType) : 0,
             actionPayload: isSet(object.actionPayload) ? globalThis.String(object.actionPayload) : '',
             stepName: isSet(object.stepName) ? globalThis.String(object.stepName) : '',
+            retryCount: isSet(object.retryCount) ? globalThis.Number(object.retryCount) : 0,
         };
     },
     toJSON(message) {
@@ -665,13 +681,16 @@ exports.AssignedAction = {
         if (message.stepName !== '') {
             obj.stepName = message.stepName;
         }
+        if (message.retryCount !== 0) {
+            obj.retryCount = Math.round(message.retryCount);
+        }
         return obj;
     },
     create(base) {
         return exports.AssignedAction.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
         const message = createBaseAssignedAction();
         message.tenantId = (_a = object.tenantId) !== null && _a !== void 0 ? _a : '';
         message.workflowRunId = (_b = object.workflowRunId) !== null && _b !== void 0 ? _b : '';
@@ -685,6 +704,7 @@ exports.AssignedAction = {
         message.actionType = (_k = object.actionType) !== null && _k !== void 0 ? _k : 0;
         message.actionPayload = (_l = object.actionPayload) !== null && _l !== void 0 ? _l : '';
         message.stepName = (_m = object.stepName) !== null && _m !== void 0 ? _m : '';
+        message.retryCount = (_o = object.retryCount) !== null && _o !== void 0 ? _o : 0;
         return message;
     },
 };
@@ -1389,7 +1409,7 @@ exports.WorkflowEvent = {
         if (message.eventPayload !== '') {
             writer.uint32(50).string(message.eventPayload);
         }
-        if (message.hangup === true) {
+        if (message.hangup !== false) {
             writer.uint32(56).bool(message.hangup);
         }
         if (message.stepRetries !== undefined) {
@@ -1504,7 +1524,7 @@ exports.WorkflowEvent = {
         if (message.eventPayload !== '') {
             obj.eventPayload = message.eventPayload;
         }
-        if (message.hangup === true) {
+        if (message.hangup !== false) {
             obj.hangup = message.hangup;
         }
         if (message.stepRetries !== undefined) {

package/protoc/events/events.d.ts

@@ -1,4 +1,4 @@
-import type { CallContext, CallOptions } from 'nice-grpc-common';
+import { type CallContext, type CallOptions } from 'nice-grpc-common';
 import * as _m0 from 'protobufjs/minimal';
 export declare const protobufPackage = "";
 export interface Event {

package/protoc/events/events.js

@@ -1,4 +1,9 @@
 "use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.178.0
+//   protoc               v3.19.1
+// source: events/events.proto
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/protoc/google/protobuf/timestamp.js

@@ -1,4 +1,9 @@
 "use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.178.0
+//   protoc               v3.19.1
+// source: google/protobuf/timestamp.proto
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -99,6 +104,9 @@ function longToNumber(long) {
     if (long.gt(globalThis.Number.MAX_SAFE_INTEGER)) {
         throw new globalThis.Error('Value is larger than Number.MAX_SAFE_INTEGER');
     }
+    if (long.lt(globalThis.Number.MIN_SAFE_INTEGER)) {
+        throw new globalThis.Error('Value is smaller than Number.MIN_SAFE_INTEGER');
+    }
     return long.toNumber();
 }
 if (_m0.util.Long !== Long) {

package/protoc/workflows/workflows.d.ts

@@ -1,4 +1,4 @@
-import type { CallContext, CallOptions } from 'nice-grpc-common';
+import { type CallContext, type CallOptions } from 'nice-grpc-common';
 import * as _m0 from 'protobufjs/minimal';
 export declare const protobufPackage = "";
 export declare enum ConcurrencyLimitStrategy {

package/protoc/workflows/workflows.js

@@ -1,4 +1,9 @@
 "use strict";
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v1.178.0
+//   protoc               v3.19.1
+// source: workflows/workflows.proto
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);

package/step.d.ts

@@ -97,7 +97,7 @@ export declare class Context<T, K> {
     putStream(data: string | Uint8Array): Promise<void>;
     spawnWorkflow<P = unknown, Q = unknown>(workflowName: string, input: Q, key?: string): ChildWorkflowRef<P>;
 }
-export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep> | NextStep | void;
+export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep | void> | NextStep | void;
 export interface CreateStep<T, K> extends z.infer<typeof CreateStepSchema> {
     run: StepRunFunction<T, K>;
 }

package/step.js

@@ -225,7 +225,8 @@ class Context {
     }
     spawnWorkflow(workflowName, input, key) {
         const { workflowRunId, stepRunId } = this.action;
-        const childWorkflowRunIdPromise = this.client.admin.run_workflow(workflowName, input, {
+        const name = this.client.config.namespace + workflowName;
+        const childWorkflowRunIdPromise = this.client.admin.run_workflow(name, input, {
             parentId: workflowRunId,
             parentStepRunId: stepRunId,
             childKey: key,