@keboola/api-client 25.0.0 → 27.0.0

package/dist/createFetchClient-BHAsPDgF.d.cts

@@ -0,0 +1,86 @@
+import * as zod from 'zod';
+import { a as ApiError } from './types-UwuKN9Kx.cjs';
+
+declare class UserError extends Error {
+    constructor(message: string);
+}
+
+type FailedStatement = {
+    id: string;
+    error?: string;
+};
+type QueryJobErrorOptions = {
+    failedStatements: FailedStatement[];
+};
+/**
+ * A query job that reached the API's terminal `failed` state — the submit/poll round-trip
+ * succeeded, the job itself did not. Distinct from {@link ApiError}, which is an HTTP-level failure
+ * of the submit/poll/results requests themselves.
+ */
+declare class QueryJobError extends Error {
+    queryJobId: string;
+    failedStatements: FailedStatement[];
+    constructor(message: string, queryJobId: string, { failedStatements }: QueryJobErrorOptions);
+}
+declare const isQueryJobError: (error: unknown) => error is QueryJobError;
+
+/**
+ * A query job that never reached a terminal state within the caller's `maxWaitTime` — the job may
+ * still complete later; this only means `waitForJob`/`executeQuery` gave up watching it.
+ */
+declare class QueryJobTimeoutError extends Error {
+    queryJobId: string;
+    constructor(message: string, queryJobId: string);
+}
+declare const isQueryJobTimeoutError: (error: unknown) => error is QueryJobTimeoutError;
+
+declare class ServiceUnavailableError extends Error {
+    constructor(serviceId: string, path: string[], clientName: string);
+}
+
+type SyncActionErrorOptions = {
+    exceptionId?: string;
+    code?: number;
+    data?: unknown;
+};
+/**
+ * A sync action reports failure two ways: a non-2xx response, and a 2xx response whose body carries
+ * `status: 'error'` (the component ran, and said no). Both collapse into this class so consumers
+ * branch on one thing.
+ */
+declare class SyncActionError extends Error {
+    exceptionId?: string;
+    code?: number;
+    data?: unknown;
+    constructor(message: string, { exceptionId, code, data }?: SyncActionErrorOptions);
+}
+declare const isSyncActionError: (error: unknown) => error is SyncActionError;
+
+/**
+ * A payload the SDK refused to accept — an input a caller assembled wrongly, or a response that did
+ * not match the shape the endpoint is documented to return.
+ *
+ * It exists so a `ZodError` never leaves the package. `ZodError.message` is `JSON.stringify` of its
+ * issue list — over a kilobyte for two problems — and a consumer that renders a caught error's
+ * message puts that blob in front of a user. `message` here is a single line built for exactly that
+ * rendering, while `issues` keeps the structured detail for anyone inspecting the failure rather
+ * than displaying it.
+ */
+declare class ValidationError extends Error {
+    issues: zod.core.$ZodIssue[];
+    constructor(message: string, issues?: zod.core.$ZodIssue[]);
+}
+declare const isValidationError: (error: unknown) => error is ValidationError;
+/**
+ * Parses with `schema`, converting a `ZodError` into a {@link ValidationError}. Use it instead of a
+ * bare `schema.parse()` anywhere the value crosses the package boundary — every client input and
+ * every response body.
+ */
+declare const parseOrThrow: <T extends zod.ZodType>(schema: T, value: unknown) => zod.output<T>;
+
+type FetchClientError = TypeError | ApiError | SyntaxError | DOMException;
+declare const isApiError: (error: unknown) => error is ApiError;
+declare const isAbortError: (error: unknown) => error is DOMException;
+declare const isFetchClientError: (error: unknown) => error is FetchClientError;
+
+export { type FetchClientError as F, QueryJobError as Q, ServiceUnavailableError as S, UserError as U, ValidationError as V, QueryJobTimeoutError as a, SyncActionError as b, isApiError as c, isFetchClientError as d, isQueryJobError as e, isQueryJobTimeoutError as f, isSyncActionError as g, isValidationError as h, isAbortError as i, parseOrThrow as p };

package/dist/createFetchClient-CFIwc6Lh.d.ts

@@ -0,0 +1,86 @@
+import * as zod from 'zod';
+import { a as ApiError } from './types-UwuKN9Kx.js';
+
+declare class UserError extends Error {
+    constructor(message: string);
+}
+
+type FailedStatement = {
+    id: string;
+    error?: string;
+};
+type QueryJobErrorOptions = {
+    failedStatements: FailedStatement[];
+};
+/**
+ * A query job that reached the API's terminal `failed` state — the submit/poll round-trip
+ * succeeded, the job itself did not. Distinct from {@link ApiError}, which is an HTTP-level failure
+ * of the submit/poll/results requests themselves.
+ */
+declare class QueryJobError extends Error {
+    queryJobId: string;
+    failedStatements: FailedStatement[];
+    constructor(message: string, queryJobId: string, { failedStatements }: QueryJobErrorOptions);
+}
+declare const isQueryJobError: (error: unknown) => error is QueryJobError;
+
+/**
+ * A query job that never reached a terminal state within the caller's `maxWaitTime` — the job may
+ * still complete later; this only means `waitForJob`/`executeQuery` gave up watching it.
+ */
+declare class QueryJobTimeoutError extends Error {
+    queryJobId: string;
+    constructor(message: string, queryJobId: string);
+}
+declare const isQueryJobTimeoutError: (error: unknown) => error is QueryJobTimeoutError;
+
+declare class ServiceUnavailableError extends Error {
+    constructor(serviceId: string, path: string[], clientName: string);
+}
+
+type SyncActionErrorOptions = {
+    exceptionId?: string;
+    code?: number;
+    data?: unknown;
+};
+/**
+ * A sync action reports failure two ways: a non-2xx response, and a 2xx response whose body carries
+ * `status: 'error'` (the component ran, and said no). Both collapse into this class so consumers
+ * branch on one thing.
+ */
+declare class SyncActionError extends Error {
+    exceptionId?: string;
+    code?: number;
+    data?: unknown;
+    constructor(message: string, { exceptionId, code, data }?: SyncActionErrorOptions);
+}
+declare const isSyncActionError: (error: unknown) => error is SyncActionError;
+
+/**
+ * A payload the SDK refused to accept — an input a caller assembled wrongly, or a response that did
+ * not match the shape the endpoint is documented to return.
+ *
+ * It exists so a `ZodError` never leaves the package. `ZodError.message` is `JSON.stringify` of its
+ * issue list — over a kilobyte for two problems — and a consumer that renders a caught error's
+ * message puts that blob in front of a user. `message` here is a single line built for exactly that
+ * rendering, while `issues` keeps the structured detail for anyone inspecting the failure rather
+ * than displaying it.
+ */
+declare class ValidationError extends Error {
+    issues: zod.core.$ZodIssue[];
+    constructor(message: string, issues?: zod.core.$ZodIssue[]);
+}
+declare const isValidationError: (error: unknown) => error is ValidationError;
+/**
+ * Parses with `schema`, converting a `ZodError` into a {@link ValidationError}. Use it instead of a
+ * bare `schema.parse()` anywhere the value crosses the package boundary — every client input and
+ * every response body.
+ */
+declare const parseOrThrow: <T extends zod.ZodType>(schema: T, value: unknown) => zod.output<T>;
+
+type FetchClientError = TypeError | ApiError | SyntaxError | DOMException;
+declare const isApiError: (error: unknown) => error is ApiError;
+declare const isAbortError: (error: unknown) => error is DOMException;
+declare const isFetchClientError: (error: unknown) => error is FetchClientError;
+
+export { type FetchClientError as F, QueryJobError as Q, ServiceUnavailableError as S, UserError as U, ValidationError as V, QueryJobTimeoutError as a, SyncActionError as b, isApiError as c, isFetchClientError as d, isQueryJobError as e, isQueryJobTimeoutError as f, isSyncActionError as g, isValidationError as h, isAbortError as i, parseOrThrow as p };

package/dist/{createOpenapiFetchClient-BFmiJ9C5.d.cts → createOpenapiFetchClient-CduEua6F.d.cts}

@@ -1,5 +1,5 @@
 import { H as HttpMethod, b as CreateFetchClientOptions, F as FetchClientOptions, A as ApiResponse } from './types-UwuKN9Kx.cjs';
-import { a as OpenapiParametersType, b as OpenapiReturnType } from './types-gcShAmmi.cjs';
+import { a as OpenapiParametersType, b as OpenapiReturnType } from './types-f8dUjMX4.cjs';
 
 type OpenapiPaths<Paths> = {
     [P in keyof Paths]: {

package/dist/{createOpenapiFetchClient-6RX67Hws.d.ts → createOpenapiFetchClient-wLlVgp3k.d.ts}

@@ -1,5 +1,5 @@
 import { H as HttpMethod, b as CreateFetchClientOptions, F as FetchClientOptions, A as ApiResponse } from './types-UwuKN9Kx.js';
-import { a as OpenapiParametersType, b as OpenapiReturnType } from './types-gcShAmmi.js';
+import { a as OpenapiParametersType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
 
 type OpenapiPaths<Paths> = {
     [P in keyof Paths]: {

package/dist/dataScience/index.cjs

@@ -1,19 +1,20 @@
 'use strict';
 
-var chunkL262THNK_cjs = require('../chunk-L262THNK.cjs');
+var chunkS6BWQKHJ_cjs = require('../chunk-S6BWQKHJ.cjs');
+var chunkBVRPZKRE_cjs = require('../chunk-BVRPZKRE.cjs');
 require('../chunk-MRHQJNWF.cjs');
-require('../chunk-7RO6PKZ4.cjs');
-require('../chunk-MMOAH3EH.cjs');
+require('../chunk-K3BLXPLA.cjs');
+require('../chunk-HUQ5ATIL.cjs');
 
 
 
 Object.defineProperty(exports, "createDataScienceClient", {
   enumerable: true,
-  get: function () { return chunkL262THNK_cjs.createDataScienceClient; }
+  get: function () { return chunkS6BWQKHJ_cjs.createDataScienceClient; }
 });
 Object.defineProperty(exports, "parseLogLines", {
   enumerable: true,
-  get: function () { return chunkL262THNK_cjs.parseLogLines; }
+  get: function () { return chunkBVRPZKRE_cjs.parseLogLines; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/dataScience/index.d.cts

@@ -1,12 +1,14 @@
 import { C as ClientInitOptions, A as ApiResponse } from '../types-UwuKN9Kx.cjs';
-import { G as GetDataAppRunsPath, a as GetDataAppRunsQuery, b as GetDataAppRunPath, c as GetDataAppLogsDownloadPath, d as GetDataAppLogsTailPath, e as GetDataAppLogsTailQuery, L as LogEntry, f as GetAppsQuery, g as GetDataAppPath, C as CreateDataAppBody, P as PatchDataAppPath, h as PatchDataAppBody, D as DeleteDataAppPath, i as GetDataAppPasswordPath, R as ResetDataAppPasswordPath, j as GetSandboxPath, k as DeleteSandboxPath } from '../utils-DK7uJcmR.cjs';
-export { p as parseLogLines } from '../utils-DK7uJcmR.cjs';
+import { GetDataAppRunsPath, GetDataAppRunsQuery, GetDataAppRunPath, GetDataAppLogsDownloadPath, GetDataAppLogsTailPath, GetDataAppLogsTailQuery, GetAppsQuery, GetDataAppPath, CreateDataAppBody, PatchDataAppPath, PatchDataAppBody, DeleteDataAppPath, GetDataAppPasswordPath, ResetDataAppPasswordPath, GetSandboxPath, DeleteSandboxPath } from './types.cjs';
+import { L as LogEntry } from '../appLogs-BbgAJ5I8.cjs';
+export { p as parseLogLines } from '../appLogs-BbgAJ5I8.cjs';
 import 'qs';
-import '../types-gcShAmmi.cjs';
+import '../types-f8dUjMX4.cjs';
 
 declare const createDataScienceClient: ({ baseUrl, middlewares, auth }: ClientInitOptions) => {
+    healthCheck: (signal?: AbortSignal) => Promise<unknown>;
     getAppRuns: (appId: GetDataAppRunsPath["appId"], query?: GetDataAppRunsQuery, signal?: AbortSignal) => Promise<{
-        state: "failed" | "starting" | "running" | "finished";
+        state: "starting" | "running" | "failed" | "finished";
         id: string;
         appId: string;
         createdAt?: string | null;
@@ -22,7 +24,7 @@ declare const createDataScienceClient: ({ baseUrl, middlewares, auth }: ClientIn
         mode: "prod" | "dev";
     }[]>;
     getAppRun: (appId: GetDataAppRunPath["appId"], runId: GetDataAppRunPath["runId"], signal?: AbortSignal) => Promise<{
-        state: "failed" | "starting" | "running" | "finished";
+        state: "starting" | "running" | "failed" | "finished";
         id: string;
         appId: string;
         createdAt?: string | null;

package/dist/dataScience/index.d.ts

@@ -1,12 +1,14 @@
 import { C as ClientInitOptions, A as ApiResponse } from '../types-UwuKN9Kx.js';
-import { G as GetDataAppRunsPath, a as GetDataAppRunsQuery, b as GetDataAppRunPath, c as GetDataAppLogsDownloadPath, d as GetDataAppLogsTailPath, e as GetDataAppLogsTailQuery, L as LogEntry, f as GetAppsQuery, g as GetDataAppPath, C as CreateDataAppBody, P as PatchDataAppPath, h as PatchDataAppBody, D as DeleteDataAppPath, i as GetDataAppPasswordPath, R as ResetDataAppPasswordPath, j as GetSandboxPath, k as DeleteSandboxPath } from '../utils-B_SOM1XR.js';
-export { p as parseLogLines } from '../utils-B_SOM1XR.js';
+import { GetDataAppRunsPath, GetDataAppRunsQuery, GetDataAppRunPath, GetDataAppLogsDownloadPath, GetDataAppLogsTailPath, GetDataAppLogsTailQuery, GetAppsQuery, GetDataAppPath, CreateDataAppBody, PatchDataAppPath, PatchDataAppBody, DeleteDataAppPath, GetDataAppPasswordPath, ResetDataAppPasswordPath, GetSandboxPath, DeleteSandboxPath } from './types.js';
+import { L as LogEntry } from '../appLogs-BbgAJ5I8.js';
+export { p as parseLogLines } from '../appLogs-BbgAJ5I8.js';
 import 'qs';
-import '../types-gcShAmmi.js';
+import '../types-f8dUjMX4.js';
 
 declare const createDataScienceClient: ({ baseUrl, middlewares, auth }: ClientInitOptions) => {
+    healthCheck: (signal?: AbortSignal) => Promise<unknown>;
     getAppRuns: (appId: GetDataAppRunsPath["appId"], query?: GetDataAppRunsQuery, signal?: AbortSignal) => Promise<{
-        state: "failed" | "starting" | "running" | "finished";
+        state: "starting" | "running" | "failed" | "finished";
         id: string;
         appId: string;
         createdAt?: string | null;
@@ -22,7 +24,7 @@ declare const createDataScienceClient: ({ baseUrl, middlewares, auth }: ClientIn
         mode: "prod" | "dev";
     }[]>;
     getAppRun: (appId: GetDataAppRunPath["appId"], runId: GetDataAppRunPath["runId"], signal?: AbortSignal) => Promise<{
-        state: "failed" | "starting" | "running" | "finished";
+        state: "starting" | "running" | "failed" | "finished";
         id: string;
         appId: string;
         createdAt?: string | null;

package/dist/dataScience/index.js

@@ -1,6 +1,7 @@
-export { createDataScienceClient, parseLogLines } from '../chunk-AXEANGGK.js';
+export { createDataScienceClient } from '../chunk-SYZ5OFNT.js';
+export { parseLogLines } from '../chunk-6XFXU5N4.js';
 import '../chunk-MSI6FVGG.js';
-import '../chunk-EDX5D6UY.js';
-import '../chunk-XHDYLUM4.js';
+import '../chunk-5A3AQIXR.js';
+import '../chunk-2BQBKU6E.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map