@hatchet-dev/typescript-sdk 1.13.1 → 1.15.0

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

@@ -1,108 +0,0 @@
-"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.LegacyHatchetClient = void 0;
-const zod_1 = require("zod");
-const config_loader_1 = require("../../util/config-loader");
-const event_client_1 = require("../event/event-client");
-const dispatcher_client_1 = require("../dispatcher/dispatcher-client");
-const admin_client_1 = require("../admin/admin-client");
-const nice_grpc_1 = require("nice-grpc");
-const worker_1 = require("../worker");
-const hatchet_logger_1 = require("./hatchet-logger");
-const grpc_helpers_1 = require("../../util/grpc-helpers");
-const client_config_1 = require("./client-config");
-const child_listener_client_1 = require("../listeners/run-listener/child-listener-client");
-const rest_1 = __importDefault(require("../rest"));
-const durable_listener_client_1 = require("../listeners/durable-listener/durable-listener-client");
-class LegacyHatchetClient {
-    constructor(config, options, axiosOpts, runs, listener) {
-        // Initializes a new Client instance.
-        // Loads config in the following order: config param > yaml file > env vars
-        var _a;
-        this.runs = runs;
-        const loaded = config_loader_1.ConfigLoader.loadClientConfig(config, {
-            path: options === null || options === void 0 ? void 0 : options.config_path,
-        });
-        try {
-            const valid = client_config_1.ClientConfigSchema.parse(loaded);
-            let logConstructor = config === null || config === void 0 ? void 0 : config.logger;
-            if (logConstructor == null) {
-                logConstructor = hatchet_logger_1.DEFAULT_LOGGER;
-            }
-            this.config = Object.assign(Object.assign({}, valid), { logger: logConstructor });
-        }
-        catch (e) {
-            if (e instanceof zod_1.z.ZodError) {
-                throw new Error(`Invalid client config: ${e.message}`);
-            }
-            throw e;
-        }
-        this.credentials =
-            (_a = options === null || options === void 0 ? void 0 : options.credentials) !== null && _a !== void 0 ? _a : config_loader_1.ConfigLoader.createCredentials(this.config.tls_config);
-        const clientFactory = (0, nice_grpc_1.createClientFactory)().use((0, grpc_helpers_1.addTokenMiddleware)(this.config.token));
-        this.tenantId = this.config.tenant_id;
-        this.api = (0, rest_1.default)(this.config.api_url, this.config.token, axiosOpts);
-        this.event = new event_client_1.EventClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this);
-        this.dispatcher = new dispatcher_client_1.DispatcherClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory);
-        this.listener =
-            listener ||
-                new child_listener_client_1.RunListenerClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this.api);
-        this.admin = new admin_client_1.AdminClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this.api, this.tenantId, this.listener, this.runs);
-        this.durableListener = new durable_listener_client_1.DurableListenerClient(this.config, (0, grpc_helpers_1.channelFactory)(this.config, this.credentials), clientFactory, this.api);
-        this.logger = this.config.logger('HatchetClient', this.config.log_level);
-        this.logger.debug(`Initialized HatchetClient`);
-    }
-    static init(config, options, axiosConfig) {
-        return new LegacyHatchetClient(config, options, axiosConfig);
-    }
-    // @deprecated
-    run(workflow) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.logger.warn('HatchetClient.run is deprecated and will be removed in a future release. Use HatchetClient.worker and Worker.start instead.');
-            const worker = yield this.worker(workflow);
-            worker.start();
-            return worker;
-        });
-    }
-    worker(workflow, opts) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const name = typeof workflow === 'string' ? workflow : workflow.id;
-            let options = {
-                name,
-            };
-            if (typeof opts === 'number') {
-                this.logger.warn('@deprecated maxRuns param is deprecated and will be removed in a future release in favor of WorkerOpts');
-                options = Object.assign(Object.assign({}, options), { maxRuns: opts });
-            }
-            else {
-                options = Object.assign(Object.assign({}, options), opts);
-            }
-            const worker = new worker_1.V0Worker(this, options);
-            if (typeof workflow !== 'string') {
-                yield worker.registerWorkflow(workflow);
-                return worker;
-            }
-            return worker;
-        });
-    }
-    webhooks(workflows) {
-        // TODO v1 workflows
-        const worker = new worker_1.V0Worker(this, {
-            name: 'webhook-worker',
-        });
-        return worker.getHandler(workflows);
-    }
-}
-exports.LegacyHatchetClient = LegacyHatchetClient;

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

@@ -1,3 +0,0 @@
-export * from './hatchet-client';
-export * from './client-config';
-export { HatchetLogger } from './hatchet-logger';

package/clients/rest/api.js

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const qs_1 = __importDefault(require("qs"));
-const Api_1 = require("./generated/Api");
-const api = (serverUrl, token, axiosOpts) => {
-    return new Api_1.Api(Object.assign({ baseURL: serverUrl, headers: {
-            Authorization: `Bearer ${token}`,
-        }, paramsSerializer: (params) => qs_1.default.stringify(params, { arrayFormat: 'repeat' }) }, axiosOpts));
-};
-exports.default = api;

package/clients/worker/handler.d.ts

@@ -1,50 +0,0 @@
-import { IncomingMessage, ServerResponse } from 'http';
-import { Workflow } from '../../workflow';
-import { V0Worker } from './worker';
-export interface HandlerOpts {
-    secret: string;
-}
-export declare class WebhookHandler {
-    private worker;
-    private workflows;
-    constructor(worker: V0Worker, workflows: Workflow[]);
-    /**
-     * 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, signature: string | string[] | undefined | null, secret: string | undefined): Promise<void>;
-    private checkSignature;
-    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.
-     */
-    expressHandler({ secret }: HandlerOpts): (req: any, res: any) => void;
-    /**
-     * A method that returns an HTTP request handler.
-     */
-    httpHandler({ secret }: HandlerOpts): (req: IncomingMessage, res: ServerResponse) => void;
-    /**
-     * A method that returns a Next.js pages router request handler.
-     */
-    nextJSPagesHandler({ secret }: HandlerOpts): (req: any, res: any) => Promise<any>;
-    /**
-     * A method that returns a Next.js request handler.
-     */
-    nextJSHandler({ secret }: HandlerOpts): {
-        GET: () => Promise<Response>;
-        POST: (req: Request) => Promise<Response>;
-        PUT: (req: Request) => Promise<Response>;
-    };
-    private getBody;
-}

package/clients/worker/handler.js

@@ -1,214 +0,0 @@
-"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 okMessage = 'The Hatchet webhooks endpoint is up and running!';
-class WebhookHandler {
-    // eslint-disable-next-line no-useless-constructor
-    constructor(worker, workflows
-    // eslint-disable-next-line no-empty-function
-    ) {
-        this.worker = worker;
-        this.workflows = workflows;
-    }
-    /**
-     * 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, signature, secret) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.checkSignature(body, signature, secret);
-            const action = JSON.parse(body);
-            yield this.worker.handleAction(action);
-        });
-    }
-    checkSignature(body, signature, secret) {
-        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}`);
-        }
-    }
-    getHealthcheckResponse(body, signature, secret) {
-        return __awaiter(this, void 0, void 0, function* () {
-            this.checkSignature(body, signature, secret);
-            for (const workflow of this.workflows) {
-                yield this.worker.registerWorkflow(workflow);
-            }
-            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.
-     */
-    expressHandler({ secret }) {
-        return (req, res) => {
-            if (req.method === 'GET') {
-                res.status(200).send(okMessage);
-                return;
-            }
-            if (req.method === 'PUT') {
-                let { body } = req;
-                if (typeof body !== 'string') {
-                    body = JSON.stringify(body);
-                }
-                this.getHealthcheckResponse(body, req.headers['x-hatchet-signature'], secret)
-                    .then((resp) => {
-                    res.status(200).json(resp);
-                })
-                    .catch((err) => {
-                    res.status(500);
-                    this.worker.logger.error(`Error handling request: ${err.message}`);
-                });
-                return;
-            }
-            if (req.method !== 'POST') {
-                res.status(405).json({ error: 'Method not allowed' });
-                return;
-            }
-            let action = req.body;
-            if (typeof action !== 'string') {
-                action = JSON.stringify(action);
-            }
-            this.handle(action, req.headers['x-hatchet-signature'], secret)
-                .then(() => {
-                res.status(200);
-            })
-                .catch((err) => {
-                res.status(500);
-                this.worker.logger.error(`Error handling request: ${err.message}`);
-            });
-        };
-    }
-    /**
-     * A method that returns an HTTP request handler.
-     */
-    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(okMessage);
-                    res.end();
-                    return;
-                }
-                const body = yield this.getBody(req);
-                if (req.method === 'PUT') {
-                    const resp = yield this.getHealthcheckResponse(body, req.headers['x-hatchet-signature'], secret);
-                    res.writeHead(200, { 'Content-Type': 'application/json' });
-                    res.write(JSON.stringify(resp));
-                    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;
-                }
-                yield this.handle(body, req.headers['x-hatchet-signature'], secret);
-                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 pages router request handler.
-     */
-    nextJSPagesHandler({ secret }) {
-        return (req, res) => __awaiter(this, void 0, void 0, function* () {
-            if (req.method === 'GET') {
-                return res.status(200).send(okMessage);
-            }
-            const sig = req.headers['x-hatchet-signature'];
-            const body = JSON.stringify(req.body);
-            if (req.method === 'PUT') {
-                const resp = yield this.getHealthcheckResponse(body, sig, secret);
-                return res.status(200).send(JSON.stringify(resp));
-            }
-            if (req.method !== 'POST') {
-                return res.status(405).send('Method not allowed');
-            }
-            yield this.handle(body, sig, secret);
-            return res.status(200).send('ok');
-        });
-    }
-    /**
-     * A method that returns a Next.js request handler.
-     */
-    nextJSHandler({ secret }) {
-        const ok = () => __awaiter(this, void 0, void 0, function* () {
-            return new Response(okMessage, { status: 200 });
-        });
-        const f = (req) => __awaiter(this, void 0, void 0, function* () {
-            const sig = req.headers.get('x-hatchet-signature');
-            const body = yield req.text();
-            if (req.method === 'PUT') {
-                const resp = yield this.getHealthcheckResponse(body, sig, secret);
-                return new Response(JSON.stringify(resp), { status: 200 });
-            }
-            if (req.method !== 'POST') {
-                return new Response('Method not allowed', { status: 405 });
-            }
-            yield this.handle(body, sig, secret);
-            return new Response('ok', { status: 200 });
-        });
-        return {
-            GET: ok,
-            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;

package/clients/worker/index.d.ts

@@ -1 +0,0 @@
-export * from './worker';

package/clients/worker/worker.d.ts

@@ -1,59 +0,0 @@
-import { LegacyHatchetClient } from '../hatchet-client';
-import { Action, ActionKey, ActionListener } from '../dispatcher/action-listener';
-import { StepActionEvent, StepActionEventType, GroupKeyActionEvent, GroupKeyActionEventType } from '../../protoc/dispatcher';
-import HatchetPromise from '../../util/hatchet-promise/hatchet-promise';
-import { Workflow } from '../../workflow';
-import { Logger } from '../../util/logger';
-import { WebhookHandler } from './handler';
-import { WebhookWorkerCreateRequest } from '../rest/generated/data-contracts';
-import { WorkflowDefinition } from '../../v1';
-import { V0Context, StepRunFunction } from '../../step';
-import { WorkerLabels } from '../dispatcher/dispatcher-client';
-export type ActionRegistry = Record<Action['actionId'], Function>;
-export interface WorkerOpts {
-    name: string;
-    handleKill?: boolean;
-    maxRuns?: number;
-    labels?: WorkerLabels;
-}
-export declare class V0Worker {
-    client: LegacyHatchetClient;
-    name: string;
-    workerId: string | undefined;
-    killing: boolean;
-    handle_kill: boolean;
-    action_registry: ActionRegistry;
-    workflow_registry: Array<WorkflowDefinition | Workflow>;
-    listener: ActionListener | undefined;
-    futures: Record<ActionKey, HatchetPromise<any>>;
-    contexts: Record<ActionKey, V0Context<any, any>>;
-    maxRuns?: number;
-    logger: Logger;
-    registeredWorkflowPromises: Array<Promise<any>>;
-    labels: WorkerLabels;
-    constructor(client: LegacyHatchetClient, options: {
-        name: string;
-        handleKill?: boolean;
-        maxRuns?: number;
-        labels?: WorkerLabels;
-    });
-    private registerActions;
-    getHandler(workflows: Workflow[]): WebhookHandler;
-    registerWebhook(webhook: WebhookWorkerCreateRequest): Promise<import("axios").AxiosResponse<import("../rest/generated/data-contracts").WebhookWorkerCreated, any, {}>>;
-    /**
-     * @deprecated use registerWorkflow instead
-     */
-    register_workflow(initWorkflow: Workflow): Promise<void>;
-    registerWorkflow(initWorkflow: Workflow): Promise<void>;
-    registerAction<T, K>(actionId: string, action: StepRunFunction<T, K>): void;
-    handleStartStepRun(action: Action): Promise<void>;
-    handleStartGroupKeyRun(action: Action): Promise<void>;
-    getStepActionEvent(action: Action, eventType: StepActionEventType, shouldNotRetry: boolean, payload?: any, retryCount?: number): StepActionEvent;
-    getGroupKeyActionEvent(action: Action, eventType: GroupKeyActionEventType, payload?: any): GroupKeyActionEvent;
-    handleCancelStepRun(action: Action): Promise<void>;
-    stop(): Promise<void>;
-    exitGracefully(handleKill: boolean): Promise<void>;
-    start(): Promise<void>;
-    handleAction(action: Action): Promise<void>;
-    upsertLabels(labels: WorkerLabels): Promise<WorkerLabels>;
-}