dataiku-sdk 0.12.2 → 0.12.3

package/dist/src/cli/commands/api-service.js

@@ -59,7 +59,6 @@ export const apiServiceCommands = {
         handler: async (c, a, f) => {
             requireArgs(a, 1, "dss api-service list-packages <serviceId> [--project-key KEY]");
             const projectKey = f["project-key"];
-            await c.apiServices.getSettings(a[0], projectKey);
             return c.apiServices.listPackages(a[0], projectKey);
         },
         usage: "dss api-service list-packages <serviceId> [--project-key KEY]",

package/dist/src/cli/commands/notebook.js

@@ -44,7 +44,11 @@ export const notebookCommands = {
                 const current = await c.notebooks.getJupyter(a[0], pk);
                 const next = {
                     ...current,
-                    cells: current.cells.map((cell) => ({ ...cell, outputs: [], execution_count: null, })),
+                    cells: current.cells.map((cell) => {
+                        if (cell.cell_type !== "code")
+                            return cell;
+                        return { ...cell, outputs: [], execution_count: 0, };
+                    }),
                 };
                 return {
                     dryRun: true,

package/dist/src/cli/output.js

@@ -73,7 +73,7 @@ export function transientBodyWithTargetContext(body, target, elapsedMs) {
 }
 export function addTransientTargetContext(error, target, elapsedMs) {
     if (error instanceof DataikuError && error.category === "transient") {
-        throw new DataikuError(error.status, error.statusText, transientBodyWithTargetContext(error.body, target, elapsedMs), error.retry, error.requestId);
+        throw new DataikuError(error.status, error.statusText, transientBodyWithTargetContext(error.body, target, elapsedMs), error.retry, error.requestId, { target, elapsedMs, });
     }
     throw error;
 }

package/dist/src/cli.js

@@ -12,7 +12,7 @@ import { COMMANDS_RUN_HINT, missingActionError, noCommandError, requireArgs, unk
 import { cliVersionResult, } from "./cli/version.js";
 import { DataikuClient, } from "./client.js";
 import { getCredentialsPath, } from "./config.js";
-import { ClientValidationError, DataikuError, dataikuErrorCode, } from "./errors.js";
+import { canonicalStatusText, ClientValidationError, DataikuError, dataikuErrorCode, } from "./errors.js";
 import { AGENTS, detectAgents, findWorkspaceRoot, installSkill, planSkillInstalls, } from "./skill.js";
 import { appendCleanupLedgerEntry, readCleanupLedger, } from "./utils/cleanup-ledger.js";
 // ---------------------------------------------------------------------------
@@ -833,16 +833,41 @@ function rawCommandContext() {
                 : undefined),
     };
 }
-function requestIdFromBody(body) {
+const SAFE_RESPONSE_METADATA_KEYS = [
+    "requestId",
+    "request_id",
+    "errorId",
+    "elapsedMs",
+];
+function safeResponseMetadata(body) {
     try {
         const parsed = JSON.parse(body);
-        const value = parsed.requestId ?? parsed.request_id ?? parsed.errorId;
-        return typeof value === "string" && value.length > 0 ? value : undefined;
+        if (!parsed || typeof parsed !== "object" || Array.isArray(parsed))
+            return {};
+        const metadata = {};
+        for (const key of SAFE_RESPONSE_METADATA_KEYS) {
+            const value = parsed[key];
+            if ((typeof value === "string" && value.length > 0)
+                || (typeof value === "number" && Number.isFinite(value))
+                || typeof value === "boolean") {
+                metadata[key] = value;
+            }
+        }
+        return metadata;
     }
     catch {
-        return undefined;
+        return {};
     }
 }
+function requestIdFromBody(body) {
+    const metadata = safeResponseMetadata(body);
+    for (const key of ["requestId", "request_id", "errorId",]) {
+        const value = metadata[key];
+        if (typeof value === "string")
+            return value;
+    }
+    return undefined;
+}
 const MISSING_PROJECT_KEY_ERROR_PREFIX = "projectKey is required";
 function errorExitCode(err) {
     if (err instanceof CommandResultFailure)
@@ -884,13 +909,18 @@ function buildErrorReport(err) {
         };
     }
     if (err instanceof DataikuError) {
-        const errorMessage = err.category === "not_found"
-            && err.message.includes("Dataiku instance not found")
-            && context.resource
+        const errorMessage = err.category === "not_found" && context.resource
             ? `Not found: ${context.resource}${context.action ? ` ${context.action}` : ""}`
                 + `${context.projectKey ? ` in project ${context.projectKey}` : ""}`
-                + ` — verify the object identifier and project key (DSS: ${err.message.split("\n")[0]}).`
-            : err.message;
+                + " — verify the object identifier and project key."
+                + `\nHint: ${err.retryHint}`
+            : err.safeMessage;
+        const safeMetadata = safeResponseMetadata(err.body);
+        if (err.trustedTarget)
+            safeMetadata.target = err.trustedTarget;
+        if (err.trustedElapsedMs !== undefined)
+            safeMetadata.elapsedMs = err.trustedElapsedMs;
+        const safeBody = JSON.stringify(safeMetadata);
         return {
             type: "error",
             ok: false,
@@ -904,8 +934,8 @@ function buildErrorReport(err) {
             requestId: err.requestId ?? requestIdFromBody(err.body),
             details: {
                 dssCategory: err.category,
-                statusText: err.statusText,
-                body: err.body,
+                statusText: canonicalStatusText(err.status),
+                body: safeBody,
                 ...(err.retry ? { retry: err.retry, } : {}),
             },
             ...context,

package/dist/src/errors.d.ts

@@ -15,6 +15,11 @@ export interface DataikuRetryMetadata {
     delaysMs: number[];
     timedOut: boolean;
 }
+export interface DataikuErrorTrustedMetadata {
+    target?: string;
+    elapsedMs?: number;
+}
+export declare function canonicalStatusText(status: number): string;
 export declare class ClientValidationError extends Error {
     readonly code: StableErrorCode;
     readonly hint?: string;
@@ -31,7 +36,10 @@ export declare class DataikuError extends Error {
     retryHint: string;
     retry?: DataikuRetryMetadata;
     requestId?: string;
-    constructor(status: number, statusText: string, body: string, retry?: DataikuRetryMetadata, requestId?: string);
+    readonly trustedTarget?: string;
+    readonly trustedElapsedMs?: number;
+    constructor(status: number, statusText: string, body: string, retry?: DataikuRetryMetadata, requestId?: string, trustedMetadata?: DataikuErrorTrustedMetadata);
+    get safeMessage(): string;
     private static extractSummary;
     private static formatRetryMetadata;
     private static buildDetails;

package/dist/src/errors.js

@@ -12,6 +12,25 @@ export function dataikuErrorCode(category) {
             return "internal_error";
     }
 }
+const CANONICAL_STATUS_TEXT = {
+    400: "Bad Request",
+    401: "Unauthorized",
+    403: "Forbidden",
+    404: "Not Found",
+    408: "Request Timeout",
+    409: "Conflict",
+    422: "Unprocessable Entity",
+    425: "Too Early",
+    429: "Too Many Requests",
+    500: "Internal Server Error",
+    501: "Not Implemented",
+    502: "Bad Gateway",
+    503: "Service Unavailable",
+    504: "Gateway Timeout",
+};
+export function canonicalStatusText(status) {
+    return CANONICAL_STATUS_TEXT[status] ?? (status === 0 ? "Network Error" : "HTTP Error");
+}
 export class ClientValidationError extends Error {
     code;
     hint;
@@ -276,8 +295,10 @@ export class DataikuError extends Error {
     retryHint;
     retry;
     requestId;
-    constructor(status, statusText, body, retry, requestId) {
-        const details = DataikuError.buildDetails(status, statusText, body, retry);
+    trustedTarget;
+    trustedElapsedMs;
+    constructor(status, statusText, body, retry, requestId, trustedMetadata) {
+        const details = DataikuError.buildDetails(status, body, retry);
         super(details.message);
         this.status = status;
         this.statusText = statusText;
@@ -288,8 +309,20 @@ export class DataikuError extends Error {
         this.retryHint = details.retryHint;
         this.retry = retry;
         this.requestId = requestId;
+        this.trustedTarget = trustedMetadata?.target;
+        this.trustedElapsedMs = trustedMetadata?.elapsedMs;
+    }
+    get safeMessage() {
+        const retrySummary = DataikuError.formatRetryMetadata(this.retry);
+        return [
+            `${this.status} ${canonicalStatusText(this.status)}`,
+            `Error type: ${this.category}`,
+            `Retryable: ${this.retryable ? "yes" : "no"}`,
+            `Hint: ${this.retryHint}`,
+            ...(retrySummary ? [retrySummary,] : []),
+        ].join("\n");
     }
-    static extractSummary(_status, _statusText, body) {
+    static extractSummary(_status, body) {
         try {
             const parsed = JSON.parse(body);
             if (parsed.message)
@@ -316,14 +349,14 @@ export class DataikuError extends Error {
             `Timed out: ${retry.timedOut ? "yes" : "no"}`,
         ].join(" | ");
     }
-    static buildDetails(status, statusText, body, retry) {
-        const summary = DataikuError.extractSummary(status, statusText, body);
+    static buildDetails(status, body, retry) {
+        const summary = DataikuError.extractSummary(status, body);
         const taxonomy = classifyDataikuError(status, body);
         const retrySummary = DataikuError.formatRetryMetadata(retry);
         return {
             ...taxonomy,
             message: [
-                `${status} ${statusText}: ${summary}`,
+                `${status} ${canonicalStatusText(status)}: ${summary}`,
                 `Error type: ${taxonomy.category}`,
                 `Retryable: ${taxonomy.retryable ? "yes" : "no"}`,
                 `Hint: ${taxonomy.retryHint}`,

package/dist/src/resources/api-services.js

@@ -28,6 +28,7 @@ export class ApiServicesResource extends BaseResource {
     }
     /** List deployable packages for an API service. */
     async listPackages(serviceId, projectKey) {
+        await this.getSettings(serviceId, projectKey);
         return this.client.get(`${this.servicePath(serviceId, projectKey)}/packages`);
     }
     /** Get an API service package summary. */

package/dist/src/resources/notebooks.js

@@ -36,11 +36,15 @@ export class NotebooksResource extends BaseResource {
      */
     async clearJupyterOutputs(name, projectKey) {
         const notebook = await this.getJupyter(name, projectKey);
-        const clearedCells = notebook.cells.map((cell) => ({
-            ...cell,
-            outputs: [],
-            execution_count: null,
-        }));
+        const clearedCells = notebook.cells.map((cell) => {
+            if (cell.cell_type !== "code")
+                return cell;
+            return {
+                ...cell,
+                outputs: [],
+                execution_count: 0,
+            };
+        });
         await this.saveJupyter(name, { ...notebook, cells: clearedCells, }, projectKey);
     }
     /** List running kernel sessions for a Jupyter notebook. */

package/dist/src/resources/sql.js

@@ -1,4 +1,4 @@
-import { DataikuError, } from "../errors.js";
+import { ClientValidationError, DataikuError, } from "../errors.js";
 import { BaseResource, } from "./base.js";
 const UNSUPPORTED_SQL_DATASET_CONNECTION_DETAIL = "neither of sql nor hdfs type";
 function isUnsupportedSqlDatasetConnectionError(error) {
@@ -161,28 +161,23 @@ export class SqlResource extends BaseResource {
         const datasetFullName = opts.datasetFullName;
         if (!datasetFullName)
             return null;
-        try {
-            const identifier = splitDatasetIdentifier(datasetFullName, opts.projectKey);
-            const projectKey = identifier.projectKey
-                ? identifier.projectKey
-                : this.resolveProjectKey(opts.projectKey);
-            const dsEnc = encodeURIComponent(identifier.datasetName);
-            const raw = await this.client.get(`/public/api/projects/${encodeURIComponent(projectKey)}/datasets/${dsEnc}`);
-            const params = asRecord(raw.params);
-            const connection = asString(params?.connection);
-            if (!connection)
-                return null;
-            return {
-                ...opts,
-                connection,
-                datasetFullName: undefined,
-                database: opts.database ?? asString(params?.schema) ?? asString(params?.catalog),
-                projectKey,
-            };
-        }
-        catch {
+        const identifier = splitDatasetIdentifier(datasetFullName, opts.projectKey);
+        const projectKey = identifier.projectKey
+            ? identifier.projectKey
+            : this.resolveProjectKey(opts.projectKey);
+        const dsEnc = encodeURIComponent(identifier.datasetName);
+        const raw = await this.client.get(`/public/api/projects/${encodeURIComponent(projectKey)}/datasets/${dsEnc}`);
+        const params = asRecord(raw.params);
+        const connection = asString(params?.connection);
+        if (!connection)
             return null;
-        }
+        return {
+            ...opts,
+            connection,
+            datasetFullName: undefined,
+            database: opts.database ?? asString(params?.schema) ?? asString(params?.catalog),
+            projectKey,
+        };
     }
     /**
      * Execute a SQL query end-to-end: start, stream all rows, verify, return combined result.
@@ -198,9 +193,7 @@ export class SqlResource extends BaseResource {
                 withSqlErrorContext(error);
             const retryOpts = await this.resolveDatasetQueryFallback(queryOpts);
             if (!retryOpts) {
-                throw new Error(buildUnsupportedSqlDatasetConnectionMessage(queryOpts.datasetFullName), {
-                    cause: error,
-                });
+                throw new ClientValidationError(buildUnsupportedSqlDatasetConnectionMessage(queryOpts.datasetFullName));
             }
             try {
                 return await this.executeQuery(retryOpts);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dataiku-sdk",
-	"version": "0.12.2",
+	"version": "0.12.3",
 	"description": "Dataiku DSS SDK and CLI for programmatic access to DSS REST APIs",
 	"type": "module",
 	"workspaces": [