@hatchet-dev/typescript-sdk 0.7.2 → 0.8.0-alpha.0

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

@@ -3,7 +3,7 @@ import { CreateWorkflowVersionOpts, RateLimitDuration, WorkflowServiceClient } f
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import { Api } from '../rest';
-import { WorkflowRunStatus } from '../rest/generated/data-contracts';
+import { WebhookWorkerCreateRequest, WorkflowRunStatus } from '../rest/generated/data-contracts';
 type WorkflowMetricsQuery = {
     workflowId?: string;
     workflowName?: string;
@@ -40,6 +40,7 @@ export declare class AdminClient {
      */
     put_workflow(workflow: CreateWorkflowVersionOpts): Promise<void>;
     put_rate_limit(key: string, limit: number, duration?: RateLimitDuration): Promise<void>;
+    webhook_create(data: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WebhookWorker, any>>;
     /**
      * Run a new instance of a workflow with the given input. This will create a new workflow run and return the ID of the
      * new run.

package/clients/admin/admin-client.js

@@ -72,6 +72,11 @@ class AdminClient {
             }
         });
     }
+    webhook_create(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.api.webhookCreate(this.tenantId, data);
+        });
+    }
     /**
      * Run a new instance of a workflow with the given input. This will create a new workflow run and return the ID of the
      * new run.
@@ -82,11 +87,12 @@ class AdminClient {
     run_workflow(workflowName, input, options) {
         return __awaiter(this, void 0, void 0, function* () {
             try {
+                let wfName = workflowName;
                 if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
-                    workflowName = this.config.namespace + workflowName;
+                    wfName = 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: wfName, 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/dispatcher/action-listener.d.ts

@@ -1,26 +1,54 @@
 import { DispatcherClient as PbDispatcherClient, AssignedAction } from '../../protoc/dispatcher';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
+import { z } from 'zod';
 import { DispatcherClient } from './dispatcher-client';
 import { Heartbeat } from './heartbeat/heartbeat-controller';
 declare enum ListenStrategy {
     LISTEN_STRATEGY_V1 = 1,
     LISTEN_STRATEGY_V2 = 2
 }
-export interface Action {
+export declare const ActionObject: z.ZodObject<{
+    tenantId: z.ZodString;
+    jobId: z.ZodString;
+    jobName: z.ZodString;
+    jobRunId: z.ZodString;
+    stepId: z.ZodString;
+    stepRunId: z.ZodString;
+    actionId: z.ZodString;
+    actionType: z.ZodEffects<z.ZodOptional<z.ZodNumber>, number | undefined, unknown>;
+    actionPayload: z.ZodString;
+    workflowRunId: z.ZodString;
+    getGroupKeyRunId: z.ZodOptional<z.ZodString>;
+    stepName: z.ZodString;
+}, "strip", z.ZodTypeAny, {
     tenantId: string;
+    stepRunId: string;
+    workflowRunId: string;
     jobId: string;
     jobName: string;
     jobRunId: string;
     stepId: string;
-    stepRunId: string;
     actionId: string;
-    actionType: number;
     actionPayload: string;
+    stepName: string;
+    getGroupKeyRunId?: string | undefined;
+    actionType?: number | undefined;
+}, {
+    tenantId: string;
+    stepRunId: string;
     workflowRunId: string;
-    getGroupKeyRunId: string;
+    jobId: string;
+    jobName: string;
+    jobRunId: string;
+    stepId: string;
+    actionId: string;
+    actionPayload: string;
     stepName: string;
-}
+    getGroupKeyRunId?: string | undefined;
+    actionType?: unknown;
+}>;
+export type Action = z.infer<typeof ActionObject>;
 export declare class ActionListener {
     config: ClientConfig;
     client: PbDispatcherClient;
@@ -34,7 +62,20 @@ export declare class ActionListener {
     listenStrategy: ListenStrategy;
     heartbeat: Heartbeat;
     constructor(client: DispatcherClient, workerId: string, retryInterval?: number, retryCount?: number);
-    actions: () => AsyncGenerator<Action, void, unknown>;
+    actions: () => AsyncGenerator<{
+        tenantId: string;
+        stepRunId: string;
+        workflowRunId: string;
+        jobId: string;
+        jobName: string;
+        jobRunId: string;
+        stepId: string;
+        actionId: string;
+        actionPayload: string;
+        stepName: string;
+        getGroupKeyRunId?: string | undefined;
+        actionType?: number | undefined;
+    }, void, unknown>;
     setListenStrategy(strategy: ListenStrategy): Promise<void>;
     getListenStrategy(): Promise<ListenStrategy>;
     incrementRetries(): Promise<void>;

package/clients/dispatcher/action-listener.js

@@ -32,11 +32,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ActionListener = void 0;
+exports.ActionListener = exports.ActionObject = void 0;
+const dispatcher_1 = require("../../protoc/dispatcher");
 const nice_grpc_1 = require("nice-grpc");
 const sleep_1 = __importDefault(require("../../util/sleep"));
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
 const logger_1 = require("../../util/logger");
+const zod_1 = require("zod");
 const heartbeat_controller_1 = require("./heartbeat/heartbeat-controller");
 const DEFAULT_ACTION_LISTENER_RETRY_INTERVAL = 5000; // milliseconds
 const DEFAULT_ACTION_LISTENER_RETRY_COUNT = 20;
@@ -46,6 +48,20 @@ var ListenStrategy;
     ListenStrategy[ListenStrategy["LISTEN_STRATEGY_V1"] = 1] = "LISTEN_STRATEGY_V1";
     ListenStrategy[ListenStrategy["LISTEN_STRATEGY_V2"] = 2] = "LISTEN_STRATEGY_V2";
 })(ListenStrategy || (ListenStrategy = {}));
+exports.ActionObject = zod_1.z.object({
+    tenantId: zod_1.z.string(),
+    jobId: zod_1.z.string(),
+    jobName: zod_1.z.string(),
+    jobRunId: zod_1.z.string(),
+    stepId: zod_1.z.string(),
+    stepRunId: zod_1.z.string(),
+    actionId: zod_1.z.string(),
+    actionType: zod_1.z.preprocess((s) => (0, dispatcher_1.actionTypeFromJSON)(s), zod_1.z.number().optional()),
+    actionPayload: zod_1.z.string(),
+    workflowRunId: zod_1.z.string(),
+    getGroupKeyRunId: zod_1.z.string().optional(),
+    stepName: zod_1.z.string(),
+});
 class ActionListener {
     constructor(client, workerId, retryInterval = DEFAULT_ACTION_LISTENER_RETRY_INTERVAL, retryCount = DEFAULT_ACTION_LISTENER_RETRY_COUNT) {
         this.lastConnectionAttempt = 0;

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

@@ -29,4 +29,5 @@ export declare class HatchetClient {
     static init(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig): HatchetClient;
     run(workflow: string | Workflow): Promise<Worker>;
     worker(workflow: string | Workflow, maxRuns?: number): Promise<Worker>;
+    webhooks(workflow: Workflow): import("../worker/handler").WebhookHandler;
 }

package/clients/hatchet-client/hatchet-client.js

@@ -142,5 +142,11 @@ class HatchetClient {
             return worker;
         });
     }
+    webhooks(workflow) {
+        const worker = new worker_1.Worker(this, {
+            name: workflow.id,
+        });
+        return worker.getHandler(workflow);
+    }
 }
 exports.HatchetClient = HatchetClient;

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, WebhookWorker, WebhookWorkerCreateRequest, WebhookWorkerListResponse, 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.
      *
@@ -899,4 +919,21 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     githubAppListBranches: (ghInstallation: string, ghRepoOwner: string, ghRepoName: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ListGithubBranchesResponse, any>>;
+    /**
+     * @description Lists all webhooks
+     *
+     * @name WebhookList
+     * @summary List webhooks
+     * @request GET:/api/v1/webhook-workers/{tenant}
+     * @secure
+     */
+    webhookList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<WebhookWorkerListResponse, any>>;
+    /**
+     * @description Creates a webhook
+     *
+     * @name WebhookCreate
+     * @summary Create a webhook
+     * @request POST:/api/v1/webhook-workers/{tenant}/create
+     */
+    webhookCreate: (tenant: string, data: WebhookWorkerCreateRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<WebhookWorker, any>>;
 }

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.
          *
@@ -741,6 +761,23 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.githubAppListBranches = (ghInstallation, ghRepoOwner, ghRepoName, params = {}) => this.request(Object.assign({ path: `/api/v1/github-app/installations/${ghInstallation}/repos/${ghRepoOwner}/${ghRepoName}/branches`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Lists all webhooks
+         *
+         * @name WebhookList
+         * @summary List webhooks
+         * @request GET:/api/v1/webhook-workers/{tenant}
+         * @secure
+         */
+        this.webhookList = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/webhook-workers/${tenant}`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Creates a webhook
+         *
+         * @name WebhookCreate
+         * @summary Create a webhook
+         * @request POST:/api/v1/webhook-workers/{tenant}/create
+         */
+        this.webhookCreate = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/webhook-workers/${tenant}/create`, method: 'POST', body: data, type: http_client_1.ContentType.Json, format: 'json' }, params));
     }
 }
 exports.Api = Api;

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;
 }
@@ -847,3 +894,28 @@ export interface WorkflowMetrics {
     /** The total number of concurrency group keys. */
     groupKeyCount?: number;
 }
+export interface WebhookWorker {
+    metadata: APIResourceMeta;
+    /** The webhook url. */
+    url: string;
+    /** The secret key for validation. */
+    secret: string;
+}
+export interface WebhookWorkerCreateRequest {
+    /** The webhook url. */
+    url: string;
+    /** The workflow IDs or names to register for this webhook worker. If not provided, workflows will be automatically detected. */
+    workflows?: string[];
+    /**
+     * The secret key for validation. If not provided, a random secret will be generated.
+     * @minLength 32
+     */
+    secret?: string;
+}
+export interface WebhookWorkerCreateResponse {
+    worker?: WebhookWorker;
+}
+export interface WebhookWorkerListResponse {
+    pagination?: PaginationResponse;
+    rows?: WebhookWorker[];
+}

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/handler.d.ts

@@ -0,0 +1,56 @@
+/// <reference types="node" />
+import { IncomingMessage, ServerResponse } from 'http';
+import { Worker } from './worker';
+export interface HandlerOpts {
+    secret: string;
+}
+export declare class WebhookHandler {
+    private worker;
+    constructor(worker: Worker);
+    /**
+     * Handles a request with a provided body, secret, and signature.
+     *
+     * @param {string | undefined} body - The body of the request.
+     * @param {string | undefined} secret - The secret used for signature verification.
+     * @param {string | string[] | undefined | null} signature - The signature of the request.
+     *
+     * @throws {HatchetError} - If no signature is provided or the signature is not a string.
+     * @throws {HatchetError} - If no secret is provided.
+     * @throws {HatchetError} - If no body is provided.
+     */
+    handle(body: string | undefined, secret: string | undefined, signature: string | string[] | undefined | null): Promise<void>;
+    private getHealthcheckResponse;
+    /**
+     * Express Handler
+     *
+     * This method is an asynchronous function that returns an Express middleware handler.
+     * The handler function is responsible for handling incoming requests and invoking the
+     * corresponding logic based on the provided secret.
+     *
+     * @param {string} secret - The secret key used to authenticate and authorize the incoming requests.
+     *
+     * @return {Function} - An Express middleware handler function that receives the request and response objects.
+     */
+    expressHandler({ secret }: HandlerOpts): (req: any, res: any) => void;
+    /**
+     * A method that returns an HTTP request handler.
+     *
+     * @param {string} secret - The secret key used for verification.
+     *
+     * @returns {function} - An HTTP request handler function.
+     */
+    httpHandler({ secret }: HandlerOpts): (req: IncomingMessage, res: ServerResponse) => void;
+    /**
+     * A method that returns a Next.js request handler.
+     *
+     * @param {any} req - The request object received from Next.js.
+     * @param {string} secret - The secret key used to verify the request.
+     * @return {Promise<Response>} - A Promise that resolves with a Response object.
+     */
+    nextJSHandler({ secret }: HandlerOpts): {
+        GET: () => Promise<Response>;
+        POST: (req: Request) => Promise<Response>;
+        PUT: (req: Request) => Promise<Response>;
+    };
+    private getBody;
+}

package/clients/worker/handler.js

@@ -0,0 +1,160 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookHandler = void 0;
+const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
+const crypto_1 = require("crypto");
+const action_listener_1 = require("../dispatcher/action-listener");
+class WebhookHandler {
+    // eslint-disable-next-line no-useless-constructor,no-empty-function
+    constructor(worker) {
+        this.worker = worker;
+    }
+    /**
+     * Handles a request with a provided body, secret, and signature.
+     *
+     * @param {string | undefined} body - The body of the request.
+     * @param {string | undefined} secret - The secret used for signature verification.
+     * @param {string | string[] | undefined | null} signature - The signature of the request.
+     *
+     * @throws {HatchetError} - If no signature is provided or the signature is not a string.
+     * @throws {HatchetError} - If no secret is provided.
+     * @throws {HatchetError} - If no body is provided.
+     */
+    handle(body, secret, signature) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!signature || typeof signature !== 'string') {
+                throw new hatchet_error_1.default('No signature provided');
+            }
+            if (!secret) {
+                throw new hatchet_error_1.default('No secret provided');
+            }
+            if (!body) {
+                throw new hatchet_error_1.default('No body provided');
+            }
+            // verify hmac signature
+            const actualSignature = (0, crypto_1.createHmac)('sha256', secret).update(body).digest('hex');
+            if (actualSignature !== signature) {
+                throw new hatchet_error_1.default(`Invalid signature, expected ${actualSignature}, got ${signature}`);
+            }
+            const action = action_listener_1.ActionObject.parse(JSON.parse(body));
+            yield this.worker.handleAction(action);
+        });
+    }
+    getHealthcheckResponse() {
+        return {
+            actions: Object.keys(this.worker.action_registry),
+        };
+    }
+    /**
+     * Express Handler
+     *
+     * This method is an asynchronous function that returns an Express middleware handler.
+     * The handler function is responsible for handling incoming requests and invoking the
+     * corresponding logic based on the provided secret.
+     *
+     * @param {string} secret - The secret key used to authenticate and authorize the incoming requests.
+     *
+     * @return {Function} - An Express middleware handler function that receives the request and response objects.
+     */
+    expressHandler({ secret }) {
+        return (req, res) => {
+            if (req.method === 'GET') {
+                res.sendStatus(200);
+                res.json(this.getHealthcheckResponse());
+                return;
+            }
+            if (req.method !== 'POST') {
+                res.sendStatus(405);
+                res.json({ error: 'Method not allowed' });
+                return;
+            }
+            this.handle(req.body, req.headers['x-hatchet-signature'], secret)
+                .then(() => {
+                res.sendStatus(200);
+            })
+                .catch((e) => {
+                res.sendStatus(500);
+                this.worker.logger.error(`Error handling request: ${e.message}`);
+            });
+        };
+    }
+    /**
+     * A method that returns an HTTP request handler.
+     *
+     * @param {string} secret - The secret key used for verification.
+     *
+     * @returns {function} - An HTTP request handler function.
+     */
+    httpHandler({ secret }) {
+        return (req, res) => {
+            const handle = () => __awaiter(this, void 0, void 0, function* () {
+                if (req.method === 'GET') {
+                    res.writeHead(200, { 'Content-Type': 'application/json' });
+                    res.write(JSON.stringify(this.getHealthcheckResponse()));
+                    res.end();
+                    return;
+                }
+                if (req.method !== 'POST') {
+                    res.writeHead(405, { 'Content-Type': 'application/json' });
+                    res.write(JSON.stringify({ error: 'Method not allowed' }));
+                    res.end();
+                    return;
+                }
+                const body = yield this.getBody(req);
+                yield this.handle(body, secret, req.headers['x-hatchet-signature']);
+                res.writeHead(200, 'OK');
+                res.end();
+            });
+            handle().catch((e) => {
+                this.worker.logger.error(`Error handling request: ${e.message}`);
+                res.writeHead(500, 'Internal server error');
+                res.end();
+            });
+        };
+    }
+    /**
+     * A method that returns a Next.js request handler.
+     *
+     * @param {any} req - The request object received from Next.js.
+     * @param {string} secret - The secret key used to verify the request.
+     * @return {Promise<Response>} - A Promise that resolves with a Response object.
+     */
+    nextJSHandler({ secret }) {
+        const healthcheck = () => __awaiter(this, void 0, void 0, function* () {
+            return new Response(JSON.stringify(this.getHealthcheckResponse()), { status: 200 });
+        });
+        const f = (req) => __awaiter(this, void 0, void 0, function* () {
+            yield this.handle(yield req.text(), secret, req.headers.get('x-hatchet-signature'));
+            return new Response('ok', { status: 200 });
+        });
+        return {
+            GET: healthcheck,
+            POST: f,
+            PUT: f,
+        };
+    }
+    getBody(req) {
+        return new Promise((resolve) => {
+            let body = '';
+            req.on('data', (chunk) => {
+                body += chunk;
+            });
+            req.on('end', () => {
+                resolve(body);
+            });
+        });
+    }
+}
+exports.WebhookHandler = WebhookHandler;