@hatchet-dev/typescript-sdk 0.1.25 → 0.1.27

package/clients/dispatcher/action-listener.d.ts

@@ -25,6 +25,7 @@ export declare class ActionListener {
     retries: number;
     retryInterval: number;
     retryCount: number;
+    done: boolean;
     constructor(client: DispatcherClient, workerId: string, retryInterval?: number, retryCount?: number);
     actions: () => AsyncGenerator<Action, void, unknown>;
     incrementRetries(): Promise<void>;

package/clients/dispatcher/action-listener.js

@@ -45,10 +45,14 @@ class ActionListener {
         this.retries = 0;
         this.retryInterval = DEFAULT_ACTION_LISTENER_RETRY_INTERVAL;
         this.retryCount = DEFAULT_ACTION_LISTENER_RETRY_COUNT;
+        this.done = false;
         this.actions = () => (function gen(client) {
             return __asyncGenerator(this, arguments, function* gen_1() {
                 var _a, e_1, _b, _c;
                 while (true) {
+                    if (client.done) {
+                        break;
+                    }
                     try {
                         try {
                             for (var _d = true, _e = (e_1 = void 0, __asyncValues(yield __await(client.getListenClient()))), _f; _f = yield __await(_e.next()), _a = _f.done, !_a; _d = true) {
@@ -121,6 +125,7 @@ class ActionListener {
     }
     unregister() {
         return __awaiter(this, void 0, void 0, function* () {
+            this.done = true;
             try {
                 return this.client.unsubscribe({
                     workerId: this.workerId,

package/clients/listener/listener-client.d.ts

@@ -18,6 +18,9 @@ export declare class ListenerClient {
     client: PbDispatcherClient;
     logger: Logger;
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
-    on(workflowRunId: string, handler: (event: StepRunEvent) => Promise<void>): Promise<void>;
+    stream(workflowRunId: string): AsyncGenerator<{
+        type: StepRunEventType;
+        payload: string;
+    }, void, unknown>;
     retrySubscribe(workflowRunId: string): Promise<AsyncIterable<import("../../protoc/dispatcher").WorkflowEvent>>;
 }

package/clients/listener/listener-client.js

@@ -15,6 +15,19 @@ var __asyncValues = (this && this.__asyncValues) || function (o) {
     function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
     function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
 };
+var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
+var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
+    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
+    var g = generator.apply(thisArg, _arguments || []), i, q = [];
+    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
+    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
+    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
+    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
+    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
+    function fulfill(value) { resume("next", value); }
+    function reject(value) { resume("throw", value); }
+    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -42,15 +55,15 @@ class ListenerClient {
         this.client = factory.create(dispatcher_1.DispatcherDefinition, channel);
         this.logger = new logger_1.Logger(`Listener`, config.log_level);
     }
-    on(workflowRunId, handler) {
-        var _a, e_1, _b, _c;
-        return __awaiter(this, void 0, void 0, function* () {
+    stream(workflowRunId) {
+        return __asyncGenerator(this, arguments, function* stream_1() {
+            var _a, e_1, _b, _c;
             let listener = this.client.subscribeToWorkflowEvents({
                 workflowRunId,
             });
             try {
                 try {
-                    for (var _d = true, listener_1 = __asyncValues(listener), listener_1_1; listener_1_1 = yield listener_1.next(), _a = listener_1_1.done, !_a; _d = true) {
+                    for (var _d = true, listener_1 = __asyncValues(listener), listener_1_1; listener_1_1 = yield __await(listener_1.next()), _a = listener_1_1.done, !_a; _d = true) {
                         _c = listener_1_1.value;
                         _d = false;
                         const workflowEvent = _c;
@@ -72,28 +85,30 @@ class ListenerClient {
                                 eventType = StepRunEventType.STEP_RUN_EVENT_TYPE_TIMED_OUT;
                                 break;
                             default:
-                                throw new hatchet_error_1.default(`Unknown event type: ${workflowEvent.eventType}`);
+                            // no nothing
+                        }
+                        if (eventType) {
+                            yield yield __await({
+                                type: eventType,
+                                payload: workflowEvent.eventPayload,
+                            });
                         }
-                        yield handler({
-                            type: eventType,
-                            payload: workflowEvent.eventPayload,
-                        });
                     }
                 }
                 catch (e_1_1) { e_1 = { error: e_1_1 }; }
                 finally {
                     try {
-                        if (!_d && !_a && (_b = listener_1.return)) yield _b.call(listener_1);
+                        if (!_d && !_a && (_b = listener_1.return)) yield __await(_b.call(listener_1));
                     }
                     finally { if (e_1) throw e_1.error; }
                 }
             }
             catch (e) {
                 if (e.code === nice_grpc_1.Status.CANCELLED) {
-                    return;
+                    return yield __await(void 0);
                 }
                 if (e.code === nice_grpc_1.Status.UNAVAILABLE) {
-                    listener = yield this.retrySubscribe(workflowRunId);
+                    listener = yield __await(this.retrySubscribe(workflowRunId));
                 }
             }
         });

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

@@ -1,4 +1,4 @@
-import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, StepRun, Tenant, TenantInvite, TenantInviteList, TenantMemberList, TriggerWorkflowRunRequest, UpdateTenantInviteRequest, User, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowRun, WorkflowRunList, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
+import { APIMeta, AcceptInviteRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreatePullRequestFromStepRun, CreateTenantInviteRequest, CreateTenantRequest, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, GetStepRunDiffResponse, LinkGithubRepositoryRequest, ListAPIMetaIntegration, ListAPITokensResponse, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, ListPullRequestsResponse, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, PullRequestState, RejectInviteRequest, ReplayEventRequest, RerunStepRunRequest, StepRun, Tenant, TenantInvite, TenantInviteList, TenantMemberList, TriggerWorkflowRunRequest, UpdateTenantInviteRequest, User, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, Worker, WorkerList, Workflow, WorkflowID, WorkflowList, WorkflowRun, WorkflowRunList, WorkflowRunStatusList, WorkflowVersion, WorkflowVersionDefinition } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -103,6 +103,15 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request POST:/api/v1/github/webhook/{webhook}
      */
     githubUpdateTenantWebhook: (webhook: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description SNS event
+     *
+     * @tags Github
+     * @name SnsUpdate
+     * @summary Github app tenant webhook
+     * @request POST:/api/v1/sns/{tenant}/{event}
+     */
+    snsUpdate: (tenant: string, event: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * @description Gets the current user
      *
@@ -274,6 +283,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         keys?: EventKey[];
         /** A list of workflow IDs to filter by */
         workflows?: WorkflowID[];
+        /** A list of workflow run statuses to filter by */
+        statuses?: WorkflowRunStatusList;
         /** The search query to filter for */
         search?: EventSearch;
         /** What to order by */
@@ -341,6 +352,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     workflowGet: (workflow: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Workflow, any>>;
+    /**
+     * @description Delete a workflow for a tenant
+     *
+     * @tags Workflow
+     * @name WorkflowDelete
+     * @summary Delete workflow
+     * @request DELETE:/api/v1/workflows/{workflow}
+     * @secure
+     */
+    workflowDelete: (workflow: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
     /**
      * @description Get a workflow version for a tenant
      *
@@ -532,6 +553,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     stepRunUpdateRerun: (tenant: string, stepRun: string, data: RerunStepRunRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<StepRun, any>>;
+    /**
+     * @description Get the schema for a step run
+     *
+     * @tags Step Run
+     * @name StepRunGetSchema
+     * @summary Get step run schema
+     * @request GET:/api/v1/tenants/{tenant}/step-runs/{step-run}/schema
+     * @secure
+     */
+    stepRunGetSchema: (tenant: string, stepRun: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<object, any>>;
     /**
      * @description Get all workers for a tenant
      *

package/clients/rest/generated/Api.js

@@ -117,6 +117,15 @@ class Api extends http_client_1.HttpClient {
          * @request POST:/api/v1/github/webhook/{webhook}
          */
         this.githubUpdateTenantWebhook = (webhook, params = {}) => this.request(Object.assign({ path: `/api/v1/github/webhook/${webhook}`, method: 'POST' }, params));
+        /**
+         * @description SNS event
+         *
+         * @tags Github
+         * @name SnsUpdate
+         * @summary Github app tenant webhook
+         * @request POST:/api/v1/sns/{tenant}/{event}
+         */
+        this.snsUpdate = (tenant, event, params = {}) => this.request(Object.assign({ path: `/api/v1/sns/${tenant}/${event}`, method: 'POST' }, params));
         /**
          * @description Gets the current user
          *
@@ -334,6 +343,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.workflowGet = (workflow, params = {}) => this.request(Object.assign({ path: `/api/v1/workflows/${workflow}`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Delete a workflow for a tenant
+         *
+         * @tags Workflow
+         * @name WorkflowDelete
+         * @summary Delete workflow
+         * @request DELETE:/api/v1/workflows/{workflow}
+         * @secure
+         */
+        this.workflowDelete = (workflow, params = {}) => this.request(Object.assign({ path: `/api/v1/workflows/${workflow}`, method: 'DELETE', secure: true }, params));
         /**
          * @description Get a workflow version for a tenant
          *
@@ -454,6 +473,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.stepRunUpdateRerun = (tenant, stepRun, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/step-runs/${stepRun}/rerun`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Get the schema for a step run
+         *
+         * @tags Step Run
+         * @name StepRunGetSchema
+         * @summary Get step run schema
+         * @request GET:/api/v1/tenants/{tenant}/step-runs/{step-run}/schema
+         * @secure
+         */
+        this.stepRunGetSchema = (tenant, stepRun, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}/step-runs/${stepRun}/schema`, method: 'GET', secure: true, format: 'json' }, params));
         /**
          * @description Get all workers for a tenant
          *

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

@@ -287,6 +287,17 @@ export interface Workflow {
     jobs?: Job[];
     deployment?: WorkflowDeploymentConfig;
 }
+export interface WorkflowConcurrency {
+    /**
+     * The maximum number of concurrent workflow runs.
+     * @format int32
+     */
+    maxRuns: number;
+    /** The strategy to use when the concurrency limit is reached. */
+    limitStrategy: 'CANCEL_IN_PROGRESS' | 'DROP_NEWEST' | 'QUEUE_NEWEST' | 'GROUP_ROUND_ROBIN';
+    /** An action which gets the concurrency group for the WorkflowRun. */
+    getConcurrencyGroup: string;
+}
 export interface WorkflowDeploymentConfig {
     metadata: APIResourceMeta;
     /** The repository name. */
@@ -320,6 +331,7 @@ export interface WorkflowVersion {
     order: number;
     workflowId: string;
     workflow?: Workflow;
+    concurrency?: WorkflowConcurrency;
     triggers?: WorkflowTriggers;
     jobs?: Job[];
 }
@@ -403,6 +415,7 @@ export declare enum WorkflowRunStatus {
     FAILED = "FAILED",
     CANCELLED = "CANCELLED"
 }
+export type WorkflowRunStatusList = WorkflowRunStatus[];
 export declare enum JobRunStatus {
     PENDING = "PENDING",
     RUNNING = "RUNNING",
@@ -480,7 +493,6 @@ export interface StepRun {
     cancelledAtEpoch?: number;
     cancelledReason?: string;
     cancelledError?: string;
-    inputSchema?: string;
 }
 export interface WorkerList {
     pagination?: PaginationResponse;

package/clients/worker/worker.d.ts

@@ -30,6 +30,6 @@ export declare class Worker {
     getGroupKeyActionEvent(action: Action, eventType: GroupKeyActionEventType, payload?: any): GroupKeyActionEvent;
     handleCancelStepRun(action: Action): void;
     stop(): Promise<void>;
-    exitGracefully(): Promise<void>;
+    exitGracefully(handleKill: boolean): Promise<void>;
     start(): Promise<void>;
 }

package/clients/worker/worker.js

@@ -35,8 +35,8 @@ class Worker {
         this.name = options.name;
         this.action_registry = {};
         this.maxRuns = options.maxRuns;
-        process.on('SIGTERM', () => this.exitGracefully());
-        process.on('SIGINT', () => this.exitGracefully());
+        process.on('SIGTERM', () => this.exitGracefully(true));
+        process.on('SIGINT', () => this.exitGracefully(true));
         this.killing = false;
         this.handle_kill = options.handleKill === undefined ? true : options.handleKill;
         this.logger = new logger_1.Logger(`Worker/${this.name}`, this.client.config.log_level);
@@ -245,16 +245,16 @@ class Worker {
     }
     stop() {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.exitGracefully();
+            yield this.exitGracefully(false);
         });
     }
-    exitGracefully() {
+    exitGracefully(handleKill) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
             this.killing = true;
             this.logger.info('Starting to exit...');
             try {
-                (_a = this.listener) === null || _a === void 0 ? void 0 : _a.unregister();
+                yield ((_a = this.listener) === null || _a === void 0 ? void 0 : _a.unregister());
             }
             catch (e) {
                 this.logger.error(`Could not unregister listener: ${e.message}`);
@@ -262,7 +262,8 @@ class Worker {
             this.logger.info('Gracefully exiting hatchet worker, running tasks will attempt to finish...');
             // attempt to wait for futures to finish
             yield Promise.all(Object.values(this.futures).map(({ promise }) => promise));
-            if (this.handle_kill) {
+            this.logger.info('Successfully finished pending tasks.');
+            if (handleKill) {
                 this.logger.info('Exiting hatchet worker...');
                 process.exit(0);
             }
@@ -309,6 +310,11 @@ class Worker {
                 }
             }
             catch (e) {
+                // TODO TEMP this needs to be handled better
+                if (this.killing) {
+                    this.logger.info(`Exiting worker, ignoring error: ${e.message}`);
+                    return;
+                }
                 this.logger.error(`Could not run worker: ${e.message}`);
                 throw new hatchet_error_1.default(`Could not run worker: ${e.message}`);
             }

package/package.json

@@ -1,25 +1,30 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.1.25",
+  "version": "0.1.27",
   "description": "Background task orchestration & visibility for developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "*",
     "!**/*.test.js",
-    "!**/*.test.d.ts"
+    "!**/*.test.d.ts",
+    "!**/*.e2e.js",
+    "!**/*.e2e.d.ts"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/hatchet-dev/hatchet.git"
+    "url": "https://github.com/hatchet-dev/hatchet-typescript.git"
   },
   "scripts": {
     "build": "echo 'build hatchet sdk with `npn run tsc:build` to ensure it is not build during the publish step' && exit 0",
     "prepare": "npm run build",
     "tsc:build": "tsc && resolve-tspaths",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "generate": "./generate-protoc.sh",
+    "test:unit": "jest --testMatch='**/*.test.ts'",
+    "test:e2e": "jest --testMatch='**/*.e2e.ts'",
+    "test:unit:watch": "jest --testMatch='**/*.test.ts' --watch",
+    "generate": "pnpm run '/generate-.*/'",
+    "generate-api": "npx --yes swagger-cli bundle ./hatchet/api-contracts/openapi/openapi.yaml --outfile openapi.yaml --type yaml && npx swagger-typescript-api -p openapi.yaml -o src/clients/rest/generated -n hatchet.ts --modular --axios",
+    "generate-protoc": "./generate-protoc.sh",
     "lint:check": "npm run eslint:check && npm run prettier:check",
     "lint:fix": "npm run eslint:fix && npm run prettier:fix",
     "eslint:check": "eslint \"{hatchet,tests}/**/*.{ts,tsx,js}\"",
@@ -28,6 +33,7 @@
     "prettier:fix": "prettier \"hatchet/**/*.{ts,tsx}\" --write",
     "exec": "npx dotenv -- ts-node -r tsconfig-paths/register --project tsconfig.json",
     "example:event": "npm run exec -- ./examples/example-event.ts",
+    "example:event-listen": "npm run exec -- ./examples/example-event-with-results.ts",
     "worker:simple": "npm run exec -- ./examples/simple-worker.ts",
     "manual:trigger": "npm run exec -- ./examples/manual-trigger.ts",
     "worker:dag": "npm run exec -- ./examples/dag-worker.ts",
@@ -86,4 +92,4 @@
     "yaml": "^2.3.4",
     "zod": "^3.22.4"
   }
-}
+}

package/step.d.ts

@@ -21,7 +21,7 @@ export declare const CreateStepSchema: z.ZodObject<{
 }>;
 type JSONPrimitive = string | number | boolean | null | Array<JSONPrimitive>;
 export type NextStep = {
-    [key: string]: NextStep | JSONPrimitive;
+    [key: string]: NextStep | JSONPrimitive | Array<NextStep>;
 };
 interface ContextData<T, K> {
     input: T;