@hatchet-dev/typescript-sdk 1.6.2 → 1.7.1

package/v1/client/features/tenant.d.ts

@@ -0,0 +1,15 @@
+import { Tenant } from '../../../clients/rest/generated/data-contracts';
+import { HatchetClient } from '../client';
+/**
+ * Client for managing Tenants
+ */
+export declare class TenantClient {
+    api: HatchetClient['api'];
+    tenantId: string;
+    constructor(client: HatchetClient);
+    /**
+     * Retrieves the current tenant.
+     * @returns The Tenant object.
+     */
+    get(): Promise<Tenant>;
+}

package/v1/client/features/tenant.js

@@ -0,0 +1,31 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TenantClient = void 0;
+/**
+ * Client for managing Tenants
+ */
+class TenantClient {
+    constructor(client) {
+        this.api = client.api;
+        this.tenantId = client.tenantId;
+    }
+    /**
+     * Retrieves the current tenant.
+     * @returns The Tenant object.
+     */
+    get() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.api.tenantGet(this.tenantId)).data;
+        });
+    }
+}
+exports.TenantClient = TenantClient;

package/v1/client/features/workflows.d.ts

@@ -1,7 +1,7 @@
 import { Workflow } from '../../../workflow';
-import { BaseWorkflowDeclaration } from '../..';
+import { BaseWorkflowDeclaration, WorkflowDefinition } from '../..';
 import { HatchetClient } from '../client';
-export declare const workflowNameString: (workflow: string | Workflow | BaseWorkflowDeclaration<any, any>) => string;
+export declare const workflowNameString: (workflow: string | Workflow | WorkflowDefinition | BaseWorkflowDeclaration<any, any>) => string;
 /**
  * WorkflowsClient is used to list and manage workflows
  */
@@ -11,7 +11,14 @@ export declare class WorkflowsClient {
     private workflowCache;
     private cacheTTL;
     constructor(client: HatchetClient, cacheTTL?: number);
-    get(workflow: string | BaseWorkflowDeclaration<any, any> | Workflow): Promise<any>;
+    /**
+     * Gets the workflow ID from a workflow name, ID, or object.
+     * If the input is not a valid UUID, it will look up the workflow by name.
+     * @param workflow - The workflow name, ID, or object.
+     * @returns The workflow ID as a string.
+     */
+    getWorkflowIdFromName(workflow: string | Workflow | WorkflowDefinition | BaseWorkflowDeclaration<any, any>): Promise<string>;
+    get(workflow: string | BaseWorkflowDeclaration<any, any> | Workflow): Promise<import("../../../clients/rest/generated/data-contracts").Workflow>;
     list(opts?: Parameters<typeof this.api.workflowList>[1]): Promise<import("../../../clients/rest/generated/data-contracts").WorkflowList>;
     delete(workflow: string | BaseWorkflowDeclaration<any, any> | Workflow): Promise<void>;
 }

package/v1/client/features/workflows.js

@@ -10,7 +10,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkflowsClient = exports.workflowNameString = void 0;
-const workflowNameString = (workflow) => (typeof workflow === 'string' ? workflow : workflow.id);
+const uuid_1 = require("../../../util/uuid");
+const workflowNameString = (workflow) => {
+    if (typeof workflow === 'string') {
+        return workflow;
+    }
+    if (typeof workflow === 'object' && 'id' in workflow) {
+        return workflow.id;
+    }
+    return workflow.name;
+};
 exports.workflowNameString = workflowNameString;
 /**
  * WorkflowsClient is used to list and manage workflows
@@ -28,6 +37,39 @@ class WorkflowsClient {
             this.cacheTTL = cacheTTL;
         }
     }
+    /**
+     * Gets the workflow ID from a workflow name, ID, or object.
+     * If the input is not a valid UUID, it will look up the workflow by name.
+     * @param workflow - The workflow name, ID, or object.
+     * @returns The workflow ID as a string.
+     */
+    getWorkflowIdFromName(workflow) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const str = (() => {
+                if (typeof workflow === 'string') {
+                    return workflow;
+                }
+                if (typeof workflow === 'object' && 'name' in workflow) {
+                    return workflow.name;
+                }
+                if (typeof workflow === 'object' && 'id' in workflow) {
+                    if (!workflow.id) {
+                        throw new Error('Workflow ID is required');
+                    }
+                    return workflow.id;
+                }
+                throw new Error('Invalid workflow: must be a string, Workflow object, or WorkflowDefinition object');
+            })();
+            if (!(0, uuid_1.isValidUUID)(str)) {
+                const wf = yield this.get(str);
+                if (!wf) {
+                    throw new Error('Invalid workflow ID: must be a valid UUID');
+                }
+                return wf.metadata.id;
+            }
+            return str;
+        });
+    }
     get(workflow) {
         return __awaiter(this, void 0, void 0, function* () {
             // Get workflow name string

package/v1/client/worker/context.js

@@ -22,6 +22,7 @@ const conditions_1 = require("../../conditions");
 const transformer_1 = require("../../conditions/transformer");
 const condition_1 = require("../../../protoc/v1/shared/condition");
 const step_1 = require("../../../step");
+const apply_namespace_1 = require("../../../util/apply-namespace");
 class Context {
     constructor(action, v1, worker) {
         // @deprecated use ctx.abortController instead
@@ -458,7 +459,7 @@ class Context {
                 else {
                     workflowName = workflow.id;
                 }
-                const name = this.v1.config.namespace + workflowName;
+                const name = (0, apply_namespace_1.applyNamespace)(workflowName, this.v1.config.namespace);
                 const opts = options || {};
                 const { sticky } = opts;
                 if (sticky && !this.worker.hasWorkflow(name)) {
@@ -515,7 +516,7 @@ class Context {
             else {
                 workflowName = workflow.id;
             }
-            const name = this.v1.config.namespace + workflowName;
+            const name = (0, apply_namespace_1.applyNamespace)(workflowName, this.v1.config.namespace);
             const opts = options || {};
             const { sticky } = opts;
             if (sticky && !this.worker.hasWorkflow(name)) {

package/v1/client/worker/worker-internal.d.ts

@@ -4,8 +4,7 @@ import HatchetPromise from '../../../util/hatchet-promise/hatchet-promise';
 import { Workflow } from '../../../workflow';
 import { Logger } from '../../../util/logger';
 import { WebhookWorkerCreateRequest } from '../../../clients/rest/generated/data-contracts';
-import { BaseWorkflowDeclaration, WorkflowDefinition } from '../../declaration';
-import { HatchetClient } from '../..';
+import { BaseWorkflowDeclaration, WorkflowDefinition, HatchetClient } from '../..';
 import { WorkerLabels } from '../../../clients/dispatcher/dispatcher-client';
 import { StepRunFunction } from '../../../step';
 import { Context } from './context';

package/v1/client/worker/worker-internal.js

@@ -29,6 +29,7 @@ const workflows_1 = require("../../../protoc/workflows");
 const task_1 = require("../../task");
 const transformer_1 = require("../../conditions/transformer");
 const step_1 = require("../../../step");
+const apply_namespace_1 = require("../../../util/apply-namespace");
 const context_1 = require("./context");
 class V1Worker {
     constructor(client, options) {
@@ -38,7 +39,7 @@ class V1Worker {
         this.registeredWorkflowPromises = [];
         this.labels = {};
         this.client = client;
-        this.name = this.client.config.namespace + options.name;
+        this.name = (0, apply_namespace_1.applyNamespace)(options.name, this.client.config.namespace);
         this.action_registry = {};
         this.maxRuns = options.maxRuns;
         this.labels = options.labels || {};
@@ -115,9 +116,9 @@ class V1Worker {
     }
     registerWorkflowV1(initWorkflow_1) {
         return __awaiter(this, arguments, void 0, function* (initWorkflow, durable = false) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
             // patch the namespace
-            const workflow = Object.assign(Object.assign({}, initWorkflow.definition), { name: (this.client.config.namespace + initWorkflow.definition.name).toLowerCase() });
+            const workflow = Object.assign(Object.assign({}, initWorkflow.definition), { name: (0, apply_namespace_1.applyNamespace)(initWorkflow.definition.name, this.client.config.namespace).toLowerCase() });
             try {
                 const { concurrency } = workflow;
                 let onFailureTask;
@@ -239,6 +240,11 @@ class V1Worker {
                         });
                     }),
                     concurrency: concurrencySolo,
+                    defaultFilters: (_x = (_w = workflow.defaultFilters) === null || _w === void 0 ? void 0 : _w.map((f) => ({
+                        scope: f.scope,
+                        expression: f.expression,
+                        payload: f.payload ? JSON.stringify(f.payload) : undefined,
+                    }))) !== null && _x !== void 0 ? _x : [],
                 });
                 this.registeredWorkflowPromises.push(registeredWorkflow);
                 yield registeredWorkflow;
@@ -253,7 +259,7 @@ class V1Worker {
     registerWorkflow(initWorkflow) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c;
-            const workflow = Object.assign(Object.assign({}, initWorkflow), { id: (this.client.config.namespace + initWorkflow.id).toLowerCase() });
+            const workflow = Object.assign(Object.assign({}, initWorkflow), { id: (0, apply_namespace_1.applyNamespace)(initWorkflow.id, this.client.config.namespace).toLowerCase() });
             try {
                 if (((_a = workflow.concurrency) === null || _a === void 0 ? void 0 : _a.key) && workflow.concurrency.expression) {
                     throw new hatchet_error_1.default('Cannot have both key function and expression in workflow concurrency configuration');
@@ -292,7 +298,7 @@ class V1Worker {
                     description: workflow.description,
                     version: workflow.version || '',
                     eventTriggers: workflow.on && workflow.on.event
-                        ? [this.client.config.namespace + workflow.on.event]
+                        ? [(0, apply_namespace_1.applyNamespace)(workflow.on.event, this.client.config.namespace)]
                         : [],
                     cronTriggers: workflow.on && workflow.on.cron ? [workflow.on.cron] : [],
                     scheduledTriggers: [],

package/v1/declaration.d.ts

@@ -1,5 +1,5 @@
 import WorkflowRunRef from '../util/workflow-run-ref';
-import { CronWorkflows, ScheduledWorkflows } from '../clients/rest/generated/data-contracts';
+import { CronWorkflows, ScheduledWorkflows, V1CreateFilterRequest } from '../clients/rest/generated/data-contracts';
 import { Workflow as WorkflowV0 } from '../workflow';
 import { IHatchetClient } from './client/client.interface';
 import { CreateWorkflowTaskOpts, CreateOnFailureTaskOpts, TaskFn, CreateWorkflowDurableTaskOpts, CreateBaseTaskOpts, CreateOnSuccessTaskOpts, Concurrency, DurableTaskFn } from './task';
@@ -39,6 +39,7 @@ export type TaskOutput<O, Key extends string, Fallback> = O extends Record<Key,
  * Extracts a property from an object type based on task name, or falls back to inferred type
  */
 export type TaskOutputType<O, TaskName extends string, InferredType extends OutputType> = TaskName extends keyof O ? O[TaskName] extends OutputType ? O[TaskName] : InferredType : InferredType;
+type DefaultFilter = Omit<V1CreateFilterRequest, 'workflowId'>;
 export type CreateBaseWorkflowOpts = {
     /**
      * The name of the workflow.
@@ -78,6 +79,7 @@ export type CreateBaseWorkflowOpts = {
      * values: Priority.LOW, Priority.MEDIUM, Priority.HIGH (1, 2, or 3 )
      */
     defaultPriority?: Priority;
+    defaultFilters?: DefaultFilter[];
 };
 export type CreateTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, TaskFn<I, O>>;
 export type CreateDurableTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, DurableTaskFn<I, O>>;
@@ -260,7 +262,10 @@ export declare class BaseWorkflowDeclaration<I extends InputType = UnknownInputT
      * @returns A promise that resolves with the workflow state.
      * @throws Error if the workflow is not bound to a Hatchet client.
      */
-    get(): Promise<any>;
+    get(): Promise<import("../clients/rest/generated/data-contracts").Workflow>;
+    /**
+     * @deprecated use definition.name instead
+     */
     get id(): string;
     /**
      * Get the friendly name of the workflow.

package/v1/declaration.js

@@ -111,7 +111,7 @@ class BaseWorkflowDeclaration {
             if (!this.client) {
                 throw UNBOUND_ERR;
             }
-            const scheduled = this.client._v0.schedule.create(this.definition.name, Object.assign({ triggerAt: enqueueAt, input: input }, options));
+            const scheduled = this.client.scheduled.create(this.definition.name, Object.assign({ triggerAt: enqueueAt, input: input }, options));
             return scheduled;
         });
     }
@@ -144,7 +144,7 @@ class BaseWorkflowDeclaration {
             if (!this.client) {
                 throw UNBOUND_ERR;
             }
-            const cronDef = this.client._v0.cron.create(this.definition.name, Object.assign(Object.assign({ expression, input: input }, options), { additionalMetadata: options === null || options === void 0 ? void 0 : options.additionalMetadata, name }));
+            const cronDef = this.client.crons.create(this.definition.name, Object.assign(Object.assign({ expression, input: input }, options), { additionalMetadata: options === null || options === void 0 ? void 0 : options.additionalMetadata, name }));
             return cronDef;
         });
     }
@@ -204,7 +204,9 @@ class BaseWorkflowDeclaration {
     //   }
     //   return this.client.workflows.unpause(this);
     // }
-    // @deprecated use definition.name instead
+    /**
+     * @deprecated use definition.name instead
+     */
     get id() {
         return this.definition.name;
     }

package/v1/examples/cancellations/workflow.js

@@ -19,9 +19,9 @@ const hatchet_client_1 = require("../hatchet-client");
 // > Declaring a Task
 exports.cancellation = hatchet_client_1.hatchet.task({
     name: 'cancellation',
-    fn: (_1, _a) => __awaiter(void 0, [_1, _a], void 0, function* (_, { cancelled }) {
+    fn: (_, ctx) => __awaiter(void 0, void 0, void 0, function* () {
         yield (0, sleep_1.default)(10 * 1000);
-        if (cancelled) {
+        if (ctx.cancelled) {
             throw new Error('Task was cancelled');
         }
         return {

package/v1/examples/on_event/workflow.d.ts

@@ -9,6 +9,7 @@ type LowerOutput = {
     };
 };
 export declare const lower: import("../..").WorkflowDeclaration<Input, LowerOutput>;
+export declare const lowerWithFilter: import("../..").WorkflowDeclaration<Input, LowerOutput>;
 type UpperOutput = {
     upper: {
         TransformedMessage: string;

package/v1/examples/on_event/workflow.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.upper = exports.lower = exports.SIMPLE_EVENT = void 0;
+exports.upper = exports.lowerWithFilter = exports.lower = exports.SIMPLE_EVENT = void 0;
 const hatchet_client_1 = require("../hatchet-client");
 exports.SIMPLE_EVENT = 'simple-event:create';
 // > Run workflow on event
@@ -10,6 +10,24 @@ exports.lower = hatchet_client_1.hatchet.workflow({
     onEvents: ['simple-event:create'],
 });
 // !!
+// > Workflow with filter
+exports.lowerWithFilter = hatchet_client_1.hatchet.workflow({
+    name: 'lower',
+    // 👀 Declare the event that will trigger the workflow
+    onEvents: ['simple-event:create'],
+    defaultFilters: [
+        {
+            expression: 'true',
+            scope: 'example-scope',
+            payload: {
+                mainCharacter: 'Anna',
+                supportingCharacter: 'Stiva',
+                location: 'Moscow',
+            },
+        },
+    ],
+});
+// !!
 exports.lower.task({
     name: 'lower',
     fn: (input) => {
@@ -32,3 +50,11 @@ exports.upper.task({
         };
     },
 });
+// > Accessing the filter payload
+exports.lowerWithFilter.task({
+    name: 'lowerWithFilter',
+    fn: (input, ctx) => {
+        console.log(ctx.filterPayload());
+    },
+});
+// !!

package/v1/examples/simple/cron.js

@@ -27,7 +27,7 @@ function main() {
         // !!
         // > List
         const crons = yield hatchet_client_1.hatchet.crons.list({
-            workflowId: workflow_1.simple.id,
+            workflow: workflow_1.simple,
         });
         // !!
         // eslint-disable-next-line no-console

package/v1/examples/simple/schedule.js

@@ -26,11 +26,11 @@ function main() {
         console.log(scheduledRunId);
         // !!
         // > Delete a Scheduled Run
-        yield hatchet_client_1.hatchet.schedules.delete(scheduled);
+        yield hatchet_client_1.hatchet.scheduled.delete(scheduled);
         // !!
         // > List Scheduled Runs
-        const scheduledRuns = yield hatchet_client_1.hatchet.schedules.list({
-            workflowId: workflow_1.simple.id,
+        const scheduledRuns = yield hatchet_client_1.hatchet.scheduled.list({
+            workflow: workflow_1.simple,
         });
         console.log(scheduledRuns);
         // !!

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.6.2";
+export declare const HATCHET_VERSION = "1.7.1";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.6.2';
+exports.HATCHET_VERSION = '1.7.1';