@hatchet-dev/typescript-sdk 1.6.3 → 1.7.1

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

@@ -18,4 +18,5 @@ export declare class FiltersClient {
     get(filterId: Parameters<typeof this.api.v1FilterGet>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
     create(opts: Parameters<typeof this.api.v1FilterCreate>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
     delete(filterId: Parameters<typeof this.api.v1FilterDelete>[1]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
+    update(filterId: Parameters<typeof this.api.v1FilterDelete>[1], updates: Parameters<typeof this.api.v1FilterUpdate>[2]): Promise<import("../../../clients/rest/generated/data-contracts").V1Filter>;
 }

package/v1/client/features/filters.js

@@ -55,5 +55,11 @@ class FiltersClient {
             return data;
         });
     }
+    update(filterId, updates) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.v1FilterUpdate(this.tenantId, filterId, updates);
+            return data;
+        });
+    }
 }
 exports.FiltersClient = FiltersClient;

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

@@ -62,6 +62,7 @@ export declare class RunsClient {
     workflows: WorkflowsClient;
     constructor(client: HatchetClient);
     get<T = any>(run: string | WorkflowRunRef<T>): Promise<import("../../../clients/rest/generated/data-contracts").V1WorkflowRunDetails>;
+    get_status<T = any>(run: string | WorkflowRunRef<T>): Promise<V1TaskStatus>;
     list(opts?: Partial<ListRunsOpts>): Promise<import("../../../clients/rest/generated/data-contracts").V1TaskSummaryList>;
     cancel(opts: CancelRunOpts): Promise<import("axios").AxiosResponse<void, any>>;
     replay(opts: ReplayRunOpts): Promise<import("axios").AxiosResponse<void, any>>;

package/v1/client/features/runs.js

@@ -26,6 +26,13 @@ class RunsClient {
             return data;
         });
     }
+    get_status(run) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const runId = typeof run === 'string' ? run : yield run.getWorkflowRunId();
+            const { data } = yield this.api.v1WorkflowRunGetStatus(runId);
+            return data;
+        });
+    }
     list(opts) {
         return __awaiter(this, void 0, void 0, function* () {
             const { data } = yield this.api.v1WorkflowRunList(this.tenantId, Object.assign({}, (yield this.prepareListFilter(opts || {}))));

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/worker/worker-internal.js

@@ -116,7 +116,7 @@ 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: (0, apply_namespace_1.applyNamespace)(initWorkflow.definition.name, this.client.config.namespace).toLowerCase() });
             try {
@@ -240,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;

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>>;

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

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.6.3";
+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.3';
+exports.HATCHET_VERSION = '1.7.1';