@keboola/api-client 25.0.0 → 27.0.0

package/dist/syncActions/types.d.cts

@@ -1,4 +1,4 @@
-import { O as OpenapiBodyType } from '../types-gcShAmmi.cjs';
+import { O as OpenapiBodyType } from '../types-f8dUjMX4.cjs';
 import * as zod from 'zod';
 
 /**
@@ -268,22 +268,338 @@ declare const apifyObjectsSchema: zod.ZodArray<zod.ZodObject<{
 type ApifyObjectsInput = zod.infer<typeof apifyObjectsInputSchema>;
 type ApifyObject = zod.infer<typeof apifyObjectsSchema>[number];
 
-type GetPublicGitRepositoryInput = {
-    repositoryUrl: string;
-} & Pick<SyncActionBody, 'tag' | 'branchId' | 'mode' | 'componentId'>;
-type GetGitPrivateRepositoryInput = {
-    username: string;
-    password: string;
-} & GetPublicGitRepositoryInput;
-type GetDataAppPublicGitRepositoryInput = Omit<GetPublicGitRepositoryInput, 'componentId'>;
-type GetDataAppPasswordPrivateGitRepositoryInput = GetDataAppPublicGitRepositoryInput & {
-    username: string;
-    password: string;
-};
-type GetDataAppSSHKeyPrivateGitRepositoryInput = GetDataAppPublicGitRepositoryInput & {
-    username: string;
-    sshKey: string;
-};
+/**
+ * `componentId` is a plain string here, unlike the git actions' closed enum. Every dbt transformation
+ * answers `dbtCompile` and `dbtRunResults` under the same action name and the same payload, so the id
+ * selects nothing — it only names the component to run, and rejecting an unlisted one would cost the
+ * caller a cast for no guarantee. The component itself refuses an action it does not serve.
+ */
+declare const dbtActionInputSchema: zod.ZodObject<{
+    branchId: zod.ZodString;
+    tag: zod.ZodOptional<zod.ZodString>;
+    mode: zod.ZodOptional<zod.ZodEnum<{
+        run: "run";
+        debug: "debug";
+    }>>;
+    componentId: zod.ZodString;
+    configId: zod.ZodString;
+    artifacts: zod.ZodOptional<zod.ZodRecord<zod.ZodString, zod.ZodUnknown>>;
+}, zod.core.$strip>;
+/**
+ * `compiled` maps a model's file name (`orders.sql`) to its compiled SQL. Key order is the
+ * component's own and is preserved, so the caller can render the models in it.
+ *
+ * A configuration that has never run does **not** answer with an empty payload — the component
+ * raises a user exception telling you to run it first, which arrives as a `SyncActionError` carrying
+ * that sentence. The empty default here is only for a payload that omits the key anyway: rendering
+ * "nothing to show" beats failing on a validation error no caller can act on. A key that is
+ * *present* with the wrong shape still fails — that is a contract change, and reading it as "no
+ * models" would hide it.
+ */
+declare const dbtCompiledSchema: zod.ZodPipe<zod.ZodObject<{
+    compiled: zod.ZodDefault<zod.ZodRecord<zod.ZodString, zod.ZodString>>;
+}, zod.core.$strip>, zod.ZodTransform<Record<string, string>, {
+    compiled: Record<string, string>;
+}>>;
+/** Each entry also carries `status` and `dependsOn`, dropped here until a consumer needs them. */
+declare const dbtModelTimingSchema: zod.ZodObject<{
+    id: zod.ZodString;
+    name: zod.ZodString;
+    thread: zod.ZodCatch<zod.ZodPipe<zod.ZodPipe<zod.ZodString, zod.ZodTransform<number, string>>, zod.ZodNumber>>;
+    timeStarted: zod.ZodString;
+    timeCompleted: zod.ZodString;
+}, zod.core.$strip>;
+/** Defaults to empty for the same reason as `compiled` above — and with the same caveat. */
+declare const dbtRunResultsSchema: zod.ZodPipe<zod.ZodObject<{
+    modelTiming: zod.ZodDefault<zod.ZodArray<zod.ZodObject<{
+        id: zod.ZodString;
+        name: zod.ZodString;
+        thread: zod.ZodCatch<zod.ZodPipe<zod.ZodPipe<zod.ZodString, zod.ZodTransform<number, string>>, zod.ZodNumber>>;
+        timeStarted: zod.ZodString;
+        timeCompleted: zod.ZodString;
+    }, zod.core.$strip>>>;
+}, zod.core.$strip>, zod.ZodTransform<{
+    id: string;
+    name: string;
+    thread: number;
+    timeStarted: string;
+    timeCompleted: string;
+}[], {
+    modelTiming: {
+        id: string;
+        name: string;
+        thread: number;
+        timeStarted: string;
+        timeCompleted: string;
+    }[];
+}>>;
+type DbtActionInput = zod.infer<typeof dbtActionInputSchema>;
+type DbtCompiled = zod.infer<typeof dbtCompiledSchema>;
+type DbtModelTiming = zod.infer<typeof dbtModelTimingSchema>;
+
+/**
+ * Components whose git repository lives under `parameters.dataApp.git.repository` and that answer to
+ * the `git-repository` action. They are the only ones serving `data-app-entrypoints`, and the only
+ * ones accepting an SSH key.
+ */
+declare const DATA_APP_FAMILY: readonly ["keboola.data-apps", "keboola.sandboxes"];
+declare const GIT_FAMILY: readonly ["keboola.data-apps", "keboola.sandboxes", "keboola-test.dbt-core-key-pair", "keboola-test.dbt-remote-snowflake", "keboola.dbt-transformation", "keboola.dbt-transformation-local-bigquery", "keboola.dbt-transformation-remote-bigquery", "keboola.dbt-transformation-remote-mssql", "keboola.dbt-transformation-remote-postgresql", "keboola.dbt-transformation-remote-redshift", "keboola.dbt-transformation-remote-snowflake"];
+/** The ids the git actions accept — anything else has no action name or payload path to resolve. */
+type GitComponentId = (typeof GIT_FAMILY)[number];
+type DataAppComponentId = (typeof DATA_APP_FAMILY)[number];
+declare const isDataAppFamily: (componentId: string) => componentId is DataAppComponentId;
+
+declare const gitAuthSchema: zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+    type: zod.ZodLiteral<"public">;
+}, zod.core.$strip>, zod.ZodObject<{
+    type: zod.ZodLiteral<"password">;
+    username: zod.ZodString;
+    '#password': zod.ZodString;
+}, zod.core.$strip>, zod.ZodObject<{
+    type: zod.ZodLiteral<"sshKey">;
+    username: zod.ZodString;
+    '#sshKey': zod.ZodString;
+}, zod.core.$strip>], "type">;
+/**
+ * Accepts only the components that serve a git repository action — the action name and the
+ * `configData` path are resolved from the id, so one from neither family has nowhere to go. The
+ * enum rejects an unsupported id when parsing, before any request is sent.
+ *
+ * **Takes no `branch`, deliberately — do not add one.** It is a run-config field the component
+ * feeds to `git clone -b <branch>`, so a stale or renamed value fails the clone and breaks the very
+ * call you make to find out which branches exist. Accepting it optionally would let a caller
+ * reintroduce that by spreading in an existing config; zod strips it instead.
+ */
+declare const getBranchesInputSchema: zod.ZodObject<{
+    branchId: zod.ZodString;
+    tag: zod.ZodOptional<zod.ZodString>;
+    mode: zod.ZodOptional<zod.ZodEnum<{
+        run: "run";
+        debug: "debug";
+    }>>;
+    repositoryUrl: zod.ZodString;
+    auth: zod.ZodDefault<zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+        type: zod.ZodLiteral<"public">;
+    }, zod.core.$strip>, zod.ZodObject<{
+        type: zod.ZodLiteral<"password">;
+        username: zod.ZodString;
+        '#password': zod.ZodString;
+    }, zod.core.$strip>, zod.ZodObject<{
+        type: zod.ZodLiteral<"sshKey">;
+        username: zod.ZodString;
+        '#sshKey': zod.ZodString;
+    }, zod.core.$strip>], "type">>;
+    componentId: zod.ZodEnum<{
+        "keboola.data-apps": "keboola.data-apps";
+        "keboola.sandboxes": "keboola.sandboxes";
+        "keboola-test.dbt-core-key-pair": "keboola-test.dbt-core-key-pair";
+        "keboola-test.dbt-remote-snowflake": "keboola-test.dbt-remote-snowflake";
+        "keboola.dbt-transformation": "keboola.dbt-transformation";
+        "keboola.dbt-transformation-local-bigquery": "keboola.dbt-transformation-local-bigquery";
+        "keboola.dbt-transformation-remote-bigquery": "keboola.dbt-transformation-remote-bigquery";
+        "keboola.dbt-transformation-remote-mssql": "keboola.dbt-transformation-remote-mssql";
+        "keboola.dbt-transformation-remote-postgresql": "keboola.dbt-transformation-remote-postgresql";
+        "keboola.dbt-transformation-remote-redshift": "keboola.dbt-transformation-remote-redshift";
+        "keboola.dbt-transformation-remote-snowflake": "keboola.dbt-transformation-remote-snowflake";
+    }>;
+}, zod.core.$strip>;
+/** Only the data-app family serves `data-app-entrypoints`; the enum rejects anything else. */
+declare const getEntrypointsInputSchema: zod.ZodObject<{
+    branchId: zod.ZodString;
+    tag: zod.ZodOptional<zod.ZodString>;
+    mode: zod.ZodOptional<zod.ZodEnum<{
+        run: "run";
+        debug: "debug";
+    }>>;
+    repositoryUrl: zod.ZodString;
+    auth: zod.ZodDefault<zod.ZodDiscriminatedUnion<[zod.ZodObject<{
+        type: zod.ZodLiteral<"public">;
+    }, zod.core.$strip>, zod.ZodObject<{
+        type: zod.ZodLiteral<"password">;
+        username: zod.ZodString;
+        '#password': zod.ZodString;
+    }, zod.core.$strip>, zod.ZodObject<{
+        type: zod.ZodLiteral<"sshKey">;
+        username: zod.ZodString;
+        '#sshKey': zod.ZodString;
+    }, zod.core.$strip>], "type">>;
+    componentId: zod.ZodEnum<{
+        "keboola.data-apps": "keboola.data-apps";
+        "keboola.sandboxes": "keboola.sandboxes";
+    }>;
+    branch: zod.ZodPipe<zod.ZodOptional<zod.ZodString>, zod.ZodTransform<string | undefined, string | undefined>>;
+}, zod.core.$strip>;
+/**
+ * Only `branch` is load-bearing — it is the value the caller selects and stores. The rest is
+ * decoration the UI renders beside it, so each field falls back to an empty string rather than
+ * failing: one commit with no message must not cost the caller the whole branch list. They stay
+ * `string` rather than becoming optional, so a consumer needs no new undefined handling.
+ */
+declare const gitBranchSchema: zod.ZodObject<{
+    branch: zod.ZodString;
+    sha: zod.ZodCatch<zod.ZodString>;
+    date: zod.ZodCatch<zod.ZodString>;
+    comment: zod.ZodCatch<zod.ZodString>;
+    author: zod.ZodCatch<zod.ZodObject<{
+        name: zod.ZodCatch<zod.ZodString>;
+        email: zod.ZodCatch<zod.ZodString>;
+    }, zod.core.$strip>>;
+}, zod.core.$strip>;
+declare const gitBranchesSchema: zod.ZodPipe<zod.ZodObject<{
+    repository: zod.ZodOptional<zod.ZodObject<{
+        branches: zod.ZodOptional<zod.ZodPipe<zod.ZodUnion<readonly [zod.ZodArray<zod.ZodObject<{
+            branch: zod.ZodString;
+            sha: zod.ZodCatch<zod.ZodString>;
+            date: zod.ZodCatch<zod.ZodString>;
+            comment: zod.ZodCatch<zod.ZodString>;
+            author: zod.ZodCatch<zod.ZodObject<{
+                name: zod.ZodCatch<zod.ZodString>;
+                email: zod.ZodCatch<zod.ZodString>;
+            }, zod.core.$strip>>;
+        }, zod.core.$strip>>, zod.ZodRecord<zod.ZodString, zod.ZodObject<{
+            branch: zod.ZodString;
+            sha: zod.ZodCatch<zod.ZodString>;
+            date: zod.ZodCatch<zod.ZodString>;
+            comment: zod.ZodCatch<zod.ZodString>;
+            author: zod.ZodCatch<zod.ZodObject<{
+                name: zod.ZodCatch<zod.ZodString>;
+                email: zod.ZodCatch<zod.ZodString>;
+            }, zod.core.$strip>>;
+        }, zod.core.$strip>>]>, zod.ZodTransform<{
+            branch: string;
+            sha: string;
+            date: string;
+            comment: string;
+            author: {
+                name: string;
+                email: string;
+            };
+        }[], Record<string, {
+            branch: string;
+            sha: string;
+            date: string;
+            comment: string;
+            author: {
+                name: string;
+                email: string;
+            };
+        }> | {
+            branch: string;
+            sha: string;
+            date: string;
+            comment: string;
+            author: {
+                name: string;
+                email: string;
+            };
+        }[]>>>;
+    }, zod.core.$strip>>;
+    branches: zod.ZodOptional<zod.ZodPipe<zod.ZodUnion<readonly [zod.ZodArray<zod.ZodObject<{
+        branch: zod.ZodString;
+        sha: zod.ZodCatch<zod.ZodString>;
+        date: zod.ZodCatch<zod.ZodString>;
+        comment: zod.ZodCatch<zod.ZodString>;
+        author: zod.ZodCatch<zod.ZodObject<{
+            name: zod.ZodCatch<zod.ZodString>;
+            email: zod.ZodCatch<zod.ZodString>;
+        }, zod.core.$strip>>;
+    }, zod.core.$strip>>, zod.ZodRecord<zod.ZodString, zod.ZodObject<{
+        branch: zod.ZodString;
+        sha: zod.ZodCatch<zod.ZodString>;
+        date: zod.ZodCatch<zod.ZodString>;
+        comment: zod.ZodCatch<zod.ZodString>;
+        author: zod.ZodCatch<zod.ZodObject<{
+            name: zod.ZodCatch<zod.ZodString>;
+            email: zod.ZodCatch<zod.ZodString>;
+        }, zod.core.$strip>>;
+    }, zod.core.$strip>>]>, zod.ZodTransform<{
+        branch: string;
+        sha: string;
+        date: string;
+        comment: string;
+        author: {
+            name: string;
+            email: string;
+        };
+    }[], Record<string, {
+        branch: string;
+        sha: string;
+        date: string;
+        comment: string;
+        author: {
+            name: string;
+            email: string;
+        };
+    }> | {
+        branch: string;
+        sha: string;
+        date: string;
+        comment: string;
+        author: {
+            name: string;
+            email: string;
+        };
+    }[]>>>;
+}, zod.core.$strip>, zod.ZodTransform<{
+    branch: string;
+    sha: string;
+    date: string;
+    comment: string;
+    author: {
+        name: string;
+        email: string;
+    };
+}[], {
+    repository?: {
+        branches?: {
+            branch: string;
+            sha: string;
+            date: string;
+            comment: string;
+            author: {
+                name: string;
+                email: string;
+            };
+        }[] | undefined;
+    } | undefined;
+    branches?: {
+        branch: string;
+        sha: string;
+        date: string;
+        comment: string;
+        author: {
+            name: string;
+            email: string;
+        };
+    }[] | undefined;
+}>>;
+declare const gitEntrypointsSchema: zod.ZodObject<{
+    entrypoints: zod.ZodArray<zod.ZodString>;
+}, zod.core.$strip>;
+type GitAuth = zod.infer<typeof gitAuthSchema>;
+type GetBranchesInput = zod.input<typeof getBranchesInputSchema>;
+type GetEntrypointsInput = zod.input<typeof getEntrypointsInputSchema>;
+type GitBranch = zod.infer<typeof gitBranchSchema>;
+type GitEntrypoints = zod.infer<typeof gitEntrypointsSchema>;
+
+declare const testLookerCredentialsInputSchema: zod.ZodObject<{
+    branchId: zod.ZodString;
+    tag: zod.ZodOptional<zod.ZodString>;
+    mode: zod.ZodOptional<zod.ZodEnum<{
+        run: "run";
+        debug: "debug";
+    }>>;
+    credentialsId: zod.ZodString;
+    '#token': zod.ZodString;
+    host: zod.ZodString;
+}, zod.core.$strip>;
+/** The component answers with a status envelope only — there is no payload to model. */
+declare const lookerCredentialsResultSchema: zod.ZodObject<{
+    status: zod.ZodOptional<zod.ZodString>;
+    message: zod.ZodOptional<zod.ZodString>;
+}, zod.core.$strip>;
+type TestLookerCredentialsInput = zod.infer<typeof testLookerCredentialsInputSchema>;
+type LookerCredentialsResult = zod.infer<typeof lookerCredentialsResultSchema>;
 
 /**
  * The generated request body, kept only so `sendSyncAction` can cast to what `openapi-fetch`
@@ -295,4 +611,4 @@ type EnrollMFAInput = Omit<SyncActionBody, 'action' | 'configData'> & {
     email: string;
 };
 
-export { type ApifyObject, type ApifyObjectsInput, type EnrollMFAInput, type GetDataAppPasswordPrivateGitRepositoryInput, type GetDataAppPublicGitRepositoryInput, type GetDataAppSSHKeyPrivateGitRepositoryInput, type GetGitPrivateRepositoryInput, type GetPublicGitRepositoryInput, type PostActionsBodyRaw, type SyncActionBody, type SyncActionContext, apifyObjectsInputSchema, apifyObjectsSchema, syncActionBodySchema, syncActionContextSchema };
+export { type ApifyObject, type ApifyObjectsInput, DATA_APP_FAMILY, type DataAppComponentId, type DbtActionInput, type DbtCompiled, type DbtModelTiming, type EnrollMFAInput, GIT_FAMILY, type GetBranchesInput, type GetEntrypointsInput, type GitAuth, type GitBranch, type GitComponentId, type GitEntrypoints, type LookerCredentialsResult, type PostActionsBodyRaw, type SyncActionBody, type SyncActionContext, type TestLookerCredentialsInput, apifyObjectsInputSchema, apifyObjectsSchema, dbtActionInputSchema, dbtCompiledSchema, dbtModelTimingSchema, dbtRunResultsSchema, getBranchesInputSchema, getEntrypointsInputSchema, gitAuthSchema, gitBranchesSchema, gitEntrypointsSchema, isDataAppFamily, lookerCredentialsResultSchema, syncActionBodySchema, syncActionContextSchema, testLookerCredentialsInputSchema };