@keboola/api-client 27.0.0 → 31.0.0

package/dist/types-CIybfUJ9.d.cts

@@ -0,0 +1,66 @@
+import { a as ProjectId } from "./types-CIJAtX8q.cjs";
+import "./types-DG_FlLJt.cjs";
+//#region src/clients/encryption/types.d.ts
+type BranchType = 'default' | 'dev';
+type EncryptParamsByScope = {
+  /** `KBC::ComponentSecure::` — any config of the component, in any project. */
+  ComponentSecure: {
+    componentId: string;
+  };
+  /** `KBC::ProjectSecure::` — the component within one project. */
+  ProjectSecure: {
+    componentId: string;
+    projectId: ProjectId;
+  };
+  /** `KBC::ConfigSecure::` — one specific configuration. */
+  ConfigSecure: {
+    componentId: string;
+    projectId: ProjectId;
+    configId: string;
+  };
+  /** `KBC::ProjectWideSecure::` — anywhere in one project (component-agnostic). */
+  ProjectWideSecure: {
+    projectId: ProjectId;
+  };
+  /** `KBC::BranchTypeSecure::` — the component within a project, scoped to a branch type. */
+  BranchTypeSecure: {
+    componentId: string;
+    projectId: ProjectId;
+    branchType: BranchType;
+  };
+  /** `KBC::BranchTypeConfigSecure::` — one config, scoped to a branch type. */
+  BranchTypeConfigSecure: {
+    componentId: string;
+    projectId: ProjectId;
+    configId: string;
+    branchType: BranchType;
+  };
+  /** `KBC::ProjectWideBranchTypeSecure::` — project-wide, scoped to a branch type. */
+  ProjectWideBranchTypeSecure: {
+    projectId: ProjectId;
+    branchType: BranchType;
+  };
+};
+type EncryptionScope = keyof EncryptParamsByScope;
+/** The required query params for a given encryption scope. */
+type EncryptParams<Scope extends EncryptionScope> = EncryptParamsByScope[Scope];
+/**
+ * Discriminated-union input for `encryptScopedSecrets`: a `scope` plus exactly the
+ * params that scope requires, plus the `data` to encrypt. The discriminant makes
+ * mismatched params (e.g. a `componentId` on a `ProjectWideSecure` call) a compile error.
+ */
+type ScopedSecrets<T extends Record<string, unknown>> = { [Scope in EncryptionScope]: {
+  scope: Scope;
+} & EncryptParams<Scope> & {
+  data: T;
+}; }[EncryptionScope];
+type EncryptQuery = {
+  projectId?: ProjectId | null;
+  branchType?: BranchType | null;
+  componentId?: string | null;
+  configId?: string | null;
+};
+type EncryptBody = string | Record<string, unknown>;
+//#endregion
+export { EncryptQuery as a, EncryptParamsByScope as i, EncryptBody as n, EncryptionScope as o, EncryptParams as r, ScopedSecrets as s, BranchType as t };
+//# sourceMappingURL=types-CIybfUJ9.d.cts.map

package/dist/{types-CFeOCzzg.d.cts → types-COFrOmuO.d.ts}

@@ -1,10 +1,9 @@
-import { d as OpenapiPathType, O as OpenapiBodyType, c as OpenapiQueryType, b as OpenapiReturnType } from './types-f8dUjMX4.cjs';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-Ds8e0l7-.js";
+//#region src/clients/queryService/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -917,13 +916,7 @@ type components = {
     /** @enum {string} */
     'models.JobState': 'created' | 'enqueued' | 'processing' | 'canceled' | 'completed' | 'failed';
     /** @enum {string} */
-    'models.StatementState':
-      | 'waiting'
-      | 'processing'
-      | 'canceled'
-      | 'completed'
-      | 'failed'
-      | 'notExecuted';
+    'models.StatementState': 'waiting' | 'processing' | 'canceled' | 'completed' | 'failed' | 'notExecuted';
   };
   responses: never;
   parameters: never;
@@ -931,7 +924,8 @@ type components = {
   headers: never;
   pathItems: never;
 };
-
+//#endregion
+//#region src/clients/queryService/types.d.ts
 type PostQueryPath = OpenapiPathType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['post']>;
 type GetQueriesPath = OpenapiPathType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>;
 type GetQueriesHistoryQuery = OpenapiQueryType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>;
@@ -941,13 +935,30 @@ type PostCancelQueryJobPath = OpenapiPathType<paths['/api/v1/queries/{queryJobId
 type GetQueryResultsPath = OpenapiPathType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
 type GetQueryResutsQuery = OpenapiQueryType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
 type JobStatusResponse = OpenapiReturnType<paths['/api/v1/queries/{queryJobId}']['get']>;
+/**
+ * The statuses a query job reports.
+ *
+ * - Terminal: `completed`, `failed`, `canceled` — one `l`, the backend's spelling.
+ * - In flight: `created`, `enqueued`, `processing`.
+ * - Overlaps the other services by label only: `processing` is a status of all three and `created`
+ *   of the queue too, while `canceled` and `failed` have no queue equivalent (it spells them
+ *   `cancelled` and `error`). A status is only meaningful against the service that reported it.
+ * - The states form a graph, not a flag set: `created` reaches only `enqueued` or `canceled`, and
+ *   `completed` is reachable only from `processing`. So a job that never started can't be `failed`.
+ * - `models.JobState` in `keboola/go-monorepo`
+ *   (`services/query/internal/repository/models/job_state.go`) is the source, and `IsTerminal()`
+ *   there is the terminal set above. Derived rather than written out, so a backend change to the
+ *   enum lands here through `pnpm gen:types`.
+ */
+type QueryJobStatus = JobStatusResponse['status'];
 type Statements = OpenapiReturnType<paths['/api/v1/branches/{branchId}/workspaces/{workspaceId}/queries']['get']>['statements'];
 type GetExportResultsQuery = OpenapiQueryType<paths['/api/v1/queries/{queryJobId}/{statementId}/export']['get']>;
 type ExportResultsResponse = {
-    content: string;
-    fileName: string;
-    mimeType: string;
+  content: string;
+  fileName: string;
+  mimeType: string;
 };
 type QueryResult = OpenapiReturnType<paths['/api/v1/queries/{queryJobId}/{statementId}/results']['get']>;
-
-export type { ExportResultsResponse as E, GetQueryJobPath as G, JobStatusResponse as J, PostQueryPath as P, QueryResult as Q, Statements as S, PostQueryBody as a, PostCancelQueryJobPath as b, components as c, GetQueryResultsPath as d, GetQueryResutsQuery as e, GetQueriesPath as f, GetQueriesHistoryQuery as g, GetExportResultsQuery as h };
+//#endregion
+export { GetQueryJobPath as a, JobStatusResponse as c, PostQueryPath as d, QueryJobStatus as f, components as h, GetQueriesPath as i, PostCancelQueryJobPath as l, Statements as m, GetExportResultsQuery as n, GetQueryResultsPath as o, QueryResult as p, GetQueriesHistoryQuery as r, GetQueryResutsQuery as s, ExportResultsResponse as t, PostQueryBody as u };
+//# sourceMappingURL=types-COFrOmuO.d.ts.map

package/dist/{types-D2qGShlS.d.ts → types-CQd9PuKY.d.cts}

@@ -1,10 +1,9 @@
-import { d as OpenapiPathType, c as OpenapiQueryType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-B-frWtGW.cjs";
+//#region src/clients/queue/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/jobs': {
     parameters: {
@@ -48,12 +47,7 @@ type paths = {
           /** @description Search jobs by *status*. You can set multiple values. */
           status?: components['schemas']['JobStatus'][];
           /** @description Filter jobs by job *type*. */
-          type?:
-            | 'standard'
-            | 'container'
-            | 'phaseContainer'
-            | 'orchestrationContainer'
-            | 'retryContainer';
+          type?: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
           /** @description Filter jobs by component properties. Only "type" is currently supported. It lists jobs of components with the given type, having a configuration in the project. */
           componentProps?: {
             type?: string;
@@ -88,25 +82,7 @@ type paths = {
            * @description Sort the jobs by specified attribute.
            * @example runId
            */
-          sortBy?:
-            | 'id'
-            | 'runId'
-            | 'branchId'
-            | 'projectId'
-            | 'projectName'
-            | 'tokenId'
-            | 'tokenDescription'
-            | 'componentId'
-            | 'configId'
-            | 'configRowIds'
-            | 'tag'
-            | 'mode'
-            | 'status'
-            | 'startTime'
-            | 'createdTime'
-            | 'endTime'
-            | 'durationSeconds'
-            | 'result';
+          sortBy?: 'id' | 'runId' | 'branchId' | 'projectId' | 'projectName' | 'tokenId' | 'tokenDescription' | 'componentId' | 'configId' | 'configRowIds' | 'tag' | 'mode' | 'status' | 'startTime' | 'createdTime' | 'endTime' | 'durationSeconds' | 'result';
           /**
            * @description Order of the sorting. Default is *desc*, newest jobs are displayed at the top.
            * @example asc
@@ -350,12 +326,7 @@ type paths = {
           /** @description Search jobs by *status*. You can set multiple values. */
           status?: components['schemas']['JobStatus'][];
           /** @description Filter jobs by job *type*. */
-          type?:
-            | 'standard'
-            | 'container'
-            | 'phaseContainer'
-            | 'orchestrationContainer'
-            | 'retryContainer';
+          type?: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
           /** @description Filter jobs by component properties. Only "type" is currently supported. It lists jobs of components with the given type, having a configuration in the project. */
           componentProps?: {
             type?: string;
@@ -390,20 +361,7 @@ type paths = {
            * @description Sort the jobs by specified attribute.
            * @example runId
            */
-          sortBy?:
-            | 'id'
-            | 'runId'
-            | 'projectId'
-            | 'branchId'
-            | 'componentId'
-            | 'configId'
-            | 'tokenDescription'
-            | 'status'
-            | 'createdTime'
-            | 'updatedTime'
-            | 'startTime'
-            | 'endTime'
-            | 'durationSeconds';
+          sortBy?: 'id' | 'runId' | 'projectId' | 'branchId' | 'componentId' | 'configId' | 'tokenDescription' | 'status' | 'createdTime' | 'updatedTime' | 'startTime' | 'endTime' | 'durationSeconds';
           /**
            * @description Order of the sorting. Default is *desc*, newest jobs are displayed at the top.
            * @example asc
@@ -467,20 +425,7 @@ type paths = {
           /** @description Number of jobs per group. */
           jobsPerGroup?: number;
           /** @description Field to sort the results by. */
-          sortBy?:
-            | 'id'
-            | 'runId'
-            | 'projectId'
-            | 'branchId'
-            | 'componentId'
-            | 'configId'
-            | 'tokenDescription'
-            | 'status'
-            | 'createdTime'
-            | 'updatedTime'
-            | 'startTime'
-            | 'endTime'
-            | 'durationSeconds';
+          sortBy?: 'id' | 'runId' | 'projectId' | 'branchId' | 'componentId' | 'configId' | 'tokenDescription' | 'status' | 'createdTime' | 'updatedTime' | 'startTime' | 'endTime' | 'durationSeconds';
           /** @description Order of sorting (asc or desc). */
           sortOrder?: 'asc' | 'desc';
           /** @description Maximum number of results to return. */
@@ -733,23 +678,9 @@ type components = {
       onlyFlowTaskIds?: string[] | null;
     };
     /** @enum {string} */
-    JobStatus:
-      | 'created'
-      | 'waiting'
-      | 'processing'
-      | 'success'
-      | 'warning'
-      | 'error'
-      | 'terminating'
-      | 'terminated'
-      | 'cancelled';
+    JobStatus: 'created' | 'waiting' | 'processing' | 'success' | 'warning' | 'error' | 'terminating' | 'terminated' | 'cancelled';
     /** @enum {string} */
-    JobType:
-      | 'standard'
-      | 'container'
-      | 'phaseContainer'
-      | 'orchestrationContainer'
-      | 'retryContainer';
+    JobType: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
     ProjectStats: {
       jobs?: {
         /**
@@ -761,9 +692,7 @@ type components = {
     };
     /** @description OpenLineage event list */
     OpenLineageEventList: components['schemas']['OpenLineageEvent'][];
-    OpenLineageEvent:
-      | components['schemas']['OpenLineageStartEvent']
-      | components['schemas']['OpenLineageCompleteEvent'];
+    OpenLineageEvent: components['schemas']['OpenLineageStartEvent'] | components['schemas']['OpenLineageCompleteEvent'];
     /** @description Job execution start event, including information about input mapping tables. */
     OpenLineageStartEvent: {
       /** @example START */
@@ -1146,30 +1075,14 @@ interface operations {
          * @description Filter jobs by job *type*.
          * @example standard
          */
-        type?:
-          | 'standard'
-          | 'container'
-          | 'phaseContainer'
-          | 'orchestrationContainer'
-          | 'retryContainer';
+        type?: 'standard' | 'container' | 'phaseContainer' | 'orchestrationContainer' | 'retryContainer';
         /** @description Number of jobs of each configuration to list */
         jobsPerConfiguration?: number;
         /**
          * @description Attribute to sort results by
          * @example startTime
          */
-        sortBy?:
-          | 'id'
-          | 'configId'
-          | 'configRowId'
-          | 'projectId'
-          | 'componentId'
-          | 'status'
-          | 'desiredStatus'
-          | 'mode'
-          | 'startTime'
-          | 'createdTime'
-          | 'endTime';
+        sortBy?: 'id' | 'configId' | 'configRowId' | 'projectId' | 'componentId' | 'status' | 'desiredStatus' | 'mode' | 'startTime' | 'createdTime' | 'endTime';
         /**
          * @description Order of the sorting, must be used with the "sortBy" parameter
          * @example asc
@@ -1328,14 +1241,25 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/queue/types.d.ts
 type QueueJob = OpenapiReturnType<paths['/jobs/{jobId}']['get']>;
 type GetQueueJobPath = OpenapiPathType<paths['/jobs/{jobId}']['get']>;
-type Flatten<T> = T extends unknown ? {
-    [K in keyof T]: T[K];
-} : never;
+/**
+ * The statuses a queue job reports.
+ *
+ * - Terminal: `success`, `warning`, `error`, `cancelled`, `terminated`.
+ * - Killable: `created`, `waiting`, `processing`. A kill is rejected in any other status.
+ * - `terminating` is neither: the kill has been accepted and the daemon is still shutting the job
+ *   down. A caller waiting for a job to stop must not treat it as an end state.
+ * - `desiredStatus` is a separate, two-value field — `processing` or `terminating` — and is what a
+ *   kill request sets. `terminating` appearing there does not mean `status` has reached it yet.
+ * - `PlainJobInterface::STATUSES_ALL` in `job-queue-internal-api-php-client` is the backend source.
+ */
+type QueueJobStatus = QueueJob['status'];
+type Flatten<T> = T extends unknown ? { [K in keyof T]: T[K]; } : never;
 type SearchJobsQuery = Flatten<OpenapiQueryType<paths['/search/jobs']['get']> & {
-    parentRunId?: string;
+  parentRunId?: string;
 }>;
 type SearchJobsResponse = OpenapiReturnType<paths['/search/jobs']['get']>;
 type SearchAllJobsQuery = Flatten<Omit<SearchJobsQuery, 'offset'>>;
@@ -1345,5 +1269,6 @@ type SearchGroupedJobsQuery = OpenapiQueryType<paths['/search/grouped-jobs']['ge
 type SearchGroupedJobsResponse = OpenapiReturnType<paths['/search/grouped-jobs']['get']>;
 type OrchestrationRerunPlanPath = OpenapiPathType<paths['/orchestration-rerun-plan/{jobId}']['get']>;
 type OrchestrationRerunPlan = OpenapiReturnType<paths['/orchestration-rerun-plan/{jobId}']['get']>;
-
-export type { CreateJobBody as C, GetQueueJobPath as G, KillJobPath as K, OrchestrationRerunPlanPath as O, QueueJob as Q, SearchJobsQuery as S, SearchAllJobsQuery as a, SearchGroupedJobsQuery as b, components as c, OrchestrationRerunPlan as d, SearchGroupedJobsResponse as e, SearchJobsResponse as f };
+//#endregion
+export { OrchestrationRerunPlanPath as a, SearchAllJobsQuery as c, SearchJobsQuery as d, SearchJobsResponse as f, OrchestrationRerunPlan as i, SearchGroupedJobsQuery as l, GetQueueJobPath as n, QueueJob as o, components as p, KillJobPath as r, QueueJobStatus as s, CreateJobBody as t, SearchGroupedJobsResponse as u };
+//# sourceMappingURL=types-CQd9PuKY.d.cts.map

package/dist/{types-COti0FGo.d.ts → types-CgF9R0Na.d.ts}

@@ -1,10 +1,9 @@
-import { c as OpenapiQueryType, d as OpenapiPathType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-Ds8e0l7-.js";
+//#region src/clients/notifications/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/events/{eventName}': {
     parameters: {
@@ -126,9 +125,7 @@ type components = {
          */
         operator?: '==' | '>=';
       }[];
-      recipient:
-        | components['schemas']['RecipientChannel_Email']
-        | components['schemas']['RecipientChannel_Webhook'];
+      recipient: components['schemas']['RecipientChannel_Email'] | components['schemas']['RecipientChannel_Webhook'];
     };
     ProjectSubscription: {
       id: components['schemas']['NumericString'];
@@ -341,9 +338,7 @@ interface operations {
            * @enum {string}
            */
           type: 'direct-project-email' | 'direct-project-webhook';
-          recipient:
-            | components['schemas']['RecipientChannel_Email']
-            | components['schemas']['RecipientChannel_Webhook'];
+          recipient: components['schemas']['RecipientChannel_Email'] | components['schemas']['RecipientChannel_Webhook'];
           /** @description Event data according to notification type schema */
           data: {
             project: {
@@ -397,12 +392,14 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/notifications/types.d.ts
 type ListSubscriptionsQuery = OpenapiQueryType<paths['/project-subscriptions']['get']>;
 type CreateSubscriptionBody = OpenapiBodyType<paths['/project-subscriptions']['post']>;
 type ProjectSubscription = OpenapiReturnType<paths['/project-subscriptions/{subscriptionId}']['get']>;
 type SubscriptionId = OpenapiPathType<paths['/project-subscriptions/{subscriptionId}']['get']>['subscriptionId'];
 type SubscriptionRecipient = CreateSubscriptionBody['recipient'];
 type SubscriptionFilter = NonNullable<CreateSubscriptionBody['filters']>[number];
-
-export type { CreateSubscriptionBody as C, ListSubscriptionsQuery as L, ProjectSubscription as P, SubscriptionId as S, SubscriptionFilter as a, SubscriptionRecipient as b, components as c };
+//#endregion
+export { SubscriptionId as a, SubscriptionFilter as i, ListSubscriptionsQuery as n, SubscriptionRecipient as o, ProjectSubscription as r, components as s, CreateSubscriptionBody as t };
+//# sourceMappingURL=types-CgF9R0Na.d.ts.map