dataiku-sdk 3.6.0 → 3.7.0

package/dist/src/errors.js

@@ -76,7 +76,11 @@ export function unexpectedResponseError(detail, status = 200) {
 }
 /** 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";
-const TLS_CERTIFICATE_HINT = "TLS certificate verification failed. Trust the DSS/corporate CA with --ca-cert PATH or NODE_EXTRA_CA_CERTS; use --insecure only for temporary troubleshooting.";
+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.";
+/** Generic 404 hint; the CLI names the resource and project when it knows them. */
+export const NOT_FOUND_HINT = "Verify projectKey and object identifiers (dataset/recipe/scenario/folder IDs).";
 const BUSINESS_APPS_API_UNAVAILABLE_HINT = "Business Apps API is not available on this DSS instance. Use classic app commands or check DSS version/feature availability.";
 const MAX_ERROR_SUMMARY_LENGTH = 200;
 function isHtmlResponseBody(body) {
@@ -170,6 +174,15 @@ export function classifyDataikuError(status, body) {
                 retryHint: TLS_CERTIFICATE_HINT,
             };
         }
+        // The same URL fails the same way on every attempt: nothing listens on
+        // the port, the host name does not resolve, or the URL is malformed.
+        if (/\b(?:connectionrefused|econnrefused|enotfound|err_invalid_url|bad port)\b/.test(lowerBody)) {
+            return {
+                category: "validation",
+                retryable: false,
+                retryHint: "DSS is not reachable at this URL. Check --url / DATAIKU_URL (scheme, host, port) and that DSS is running; do not retry unchanged.",
+            };
+        }
         return {
             category: "transient",
             retryable: true,
@@ -295,11 +308,7 @@ export function classifyDataikuError(status, body) {
             || (lowerBody.includes("permission")
                 && (lowerBody.includes("cannot use") || lowerBody.includes("not allowed"))));
     if (isServerPermissionLike) {
-        return {
-            category: "forbidden",
-            retryable: false,
-            retryHint: "Check API key validity and project permissions for the requested action.",
-        };
+        return { category: "forbidden", retryable: false, retryHint: FORBIDDEN_HINT, };
     }
     if (status === 404) {
         if (isBusinessAppsApiRootNotFound(lowerBody)) {
@@ -315,15 +324,11 @@ export function classifyDataikuError(status, body) {
             retryable: false,
             retryHint: isHtmlGatewayResponse
                 ? "Resource was not found (gateway returned HTML). Verify DSS URL, projectKey, and object identifiers."
-                : "Verify projectKey and object identifiers (dataset/recipe/scenario/folder IDs).",
+                : NOT_FOUND_HINT,
         };
     }
     if (status === 401 || status === 403) {
-        return {
-            category: "forbidden",
-            retryable: false,
-            retryHint: "Check API key validity and project permissions for the requested action.",
-        };
+        return { category: "forbidden", retryable: false, retryHint: FORBIDDEN_HINT, };
     }
     if (status === 400 || status === 409 || status === 422) {
         return {
@@ -368,7 +373,7 @@ export class DataikuError extends Error {
     trustedElapsedMs;
     bodyTruncated;
     constructor(status, statusText, body, retry, requestId, trustedMetadata) {
-        const details = DataikuError.buildDetails(status, body, retry);
+        const details = DataikuError.buildDetails(status, body);
         super(details.message);
         this.status = status;
         this.statusText = statusText;
@@ -383,15 +388,13 @@ export class DataikuError extends Error {
         this.trustedElapsedMs = trustedMetadata?.elapsedMs;
         this.bodyTruncated = trustedMetadata?.bodyTruncated === true ? true : undefined;
     }
+    /** Status line only: never echoes response body text. */
     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");
+        return `${this.status} ${canonicalStatusText(this.status)}`;
+    }
+    /** The DSS message part of `message` (HTML summarized, server paths stripped, bounded). */
+    get summary() {
+        return this.message.slice(this.safeMessage.length + 2);
     }
     static extractSummary(_status, body) {
         try {
@@ -406,33 +409,14 @@ export class DataikuError extends Error {
             return "(empty response body)";
         return summarizeErrorText(body);
     }
-    static formatRetryMetadata(retry) {
-        if (!retry)
-            return undefined;
-        const shownDelays = retry.delaysMs.slice(0, 10);
-        const delaysSuffix = retry.delaysMs.length > shownDelays.length ? ", …" : "";
-        const delaysPart = shownDelays.length > 0 ? `[${shownDelays.join(", ")}${delaysSuffix}]` : "[]";
-        return [
-            `Retry attempts: ${retry.attempts}/${retry.maxAttempts}`,
-            `Retry policy: ${retry.enabled ? "enabled" : "disabled"} for ${retry.method}`,
-            `Retries performed: ${retry.retries}`,
-            `Backoff delays (ms): ${delaysPart}`,
-            `Timed out: ${retry.timedOut ? "yes" : "no"}`,
-        ].join(" | ");
-    }
-    static buildDetails(status, body, retry) {
-        const summary = DataikuError.extractSummary(status, body);
-        const taxonomy = classifyDataikuError(status, body);
-        const retrySummary = DataikuError.formatRetryMetadata(retry);
+    /**
+     * One line: status plus the DSS message. Category, retryability, hint, and
+     * retry metadata are structured fields on the error, not message prose.
+     */
+    static buildDetails(status, body) {
         return {
-            ...taxonomy,
-            message: [
-                `${status} ${canonicalStatusText(status)}: ${summary}`,
-                `Error type: ${taxonomy.category}`,
-                `Retryable: ${taxonomy.retryable ? "yes" : "no"}`,
-                `Hint: ${taxonomy.retryHint}`,
-                ...(retrySummary ? [retrySummary,] : []),
-            ].join("\n"),
+            ...classifyDataikuError(status, body),
+            message: `${status} ${canonicalStatusText(status)}: ${DataikuError.extractSummary(status, body).replace(/\s+/g, " ").trim()}`,
         };
     }
 }

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

@@ -124,21 +124,26 @@
         "code-env.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "envName",
-                    "envLang"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "envName": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "envLang": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "deploymentMode": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -361,41 +366,32 @@
         "dataset.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "name"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "type": {
-                        "type": "string"
-                    },
-                    "shortDesc": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "managed": {
-                        "type": "boolean"
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
                     },
-                    "params": {
-                        "additionalProperties": true,
-                        "type": "object",
-                        "properties": {
-                            "connection": {
-                                "type": "string"
-                            },
-                            "uploadConnection": {
-                                "type": "string"
-                            },
-                            "schema": {
-                                "type": "string"
-                            },
-                            "catalog": {
-                                "type": "string"
-                            }
-                        }
+                    "connection": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -730,44 +726,146 @@
                 }
             }
         },
+        "folder.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "name": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "connection": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
+        "future.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "jobId": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "owner": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "alive": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    },
+                    "hasResult": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    },
+                    "runningTime": {
+                        "type": [
+                            "number",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
+        "group.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "name": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "description": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "admin": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
         "job.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
+                "additionalProperties": false,
                 "properties": {
-                    "def": {
-                        "additionalProperties": true,
-                        "type": "object",
-                        "properties": {
-                            "id": {
-                                "type": "string"
-                            },
-                            "type": {
-                                "type": "string"
-                            }
-                        }
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
-                    "baseStatus": {
-                        "additionalProperties": true,
-                        "type": "object",
-                        "properties": {
-                            "def": {
-                                "additionalProperties": true,
-                                "type": "object",
-                                "properties": {
-                                    "id": {
-                                        "type": "string"
-                                    },
-                                    "type": {
-                                        "type": "string"
-                                    }
-                                }
-                            },
-                            "state": {
-                                "type": "string"
-                            }
-                        }
+                    "name": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "state": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "startTime": {
+                        "type": [
+                            "number",
+                            "null"
+                        ]
+                    },
+                    "endTime": {
+                        "type": [
+                            "number",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -908,6 +1006,60 @@
                 }
             }
         },
+        "macro.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "runnableType": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "ownerPluginId": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "label": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
+        "meaning.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "label": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
         "notebook.get-jupyter": {
             "additionalProperties": true,
             "type": "object",
@@ -1186,6 +1338,33 @@
                 }
             }
         },
+        "plugin.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "id": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "version": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "label": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    }
+                }
+            }
+        },
         "project-library.diff": {
             "type": "object",
             "additionalProperties": false,
@@ -1407,21 +1586,26 @@
         "project.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "projectKey",
-                    "name"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "projectKey": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
-                    "shortDesc": {
-                        "type": "string"
+                    "ownerLogin": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -1492,17 +1676,32 @@
         "recipe.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "name"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "type": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "inputs": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "outputs": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
                     }
                 }
             }
@@ -1573,20 +1772,38 @@
         "scenario.list": {
             "type": "array",
             "items": {
-                "additionalProperties": true,
                 "type": "object",
-                "required": [
-                    "id"
-                ],
+                "additionalProperties": false,
                 "properties": {
                     "id": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "name": {
-                        "type": "string"
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "type": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
                     },
                     "active": {
-                        "type": "boolean"
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    },
+                    "running": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
                     }
                 }
             }
@@ -1730,6 +1947,45 @@
                     }
                 }
             ]
+        },
+        "user.list": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                    "login": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "displayName": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "userProfile": {
+                        "type": [
+                            "string",
+                            "null"
+                        ]
+                    },
+                    "groups": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "enabled": {
+                        "type": [
+                            "boolean",
+                            "null"
+                        ]
+                    }
+                }
+            }
         }
     }
 }