@hatchet-dev/typescript-sdk 1.5.4 → 1.6.1

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

@@ -3,6 +3,8 @@ import { EventsServiceClient } from '../../protoc/events/events';
 import { ClientConfig } from '../hatchet-client/client-config';
 import { Logger } from '../../util/logger';
 import { retrier } from '../../util/retrier';
+import { HatchetClient } from '../../v1';
+import { LegacyHatchetClient } from '../hatchet-client';
 export declare enum LogLevel {
     INFO = "INFO",
     WARN = "WARN",
@@ -11,19 +13,26 @@ export declare enum LogLevel {
 }
 export interface PushEventOptions {
     additionalMetadata?: Record<string, string>;
+    priority?: number;
+    scope?: string;
 }
 export interface EventWithMetadata<T> {
     payload: T;
     additionalMetadata?: Record<string, any>;
+    priority?: number;
+    scope?: string;
 }
 export declare class EventClient {
     config: ClientConfig;
     client: EventsServiceClient;
     retrier: typeof retrier;
+    api: HatchetClient['api'];
+    tenantId: string;
     logger: Logger;
-    constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
+    constructor(config: ClientConfig, channel: Channel, factory: ClientFactory, hatchetClient: LegacyHatchetClient);
     push<T>(type: string, input: T, options?: PushEventOptions): Promise<import("../../protoc/events/events").Event>;
     bulkPush<T>(type: string, inputs: EventWithMetadata<T>[], options?: PushEventOptions): Promise<import("../../protoc/events/events").Events>;
     putLog(stepRunId: string, log: string, level?: LogLevel, taskRetryCount?: number, metadata?: Record<string, any>): Promise<void>;
     putStream(stepRunId: string, data: string | Uint8Array): Promise<void>;
+    list(opts?: Parameters<typeof this.api.v1EventList>[1]): Promise<import("../rest/generated/data-contracts").V1EventList>;
 }

package/clients/event/event-client.js

@@ -25,11 +25,13 @@ var LogLevel;
     LogLevel["DEBUG"] = "DEBUG";
 })(LogLevel || (exports.LogLevel = LogLevel = {}));
 class EventClient {
-    constructor(config, channel, factory) {
+    constructor(config, channel, factory, hatchetClient) {
         this.config = config;
         this.client = factory.create(events_1.EventsServiceDefinition, channel);
         this.logger = config.logger(`Dispatcher`, config.log_level);
         this.retrier = retrier_1.retrier;
+        this.api = hatchetClient.api;
+        this.tenantId = config.tenant_id;
     }
     push(type, input, options = {}) {
         var _a;
@@ -41,6 +43,8 @@ class EventClient {
             additionalMetadata: options.additionalMetadata
                 ? JSON.stringify(options.additionalMetadata)
                 : undefined,
+            priority: options.priority,
+            scope: options.scope,
         };
         try {
             const e = this.retrier(() => __awaiter(this, void 0, void 0, function* () { return this.client.push(req); }), this.logger);
@@ -68,6 +72,8 @@ class EventClient {
                     }
                     return undefined;
                 })(),
+                priority: input.priority,
+                scope: input.scope,
             };
         });
         const req = {
@@ -130,5 +136,11 @@ class EventClient {
             });
         });
     }
+    list(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.v1EventList(this.tenantId, opts);
+            return data;
+        });
+    }
 }
 exports.EventClient = EventClient;

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

@@ -56,7 +56,7 @@ class LegacyHatchetClient {
         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.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 = 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);

package/clients/rest/generated/Api.d.ts

@@ -1,4 +1,4 @@
-import { AcceptInviteRequest, APIErrors, APIMeta, BulkCreateEventRequest, BulkCreateEventResponse, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, ListAPIMetaIntegration, ListAPITokensResponse, ListSlackWebhooks, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, ScheduleWorkflowRunRequest, SNSIntegration, StepRun, StepRunArchiveList, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1CancelTaskRequest, V1DagChildren, V1LogLineList, V1ReplayTaskRequest, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TriggerWorkflowRunRequest, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, WebhookWorkerCreated, WebhookWorkerCreateRequest, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunsCancelRequest, WorkflowRunShape, WorkflowRunsMetrics, WorkflowRunStatus, WorkflowRunStatusList, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
+import { AcceptInviteRequest, APIErrors, APIMeta, BulkCreateEventRequest, BulkCreateEventResponse, CancelEventRequest, CreateAPITokenRequest, CreateAPITokenResponse, CreateCronWorkflowTriggerRequest, CreateEventRequest, CreateSNSIntegrationRequest, CreateTenantAlertEmailGroupRequest, CreateTenantInviteRequest, CreateTenantRequest, CronWorkflows, CronWorkflowsList, CronWorkflowsOrderByField, Event, EventData, EventKey, EventKeyList, EventList, EventOrderByDirection, EventOrderByField, EventSearch, ListAPIMetaIntegration, ListAPITokensResponse, ListSlackWebhooks, ListSNSIntegrations, LogLineLevelField, LogLineList, LogLineOrderByDirection, LogLineOrderByField, LogLineSearch, RateLimitList, RateLimitOrderByDirection, RateLimitOrderByField, RejectInviteRequest, ReplayEventRequest, ReplayWorkflowRunsRequest, ReplayWorkflowRunsResponse, RerunStepRunRequest, ScheduledRunStatus, ScheduledWorkflows, ScheduledWorkflowsList, ScheduledWorkflowsOrderByField, ScheduleWorkflowRunRequest, SNSIntegration, StepRun, StepRunArchiveList, StepRunEventList, Tenant, TenantAlertEmailGroup, TenantAlertEmailGroupList, TenantAlertingSettings, TenantInvite, TenantInviteList, TenantMember, TenantMemberList, TenantQueueMetrics, TenantResourcePolicy, TenantStepRunQueueMetrics, TriggerWorkflowRunRequest, UpdateTenantAlertEmailGroupRequest, UpdateTenantInviteRequest, UpdateTenantRequest, UpdateWorkerRequest, User, UserChangePasswordRequest, UserLoginRequest, UserRegisterRequest, UserTenantMembershipsList, V1CancelTaskRequest, V1CreateFilterRequest, V1DagChildren, V1EventList, V1Filter, V1FilterList, V1LogLineList, V1ReplayTaskRequest, V1TaskEventList, V1TaskPointMetrics, V1TaskRunMetrics, V1TaskStatus, V1TaskSummary, V1TaskSummaryList, V1TaskTimingList, V1TriggerWorkflowRunRequest, V1WorkflowRunDetails, V1WorkflowRunDisplayNameList, WebhookWorkerCreated, WebhookWorkerCreateRequest, WebhookWorkerListResponse, WebhookWorkerRequestListResponse, Worker, WorkerList, Workflow, WorkflowID, WorkflowKindList, WorkflowList, WorkflowMetrics, WorkflowRun, WorkflowRunList, WorkflowRunOrderByDirection, WorkflowRunOrderByField, WorkflowRunsCancelRequest, WorkflowRunShape, WorkflowRunsMetrics, WorkflowRunStatus, WorkflowRunStatusList, WorkflowUpdateRequest, WorkflowVersion, WorkflowWorkersCount } from './data-contracts';
 import { HttpClient, RequestParams } from './http-client';
 export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
     /**
@@ -10,7 +10,10 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @request GET:/api/v1/stable/tasks/{task}
      * @secure
      */
-    v1TaskGet: (task: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskSummary, any>>;
+    v1TaskGet: (task: string, query?: {
+        /** The attempt number */
+        attempt?: number;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskSummary, any>>;
     /**
      * @description List events for a task
      *
@@ -134,6 +137,13 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @maxLength 36
          */
         parent_task_external_id?: string;
+        /**
+         * The external id of the event that triggered the workflow run
+         * @format uuid
+         * @minLength 36
+         * @maxLength 36
+         */
+        triggering_event_external_id?: string;
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskSummaryList, any>>;
     /**
      * @description Lists displayable names of workflow runs for a tenant
@@ -189,6 +199,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         limit?: number;
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskEventList, any>>;
+    /**
+     * @description Get the timings for a workflow run
+     *
+     * @tags Workflow Runs
+     * @name V1WorkflowRunGetTimings
+     * @summary List timings for a workflow run
+     * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}/task-timings
+     * @secure
+     */
+    v1WorkflowRunGetTimings: (v1WorkflowRun: string, query?: {
+        /**
+         * The depth to retrieve children
+         * @format int64
+         */
+        depth?: number;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskTimingList, any>>;
     /**
      * @description Get a summary of task run metrics for a tenant
      *
@@ -204,6 +230,11 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @format date-time
          */
         since: string;
+        /**
+         * The end time to get metrics for
+         * @format date-time
+         */
+        until?: string;
         /** The workflow id to find runs for */
         workflow_ids?: string[];
         /**
@@ -213,6 +244,13 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @maxLength 36
          */
         parent_task_external_id?: string;
+        /**
+         * The id of the event that triggered the task
+         * @format uuid
+         * @minLength 36
+         * @maxLength 36
+         */
+        triggering_event_external_id?: string;
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskRunMetrics, any>>;
     /**
      * @description Get a minute by minute breakdown of task metrics for a tenant
@@ -237,6 +275,83 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          */
         finishedBefore?: string;
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskPointMetrics, any>>;
+    /**
+     * @description Lists all events for a tenant.
+     *
+     * @tags Event
+     * @name V1EventList
+     * @summary List events
+     * @request GET:/api/v1/stable/tenants/{tenant}/events
+     * @secure
+     */
+    v1EventList: (tenant: string, query?: {
+        /**
+         * The number to skip
+         * @format int64
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int64
+         */
+        limit?: number;
+        /** A list of keys to filter by */
+        keys?: EventKey[];
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1EventList, any>>;
+    /**
+     * @description Lists all filters for a tenant.
+     *
+     * @tags Filter
+     * @name V1FilterList
+     * @summary List filters
+     * @request GET:/api/v1/stable/tenants/{tenant}/filters
+     * @secure
+     */
+    v1FilterList: (tenant: string, query?: {
+        /**
+         * The number to skip
+         * @format int64
+         */
+        offset?: number;
+        /**
+         * The number to limit by
+         * @format int64
+         */
+        limit?: number;
+        /** The workflow ids to filter by */
+        workflowIds?: string[];
+        /** The scopes to subset candidate filters by */
+        scopes?: string[];
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1FilterList, any>>;
+    /**
+     * @description Create a new filter
+     *
+     * @tags Filter
+     * @name V1FilterCreate
+     * @summary Create a filter
+     * @request POST:/api/v1/stable/tenants/{tenant}/filters
+     * @secure
+     */
+    v1FilterCreate: (tenant: string, data: V1CreateFilterRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Filter, any>>;
+    /**
+     * @description Get a filter by its id
+     *
+     * @tags Filter
+     * @name V1FilterGet
+     * @summary Get a filter
+     * @request GET:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
+     * @secure
+     */
+    v1FilterGet: (tenant: string, v1Filter: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Filter, any>>;
+    /**
+     * @description Delete a filter
+     *
+     * @tags Filter
+     * @name V1FilterDelete
+     * @request DELETE:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
+     * @secure
+     */
+    v1FilterDelete: (tenant: string, v1Filter: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Filter, any>>;
     /**
      * @description Gets the readiness status
      *

package/clients/rest/generated/Api.js

@@ -25,7 +25,7 @@ class Api extends http_client_1.HttpClient {
          * @request GET:/api/v1/stable/tasks/{task}
          * @secure
          */
-        this.v1TaskGet = (task, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tasks/${task}`, method: 'GET', secure: true, format: 'json' }, params));
+        this.v1TaskGet = (task, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tasks/${task}`, method: 'GET', query: query, secure: true, format: 'json' }, params));
         /**
          * @description List events for a task
          *
@@ -126,6 +126,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.v1WorkflowRunTaskEventsList = (v1WorkflowRun, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/workflow-runs/${v1WorkflowRun}/task-events`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Get the timings for a workflow run
+         *
+         * @tags Workflow Runs
+         * @name V1WorkflowRunGetTimings
+         * @summary List timings for a workflow run
+         * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}/task-timings
+         * @secure
+         */
+        this.v1WorkflowRunGetTimings = (v1WorkflowRun, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/workflow-runs/${v1WorkflowRun}/task-timings`, method: 'GET', query: query, secure: true, format: 'json' }, params));
         /**
          * @description Get a summary of task run metrics for a tenant
          *
@@ -146,6 +156,55 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.v1TaskGetPointMetrics = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/task-point-metrics`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Lists all events for a tenant.
+         *
+         * @tags Event
+         * @name V1EventList
+         * @summary List events
+         * @request GET:/api/v1/stable/tenants/{tenant}/events
+         * @secure
+         */
+        this.v1EventList = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/events`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Lists all filters for a tenant.
+         *
+         * @tags Filter
+         * @name V1FilterList
+         * @summary List filters
+         * @request GET:/api/v1/stable/tenants/{tenant}/filters
+         * @secure
+         */
+        this.v1FilterList = (tenant, query, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/filters`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Create a new filter
+         *
+         * @tags Filter
+         * @name V1FilterCreate
+         * @summary Create a filter
+         * @request POST:/api/v1/stable/tenants/{tenant}/filters
+         * @secure
+         */
+        this.v1FilterCreate = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/filters`, method: 'POST', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Get a filter by its id
+         *
+         * @tags Filter
+         * @name V1FilterGet
+         * @summary Get a filter
+         * @request GET:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
+         * @secure
+         */
+        this.v1FilterGet = (tenant, v1Filter, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/filters/${v1Filter}`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Delete a filter
+         *
+         * @tags Filter
+         * @name V1FilterDelete
+         * @request DELETE:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
+         * @secure
+         */
+        this.v1FilterDelete = (tenant, v1Filter, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/filters/${v1Filter}`, method: 'DELETE', secure: true, format: 'json' }, params));
         /**
          * @description Gets the readiness status
          *

package/clients/rest/generated/data-contracts.d.ts

@@ -538,6 +538,13 @@ export interface CreateEventRequest {
     data: object;
     /** Additional metadata for the event. */
     additionalMetadata?: object;
+    /**
+     * The priority of the event.
+     * @format int32
+     */
+    priority?: number;
+    /** The scope for event filtering. */
+    scope?: string;
 }
 export interface BulkCreateEventRequest {
     events: CreateEventRequest[];
@@ -592,6 +599,70 @@ export interface EventList {
     pagination?: PaginationResponse;
     rows?: Event[];
 }
+export interface V1EventList {
+    pagination?: PaginationResponse;
+    rows?: {
+        metadata: APIResourceMeta;
+        /** The key for the event. */
+        key: string;
+        /** The tenant associated with this event. */
+        tenant?: Tenant;
+        /** The ID of the tenant associated with this event. */
+        tenantId: string;
+        /** The workflow run summary for this event. */
+        workflowRunSummary: {
+            /**
+             * The number of running runs.
+             * @format int64
+             */
+            running: number;
+            /**
+             * The number of queued runs.
+             * @format int64
+             */
+            queued: number;
+            /**
+             * The number of succeeded runs.
+             * @format int64
+             */
+            succeeded: number;
+            /**
+             * The number of failed runs.
+             * @format int64
+             */
+            failed: number;
+            /**
+             * The number of cancelled runs.
+             * @format int64
+             */
+            cancelled: number;
+        };
+        /** Additional metadata for the event. */
+        additionalMetadata?: object;
+    }[];
+}
+export interface V1FilterList {
+    pagination?: PaginationResponse;
+    rows?: V1Filter[];
+}
+export interface V1Filter {
+    metadata: APIResourceMeta;
+    /** The ID of the tenant associated with this filter. */
+    tenantId: string;
+    /**
+     * The workflow id associated with this filter.
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     */
+    workflowId: string;
+    /** The scope associated with this filter. Used for subsetting candidate filters at evaluation time */
+    scope: string;
+    /** The expression associated with this filter. */
+    expression: string;
+    /** Additional payload data associated with the filter */
+    payload: object;
+}
 export interface RateLimit {
     /** The key for the rate limit. */
     key: string;
@@ -633,6 +704,8 @@ export interface Workflow {
     tags?: WorkflowTag[];
     /** The jobs of the workflow. */
     jobs?: Job[];
+    /** The tenant id of the workflow. */
+    tenantId: string;
 }
 export interface WorkflowUpdateRequest {
     /** Whether the workflow is paused. */
@@ -1317,6 +1390,10 @@ export interface V1TaskSummary {
     metadata: APIResourceMeta;
     /** The action ID of the task. */
     actionId?: string;
+    /** The number of retries of the task. */
+    retryCount?: number;
+    /** The attempt number of the task. */
+    attempt?: number;
     /** Additional metadata for the task run. */
     additionalMetadata?: object;
     /** The list of children tasks */
@@ -1387,7 +1464,7 @@ export interface V1TaskSummary {
      * The external ID of the workflow run
      * @format uuid
      */
-    workflowRunExternalId?: string;
+    workflowRunExternalId: string;
     /**
      * The version ID of the workflow
      * @format uuid
@@ -1414,6 +1491,10 @@ export interface V1TaskEventList {
         /** @format uuid */
         workerId?: string;
         taskDisplayName?: string;
+        /** The number of retries of the task. */
+        retryCount?: number;
+        /** The attempt number of the task. */
+        attempt?: number;
     }[];
 }
 export type V1TaskRunMetrics = {
@@ -1540,8 +1621,95 @@ export interface V1LogLine {
     message: string;
     /** The log metadata. */
     metadata: object;
+    /** The retry count of the log line. */
+    retryCount?: number;
+    /** The attempt number of the log line. */
+    attempt?: number;
+    /** The log level. */
+    level?: V1LogLineLevel;
 }
 export interface V1LogLineList {
     pagination?: PaginationResponse;
     rows?: V1LogLine[];
 }
+export interface V1TaskTiming {
+    metadata: APIResourceMeta;
+    /** The depth of the task in the waterfall. */
+    depth: number;
+    status: V1TaskStatus;
+    /** The display name of the task run. */
+    taskDisplayName: string;
+    /**
+     * The external ID of the task.
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     */
+    taskExternalId: string;
+    /** The ID of the task. */
+    taskId: number;
+    /**
+     * The timestamp the task was inserted.
+     * @format date-time
+     */
+    taskInsertedAt: string;
+    /**
+     * The ID of the tenant.
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     * @example "bb214807-246e-43a5-a25d-41761d1cff9e"
+     */
+    tenantId: string;
+    /**
+     * The external ID of the parent task.
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     */
+    parentTaskExternalId?: string;
+    /**
+     * The timestamp the task run was queued.
+     * @format date-time
+     */
+    queuedAt?: string;
+    /**
+     * The timestamp the task run started.
+     * @format date-time
+     */
+    startedAt?: string;
+    /**
+     * The timestamp the task run finished.
+     * @format date-time
+     */
+    finishedAt?: string;
+    /**
+     * The external ID of the workflow run.
+     * @format uuid
+     */
+    workflowRunId?: string;
+    /** The number of retries of the task. */
+    retryCount?: number;
+    /** The attempt number of the task. */
+    attempt?: number;
+}
+export interface V1TaskTimingList {
+    pagination: PaginationResponse;
+    /** The list of task timings */
+    rows: V1TaskTiming[];
+}
+export interface V1CreateFilterRequest {
+    /**
+     * The workflow id
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     */
+    workflowId: string;
+    /** The expression for the filter */
+    expression: string;
+    /** The scope associated with this filter. Used for subsetting candidate filters at evaluation time */
+    scope: string;
+    /** The payload for the filter */
+    payload?: object;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.5.4",
+  "version": "1.6.1",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [

package/protoc/events/events.d.ts

@@ -14,6 +14,8 @@ export interface Event {
     eventTimestamp: Date | undefined;
     /** the payload for the event */
     additionalMetadata?: string | undefined;
+    /** the scope associated with this filter. Used for subsetting candidate filters at evaluation time */
+    scope?: string | undefined;
 }
 export interface Events {
     events: Event[];
@@ -58,6 +60,9 @@ export interface PushEventRequest {
     eventTimestamp: Date | undefined;
     /** metadata for the event */
     additionalMetadata?: string | undefined;
+    priority?: number | undefined;
+    /** the scope associated with this filter. Used for subsetting candidate filters at evaluation time */
+    scope?: string | undefined;
 }
 export interface ReplayEventRequest {
     /** the event id to replay */

package/protoc/events/events.js

@@ -18,6 +18,7 @@ function createBaseEvent() {
         payload: '',
         eventTimestamp: undefined,
         additionalMetadata: undefined,
+        scope: undefined,
     };
 }
 exports.Event = {
@@ -40,6 +41,9 @@ exports.Event = {
         if (message.additionalMetadata !== undefined) {
             writer.uint32(50).string(message.additionalMetadata);
         }
+        if (message.scope !== undefined) {
+            writer.uint32(58).string(message.scope);
+        }
         return writer;
     },
     decode(input, length) {
@@ -91,6 +95,13 @@ exports.Event = {
                     message.additionalMetadata = reader.string();
                     continue;
                 }
+                case 7: {
+                    if (tag !== 58) {
+                        break;
+                    }
+                    message.scope = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -111,6 +122,7 @@ exports.Event = {
             additionalMetadata: isSet(object.additionalMetadata)
                 ? globalThis.String(object.additionalMetadata)
                 : undefined,
+            scope: isSet(object.scope) ? globalThis.String(object.scope) : undefined,
         };
     },
     toJSON(message) {
@@ -133,13 +145,16 @@ exports.Event = {
         if (message.additionalMetadata !== undefined) {
             obj.additionalMetadata = message.additionalMetadata;
         }
+        if (message.scope !== undefined) {
+            obj.scope = message.scope;
+        }
         return obj;
     },
     create(base) {
         return exports.Event.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const message = createBaseEvent();
         message.tenantId = (_a = object.tenantId) !== null && _a !== void 0 ? _a : '';
         message.eventId = (_b = object.eventId) !== null && _b !== void 0 ? _b : '';
@@ -147,6 +162,7 @@ exports.Event = {
         message.payload = (_d = object.payload) !== null && _d !== void 0 ? _d : '';
         message.eventTimestamp = (_e = object.eventTimestamp) !== null && _e !== void 0 ? _e : undefined;
         message.additionalMetadata = (_f = object.additionalMetadata) !== null && _f !== void 0 ? _f : undefined;
+        message.scope = (_g = object.scope) !== null && _g !== void 0 ? _g : undefined;
         return message;
     },
 };
@@ -576,7 +592,14 @@ exports.BulkPushEventRequest = {
     },
 };
 function createBasePushEventRequest() {
-    return { key: '', payload: '', eventTimestamp: undefined, additionalMetadata: undefined };
+    return {
+        key: '',
+        payload: '',
+        eventTimestamp: undefined,
+        additionalMetadata: undefined,
+        priority: undefined,
+        scope: undefined,
+    };
 }
 exports.PushEventRequest = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -592,6 +615,12 @@ exports.PushEventRequest = {
         if (message.additionalMetadata !== undefined) {
             writer.uint32(34).string(message.additionalMetadata);
         }
+        if (message.priority !== undefined) {
+            writer.uint32(40).int32(message.priority);
+        }
+        if (message.scope !== undefined) {
+            writer.uint32(50).string(message.scope);
+        }
         return writer;
     },
     decode(input, length) {
@@ -629,6 +658,20 @@ exports.PushEventRequest = {
                     message.additionalMetadata = reader.string();
                     continue;
                 }
+                case 5: {
+                    if (tag !== 40) {
+                        break;
+                    }
+                    message.priority = reader.int32();
+                    continue;
+                }
+                case 6: {
+                    if (tag !== 50) {
+                        break;
+                    }
+                    message.scope = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -647,6 +690,8 @@ exports.PushEventRequest = {
             additionalMetadata: isSet(object.additionalMetadata)
                 ? globalThis.String(object.additionalMetadata)
                 : undefined,
+            priority: isSet(object.priority) ? globalThis.Number(object.priority) : undefined,
+            scope: isSet(object.scope) ? globalThis.String(object.scope) : undefined,
         };
     },
     toJSON(message) {
@@ -663,18 +708,26 @@ exports.PushEventRequest = {
         if (message.additionalMetadata !== undefined) {
             obj.additionalMetadata = message.additionalMetadata;
         }
+        if (message.priority !== undefined) {
+            obj.priority = Math.round(message.priority);
+        }
+        if (message.scope !== undefined) {
+            obj.scope = message.scope;
+        }
         return obj;
     },
     create(base) {
         return exports.PushEventRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         const message = createBasePushEventRequest();
         message.key = (_a = object.key) !== null && _a !== void 0 ? _a : '';
         message.payload = (_b = object.payload) !== null && _b !== void 0 ? _b : '';
         message.eventTimestamp = (_c = object.eventTimestamp) !== null && _c !== void 0 ? _c : undefined;
         message.additionalMetadata = (_d = object.additionalMetadata) !== null && _d !== void 0 ? _d : undefined;
+        message.priority = (_e = object.priority) !== null && _e !== void 0 ? _e : undefined;
+        message.scope = (_f = object.scope) !== null && _f !== void 0 ? _f : undefined;
         return message;
     },
 };

package/v1/client/client.d.ts

@@ -14,6 +14,7 @@ import { RunsClient } from './features/runs';
 import { InputType, OutputType, UnknownInputType, StrictWorkflowOutputType } from '../types';
 import { RatelimitsClient } from './features';
 import { AdminClient } from './admin';
+import { FiltersClient } from './features/filters';
 /**
  * HatchetV1 implements the main client interface for interacting with the Hatchet workflow engine.
  * It provides methods for creating and executing workflows, as well as managing workers.
@@ -162,6 +163,12 @@ export declare class HatchetClient implements IHatchetClient {
      * @returns A metrics client instance
      */
     get metrics(): MetricsClient;
+    private _filters;
+    /**
+     * Get the filters client for creating and managing filters
+     * @returns A filters client instance
+     */
+    get filters(): FiltersClient;
     private _ratelimits;
     /**
      * Get the rate limits client for creating and managing rate limits

package/v1/client/client.js

@@ -29,6 +29,7 @@ const workflows_1 = require("./features/workflows");
 const runs_1 = require("./features/runs");
 const features_1 = require("./features");
 const admin_1 = require("./admin");
+const filters_1 = require("./features/filters");
 /**
  * HatchetV1 implements the main client interface for interacting with the Hatchet workflow engine.
  * It provides methods for creating and executing workflows, as well as managing workers.
@@ -224,6 +225,16 @@ class HatchetClient {
         }
         return this._metrics;
     }
+    /**
+     * Get the filters client for creating and managing filters
+     * @returns A filters client instance
+     */
+    get filters() {
+        if (!this._filters) {
+            this._filters = new filters_1.FiltersClient(this);
+        }
+        return this._filters;
+    }
     /**
      * Get the rate limits client for creating and managing rate limits
      * @returns A rate limits client instance

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

@@ -0,0 +1,21 @@
+import { HatchetClient } from '../client';
+export type WorkflowIdScopePair = {
+    workflowId: string;
+    scope: string;
+};
+/**
+ * The filters client is a client for interacting with Hatchet's filters API.
+ */
+export declare class FiltersClient {
+    tenantId: string;
+    api: HatchetClient['api'];
+    constructor(client: HatchetClient);
+    list(opts?: {
+        limit?: number;
+        offset?: number;
+        workflowIdsAndScopes?: WorkflowIdScopePair[];
+    }): Promise<import("../../../clients/rest/generated/data-contracts").V1FilterList>;
+    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>;
+}

package/v1/client/features/filters.js

@@ -0,0 +1,59 @@
+"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.FiltersClient = void 0;
+/**
+ * The filters client is a client for interacting with Hatchet's filters API.
+ */
+class FiltersClient {
+    constructor(client) {
+        this.tenantId = client.tenantId;
+        this.api = client.api;
+    }
+    list(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b;
+            const hasWorkflowIdsAndScopes = (opts === null || opts === void 0 ? void 0 : opts.workflowIdsAndScopes) !== undefined;
+            const workflowIds = hasWorkflowIdsAndScopes
+                ? (_a = opts.workflowIdsAndScopes) === null || _a === void 0 ? void 0 : _a.map((pair) => pair.workflowId)
+                : undefined;
+            const scopes = hasWorkflowIdsAndScopes
+                ? (_b = opts.workflowIdsAndScopes) === null || _b === void 0 ? void 0 : _b.map((pair) => pair.scope)
+                : undefined;
+            const { data } = yield this.api.v1FilterList(this.tenantId, {
+                limit: opts === null || opts === void 0 ? void 0 : opts.limit,
+                offset: opts === null || opts === void 0 ? void 0 : opts.offset,
+                workflowIds,
+                scopes,
+            });
+            return data;
+        });
+    }
+    get(filterId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.v1FilterGet(this.tenantId, filterId);
+            return data;
+        });
+    }
+    create(opts) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.v1FilterCreate(this.tenantId, opts);
+            return data;
+        });
+    }
+    delete(filterId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.api.v1FilterDelete(this.tenantId, filterId);
+            return data;
+        });
+    }
+}
+exports.FiltersClient = FiltersClient;

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

@@ -45,6 +45,13 @@ export interface ListRunsOpts extends RunFilter {
      * @maxLength 36
      */
     parentTaskExternalId?: string;
+    /**
+     * The triggering event external id to filter by
+     * @format uuid
+     * @minLength 36
+     * @maxLength 36
+     */
+    triggeringEventExternalId?: string;
 }
 /**
  * RunsClient is used to list and manage runs

package/v1/client/features/runs.js

@@ -78,6 +78,7 @@ class RunsClient {
                 workflow_ids: yield Promise.all(((_b = opts.workflowNames) === null || _b === void 0 ? void 0 : _b.map((name) => __awaiter(this, void 0, void 0, function* () { return (yield this.workflows.get(name)).metadata.id; }))) || []),
                 additional_metadata: am,
                 only_tasks: opts.onlyTasks || false,
+                triggering_event_external_id: opts.triggeringEventExternalId,
             };
         });
     }

package/v1/client/features/workflows.js

@@ -51,7 +51,7 @@ class WorkflowsClient {
                         workflow: wf,
                         expiry: Date.now() + this.cacheTTL,
                     });
-                    return workflow;
+                    return wf;
                 }
                 throw new Error(`Workflow with name ${name} not found`);
             }

package/v1/client/worker/context.d.ts

@@ -67,6 +67,11 @@ export declare class Context<T, K = {}> {
      * @returns The triggers for the current workflow.
      */
     triggers(): TriggerData;
+    /**
+     * Gets the payload from the filter that matched when triggering the event.
+     * @returns The payload.
+     */
+    filterPayload(): Record<string, any>;
     /**
      * Determines if the workflow was triggered by an event.
      * @returns True if the workflow was triggered by an event, otherwise false.

package/v1/client/worker/context.js

@@ -112,6 +112,14 @@ class Context {
     triggers() {
         return this.data.triggers;
     }
+    /**
+     * Gets the payload from the filter that matched when triggering the event.
+     * @returns The payload.
+     */
+    filterPayload() {
+        var _a;
+        return ((_a = this.data.triggers) === null || _a === void 0 ? void 0 : _a.filter_payload) || {};
+    }
     /**
      * Determines if the workflow was triggered by an event.
      * @returns True if the workflow was triggered by an event, otherwise false.

package/v1/examples/on_event/event.js

@@ -15,6 +15,7 @@ function main() {
         // > Pushing an Event
         const res = yield hatchet_client_1.hatchet.events.push('simple-event:create', {
             Message: 'hello',
+            ShouldSkip: false,
         });
         // !!
         // eslint-disable-next-line no-console

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

@@ -1,5 +1,6 @@
 export type Input = {
     Message: string;
+    ShouldSkip: boolean;
 };
 export declare const SIMPLE_EVENT = "simple-event:create";
 type LowerOutput = {

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.5.4";
+export declare const HATCHET_VERSION = "1.6.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.5.4';
+exports.HATCHET_VERSION = '1.6.1';