@hatchet-dev/typescript-sdk 0.15.0 → 0.16.0-alpha.1

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

@@ -45,6 +45,8 @@ export declare const ClientConfigSchema: z.ZodObject<{
     log_level: z.ZodOptional<z.ZodEnum<["OFF", "DEBUG", "INFO", "WARN", "ERROR"]>>;
     tenant_id: z.ZodString;
     namespace: z.ZodOptional<z.ZodString>;
+    runnable_actions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    cloud_register_id: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     token: string;
     tls_config: {
@@ -59,6 +61,8 @@ export declare const ClientConfigSchema: z.ZodObject<{
     tenant_id: string;
     log_level?: "OFF" | "DEBUG" | "INFO" | "WARN" | "ERROR" | undefined;
     namespace?: string | undefined;
+    runnable_actions?: string[] | undefined;
+    cloud_register_id?: string | undefined;
 }, {
     token: string;
     tls_config: {
@@ -73,6 +77,8 @@ export declare const ClientConfigSchema: z.ZodObject<{
     tenant_id: string;
     log_level?: "OFF" | "DEBUG" | "INFO" | "WARN" | "ERROR" | undefined;
     namespace?: string | undefined;
+    runnable_actions?: string[] | undefined;
+    cloud_register_id?: string | undefined;
 }>;
 export type ClientConfig = z.infer<typeof ClientConfigSchema> & {
     credentials?: ChannelCredentials;

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

@@ -17,4 +17,6 @@ exports.ClientConfigSchema = zod_1.z.object({
     log_level: zod_1.z.enum(['OFF', 'DEBUG', 'INFO', 'WARN', 'ERROR']).optional(),
     tenant_id: zod_1.z.string(),
     namespace: zod_1.z.string().optional(),
+    runnable_actions: zod_1.z.array(zod_1.z.string()).optional(),
+    cloud_register_id: zod_1.z.string().optional(),
 });

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

@@ -9,6 +9,7 @@ import { AxiosRequestConfig } from 'axios';
 import { ClientConfig } from './client-config';
 import { ListenerClient } from '../listener/listener-client';
 import { Api } from '../rest/generated/Api';
+import { CloudApi } from '../rest';
 export interface HatchetClientOptions {
     config_path?: string;
     credentials?: ChannelCredentials;
@@ -22,6 +23,7 @@ export declare class HatchetClient {
     dispatcher: DispatcherClient;
     admin: AdminClient;
     api: Api;
+    cloudApi: CloudApi;
     listener: ListenerClient;
     tenantId: string;
     logger: Logger;

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

@@ -1,4 +1,27 @@
 "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 __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) {
@@ -48,7 +71,7 @@ const worker_1 = require("../worker");
 const logger_1 = __importDefault(require("../../util/logger/logger"));
 const client_config_1 = require("./client-config");
 const listener_client_1 = require("../listener/listener-client");
-const rest_1 = __importDefault(require("../rest"));
+const rest_1 = __importStar(require("../rest"));
 const channelFactory = (config, credentials) => (0, nice_grpc_1.createChannel)(config.host_port, credentials, {
     'grpc.ssl_target_name_override': config.tls_config.server_name,
     'grpc.keepalive_timeout_ms': 60 * 1000,
@@ -109,6 +132,7 @@ class HatchetClient {
         const clientFactory = (0, nice_grpc_1.createClientFactory)().use((0, exports.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.cloudApi = (0, rest_1.cloudApi)(this.config.api_url, this.config.token, axiosOpts);
         this.event = new event_client_1.EventClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory);
         this.dispatcher = new dispatcher_client_1.DispatcherClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory);
         this.listener = new listener_client_1.ListenerClient(this.config, (0, exports.channelFactory)(this.config, this.credentials), clientFactory, this.api);

package/clients/rest/api.d.ts

@@ -1,4 +1,7 @@
 import { AxiosRequestConfig } from 'axios';
 import { Api } from './generated/Api';
+import { Api as CloudApi } from './generated/cloud/Api';
 declare const api: (serverUrl: string, token: string, axiosOpts?: AxiosRequestConfig) => Api<unknown>;
+export declare const cloudApi: (serverUrl: string, token: string, axiosOpts?: AxiosRequestConfig) => CloudApi<unknown>;
+export { api, CloudApi };
 export default api;

package/clients/rest/api.js

@@ -3,11 +3,21 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudApi = exports.api = exports.cloudApi = void 0;
 const qs_1 = __importDefault(require("qs"));
 const Api_1 = require("./generated/Api");
+const Api_2 = require("./generated/cloud/Api");
+Object.defineProperty(exports, "CloudApi", { enumerable: true, get: function () { return Api_2.Api; } });
 const api = (serverUrl, token, axiosOpts) => {
     return new Api_1.Api(Object.assign({ baseURL: serverUrl, headers: {
             Authorization: `Bearer ${token}`,
         }, paramsSerializer: (params) => qs_1.default.stringify(params, { arrayFormat: 'repeat' }) }, axiosOpts));
 };
+exports.api = api;
+const cloudApi = (serverUrl, token, axiosOpts) => {
+    return new Api_2.Api(Object.assign({ baseURL: serverUrl, headers: {
+            Authorization: `Bearer ${token}`,
+        }, paramsSerializer: (params) => qs_1.default.stringify(params, { arrayFormat: 'repeat' }) }, axiosOpts));
+};
+exports.cloudApi = cloudApi;
 exports.default = api;

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

@@ -0,0 +1,364 @@
+import { APICloudMetadata, Build, CreateManagedWorkerRequest, FeatureFlags, InfraAsCodeRequest, InstanceList, ListGithubAppInstallationsResponse, ListGithubBranchesResponse, ListGithubReposResponse, LogLineList, ManagedWorker, ManagedWorkerEventList, ManagedWorkerList, Matrix, RuntimeConfigActionsResponse, TenantBillingState, TenantSubscription, UpdateManagedWorkerRequest, UpdateTenantSubscription, VectorPushRequest, WorkflowRunEventsMetricsCounts } from './data-contracts';
+import { HttpClient, RequestParams } from './http-client';
+export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * @description Gets metadata for the Hatchet instance
+     *
+     * @tags Metadata
+     * @name MetadataGet
+     * @summary Get metadata
+     * @request GET:/api/v1/cloud/metadata
+     */
+    metadataGet: (params?: RequestParams) => Promise<import("axios").AxiosResponse<APICloudMetadata, any>>;
+    /**
+     * @description Starts the OAuth flow
+     *
+     * @tags User
+     * @name UserUpdateGithubAppOauthStart
+     * @summary Start OAuth flow
+     * @request GET:/api/v1/cloud/users/github-app/start
+     * @secure
+     */
+    userUpdateGithubAppOauthStart: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * @description Completes the OAuth flow
+     *
+     * @tags User
+     * @name UserUpdateGithubAppOauthCallback
+     * @summary Complete OAuth flow
+     * @request GET:/api/v1/cloud/users/github-app/callback
+     * @secure
+     */
+    userUpdateGithubAppOauthCallback: (params?: RequestParams) => Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * @description Github App global webhook
+     *
+     * @tags Github
+     * @name GithubUpdateGlobalWebhook
+     * @summary Github app global webhook
+     * @request POST:/api/v1/cloud/github/webhook
+     */
+    githubUpdateGlobalWebhook: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Github App tenant webhook
+     *
+     * @tags Github
+     * @name GithubUpdateTenantWebhook
+     * @summary Github app tenant webhook
+     * @request POST:/api/v1/cloud/github/webhook/{webhook}
+     */
+    githubUpdateTenantWebhook: (webhook: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description List Github App installations
+     *
+     * @tags Github
+     * @name GithubAppListInstallations
+     * @summary List Github App installations
+     * @request GET:/api/v1/cloud/github-app/installations
+     * @secure
+     */
+    githubAppListInstallations: (params?: RequestParams) => Promise<import("axios").AxiosResponse<ListGithubAppInstallationsResponse, any>>;
+    /**
+     * @description List Github App repositories
+     *
+     * @tags Github
+     * @name GithubAppListRepos
+     * @summary List Github App repositories
+     * @request GET:/api/v1/cloud/github-app/installations/{gh-installation}/repos
+     * @secure
+     */
+    githubAppListRepos: (ghInstallation: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ListGithubReposResponse, any>>;
+    /**
+     * @description List Github App branches
+     *
+     * @tags Github
+     * @name GithubAppListBranches
+     * @summary List Github App branches
+     * @request GET:/api/v1/cloud/github-app/installations/{gh-installation}/repos/{gh-repo-owner}/{gh-repo-name}/branches
+     * @secure
+     */
+    githubAppListBranches: (ghInstallation: string, ghRepoOwner: string, ghRepoName: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ListGithubBranchesResponse, any>>;
+    /**
+     * @description Get all managed workers for the tenant
+     *
+     * @tags Managed Worker
+     * @name ManagedWorkerList
+     * @summary List Managed Workers
+     * @request GET:/api/v1/cloud/tenants/{tenant}/managed-worker
+     * @secure
+     */
+    managedWorkerList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ManagedWorkerList, any>>;
+    /**
+     * @description Create a managed worker for the tenant
+     *
+     * @tags Managed Worker
+     * @name ManagedWorkerCreate
+     * @summary Create Managed Worker
+     * @request POST:/api/v1/cloud/tenants/{tenant}/managed-worker
+     * @secure
+     */
+    managedWorkerCreate: (tenant: string, data: CreateManagedWorkerRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<ManagedWorker, any>>;
+    /**
+     * @description Get a managed worker for the tenant
+     *
+     * @tags Managed Worker
+     * @name ManagedWorkerGet
+     * @summary Get Managed Worker
+     * @request GET:/api/v1/cloud/managed-worker/{managed-worker}
+     * @secure
+     */
+    managedWorkerGet: (managedWorker: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ManagedWorker, any>>;
+    /**
+     * @description Update a managed worker for the tenant
+     *
+     * @tags Managed Worker
+     * @name ManagedWorkerUpdate
+     * @summary Update Managed Worker
+     * @request POST:/api/v1/cloud/managed-worker/{managed-worker}
+     * @secure
+     */
+    managedWorkerUpdate: (managedWorker: string, data: UpdateManagedWorkerRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<ManagedWorker, any>>;
+    /**
+     * @description Delete a managed worker for the tenant
+     *
+     * @tags Managed Worker
+     * @name ManagedWorkerDelete
+     * @summary Delete Managed Worker
+     * @request DELETE:/api/v1/cloud/managed-worker/{managed-worker}
+     * @secure
+     */
+    managedWorkerDelete: (managedWorker: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ManagedWorker, any>>;
+    /**
+     * @description Registers runtime configs via infra-as-code
+     *
+     * @tags Managed Worker
+     * @name InfraAsCodeCreate
+     * @summary Create Infra as Code
+     * @request POST:/api/v1/cloud/infra-as-code/{infra-as-code-request}
+     * @secure
+     */
+    infraAsCodeCreate: (infraAsCodeRequest: string, data: InfraAsCodeRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get a list of runtime config actions for a managed worker
+     *
+     * @tags Managed Worker
+     * @name RuntimeConfigListActions
+     * @summary Get Runtime Config Actions
+     * @request GET:/api/v1/cloud/runtime-config/{runtime-config}/actions
+     * @secure
+     */
+    runtimeConfigListActions: (runtimeConfig: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<RuntimeConfigActionsResponse, any>>;
+    /**
+     * @description Get CPU metrics for a managed worker
+     *
+     * @tags Metrics
+     * @name MetricsCpuGet
+     * @summary Get CPU Metrics
+     * @request GET:/api/v1/cloud/managed-worker/{managed-worker}/metrics/cpu
+     * @secure
+     */
+    metricsCpuGet: (managedWorker: string, query?: {
+        /**
+         * When the metrics should start
+         * @format date-time
+         */
+        after?: string;
+        /**
+         * When the metrics should end
+         * @format date-time
+         */
+        before?: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<Matrix, any>>;
+    /**
+     * @description Get memory metrics for a managed worker
+     *
+     * @tags Metrics
+     * @name MetricsMemoryGet
+     * @summary Get Memory Metrics
+     * @request GET:/api/v1/cloud/managed-worker/{managed-worker}/metrics/memory
+     * @secure
+     */
+    metricsMemoryGet: (managedWorker: string, query?: {
+        /**
+         * When the metrics should start
+         * @format date-time
+         */
+        after?: string;
+        /**
+         * When the metrics should end
+         * @format date-time
+         */
+        before?: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<Matrix, any>>;
+    /**
+     * @description Get disk metrics for a managed worker
+     *
+     * @tags Metrics
+     * @name MetricsDiskGet
+     * @summary Get Disk Metrics
+     * @request GET:/api/v1/cloud/managed-worker/{managed-worker}/metrics/disk
+     * @secure
+     */
+    metricsDiskGet: (managedWorker: string, query?: {
+        /**
+         * When the metrics should start
+         * @format date-time
+         */
+        after?: string;
+        /**
+         * When the metrics should end
+         * @format date-time
+         */
+        before?: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<Matrix, any>>;
+    /**
+     * @description Lists logs for a managed worker
+     *
+     * @tags Log
+     * @name LogList
+     * @summary List Logs
+     * @request GET:/api/v1/cloud/managed-worker/{managed-worker}/logs
+     * @secure
+     */
+    logList: (managedWorker: string, query?: {
+        /**
+         * When the logs should start
+         * @format date-time
+         */
+        after?: string;
+        /**
+         * When the logs should end
+         * @format date-time
+         */
+        before?: string;
+        /** The search query to filter for */
+        search?: string;
+        /** The direction to sort the logs */
+        direction?: "forward" | "backward";
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<LogLineList, any>>;
+    /**
+     * @description Get all instances for a managed worker
+     *
+     * @tags Managed Worker
+     * @name ManagedWorkerInstancesList
+     * @summary List Instances
+     * @request GET:/api/v1/cloud/managed-worker/{managed-worker}/instances
+     * @secure
+     */
+    managedWorkerInstancesList: (managedWorker: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<InstanceList, any>>;
+    /**
+     * @description Get a build
+     *
+     * @tags Build
+     * @name BuildGet
+     * @summary Get Build
+     * @request GET:/api/v1/cloud/build/{build}
+     * @secure
+     */
+    buildGet: (build: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<Build, any>>;
+    /**
+     * @description Get the build logs for a specific build of a managed worker
+     *
+     * @tags Log
+     * @name BuildLogsList
+     * @summary Get Build Logs
+     * @request GET:/api/v1/cloud/build/{build}/logs
+     * @secure
+     */
+    buildLogsList: (build: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<LogLineList, any>>;
+    /**
+     * @description Get events for a managed worker
+     *
+     * @tags Managed Worker
+     * @name ManagedWorkerEventsList
+     * @summary Get Managed Worker Events
+     * @request GET:/api/v1/cloud/managed-worker/{managed-worker}/events
+     * @secure
+     */
+    managedWorkerEventsList: (managedWorker: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<ManagedWorkerEventList, any>>;
+    /**
+     * @description Receive a webhook message from Lago
+     *
+     * @tags Billing
+     * @name LagoMessageCreate
+     * @summary Receive a webhook message from Lago
+     * @request POST:/api/v1/billing/lago/webhook
+     */
+    lagoMessageCreate: (params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Gets the billing state for a tenant
+     *
+     * @tags Tenant
+     * @name TenantBillingStateGet
+     * @summary Get the billing state for a tenant
+     * @request GET:/api/v1/billing/tenants/{tenant}
+     * @secure
+     */
+    tenantBillingStateGet: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<TenantBillingState, any>>;
+    /**
+     * @description Update a subscription
+     *
+     * @tags Billing
+     * @name SubscriptionUpsert
+     * @summary Create a new subscription
+     * @request PATCH:/api/v1/billing/tenants/{tenant}/subscription
+     * @secure
+     */
+    subscriptionUpsert: (tenant: string, data: UpdateTenantSubscription, params?: RequestParams) => Promise<import("axios").AxiosResponse<TenantSubscription, any>>;
+    /**
+     * @description Get the billing portal link
+     *
+     * @tags Billing
+     * @name BillingPortalLinkGet
+     * @summary Create a link to the billing portal
+     * @request GET:/api/v1/billing/tenants/{tenant}/billing-portal-link
+     * @secure
+     */
+    billingPortalLinkGet: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<{
+        /** The url to the billing portal */
+        url?: string;
+    }, any>>;
+    /**
+     * @description Push a log entry for the tenant
+     *
+     * @tags Log
+     * @name LogCreate
+     * @summary Push Log Entry
+     * @request POST:/api/v1/cloud/tenants/{tenant}/logs
+     * @secure
+     */
+    logCreate: (tenant: string, data: VectorPushRequest, params?: RequestParams) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * @description Get all feature flags for the tenant
+     *
+     * @tags Feature Flags
+     * @name FeatureFlagsList
+     * @summary List Feature Flags
+     * @request GET:/api/v1/cloud/tenants/{tenant}/feature-flags
+     * @secure
+     */
+    featureFlagsList: (tenant: string, params?: RequestParams) => Promise<import("axios").AxiosResponse<FeatureFlags, any>>;
+    /**
+     * @description Get a minute by minute breakdown of workflow run metrics for a tenant
+     *
+     * @tags Workflow
+     * @name WorkflowRunEventsGetMetrics
+     * @summary Get workflow runs
+     * @request GET:/api/v1/cloud/tenants/{tenant}/runs-metrics
+     * @secure
+     */
+    workflowRunEventsGetMetrics: (tenant: string, query?: {
+        /**
+         * The time after the workflow run was created
+         * @format date-time
+         * @example "2021-01-01T00:00:00Z"
+         */
+        createdAfter?: string;
+        /**
+         * The time before the workflow run was completed
+         * @format date-time
+         * @example "2021-01-01T00:00:00Z"
+         */
+        finishedBefore?: string;
+    }, params?: RequestParams) => Promise<import("axios").AxiosResponse<WorkflowRunEventsMetricsCounts, any>>;
+}