dataiku-sdk 0.12.6 → 1.0.0

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

@@ -32,9 +32,9 @@ export const codeCommands = {
             const run = await c.scenarios.runScript(script, {
                 envName: f["env"],
                 projectKey: f["project-key"],
-                timeoutMs: num(f["timeout"]),
+                timeoutMs: num(f["timeout"], "--timeout"),
                 keepScenario: f["keep"] === true,
-                maxLogBytes: num(f["max-log-bytes"]),
+                maxLogBytes: num(f["max-log-bytes"], "--max-log-bytes"),
             });
             const result = {
                 outcome: run.outcome,

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

@@ -1,5 +1,7 @@
+import * as fs from "node:fs";
+import { ClientValidationError, } from "../../errors.js";
 import { deepMerge, } from "../../utils/deep-merge.js";
-import { jsonInput, } from "../coerce.js";
+import { jsonInput, parseBooleanOption, } from "../coerce.js";
 import { readIfExists, skipResult, } from "../output.js";
 import { requireArgs, UsageError, } from "../usage.js";
 export const dashboardCommands = {
@@ -18,12 +20,91 @@ export const dashboardCommands = {
         description: "Get dashboard definition.",
         examples: ["dss dashboard get DASHBOARD_ID",],
     },
+    export: {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss dashboard export <id> --output PATH [--paper-size SIZE] [--orientation PORTRAIT|LANDSCAPE] [--file-type PDF] [--slide-index N] [--project-key KEY]");
+            const outputPath = f["output"];
+            if (typeof outputPath !== "string" || !outputPath.trim()) {
+                throw new UsageError("--output PATH is required.", "missing_required_flag");
+            }
+            const paperSizeFlag = f["paper-size"];
+            if (paperSizeFlag !== undefined && typeof paperSizeFlag !== "string") {
+                throw new UsageError("--paper-size requires a value.");
+            }
+            const paperSize = (paperSizeFlag ?? "A4").trim();
+            if (!paperSize)
+                throw new UsageError("--paper-size must not be empty.");
+            const orientationFlag = f["orientation"];
+            if (orientationFlag !== undefined && typeof orientationFlag !== "string") {
+                throw new UsageError("--orientation requires a value.");
+            }
+            const orientation = (orientationFlag ?? "LANDSCAPE").trim().toUpperCase();
+            if (orientation !== "PORTRAIT" && orientation !== "LANDSCAPE") {
+                throw new UsageError("--orientation must be PORTRAIT or LANDSCAPE.", "invalid_enum");
+            }
+            const fileTypeFlag = f["file-type"];
+            if (fileTypeFlag !== undefined && typeof fileTypeFlag !== "string") {
+                throw new UsageError("--file-type requires a value.");
+            }
+            const fileType = (fileTypeFlag ?? "PDF").trim().toUpperCase();
+            if (fileType !== "PDF") {
+                throw new UsageError("--file-type must be PDF.", "invalid_enum");
+            }
+            const slideIndexFlag = f["slide-index"];
+            if (slideIndexFlag !== undefined
+                && (typeof slideIndexFlag !== "string" || !/^(0|[1-9]\d*)$/u.test(slideIndexFlag))) {
+                throw new UsageError("--slide-index must be a non-negative integer.");
+            }
+            const slideIndex = slideIndexFlag === undefined ? 0 : Number(slideIndexFlag);
+            const response = await c.dashboards.export(a[0], {
+                paperSize,
+                orientation,
+                fileType,
+                slideIndex,
+                projectKey: f["project-key"],
+            });
+            const bytes = Buffer.from(await response.arrayBuffer());
+            const isPdf = bytes.length >= 5
+                && bytes[0] === 0x25
+                && bytes[1] === 0x50
+                && bytes[2] === 0x44
+                && bytes[3] === 0x46
+                && bytes[4] === 0x2d;
+            if (!isPdf) {
+                throw new ClientValidationError("DSS dashboard export did not return a PDF.", "validation_failed", "Confirm DSS graphics export is configured and retry the export.");
+            }
+            fs.writeFileSync(outputPath, bytes);
+            return {
+                path: outputPath,
+                bytes: bytes.length,
+                contentType: response.headers.get("content-type") ?? undefined,
+                dashboardId: a[0],
+                paperSize,
+                orientation,
+                fileType,
+                slideIndex,
+            };
+        },
+        usage: "dss dashboard export <id> --output PATH [--paper-size SIZE] [--orientation PORTRAIT|LANDSCAPE] [--file-type PDF] [--slide-index N] [--project-key KEY]",
+        description: "Render a dashboard page as PDF. Requires DSS graphics export to be configured.",
+        examples: [
+            "dss dashboard export DASHBOARD_ID --output dashboard.pdf",
+            "dss dashboard export DASHBOARD_ID --output dashboard.pdf --orientation LANDSCAPE --slide-index 0",
+        ],
+    },
     create: {
         handler: async (c, _a, f) => {
-            const name = f["name"];
-            if (!name)
-                throw new UsageError("--name is required. Usage: dss dashboard create --name NAME");
             const settings = jsonInput(f);
+            const flagName = f["name"];
+            const settingsName = settings?.["name"];
+            const name = flagName ?? (typeof settingsName === "string" ? settingsName : undefined);
+            const listed = parseBooleanOption(f["listed"], "--listed");
+            if (!name) {
+                throw new UsageError("--name or dashboard settings containing a string name are required. Usage: dss dashboard create --name NAME");
+            }
+            const payload = { ...(settings ?? { pages: [], }), name, };
+            if (listed !== undefined)
+                payload.listed = listed;
             const pk = f["project-key"];
             if (f["if-not-exists"] === true || f["dry-run"] === true) {
                 const existing = (await c.dashboards.list(pk)).find((dashboard) => dashboard.name === name);
@@ -36,46 +117,54 @@ export const dashboardCommands = {
                         action: "create",
                         resource: "dashboard",
                         name,
-                        payload: settings ?? { pages: [], },
+                        payload,
                         ...(existing ? { current: existing, } : {}),
                     };
                 }
             }
             const created = await c.dashboards.create({
                 name,
+                listed,
                 settings,
                 projectKey: pk,
             });
             return { created: created.id, resource: "dashboard", ...created, };
         },
-        usage: "dss dashboard create --name NAME [--data JSON|--data-file PATH|--stdin] [--if-not-exists] [--dry-run] [--project-key KEY]",
-        description: "Create a dashboard. Defaults to an empty pages array.",
-        examples: ["dss dashboard create --name 'Agent dashboard' --dry-run",],
+        usage: "dss dashboard create (--name NAME|--data JSON|--data-file PATH|--stdin) [--listed true|false] [--if-not-exists] [--dry-run] [--project-key KEY]",
+        description: "Create a dashboard from raw settings or minimal name/listed fields. Defaults to an empty pages array.",
+        examples: [
+            "dss dashboard create --name 'Agent dashboard' --listed true --dry-run",
+            'dss dashboard create --data \'{"name":"Agent dashboard","pages":[]}\'',
+        ],
     },
     update: {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss dashboard update <id> [--name NAME|--data JSON]");
+            requireArgs(a, 1, "dss dashboard update <id> [--name NAME|--listed true|false|--data JSON]");
             const name = f["name"];
+            const listed = parseBooleanOption(f["listed"], "--listed");
             const data = jsonInput(f);
-            if (!name && !data) {
-                throw new UsageError("--name, --data, --data-file, or --stdin is required.");
+            if (name === undefined && listed === undefined && !data) {
+                throw new UsageError("--name, --listed, --data, --data-file, or --stdin is required.");
             }
             if (f["dry-run"] === true) {
                 const current = await c.dashboards.get(a[0], f["project-key"]);
                 const next = deepMerge(current, data ?? {});
                 if (name !== undefined)
                     next.name = name;
+                if (listed !== undefined)
+                    next.listed = listed;
                 return { dryRun: true, action: "update", resource: "dashboard", id: a[0], current, next, };
             }
             return c.dashboards.update(a[0], {
                 name,
+                listed,
                 data,
                 projectKey: f["project-key"],
             });
         },
-        usage: "dss dashboard update <id> (--name NAME|--data JSON|--data-file PATH|--stdin) [--dry-run] [--project-key KEY]",
+        usage: "dss dashboard update <id> (--name NAME|--listed true|false|--data JSON|--data-file PATH|--stdin) [--dry-run] [--project-key KEY]",
         description: "Update dashboard settings via merge.",
-        examples: ["dss dashboard update DASHBOARD_ID --name 'New name' --dry-run",],
+        examples: ["dss dashboard update DASHBOARD_ID --listed true --dry-run",],
     },
     delete: {
         handler: async (c, a, f) => {

package/dist/src/cli/commands/data-quality.js

@@ -164,10 +164,10 @@ export const dataQualityCommands = {
         handler: (c, a, f) => {
             requireArgs(a, 1, "dss data-quality history <dataset>");
             return c.dataQuality.history(a[0], {
-                minTimestamp: num(f["min-timestamp"]),
-                maxTimestamp: num(f["max-timestamp"]),
-                resultsPerPage: num(f["results-per-page"]),
-                page: num(f["page"]),
+                minTimestamp: num(f["min-timestamp"], "--min-timestamp"),
+                maxTimestamp: num(f["max-timestamp"], "--max-timestamp"),
+                resultsPerPage: num(f["results-per-page"], "--results-per-page"),
+                page: num(f["page"], "--page"),
                 ruleId: f["rule-id"],
                 projectKey: f["project-key"],
             });
@@ -187,8 +187,8 @@ export const dataQualityCommands = {
     },
     "project-timeline": {
         handler: (c, _a, f) => c.dataQuality.projectTimeline({
-            minTimestamp: num(f["min-timestamp"]),
-            maxTimestamp: num(f["max-timestamp"]),
+            minTimestamp: num(f["min-timestamp"], "--min-timestamp"),
+            maxTimestamp: num(f["max-timestamp"], "--max-timestamp"),
             projectKey: f["project-key"],
         }),
         usage: "dss data-quality project-timeline [--min-timestamp MS] [--max-timestamp MS] [--project-key KEY]",
@@ -201,10 +201,10 @@ export const dataQualityCommands = {
             const pk = f["project-key"];
             const options = {
                 partition: f["partition"],
-                pollIntervalMs: num(f["poll-interval"]),
+                pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
                 ruleId: f["rule-id"],
                 projectKey: pk,
-                timeoutMs: num(f["timeout"]),
+                timeoutMs: num(f["timeout"], "--timeout"),
             };
             if (f["dry-run"] === true) {
                 const params = new URLSearchParams();

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

@@ -108,9 +108,9 @@ export const datasetCommands = {
         handler: (c, a, f) => {
             requireArgs(a, 1, "dss dataset preview <name>");
             return c.datasets.preview(a[0], {
-                maxRows: num(f["max-rows"]),
+                maxRows: num(f["max-rows"], "--max-rows"),
                 projectKey: f["project-key"],
-                timeoutMs: num(f["timeout"]),
+                timeoutMs: num(f["timeout"], "--timeout"),
             });
         },
         usage: "dss dataset preview <name> [--max-rows N] [--rows N] [--project-key KEY] [--timeout MS]",
@@ -132,7 +132,7 @@ export const datasetCommands = {
             const result = await c.datasets.download(a[0], {
                 outputPath: f["output"],
                 projectKey: f["project-key"],
-                limit: num(f["limit"]),
+                limit: num(f["limit"], "--limit"),
             });
             if (result.truncated) {
                 enqueueCliWarning({
@@ -166,8 +166,11 @@ export const datasetCommands = {
             const name = f["name"];
             const connection = f["connection"];
             const dsType = f["type"];
-            if (!name || !connection || !dsType) {
-                throw new UsageError("--name, --connection, and --type are required. Usage: dss dataset create --name NAME --connection CONN --type TYPE");
+            if (!name || !dsType) {
+                throw new UsageError("--name and --type are required. Usage: dss dataset create --name NAME --type TYPE [--connection CONN]");
+            }
+            if (!connection && dsType.toLowerCase() !== "uploadedfiles") {
+                throw new UsageError("--connection is required unless --type is UploadedFiles.");
             }
             const payload = {
                 datasetName: name,
@@ -198,9 +201,10 @@ export const datasetCommands = {
             const moved = await moveCreatedItemsToZone(c, f, [{ objectId: name, objectType: "DATASET", },], pk);
             return { created: name, resource: "dataset", ...moved, };
         },
-        usage: "dss dataset create --name NAME --connection CONN --type TYPE [--zone ZONE|--zone-id ID] [--if-not-exists] [--dry-run] [--project-key KEY]",
-        description: "Create a new dataset.",
+        usage: "dss dataset create --name NAME --type TYPE [--connection CONN] [--zone ZONE|--zone-id ID] [--if-not-exists] [--dry-run] [--project-key KEY]",
+        description: "Create a new dataset. UploadedFiles uses the server's default upload connection when omitted.",
         examples: [
+            "dss dataset create --name uploads --type UploadedFiles",
             "dss dataset create --name orders --connection filesystem --type Filesystem",
             "dss dataset create --name orders --connection filesystem --type Filesystem --zone Experiments --dry-run",
         ],

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

@@ -18,8 +18,8 @@ export const folderCommands = {
             const type = f["type"];
             const connection = f["connection"];
             const pk = f["project-key"];
-            if (!name || !type || !connection) {
-                throw new UsageError("--name, --type, and --connection are required. Usage: dss folder create --name NAME --type TYPE --connection CONN [--path PATH]");
+            if (!name) {
+                throw new UsageError("--name is required. Usage: dss folder create --name NAME [--type TYPE] [--connection CONN] [--path PATH]");
             }
             const payload = {
                 name,
@@ -48,9 +48,10 @@ export const folderCommands = {
             const created = await c.folders.create(payload);
             return { created: created.id ?? name, resource: "folder", ...created, };
         },
-        usage: "dss folder create --name NAME --type TYPE --connection CONN [--path PATH] [--if-not-exists] [--dry-run] [--project-key KEY]",
-        description: "Create a managed folder.",
+        usage: "dss folder create --name NAME [--type TYPE] [--connection CONN] [--path PATH] [--if-not-exists] [--dry-run] [--project-key KEY]",
+        description: "Create a managed folder; when omitted, the connection is selected from writable managed-folder storage and DSS infers the folder type.",
         examples: [
+            "dss folder create --name exports",
             "dss folder create --name exports --type S3 --connection s3_connection",
             "dss folder create --name exports --type S3 --connection s3_connection --path /dataiku/MYPROJ/exports --dry-run",
         ],

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

@@ -24,8 +24,8 @@ export const futureCommands = {
         handler: (c, a, f) => {
             requireArgs(a, 1, "dss future wait <id>");
             return c.futures.wait(a[0], {
-                pollIntervalMs: num(f["poll-interval"]),
-                timeoutMs: num(f["timeout"]),
+                pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
+                timeoutMs: num(f["timeout"], "--timeout"),
             });
         },
         usage: "dss future wait <id> [--timeout MS] [--poll-interval MS]",

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

@@ -24,6 +24,7 @@ import { mlTaskCommands, } from "./ml-task.js";
 import { modelEvaluationStoreCommands, } from "./model-evaluation-store.js";
 import { notebookCommands, } from "./notebook.js";
 import { projectDeployerCommands, } from "./project-deployer.js";
+import { projectGitCommands, } from "./project-git.js";
 import { projectLibraryCommands, } from "./project-library.js";
 import { projectCommands, } from "./project.js";
 import { recipeCommands, } from "./recipe.js";
@@ -49,6 +50,7 @@ export const commands = {
     "api-deployer": apiDeployerCommands,
     bundle: bundleCommands,
     "project-deployer": projectDeployerCommands,
+    "project-git": projectGitCommands,
     "project-library": projectLibraryCommands,
     "streaming-endpoint": streamingEndpointCommands,
     "continuous-activity": continuousActivityCommands,

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

@@ -67,7 +67,7 @@ function filteredJobList(jobs, flags) {
             return false;
         return true;
     });
-    const limit = flags["latest"] === true ? 1 : num(flags["limit"]);
+    const limit = flags["latest"] === true ? 1 : num(flags["limit"], "--limit");
     if (limit !== undefined)
         result = result.slice(0, Math.max(0, limit));
     return result;
@@ -259,9 +259,9 @@ export const jobCommands = {
             const options = {
                 buildMode: f["build-mode"],
                 partition: f["partition"],
-                pollIntervalMs: num(f["poll-interval"]),
+                pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
                 targetType: jobBuildTargetTypeFromFlags(f),
-                timeoutMs: num(f["timeout"]),
+                timeoutMs: num(f["timeout"], "--timeout"),
             };
             if (f["dry-run"] === true) {
                 return {
@@ -297,8 +297,8 @@ export const jobCommands = {
                 logFilter: jobLogFilterFromFlag(f["log-filter"]),
                 maxLogLines: maxLogLinesFromFlags(f),
                 partition: f["partition"],
-                pollIntervalMs: num(f["poll-interval"]),
-                timeoutMs: num(f["timeout"]),
+                pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
+                timeoutMs: num(f["timeout"], "--timeout"),
                 summary: f["summary"] === true,
                 targetType: jobBuildTargetTypeFromFlags(f),
             };
@@ -331,8 +331,8 @@ export const jobCommands = {
                 includeLogs: f["include-logs"] === true,
                 logFilter: jobLogFilterFromFlag(f["log-filter"]),
                 maxLogLines: maxLogLinesFromFlags(f),
-                pollIntervalMs: num(f["poll-interval"]),
-                timeoutMs: num(f["timeout"]),
+                pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
+                timeoutMs: num(f["timeout"], "--timeout"),
                 summary: f["summary"] === true,
                 projectKey: f["project-key"],
             });
@@ -351,8 +351,8 @@ export const jobCommands = {
                 includeLogs: f["include-logs"] === true,
                 logFilter: jobLogFilterFromFlag(f["log-filter"]),
                 maxLogLines: maxLogLinesFromFlags(f),
-                pollIntervalMs: num(f["poll-interval"]),
-                timeoutMs: num(f["timeout"]),
+                pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
+                timeoutMs: num(f["timeout"], "--timeout"),
                 summary: f["summary"] !== false,
                 projectKey: f["project-key"],
             };
@@ -370,8 +370,8 @@ export const jobCommands = {
                 includeLogs: f["include-logs"] === true,
                 logFilter: jobLogFilterFromFlag(f["log-filter"]),
                 maxLogLines: maxLogLinesFromFlags(f),
-                pollIntervalMs: num(f["poll-interval"]),
-                timeoutMs: num(f["timeout"]),
+                pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
+                timeoutMs: num(f["timeout"], "--timeout"),
                 summary: true,
                 projectKey: f["project-key"],
             };

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

@@ -217,7 +217,7 @@ export const notebookCommands = {
             const pk = f["project-key"];
             const options = {
                 cellId: f["cell-id"],
-                numRunsToRetain: num(f["retain"]),
+                numRunsToRetain: num(f["retain"], "--retain"),
                 projectKey: pk,
             };
             if (f["dry-run"] === true) {

package/dist/src/cli/commands/project-git.d.ts

@@ -0,0 +1,2 @@
+import type { CommandMeta } from "../types.js";
+export declare const projectGitCommands: Record<string, CommandMeta>;