dataiku-sdk 4.0.0 → 4.2.0

package/dist/src/client.js

@@ -2,7 +2,7 @@ import { readFileSync, } from "node:fs";
 import { basename, } from "node:path";
 import { Value, } from "@sinclair/typebox/value";
 import { safeParseSchema, } from "./schemas.js";
-import { classifyDataikuError, ClientValidationError, DataikuError, nonJsonResponseBody, } from "./errors.js";
+import { classifyDataikuError, ClientValidationError, DataikuError, nonJsonResponseBody, RESPONSE_TOO_LARGE_STATUS_TEXT, } from "./errors.js";
 /* ------------------------------------------------------------------ */
 /*  Constants                                                          */
 /* ------------------------------------------------------------------ */
@@ -18,7 +18,6 @@ const DEFAULT_REQUEST_TIMEOUT_MS = 30_000;
  * streaming methods (stream, postStream) are unaffected.
  */
 const DEFAULT_MAX_BUFFERED_BODY_BYTES = 50 * 1024 * 1024;
-const RESPONSE_TOO_LARGE_STATUS_TEXT = "Response Too Large";
 /* ------------------------------------------------------------------ */
 /*  Helpers                                                            */
 /* ------------------------------------------------------------------ */
@@ -115,6 +114,8 @@ function trimFromUtf8BoundaryStart(bytes) {
 function buildBodyReadTimeoutError(timeoutMs) {
     return new DataikuError(0, "Request Timeout", `Request timed out after ${timeoutMs}ms while reading the response body.`);
 }
+/** Total budget of a tail read (e.g. `job log`) as a multiple of the per-chunk stall timeout. */
+const TAIL_READ_TOTAL_BUDGET_FACTOR = 10;
 /**
  * Read the next chunk of a response body under a hard deadline.
  * When `remainingMs` elapses, the stream is cancelled and the caller's
@@ -255,6 +256,7 @@ export class DataikuClient {
     workspacesResource;
     metricsResource;
     meaningsResource;
+    messagingChannelsResource;
     analysesResource;
     mlTasksResource;
     savedModelsResource;
@@ -507,6 +509,13 @@ export class DataikuClient {
         }
         return this.meaningsResource;
     }
+    get messagingChannels() {
+        if (!this.messagingChannelsResource) {
+            const { MessagingChannelsResource: Resource, } = require("./resources/messaging-channels.js");
+            this.messagingChannelsResource = new Resource(this);
+        }
+        return this.messagingChannelsResource;
+    }
     get analyses() {
         if (!this.analysesResource) {
             const { AnalysesResource: Resource, } = require("./resources/analyses.js");
@@ -699,7 +708,7 @@ export class DataikuClient {
      * the tail is kept and `truncated` is true — so callers that need the end
      * of a large document (e.g. job logs) stay bounded without losing the most
      * recent content. The request timeout applies per received chunk (a stall
-     * deadline), not to the whole transfer.
+     * deadline); the whole transfer is capped at 10x the request timeout.
      */
     async getTextTailLimited(path, maxBytes) {
         const limit = Math.max(0, Math.floor(maxBytes));
@@ -819,6 +828,18 @@ export class DataikuClient {
      * boundary is set correctly.
      */
     async uploadForm(path, parts, query) {
+        return this.parseJsonResponse(await this.postFormData(path, parts, query));
+    }
+    /**
+     * POST a multipart/form-data body like {@link uploadForm} for endpoints whose
+     * success carries no JSON the caller needs (e.g. mail sends): the response
+     * body is not parsed, so a non-JSON acknowledgement cannot turn an already
+     * applied write into a client error.
+     */
+    async uploadFormVoid(path, parts, query) {
+        await this.postFormData(path, parts, query);
+    }
+    async postFormData(path, parts, query) {
         const formData = new FormData();
         for (const part of parts) {
             if (part.value !== undefined) {
@@ -837,12 +858,11 @@ export class DataikuClient {
             formData.append(part.name, blob, part.fileName);
         }
         const suffix = query && [...query.keys(),].length > 0 ? `?${query.toString()}` : "";
-        const res = await this.fetchWithRetry(`${this.baseUrl}${path}${suffix}`, {
+        return this.fetchWithRetry(`${this.baseUrl}${path}${suffix}`, {
             method: "POST",
             headers: { Authorization: `Bearer ${this.apiKey}`, },
             body: formData,
         });
-        return this.parseJsonResponse(res);
     }
     async uploadResponse(path, filePath, fileName) {
         const fileBlob = Bun.file(filePath);
@@ -1090,9 +1110,10 @@ export class DataikuClient {
      * decoded text never contains a replacement character.
      *
      * The request timeout applies per chunk (a stall deadline), like the
-     * streaming path: a large body that keeps arriving is read to EOF however
-     * long the whole transfer takes, while a body that stops sending for longer
-     * than the timeout fails with the body-read timeout error.
+     * streaming path: a body that stops sending for longer than the timeout
+     * fails with the body-read timeout error. A total budget of
+     * {@link TAIL_READ_TOTAL_BUDGET_FACTOR} x the request timeout bounds a body
+     * that keeps trickling, with an error naming that limit.
      */
     async readBodyTextTail(res, maxBytes) {
         const limit = Math.max(0, Math.floor(maxBytes));
@@ -1103,9 +1124,24 @@ export class DataikuClient {
         let writeOffset = 0;
         let retainedBytes = 0;
         let truncated = false;
+        // Stall deadline per chunk, plus an overall cap so a body that trickles
+        // forever still ends; the error names which limit fired.
+        const totalBudgetMs = this.requestTimeoutMs * TAIL_READ_TOTAL_BUDGET_FACTOR;
+        const startedAt = Date.now();
         try {
             while (true) {
-                const { done, value, } = await readChunkWithDeadline(reader, this.requestTimeoutMs, this.requestTimeoutMs);
+                const totalRemainingMs = totalBudgetMs - (Date.now() - startedAt);
+                const totalBound = totalRemainingMs < this.requestTimeoutMs;
+                let chunk;
+                try {
+                    chunk = await readChunkWithDeadline(reader, Math.max(0, Math.min(this.requestTimeoutMs, totalRemainingMs)), this.requestTimeoutMs);
+                }
+                catch (error) {
+                    if (!totalBound || !(error instanceof DataikuError) || error.status !== 0)
+                        throw error;
+                    throw new DataikuError(0, "Request Timeout", `Response body was still arriving after ${totalBudgetMs}ms (the total read limit is ${TAIL_READ_TOTAL_BUDGET_FACTOR}x --request-timeout); raise --request-timeout to allow more time.`);
+                }
+                const { done, value, } = chunk;
                 if (done)
                     break;
                 if (limit === 0) {

package/dist/src/errors.d.ts

@@ -51,6 +51,8 @@ export declare const UNEXPECTED_RESPONSE_MARKER = "Unexpected DSS response";
 export declare function unexpectedResponseError(detail: string, status?: number): DataikuError;
 /** Prefix for a SQL query failure reported by DSS on a 2xx finish-streaming response. */
 export declare const SQL_QUERY_FAILED_MARKER = "SQL query failed in DSS";
+/** statusText of a DataikuError raised when a response exceeds a client-side byte budget. */
+export declare const RESPONSE_TOO_LARGE_STATUS_TEXT = "Response Too Large";
 /** Generic permission hint; the CLI names the project when the request was project-scoped. */
 export declare const FORBIDDEN_HINT = "Check API key validity and project permissions for the requested action.";
 /** Generic 404 hint; the CLI names the resource and project when it knows them. */

package/dist/src/errors.js

@@ -78,6 +78,9 @@ export function unexpectedResponseError(detail, status = 200) {
 const DEFINITE_FAILURE_HINT = "DSS reported that the request failed (for SQL: syntax error, missing object, or missing privileges of the connection's role). Fix the request or grants; do not retry unchanged.";
 /** Prefix for a SQL query failure reported by DSS on a 2xx finish-streaming response. */
 export const SQL_QUERY_FAILED_MARKER = "SQL query failed in DSS";
+/** statusText of a DataikuError raised when a response exceeds a client-side byte budget. */
+export const RESPONSE_TOO_LARGE_STATUS_TEXT = "Response Too Large";
+const RESPONSE_TOO_LARGE_HINT = "The response exceeded a client-side size limit; retrying returns the same body. Narrow the request (fewer rows or columns, --preview, --output PATH) instead.";
 const TLS_CERTIFICATE_HINT = "TLS certificate verification failed. Trust the DSS/corporate CA with --ca-cert PATH or NODE_EXTRA_CA_CERTS, or save it for every process and directory with `dss auth login --ca-cert PATH` (a project .env applies only when dss runs in that directory); use --insecure only for temporary troubleshooting.";
 /** Generic permission hint; the CLI names the project when the request was project-scoped. */
 export const FORBIDDEN_HINT = "Check API key validity and project permissions for the requested action.";
@@ -388,14 +391,21 @@ export class DataikuError extends Error {
         this.body = body;
         this.name = "DataikuError";
         const definite = trustedMetadata?.definiteFailure === true;
+        // A client-side byte budget tripped: the same request returns the same
+        // oversized body, so retrying cannot help (it is not a transport fault).
+        const overBudget = statusText === RESPONSE_TOO_LARGE_STATUS_TEXT;
         // A definite DSS refusal is not a transport/server fault: replaying it
         // unchanged cannot succeed. Keep a more specific forbidden/not_found class.
-        const reclassify = definite
+        const reclassify = overBudget || definite
             && (details.category === "transient" || details.category === "unknown"
                 || details.category === "unexpected_response");
         this.category = reclassify ? "validation" : details.category;
         this.retryable = reclassify ? false : details.retryable;
-        this.retryHint = reclassify ? DEFINITE_FAILURE_HINT : details.retryHint;
+        this.retryHint = overBudget
+            ? RESPONSE_TOO_LARGE_HINT
+            : reclassify
+                ? DEFINITE_FAILURE_HINT
+                : details.retryHint;
         this.retry = retry;
         this.requestId = requestId;
         this.trustedTarget = trustedMetadata?.target;

package/dist/src/generated/action-output-schemas.json

@@ -1125,6 +1125,12 @@
                 "resume": {
                     "type": "string"
                 },
+                "resumeArgv": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
                 "progress": {
                     "type": "object",
                     "required": [
@@ -1199,6 +1205,12 @@
                 "resume": {
                     "type": "string"
                 },
+                "resumeArgv": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
                 "progress": {
                     "type": "object",
                     "required": [
@@ -1288,6 +1300,33 @@
                 }
             }
         },
+        "messaging-channel.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "family": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
         "notebook.get-jupyter": {
             "additionalProperties": true,
             "type": "object",
@@ -1976,6 +2015,208 @@
                 }
             }
         },
+        "scenario.get-run": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "runId",
+                "steps"
+            ],
+            "properties": {
+                "runId": {
+                    "type": "string"
+                },
+                "scenarioId": {
+                    "type": "string"
+                },
+                "projectKey": {
+                    "type": "string"
+                },
+                "outcome": {
+                    "type": "string"
+                },
+                "start": {
+                    "type": "number"
+                },
+                "end": {
+                    "type": "number"
+                },
+                "durationMs": {
+                    "type": "number"
+                },
+                "trigger": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": {
+                            "type": "string"
+                        },
+                        "name": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "steps": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "id": {
+                                "type": "string"
+                            },
+                            "name": {
+                                "type": "string"
+                            },
+                            "type": {
+                                "type": "string"
+                            },
+                            "outcome": {
+                                "type": "string"
+                            },
+                            "message": {
+                                "type": "string"
+                            },
+                            "datasets": {
+                                "type": "array",
+                                "items": {
+                                    "type": "object",
+                                    "additionalProperties": false,
+                                    "properties": {
+                                        "dataset": {
+                                            "type": "string"
+                                        },
+                                        "projectKey": {
+                                            "type": "string"
+                                        },
+                                        "partition": {
+                                            "type": "string"
+                                        },
+                                        "outcome": {
+                                            "type": "string"
+                                        }
+                                    }
+                                }
+                            },
+                            "jobs": {
+                                "type": "array",
+                                "items": {
+                                    "type": "object",
+                                    "additionalProperties": false,
+                                    "properties": {
+                                        "jobId": {
+                                            "type": "string"
+                                        },
+                                        "outcome": {
+                                            "type": "string"
+                                        },
+                                        "message": {
+                                            "type": "string"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                },
+                "failure": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "stepId": {
+                            "type": "string"
+                        },
+                        "jobId": {
+                            "type": "string"
+                        },
+                        "dataset": {
+                            "type": "string"
+                        },
+                        "recipe": {
+                            "type": "string"
+                        },
+                        "inputs": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        },
+                        "message": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "next": {
+                    "type": "array",
+                    "description": "Next commands to run, each as an argv array.",
+                    "items": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "hint": {
+                    "type": "string",
+                    "description": "Edit-and-rerun commands when the failed recipe is known."
+                }
+            }
+        },
+        "scenario.last-runs": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                    "runId"
+                ],
+                "properties": {
+                    "runId": {
+                        "type": "string"
+                    },
+                    "outcome": {
+                        "type": "string"
+                    },
+                    "start": {
+                        "type": "number"
+                    },
+                    "end": {
+                        "type": "number"
+                    },
+                    "trigger": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "type": {
+                                "type": "string"
+                            },
+                            "name": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    "failure": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "message": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    "next": {
+                        "type": "array",
+                        "description": "Next commands to run, each as an argv array.",
+                        "items": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "scenario.list": {
             "type": "array",
             "items": {
@@ -2015,6 +2256,61 @@
                 }
             }
         },
+        "scenario.runs-by-date": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "required": [
+                    "runId"
+                ],
+                "properties": {
+                    "runId": {
+                        "type": "string"
+                    },
+                    "outcome": {
+                        "type": "string"
+                    },
+                    "start": {
+                        "type": "number"
+                    },
+                    "end": {
+                        "type": "number"
+                    },
+                    "trigger": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "type": {
+                                "type": "string"
+                            },
+                            "name": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    "failure": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "message": {
+                                "type": "string"
+                            }
+                        }
+                    },
+                    "next": {
+                        "type": "array",
+                        "description": "Next commands to run, each as an argv array.",
+                        "items": {
+                            "type": "array",
+                            "items": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "scenario.status": {
             "additionalProperties": true,
             "type": "object",

package/dist/src/index.d.ts

@@ -27,6 +27,7 @@ export * from "./resources/knowledge-banks.js";
 export * from "./resources/llms.js";
 export { type MacroResultOptions, type MacroRunFailure, type MacroRunHandle, type MacroRunOptions, type MacroRunWaitedResult, MacrosResource, type MacroWaitOptions, } from "./resources/macros.js";
 export { MeaningsResource, } from "./resources/meanings.js";
+export * from "./resources/messaging-channels.js";
 export { MetricsResource, } from "./resources/metrics.js";
 export * from "./resources/ml-tasks.js";
 export { type MlflowDeployRunOptions, type MlflowExperimentsDatasetOptions, MlflowExtensionResource, type MlflowInferenceInfo, type MlflowPredictionType, } from "./resources/mlflow-extension.js";

package/dist/src/index.js

@@ -30,6 +30,7 @@ export * from "./resources/knowledge-banks.js";
 export * from "./resources/llms.js";
 export { MacrosResource, } from "./resources/macros.js";
 export { MeaningsResource, } from "./resources/meanings.js";
+export * from "./resources/messaging-channels.js";
 export { MetricsResource, } from "./resources/metrics.js";
 export * from "./resources/ml-tasks.js";
 export { MlflowExtensionResource, } from "./resources/mlflow-extension.js";

package/dist/src/resources/bundles.d.ts

@@ -126,6 +126,24 @@ export declare class ProjectDeployerResource extends BaseResource {
     getDeploymentSettings(deploymentId: string): Promise<Record<string, unknown>>;
     /** Governance status of the deployment's bundle (or `bundleId`'s): messages on whether it may deploy. */
     getGovernanceStatus(deploymentId: string, bundleId?: string): Promise<Record<string, unknown>>;
+    /**
+     * Combined last-run outcome of the deployment's test scenarios, worst
+     * outcome wins. `bundleId` filters the runs to one bundle;
+     * `automationNodeId` is required for multi-node deployments only.
+     */
+    getTestingStatus(deploymentId: string, options?: {
+        bundleId?: string;
+        automationNodeId?: string;
+    }): Promise<Record<string, unknown>>;
+    /**
+     * Run every test scenario of the deployment on its Automation node and
+     * return the resulting testing status. The request stays open until the
+     * scenarios finish. `automationNodeId` is required for multi-node
+     * deployments only.
+     */
+    runTestScenarios(deploymentId: string, options?: {
+        automationNodeId?: string;
+    }): Promise<Record<string, unknown>>;
     /** Delete a published project no deployment uses. */
     deleteProject(publishedProjectKey: string): Promise<void>;
     /** Get a published project's settings (permissions, owner). */

package/dist/src/resources/bundles.js

@@ -186,6 +186,32 @@ export class ProjectDeployerResource extends BaseResource {
         const query = bundleId ? `?bundleId=${encodeURIComponent(bundleId)}` : "";
         return this.client.get(`/public/api/project-deployer/deployments/${encodeURIComponent(deploymentId)}/governance-status${query}`);
     }
+    /**
+     * Combined last-run outcome of the deployment's test scenarios, worst
+     * outcome wins. `bundleId` filters the runs to one bundle;
+     * `automationNodeId` is required for multi-node deployments only.
+     */
+    async getTestingStatus(deploymentId, options = {}) {
+        const query = new URLSearchParams();
+        if (options.bundleId)
+            query.set("bundleId", options.bundleId);
+        if (options.automationNodeId)
+            query.set("automationNodeId", options.automationNodeId);
+        const suffix = query.size > 0 ? `?${query.toString()}` : "";
+        return this.client.get(`/public/api/project-deployer/deployments/${encodeURIComponent(deploymentId)}/testing-status${suffix}`);
+    }
+    /**
+     * Run every test scenario of the deployment on its Automation node and
+     * return the resulting testing status. The request stays open until the
+     * scenarios finish. `automationNodeId` is required for multi-node
+     * deployments only.
+     */
+    async runTestScenarios(deploymentId, options = {}) {
+        const suffix = options.automationNodeId
+            ? `?automationNodeId=${encodeURIComponent(options.automationNodeId)}`
+            : "";
+        return this.client.post(`/public/api/project-deployer/deployments/${encodeURIComponent(deploymentId)}/run-test-scenarios${suffix}`);
+    }
     /** Delete a published project no deployment uses. */
     async deleteProject(publishedProjectKey) {
         await this.client.del(`/public/api/project-deployer/projects/${encodeURIComponent(publishedProjectKey)}`);

package/dist/src/resources/futures.d.ts

@@ -21,10 +21,13 @@ export declare class FuturesResource extends BaseResource {
     /**
      * Long tasks in progress (GET /futures/): the caller's own by default,
      * every user's with `allUsers`, running scenarios too with `withScenarios`.
+     * `scenariosOnly` lists running scenarios and nothing else, like dataikuapi's
+     * `list_running_scenarios` (`withScenarios=true&withNotScenarios=false`).
      */
     list(opts?: {
         allUsers?: boolean;
         withScenarios?: boolean;
+        scenariosOnly?: boolean;
     }): Promise<FutureState[]>;
     /** Wait for a started task; a task DSS already finished inline is returned as is. */
     waitTask(task: DssTask, opts?: FutureWaitOptions): Promise<FutureWaitResult | DssTask>;

package/dist/src/resources/futures.js

@@ -37,12 +37,16 @@ export class FuturesResource extends BaseResource {
     /**
      * Long tasks in progress (GET /futures/): the caller's own by default,
      * every user's with `allUsers`, running scenarios too with `withScenarios`.
+     * `scenariosOnly` lists running scenarios and nothing else, like dataikuapi's
+     * `list_running_scenarios` (`withScenarios=true&withNotScenarios=false`).
      */
     async list(opts = {}) {
         const query = new URLSearchParams({
             allUsers: String(opts.allUsers === true),
-            withScenarios: String(opts.withScenarios === true),
+            withScenarios: String(opts.withScenarios === true || opts.scenariosOnly === true),
         });
+        if (opts.scenariosOnly === true)
+            query.set("withNotScenarios", "false");
         return this.client.get(`/public/api/futures/?${query}`);
     }
     /** Wait for a started task; a task DSS already finished inline is returned as is. */