@hatchet-dev/typescript-sdk 0.1.11 → 0.1.13

package/clients/rest/index.d.ts

@@ -0,0 +1,8 @@
+import api from './api';
+import { Api } from './generated/Api';
+import { Worker as _Worker, Workflow as _Workflow } from './generated/data-contracts';
+import * as APIContracts from './generated/data-contracts';
+type ApiWorker = _Worker;
+type ApiWorkflow = _Workflow;
+export { ApiWorker, ApiWorkflow, APIContracts, Api };
+export default api;

package/clients/rest/index.js

@@ -0,0 +1,35 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Api = exports.APIContracts = void 0;
+const api_1 = __importDefault(require("./api"));
+const Api_1 = require("./generated/Api");
+Object.defineProperty(exports, "Api", { enumerable: true, get: function () { return Api_1.Api; } });
+const APIContracts = __importStar(require("./generated/data-contracts"));
+exports.APIContracts = APIContracts;
+exports.default = api_1.default;

package/clients/worker/worker.d.ts

@@ -4,7 +4,7 @@ import { StepActionEvent, StepActionEventType, GroupKeyActionEvent, GroupKeyActi
 import HatchetPromise from '../../util/hatchet-promise/hatchet-promise';
 import { Workflow } from '../../workflow';
 import { Logger } from '../../util/logger';
-import { Context } from '../../step';
+import { Context, StepRunFunction } from '../../step';
 export type ActionRegistry = Record<Action['actionId'], Function>;
 export declare class Worker {
     serviceName: string;
@@ -15,13 +15,14 @@ export declare class Worker {
     action_registry: ActionRegistry;
     listener: ActionListener | undefined;
     futures: Record<Action['stepRunId'], HatchetPromise<any>>;
-    contexts: Record<Action['stepRunId'], Context<any>>;
+    contexts: Record<Action['stepRunId'], Context<any, any>>;
     logger: Logger;
     constructor(client: HatchetClient, options: {
         name: string;
         handleKill?: boolean;
     });
     registerWorkflow(workflow: Workflow): Promise<void>;
+    registerAction<T, K>(actionId: string, action: StepRunFunction<T, K>): void;
     handleStartStepRun(action: Action): void;
     handleStartGroupKeyRun(action: Action): void;
     getStepActionEvent(action: Action, eventType: StepActionEventType, payload?: any): StepActionEvent;

package/clients/worker/worker.js

@@ -73,6 +73,7 @@ class Worker {
                                     timeout: step.timeout || '60s',
                                     inputs: '{}',
                                     parents: (_a = step.parents) !== null && _a !== void 0 ? _a : [],
+                                    userData: '{}',
                                 });
                             }),
                         },
@@ -90,6 +91,9 @@ class Worker {
                 ? Object.assign(Object.assign({}, this.action_registry), { [`${this.serviceName}:${workflow.concurrency.name}`]: workflow.concurrency.key }) : Object.assign({}, this.action_registry);
         });
     }
+    registerAction(actionId, action) {
+        this.action_registry[actionId] = action;
+    }
     handleStartStepRun(action) {
         const { actionId } = action;
         const context = new step_1.Context(action.actionPayload);

package/index.d.ts

@@ -2,4 +2,6 @@ import { HatchetClient as Hatchet } from './clients/hatchet-client';
 export * from './workflow';
 export * from './step';
 export * from './clients/worker';
+export * from './clients/rest';
+export * from './clients/admin';
 export default Hatchet;

package/index.js

@@ -18,4 +18,6 @@ const hatchet_client_1 = require("./clients/hatchet-client");
 __exportStar(require("./workflow"), exports);
 __exportStar(require("./step"), exports);
 __exportStar(require("./clients/worker"), exports);
+__exportStar(require("./clients/rest"), exports);
+__exportStar(require("./clients/admin"), exports);
 exports.default = hatchet_client_1.HatchetClient;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "Background task orchestration & visibility for developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,14 +33,18 @@
     "worker:dag": "npm run exec -- ./examples/dag-worker.ts",
     "worker:concurrency": "npm run exec -- ./examples/concurrency/concurrency-worker.ts",
     "event:concurrency": "npm run exec -- ./examples/concurrency/concurrency-event.ts",
+    "api": "npm run exec -- ./examples/api.ts",
     "prepublish": "cp package.json dist/package.json;",
-    "publish:ci": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks"
+    "publish:ci": "rm -rf ./dist && npm run tsc:build && npm run prepublish && cd dist && npm publish --access public --no-git-checks",
+    "generate-docs": "typedoc"
   },
   "keywords": [],
   "author": "",
   "license": "MIT",
   "devDependencies": {
+    "@types/node": "^20.11.16",
     "@types/jest": "^29.5.11",
+    "@types/node": "^20.11.16",
     "@typescript-eslint/eslint-plugin": "^6.4.0",
     "autoprefixer": "^10.4.16",
     "dotenv-cli": "^7.3.0",
@@ -62,14 +66,19 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "ts-proto": "^1.167.0",
+    "typedoc": "^0.25.7",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.3.3"
   },
   "dependencies": {
+    "@types/qs": "^6.9.11",
+    "axios": "^1.6.7",
     "long": "^5.2.3",
     "nice-grpc": "^2.1.7",
     "nice-grpc-common": "^2.0.2",
     "protobufjs": "^7.2.6",
+    "qs": "^6.11.2",
     "yaml": "^2.3.4",
     "zod": "^3.22.4"
   }
-}
+}

package/protoc/workflows/workflows.d.ts

@@ -62,6 +62,8 @@ export interface CreateWorkflowStepOpts {
     inputs: string;
     /** (optional) the step parents. if none are passed in, this is a root step */
     parents: string[];
+    /** (optional) the custom step user data, assuming string representation of JSON */
+    userData: string;
 }
 /** ListWorkflowsRequest is the request for ListWorkflows. */
 export interface ListWorkflowsRequest {

package/protoc/workflows/workflows.js

@@ -470,7 +470,7 @@ exports.CreateWorkflowJobOpts = {
     },
 };
 function createBaseCreateWorkflowStepOpts() {
-    return { readableId: "", action: "", timeout: "", inputs: "", parents: [] };
+    return { readableId: "", action: "", timeout: "", inputs: "", parents: [], userData: "" };
 }
 exports.CreateWorkflowStepOpts = {
     encode(message, writer = _m0.Writer.create()) {
@@ -489,6 +489,9 @@ exports.CreateWorkflowStepOpts = {
         for (const v of message.parents) {
             writer.uint32(42).string(v);
         }
+        if (message.userData !== "") {
+            writer.uint32(50).string(message.userData);
+        }
         return writer;
     },
     decode(input, length) {
@@ -528,6 +531,12 @@ exports.CreateWorkflowStepOpts = {
                     }
                     message.parents.push(reader.string());
                     continue;
+                case 6:
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.userData = reader.string();
+                    continue;
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -543,6 +552,7 @@ exports.CreateWorkflowStepOpts = {
             timeout: isSet(object.timeout) ? globalThis.String(object.timeout) : "",
             inputs: isSet(object.inputs) ? globalThis.String(object.inputs) : "",
             parents: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.parents) ? object.parents.map((e) => globalThis.String(e)) : [],
+            userData: isSet(object.userData) ? globalThis.String(object.userData) : "",
         };
     },
     toJSON(message) {
@@ -563,19 +573,23 @@ exports.CreateWorkflowStepOpts = {
         if ((_a = message.parents) === null || _a === void 0 ? void 0 : _a.length) {
             obj.parents = message.parents;
         }
+        if (message.userData !== "") {
+            obj.userData = message.userData;
+        }
         return obj;
     },
     create(base) {
         return exports.CreateWorkflowStepOpts.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         const message = createBaseCreateWorkflowStepOpts();
         message.readableId = (_a = object.readableId) !== null && _a !== void 0 ? _a : "";
         message.action = (_b = object.action) !== null && _b !== void 0 ? _b : "";
         message.timeout = (_c = object.timeout) !== null && _c !== void 0 ? _c : "";
         message.inputs = (_d = object.inputs) !== null && _d !== void 0 ? _d : "";
         message.parents = ((_e = object.parents) === null || _e === void 0 ? void 0 : _e.map((e) => e)) || [];
+        message.userData = (_f = object.userData) !== null && _f !== void 0 ? _f : "";
         return message;
     },
 };

package/step.d.ts

@@ -15,20 +15,23 @@ export declare const CreateStepSchema: z.ZodObject<{
 export type NextStep = {
     [key: string]: string;
 };
-interface ContextData<T = unknown> {
+interface ContextData<T, K> {
     input: T;
     parents: Record<string, any>;
-    triggered_by_event: string;
+    triggered_by: string;
+    user_data: K;
 }
-export declare class Context<T = unknown> {
-    data: ContextData<T>;
+export declare class Context<T, K> {
+    data: ContextData<T, K>;
     controller: AbortController;
     constructor(payload: string);
     stepOutput(step: string): string;
     triggeredByEvent(): boolean;
-    workflowInput(): any;
+    workflowInput(): T;
+    userData(): K;
 }
-export interface CreateStep<T> extends z.infer<typeof CreateStepSchema> {
-    run: (ctx: Context) => Promise<NextStep> | NextStep | void;
+export type StepRunFunction<T, K> = (ctx: Context<T, K>) => Promise<NextStep> | NextStep | void;
+export interface CreateStep<T, K> extends z.infer<typeof CreateStepSchema> {
+    run: StepRunFunction<T, K>;
 }
 export {};

package/step.js

@@ -56,11 +56,15 @@ class Context {
     }
     triggeredByEvent() {
         var _a;
-        return ((_a = this.data) === null || _a === void 0 ? void 0 : _a.triggered_by_event) === 'event';
+        return ((_a = this.data) === null || _a === void 0 ? void 0 : _a.triggered_by) === 'event';
     }
     workflowInput() {
         var _a;
-        return ((_a = this.data) === null || _a === void 0 ? void 0 : _a.input) || {};
+        return (_a = this.data) === null || _a === void 0 ? void 0 : _a.input;
+    }
+    userData() {
+        var _a;
+        return (_a = this.data) === null || _a === void 0 ? void 0 : _a.user_data;
     }
 }
 exports.Context = Context;

package/util/config-loader/config-loader.d.ts

@@ -4,10 +4,10 @@ interface LoadClientConfigOptions {
     path?: string;
 }
 export declare class ConfigLoader {
-    static load_client_config(config?: LoadClientConfigOptions): Partial<ClientConfig>;
+    static loadClientConfig(config?: LoadClientConfigOptions): Partial<ClientConfig>;
     static get default_yaml_config_path(): string;
     static createCredentials(config: ClientConfig['tls_config']): ChannelCredentials;
-    static load_yaml_config(path?: string): ClientConfig | undefined;
+    static loadYamlConfig(path?: string): ClientConfig | undefined;
     private static env;
 }
 export {};

package/util/config-loader/config-loader.js

@@ -30,11 +30,12 @@ const p = __importStar(require("path"));
 const zod_1 = require("zod");
 const hatchet_client_1 = require("../../clients/hatchet-client");
 const nice_grpc_1 = require("nice-grpc");
+const token_1 = require("./token");
 const DEFAULT_CONFIG_FILE = '.hatchet.yaml';
 class ConfigLoader {
-    static load_client_config(config) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
-        const yaml = this.load_yaml_config(config === null || config === void 0 ? void 0 : config.path);
+    static loadClientConfig(config) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w;
+        const yaml = this.loadYamlConfig(config === null || config === void 0 ? void 0 : config.path);
         const tlsConfig = {
             tls_strategy: (_c = (_b = (_a = yaml === null || yaml === void 0 ? void 0 : yaml.tls_config) === null || _a === void 0 ? void 0 : _a.tls_strategy) !== null && _b !== void 0 ? _b : this.env('HATCHET_CLIENT_TLS_STRATEGY')) !== null && _c !== void 0 ? _c : 'tls',
             cert_file: (_e = (_d = yaml === null || yaml === void 0 ? void 0 : yaml.tls_config) === null || _d === void 0 ? void 0 : _d.cert_file) !== null && _e !== void 0 ? _e : this.env('HATCHET_CLIENT_TLS_CERT_FILE'),
@@ -42,11 +43,30 @@ class ConfigLoader {
             ca_file: (_j = (_h = yaml === null || yaml === void 0 ? void 0 : yaml.tls_config) === null || _h === void 0 ? void 0 : _h.ca_file) !== null && _j !== void 0 ? _j : this.env('HATCHET_CLIENT_TLS_ROOT_CA_FILE'),
             server_name: (_l = (_k = yaml === null || yaml === void 0 ? void 0 : yaml.tls_config) === null || _k === void 0 ? void 0 : _k.server_name) !== null && _l !== void 0 ? _l : this.env('HATCHET_CLIENT_TLS_SERVER_NAME'),
         };
+        const token = (_m = yaml === null || yaml === void 0 ? void 0 : yaml.token) !== null && _m !== void 0 ? _m : this.env('HATCHET_CLIENT_TOKEN');
+        let grpcBroadcastAddress;
+        let apiUrl;
+        const tenantId = (0, token_1.getTenantIdFromJWT)(token);
+        if (!tenantId) {
+            throw new Error('Tenant ID not found in subject claim of token');
+        }
+        try {
+            const addresses = (0, token_1.getAddressesFromJWT)(token);
+            grpcBroadcastAddress =
+                (_p = (_o = yaml === null || yaml === void 0 ? void 0 : yaml.host_port) !== null && _o !== void 0 ? _o : this.env('HATCHET_CLIENT_HOST_PORT')) !== null && _p !== void 0 ? _p : addresses.grpcBroadcastAddress;
+            apiUrl = (_r = (_q = yaml === null || yaml === void 0 ? void 0 : yaml.api_url) !== null && _q !== void 0 ? _q : this.env('HATCHET_CLIENT_API_URL')) !== null && _r !== void 0 ? _r : addresses.serverUrl;
+        }
+        catch (e) {
+            grpcBroadcastAddress = (_s = yaml === null || yaml === void 0 ? void 0 : yaml.host_port) !== null && _s !== void 0 ? _s : this.env('HATCHET_CLIENT_HOST_PORT');
+            apiUrl = (_t = yaml === null || yaml === void 0 ? void 0 : yaml.api_url) !== null && _t !== void 0 ? _t : this.env('HATCHET_CLIENT_API_URL');
+        }
         return {
-            token: (_m = yaml === null || yaml === void 0 ? void 0 : yaml.token) !== null && _m !== void 0 ? _m : this.env('HATCHET_CLIENT_TOKEN'),
-            host_port: (_o = yaml === null || yaml === void 0 ? void 0 : yaml.host_port) !== null && _o !== void 0 ? _o : this.env('HATCHET_CLIENT_HOST_PORT'),
+            token: (_u = yaml === null || yaml === void 0 ? void 0 : yaml.token) !== null && _u !== void 0 ? _u : this.env('HATCHET_CLIENT_TOKEN'),
+            host_port: grpcBroadcastAddress,
+            api_url: apiUrl,
             tls_config: tlsConfig,
-            log_level: (_q = (_p = yaml === null || yaml === void 0 ? void 0 : yaml.log_level) !== null && _p !== void 0 ? _p : this.env('HATCHET_CLIENT_LOG_LEVEL')) !== null && _q !== void 0 ? _q : 'INFO',
+            log_level: (_w = (_v = yaml === null || yaml === void 0 ? void 0 : yaml.log_level) !== null && _v !== void 0 ? _v : this.env('HATCHET_CLIENT_LOG_LEVEL')) !== null && _w !== void 0 ? _w : 'INFO',
+            tenant_id: tenantId,
         };
     }
     static get default_yaml_config_path() {
@@ -62,7 +82,7 @@ class ConfigLoader {
         const certChain = config.cert_file ? (0, fs_1.readFileSync)(config.cert_file) : null;
         return nice_grpc_1.ChannelCredentials.createSsl(rootCerts, privateKey, certChain);
     }
-    static load_yaml_config(path) {
+    static loadYamlConfig(path) {
         try {
             const configFile = (0, fs_1.readFileSync)(p.join(__dirname, path !== null && path !== void 0 ? path : this.default_yaml_config_path), 'utf8');
             const config = (0, yaml_1.parse)(configFile);

package/util/config-loader/token.d.ts

@@ -0,0 +1,5 @@
+export declare function getTenantIdFromJWT(token: string): string;
+export declare function getAddressesFromJWT(token: string): {
+    serverUrl: string;
+    grpcBroadcastAddress: string;
+};

package/util/config-loader/token.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAddressesFromJWT = exports.getTenantIdFromJWT = void 0;
+function getTenantIdFromJWT(token) {
+    const claims = extractClaimsFromJWT(token);
+    return claims.sub;
+}
+exports.getTenantIdFromJWT = getTenantIdFromJWT;
+function getAddressesFromJWT(token) {
+    const claims = extractClaimsFromJWT(token);
+    return {
+        serverUrl: claims.server_url,
+        grpcBroadcastAddress: claims.grpc_broadcast_address,
+    };
+}
+exports.getAddressesFromJWT = getAddressesFromJWT;
+function extractClaimsFromJWT(token) {
+    const parts = token.split('.');
+    if (parts.length !== 3) {
+        throw new Error('Invalid token format');
+    }
+    const claimsPart = parts[1];
+    const claimsData = atob(claimsPart.replace(/-/g, '+').replace(/_/g, '/'));
+    const claims = JSON.parse(claimsData);
+    return claims;
+}

package/workflow.d.ts

@@ -106,6 +106,6 @@ export interface Workflow extends z.infer<typeof CreateWorkflowSchema> {
     concurrency?: z.infer<typeof WorkflowConcurrency> & {
         key: (ctx: any) => string;
     };
-    steps: CreateStep<any>[];
+    steps: CreateStep<any, any>[];
 }
 export {};