@hatchet-dev/typescript-sdk 1.6.2 → 1.7.1

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

@@ -186,6 +186,7 @@ export declare class AdminClient {
      * @param name the name of the workflow to schedule
      * @param options an object containing the schedules to set
      * @param input an object containing the input to the workflow
+     * @deprecated use hatchet.schedules.create instead
      */
     scheduleWorkflow(name: string, options?: {
         schedules?: Date[];

package/clients/admin/admin-client.js

@@ -18,6 +18,7 @@ const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error
 const retrier_1 = require("../../util/retrier");
 const workflow_run_ref_1 = __importDefault(require("../../util/workflow-run-ref"));
 const workflows_2 = require("../../protoc/v1/workflows");
+const apply_namespace_1 = require("../../util/apply-namespace");
 class AdminClient {
     constructor(config, channel, factory, api, tenantId, listenerClient, workflows) {
         this.config = config;
@@ -116,11 +117,8 @@ class AdminClient {
      * @returns the ID of the new workflow run
      */
     runWorkflow(workflowName, input, options) {
-        let computedName = workflowName;
+        const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace);
         try {
-            if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
-                computedName = this.config.namespace + workflowName;
-            }
             const inputStr = JSON.stringify(input);
             const resp = this.client.triggerWorkflow(Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
                     ? JSON.stringify(options === null || options === void 0 ? void 0 : options.additionalMetadata)
@@ -140,10 +138,7 @@ class AdminClient {
     runWorkflows(workflowRuns) {
         // Prepare workflows to be triggered in bulk
         const workflowRequests = workflowRuns.map(({ workflowName, input, options }) => {
-            let computedName = workflowName;
-            if (this.config.namespace && !workflowName.startsWith(this.config.namespace)) {
-                computedName = this.config.namespace + workflowName;
-            }
+            const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace);
             const inputStr = JSON.stringify(input);
             return Object.assign(Object.assign({ name: computedName, input: inputStr }, options), { additionalMetadata: (options === null || options === void 0 ? void 0 : options.additionalMetadata)
                     ? JSON.stringify(options.additionalMetadata)
@@ -274,13 +269,12 @@ class AdminClient {
      * @param name the name of the workflow to schedule
      * @param options an object containing the schedules to set
      * @param input an object containing the input to the workflow
+     * @deprecated use hatchet.schedules.create instead
      */
     scheduleWorkflow(name, options) {
         let computedName = name;
         try {
-            if (this.config.namespace && !name.startsWith(this.config.namespace)) {
-                computedName = this.config.namespace + name;
-            }
+            computedName = (0, apply_namespace_1.applyNamespace)(name, this.config.namespace);
             let input;
             if (options === null || options === void 0 ? void 0 : options.input) {
                 input = JSON.stringify(options.input);

package/clients/event/event-client.js

@@ -16,6 +16,7 @@ exports.EventClient = exports.LogLevel = void 0;
 const events_1 = require("../../protoc/events/events");
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
 const retrier_1 = require("../../util/retrier");
+const apply_namespace_1 = require("../../util/apply-namespace");
 // eslint-disable-next-line no-shadow
 var LogLevel;
 (function (LogLevel) {
@@ -34,8 +35,7 @@ class EventClient {
         this.tenantId = config.tenant_id;
     }
     push(type, input, options = {}) {
-        var _a;
-        const namespacedType = `${(_a = this.config.namespace) !== null && _a !== void 0 ? _a : ''}${type}`;
+        const namespacedType = (0, apply_namespace_1.applyNamespace)(type, this.config.namespace);
         const req = {
             key: namespacedType,
             payload: JSON.stringify(input),
@@ -56,8 +56,7 @@ class EventClient {
         }
     }
     bulkPush(type, inputs, options = {}) {
-        var _a;
-        const namespacedType = `${(_a = this.config.namespace) !== null && _a !== void 0 ? _a : ''}${type}`;
+        const namespacedType = (0, apply_namespace_1.applyNamespace)(type, this.config.namespace);
         const events = inputs.map((input) => {
             return {
                 key: namespacedType,

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

@@ -10,8 +10,6 @@ import { RunsClient } from '../../v1';
 import { ClientConfig } from './client-config';
 import { RunListenerClient } from '../listeners/run-listener/child-listener-client';
 import { Api } from '../rest/generated/Api';
-import { CronClient } from './features/cron-client';
-import { ScheduleClient } from './features/schedule-client';
 import { DurableListenerClient } from '../listeners/durable-listener/durable-listener-client';
 export interface HatchetClientOptions {
     config_path?: string;
@@ -29,8 +27,6 @@ export declare class LegacyHatchetClient {
     tenantId: string;
     durableListener: DurableListenerClient;
     logger: Logger;
-    cron: CronClient;
-    schedule: ScheduleClient;
     constructor(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosOpts?: AxiosRequestConfig, runs?: RunsClient);
     static init(config?: Partial<ClientConfig>, options?: HatchetClientOptions, axiosConfig?: AxiosRequestConfig): LegacyHatchetClient;
     run(workflow: string | V0Workflow): Promise<V0Worker>;

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

@@ -25,8 +25,6 @@ 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 cron_client_1 = require("./features/cron-client");
-const schedule_client_1 = require("./features/schedule-client");
 const durable_listener_client_1 = require("../listeners/durable-listener/durable-listener-client");
 class LegacyHatchetClient {
     constructor(config, options, axiosOpts, runs) {
@@ -63,9 +61,6 @@ class LegacyHatchetClient {
         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`);
-        // Feature Clients
-        this.cron = new cron_client_1.CronClient(this.tenantId, this.config, this.api, this.admin);
-        this.schedule = new schedule_client_1.ScheduleClient(this.tenantId, this.config, this.api, this.admin);
     }
     static init(config, options, axiosConfig) {
         return new LegacyHatchetClient(config, options, axiosConfig);

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, 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 { 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, V1UpdateFilterRequest, 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> {
     /**
@@ -144,6 +144,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
          * @maxLength 36
          */
         triggering_event_external_id?: string;
+        /** A flag for whether or not to include the input and output payloads in the response. Defaults to `true` if unset. */
+        include_payloads?: boolean;
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskSummaryList, any>>;
     /**
      * @description Lists displayable names of workflow runs for a tenant
@@ -178,6 +180,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     v1WorkflowRunGet: (v1WorkflowRun: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1WorkflowRunDetails, any>>;
+    /**
+     * @description Get the status of a workflow run.
+     *
+     * @tags Workflow Runs
+     * @name V1WorkflowRunGetStatus
+     * @summary Get workflow run status
+     * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}/status
+     * @secure
+     */
+    v1WorkflowRunGetStatus: (v1WorkflowRun: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1TaskStatus, any>>;
     /**
      * @description List all tasks for a workflow run
      *
@@ -297,7 +309,37 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
         limit?: number;
         /** A list of keys to filter by */
         keys?: EventKey[];
+        /**
+         * Consider events that occurred after this time
+         * @format date-time
+         */
+        since?: string;
+        /**
+         * Consider events that occurred before this time
+         * @format date-time
+         */
+        until?: string;
+        /** Filter to events that are associated with a specific workflow run */
+        workflowIds?: string[];
+        /** Filter to events that are associated with workflow runs matching a certain status */
+        workflowRunStatuses?: V1TaskStatus[];
+        /** Filter to specific events by their ids */
+        eventIds?: string[];
+        /** Filter by additional metadata on the events */
+        additionalMetadata?: string[];
+        /** The scopes to filter by */
+        scopes?: string[];
     }, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1EventList, any>>;
+    /**
+     * @description Lists all event keys for a tenant.
+     *
+     * @tags Event
+     * @name V1EventKeyList
+     * @summary List event keys
+     * @request GET:/api/v1/stable/tenants/{tenant}/events/keys
+     * @secure
+     */
+    v1EventKeyList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<EventKeyList, any>>;
     /**
      * @description Lists all filters for a tenant.
      *
@@ -352,6 +394,15 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     v1FilterDelete: (tenant: string, v1Filter: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Filter, any>>;
+    /**
+     * @description Update a filter
+     *
+     * @tags Filter
+     * @name V1FilterUpdate
+     * @request PATCH:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
+     * @secure
+     */
+    v1FilterUpdate: (tenant: string, v1Filter: string, data: V1UpdateFilterRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<V1Filter, any>>;
     /**
      * @description Gets the readiness status
      *
@@ -671,6 +722,16 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
      * @secure
      */
     tenantUpdate: (tenant: string, data: UpdateTenantRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<Tenant, any>>;
+    /**
+     * @description Get the details of a tenant
+     *
+     * @tags Tenant
+     * @name TenantGet
+     * @summary Get tenant
+     * @request GET:/api/v1/tenants/{tenant}
+     * @secure
+     */
+    tenantGet: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Tenant, any>>;
     /**
      * @description Gets the alerting settings for a tenant
      *

package/clients/rest/generated/Api.js

@@ -116,6 +116,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.v1WorkflowRunGet = (v1WorkflowRun, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/workflow-runs/${v1WorkflowRun}`, method: 'GET', secure: true, format: 'json' }, params));
+        /**
+         * @description Get the status of a workflow run.
+         *
+         * @tags Workflow Runs
+         * @name V1WorkflowRunGetStatus
+         * @summary Get workflow run status
+         * @request GET:/api/v1/stable/workflow-runs/{v1-workflow-run}/status
+         * @secure
+         */
+        this.v1WorkflowRunGetStatus = (v1WorkflowRun, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/workflow-runs/${v1WorkflowRun}/status`, method: 'GET', secure: true, format: 'json' }, params));
         /**
          * @description List all tasks for a workflow run
          *
@@ -166,6 +176,16 @@ class Api extends http_client_1.HttpClient {
          * @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 event keys for a tenant.
+         *
+         * @tags Event
+         * @name V1EventKeyList
+         * @summary List event keys
+         * @request GET:/api/v1/stable/tenants/{tenant}/events/keys
+         * @secure
+         */
+        this.v1EventKeyList = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/events/keys`, method: 'GET', secure: true, format: 'json' }, params));
         /**
          * @description Lists all filters for a tenant.
          *
@@ -205,6 +225,15 @@ class Api extends http_client_1.HttpClient {
          * @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 Update a filter
+         *
+         * @tags Filter
+         * @name V1FilterUpdate
+         * @request PATCH:/api/v1/stable/tenants/{tenant}/filters/{v1-filter}
+         * @secure
+         */
+        this.v1FilterUpdate = (tenant, v1Filter, data, params = {}) => this.request(Object.assign({ path: `/api/v1/stable/tenants/${tenant}/filters/${v1Filter}`, method: 'PATCH', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
         /**
          * @description Gets the readiness status
          *
@@ -524,6 +553,16 @@ class Api extends http_client_1.HttpClient {
          * @secure
          */
         this.tenantUpdate = (tenant, data, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}`, method: 'PATCH', body: data, secure: true, type: http_client_1.ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Get the details of a tenant
+         *
+         * @tags Tenant
+         * @name TenantGet
+         * @summary Get tenant
+         * @request GET:/api/v1/tenants/{tenant}
+         * @secure
+         */
+        this.tenantGet = (tenant, params = {}) => this.request(Object.assign({ path: `/api/v1/tenants/${tenant}`, method: 'GET', secure: true, format: 'json' }, params));
         /**
          * @description Gets the alerting settings for a tenant
          *