dataiku-sdk 3.9.0 → 4.1.0

package/README.md

@@ -16,7 +16,7 @@ Malformed user/group listings and scenario run histories fail explicitly instead
 
 ## Platform support
 
-The published `dss` CLI requires Bun >= 1.4.2 and supports Linux, macOS, and Windows. CI runs Bun 1.4.2 on all three operating systems. The runtime dependency is pure JavaScript, so the same package also runs on every Bun-supported x64 and ARM64 system.
+The published `dss` CLI requires Bun >= 1.4.3 and supports Linux, macOS, and Windows. CI runs Bun 1.4.3 on all three operating systems. The runtime dependency is pure JavaScript, so the same package also runs on every Bun-supported x64 and ARM64 system.
 
 Run directly with Bun:
 
@@ -29,7 +29,7 @@ Or install the npm binary:
 ```text
 npm install --global dataiku-sdk
 ```
-The installed `dss` bin bootstraps Bun with automatic `.env` preloading disabled, so Bun >= 1.4.2 must be on `PATH`; the CLI's own `.env` handling stays authoritative. `bunx --bun` forces Bun's Node-compatibility mode, which provides the same no-preload guarantee across operating systems.
+The installed `dss` bin bootstraps Bun with automatic `.env` preloading disabled, so Bun >= 1.4.3 must be on `PATH`; the CLI's own `.env` handling stays authoritative. `bunx --bun` forces Bun's Node-compatibility mode, which provides the same no-preload guarantee across operating systems.
 
 Bun is the only supported runtime and the package manager. Examples below assume an installed `dss` binary. From a checkout, use `bun --no-env-file src/cli.ts ...` or the packaged launcher `bun --no-env-file ./bin/dss.js ...`. From another working directory, pass the checkout's absolute `bin/dss.js` path to Bun.
 `--no-env-file` disables Bun's automatic preloading only; the CLI still applies its documented `.env` handling unless `DATAIKU_DISABLE_ENV=1` is set.
@@ -181,7 +181,7 @@ then update `tests/live-coverage.ts` when the
 registry changes; catalogue drift fails the offline gate. Plan/dry-run calls do not count
 as executed live coverage.
 
-Regular `bun run check` and `bun run lint` include the live runner and fixtures.
+Regular `bun run verify` and `bun run lint` include the live runner and fixtures.
 Lint includes project-owned rules in `tools/oxlint/index.ts`: accumulator-copy, widen-then-assert, and chained-assertion errors, alongside the native accumulating-spread check.
 For focused verification:
 
@@ -291,6 +291,7 @@ Use environment variables for ephemeral runs. For disposable agent tests, set `D
 Credential precedence is flags first, then `DATAIKU_*` environment variables, then saved credentials in `DSS_CONFIG_DIR` or the platform config directory.
 Set `DATAIKU_DISABLE_ENV=1` when a test must ignore both `.env` files and `DATAIKU_*` environment variables.
 When `.env` loading is enabled, the CLI reads `.env` from the CLI build/root directory and from the command's current working directory; put test-specific `.env` files in the directory where you invoke `dss`. Only `DATAIKU_*`, `NODE_TLS_REJECT_UNAUTHORIZED`, and `NODE_EXTRA_CA_CERTS` are read from `.env`; other keys are ignored.
+Set `DSS_PRETTY=1` to indent stdout JSON (still one JSON value). Use it when the shell or agent harness cuts long lines (omp's bash tool cuts each line at 768 bytes), so a one-line result is not truncated. It is read from the process environment only, not from `.env`.
 
 POSIX shell:
 

package/dist/build-metadata.json

@@ -1 +1 @@
-{"format":1,"buildRevision":"3f9f0582b0fa45ee3708215954761d75f6edf9b7"}
+{"format":1,"buildRevision":"88fd13012a34de8687737c530fbe86469d8e3f5d"}

package/dist/packages/types/src/index.d.ts

@@ -284,6 +284,12 @@ export declare const JobWaitResultSchema: import("@sinclair/typebox").TObject<{
     pollCount: import("@sinclair/typebox").TNumber;
     success: import("@sinclair/typebox").TBoolean;
     timedOut: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    /** Present on a wait timeout: the wait never cancels the job, so this is `false`. */
+    cancelled: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+    /** CLI only, on a wait timeout: POSIX display form of the command that resumes waiting for the still-running job. */
+    resume: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    /** CLI only, on a wait timeout: the resume command as argv, runnable without a shell on any OS. */
+    resumeArgv: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
     progress: import("@sinclair/typebox").TObject<{
         done: import("@sinclair/typebox").TNumber;
         failed: import("@sinclair/typebox").TNumber;

package/dist/packages/types/src/index.js

@@ -308,6 +308,12 @@ export const JobWaitResultSchema = Type.Object({
     pollCount: Type.Number(),
     success: Type.Boolean(),
     timedOut: Type.Optional(Type.Boolean()),
+    /** Present on a wait timeout: the wait never cancels the job, so this is `false`. */
+    cancelled: Type.Optional(Type.Boolean()),
+    /** CLI only, on a wait timeout: POSIX display form of the command that resumes waiting for the still-running job. */
+    resume: Type.Optional(Type.String()),
+    /** CLI only, on a wait timeout: the resume command as argv, runnable without a shell on any OS. */
+    resumeArgv: Type.Optional(Type.Array(Type.String())),
     progress: Type.Object({
         done: Type.Number(),
         failed: Type.Number(),

package/dist/src/cli/coerce.d.ts

@@ -21,6 +21,12 @@ export declare function parseJsonObject(text: string, source: string): Record<st
 export declare function json(v: string | boolean | undefined, source?: string): Record<string, unknown> | undefined;
 export declare function readStdinText(): string;
 export declare function readInputText(path: string, flag: string): string;
+/**
+ * Async UTF-8 read of a user-supplied path (BOM kept, like `readFileSync`).
+ * Stays on node:fs: Bun 1.4.3 `Bun.file(path)` reads of a missing path ended the
+ * process on Windows CI instead of rejecting with ENOENT.
+ */
+export declare function readTextFile(path: string): Promise<string>;
 export declare function seenJsonInputCredentials(): readonly string[];
 export declare function jsonInput(flags: Record<string, string | boolean>): Record<string, unknown> | undefined;
 export declare function unknownJsonInput(flags: Record<string, string | boolean>): unknown;

package/dist/src/cli/coerce.js

@@ -1,4 +1,5 @@
 import { readFileSync, } from "node:fs";
+import { readFile, } from "node:fs/promises";
 import { credentialValues, } from "../utils/secret-sanitize.js";
 import { UsageError, } from "./usage.js";
 function safeValuePreview(value) {
@@ -174,6 +175,14 @@ export function readInputText(path, flag) {
         throw new UsageError(`Could not read ${flag} file: ${path}`, "validation_failed", "Verify that the path names an existing, readable file.", { flag, path, ...(cause ? { cause, } : {}), });
     }
 }
+/**
+ * Async UTF-8 read of a user-supplied path (BOM kept, like `readFileSync`).
+ * Stays on node:fs: Bun 1.4.3 `Bun.file(path)` reads of a missing path ended the
+ * process on Windows CI instead of rejecting with ENOENT.
+ */
+export async function readTextFile(path) {
+    return readFile(path, "utf-8");
+}
 /**
  * Credential values seen in this process's JSON inputs. DSS error text can
  * echo the request payload, so error reports redact these.

package/dist/src/cli/command-syntax.json

@@ -87,6 +87,15 @@
             {
                 "arg": "analysisId"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -1699,6 +1708,15 @@
             "get",
             {
                 "arg": "id"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "business-app.install-from-archive": [
@@ -1956,6 +1974,15 @@
             },
             {
                 "arg": "name"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "code-env.get-definition": [
@@ -3106,6 +3133,15 @@
             {
                 "arg": "id"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -3320,6 +3356,15 @@
             "get",
             {
                 "arg": "dataCollectionId"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "data-collection.list": [
@@ -5033,6 +5078,15 @@
             {
                 "arg": "discussionId"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -5373,6 +5427,15 @@
             {
                 "arg": "id"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -6092,6 +6155,15 @@
             {
                 "arg": "name-or-id"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -6409,6 +6481,15 @@
             "get",
             {
                 "arg": "name"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "group.list": [
@@ -6634,6 +6715,15 @@
             {
                 "arg": "id"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -7900,6 +7990,15 @@
             {
                 "arg": "macro_id"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -8209,6 +8308,15 @@
             "get",
             {
                 "arg": "meaningId"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "meaning.list": [
@@ -9758,6 +9866,15 @@
             {
                 "arg": "storeId"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -11627,6 +11744,15 @@
             "get",
             {
                 "arg": "folderId"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "project-folder.move": [
@@ -13940,6 +14066,15 @@
                     ]
                 ]
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -15058,6 +15193,15 @@
             {
                 "arg": "modelId"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -15612,6 +15756,15 @@
             {
                 "arg": "id"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -15633,6 +15786,15 @@
             {
                 "arg": "runId"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -15661,6 +15823,15 @@
                     ]
                 ]
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -16525,6 +16696,15 @@
             {
                 "arg": "id"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -16784,6 +16964,15 @@
             "get",
             {
                 "arg": "login"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "user.list": [
@@ -16941,6 +17130,15 @@
             "dss",
             "variable",
             "get",
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -17446,6 +17644,15 @@
             {
                 "arg": "id-or-name"
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -17697,6 +17904,15 @@
             "get",
             {
                 "arg": "workspaceKey"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "full"
+                        }
+                    ]
+                ]
             }
         ],
         "workspace.list": [

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

@@ -754,7 +754,7 @@ export const appCommands = withUsage("app", {
             const usage = commandUsage("app", "permissions-diff");
             requireNoArgs(_a, usage);
             const file = requiredStringFlag(f, "file", usage);
-            const snapshot = readAppPermissionsSnapshot(file);
+            const snapshot = await readAppPermissionsSnapshot(file);
             const projectKey = c.resolveProjectKey(f["project-key"]);
             assertAppPermissionsSnapshotBinding(snapshot, projectKey, c.getBaseUrl());
             const currentProjectIncarnationHash = await requireProjectIncarnationHash(c, projectKey);
@@ -779,7 +779,7 @@ export const appCommands = withUsage("app", {
             const usage = commandUsage("app", "permissions-restore");
             requireNoArgs(_a, usage);
             const file = requiredStringFlag(f, "file", usage);
-            const snapshot = readAppPermissionsSnapshot(file);
+            const snapshot = await readAppPermissionsSnapshot(file);
             const projectKey = c.resolveProjectKey(f["project-key"]);
             assertAppPermissionsSnapshotBinding(snapshot, projectKey, c.getBaseUrl());
             const currentProjectIncarnationHash = await requireProjectIncarnationHash(c, projectKey);

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

@@ -1,7 +1,6 @@
-import { readFileSync, writeFileSync, } from "node:fs";
 import { ClientValidationError, } from "../../errors.js";
 import { SHA256_HEX_PATTERN, stableHash, } from "../../utils/stable-hash.js";
-import { json, jsonInput, num, numFlag, parseBooleanOption, } from "../coerce.js";
+import { json, jsonInput, num, numFlag, parseBooleanOption, readTextFile, } from "../coerce.js";
 import { executionMode, } from "../flags.js";
 import { enqueueCliWarning, isNotFoundError, readIfExists, skipResult, } from "../output.js";
 import { commandUsage, withUsage, } from "../syntax.js";
@@ -49,9 +48,9 @@ function splitPackageSpec(raw) {
  * (set-packages replaces specPackageList wholesale); only a call with no
  * package source flag at all is a usage error.
  */
-function codeEnvPackageList(flags) {
+async function codeEnvPackageList(flags) {
     const file = flags["file"];
-    const packages = typeof file === "string" ? splitPackageSpec(readFileSync(file, "utf-8")) : [];
+    const packages = typeof file === "string" ? splitPackageSpec(await readTextFile(file)) : [];
     if (typeof flags["packages"] === "string") {
         packages.push(...splitPackageSpec(flags["packages"]));
     }
@@ -80,13 +79,15 @@ export const codeEnvCommands = withUsage("code-env", {
         examples: ["dss code-env list", "dss code-env list --lang PYTHON",],
     },
     get: {
-        handler: (c, a) => {
+        handler: (c, a, f) => {
             const usage = commandUsage("code-env", "get");
             requireArgs(a, 2, usage);
             const envLang = requireEnvLang(a[0], usage);
-            return c.codeEnvs.get(envLang, a[1]);
+            return f["full"] === true
+                ? c.codeEnvs.getDefinition(envLang, a[1])
+                : c.codeEnvs.get(envLang, a[1]);
         },
-        description: "Get code environment details: requested vs installed packages, Python interpreter, deployment mode, and the stable definition hash (definitionHash) used by set-definition --expect-hash.",
+        description: "Get code environment details: requested vs installed packages, Python interpreter, deployment mode, and the stable definition hash (definitionHash) used by set-definition --expect-hash. --full returns the raw DSS definition (same as get-definition).",
         examples: ["dss code-env get PYTHON my_env",],
     },
     "get-definition": {
@@ -122,7 +123,7 @@ export const codeEnvCommands = withUsage("code-env", {
             });
             const output = f["output"];
             if (typeof output === "string" && output.trim().length > 0) {
-                writeFileSync(output, result.log, "utf-8");
+                await Bun.write(output, result.log);
                 if (result.truncated || result.tailed) {
                     const limits = [
                         result.tailed ? `tail limited to ${maxLines ?? 500} lines` : undefined,
@@ -257,7 +258,7 @@ export const codeEnvCommands = withUsage("code-env", {
             const usage = commandUsage("code-env", "set-packages");
             requireArgs(a, 2, usage);
             const envLang = requireEnvLang(a[0], usage);
-            const packages = codeEnvPackageList(f);
+            const packages = await codeEnvPackageList(f);
             const installCorePackages = parseBooleanOption(f["install-core-packages"], "--install-core-packages");
             const expectHash = validateExpectHash(f["expect-hash"]);
             if (executionMode(f).dryRun) {

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

@@ -115,19 +115,33 @@ export const codeCommands = withUsage("code", {
                 maxLogBytes: run.maxLogBytes,
                 cleanup: run.cleanup,
                 ...(run.timedOut === true ? { timedOut: true, timeoutMs: run.timeoutMs, } : {}),
+                ...(run.outputTruncated === true ? { outputTruncated: true, } : {}),
+                ...(run.outputOmittedBytes !== undefined
+                    ? { outputOmittedBytes: run.outputOmittedBytes, }
+                    : {}),
             };
             if (f["full-log"] === true || run.output === undefined) {
                 result.log = run.log;
             }
+            if (run.outputTruncated === true) {
+                enqueueCliWarning({
+                    code: "code_run_output_truncated",
+                    hint: run.outputOmittedBytes !== undefined
+                        ? `Script output exceeded the capture budget; the first ${run.outputOmittedBytes} bytes were dropped and \`output\` holds the last part. Raise --max-log-bytes (the budget is a quarter of it) or print less.`
+                        : "The run log exceeded --max-log-bytes, so the start of the script output was cut and `output` holds the last part. Raise --max-log-bytes or print less.",
+                    ...(run.outputOmittedBytes !== undefined ? { omittedBytes: run.outputOmittedBytes, } : {}),
+                    maxLogBytes: run.maxLogBytes,
+                });
+            }
             if (run.cleanup.status === "failed") {
                 reportCleanupFailure({ scenarioId: run.scenarioId, error: run.cleanup.error ?? "unknown", });
             }
             return result;
         },
-        description: "Run Python through a throwaway custom-python scenario and return captured output plus outcome. --timeout caps waiting; --max-log-bytes caps logs; --full-log returns the capped raw log. Exits 4 unless outcome is SUCCESS.",
+        description: "Run Python through a throwaway custom-python scenario and return captured output plus outcome. --timeout caps waiting; --max-log-bytes caps the log tail read (script output keeps its last quarter; a code_run_output_truncated warning reports cuts); --full-log returns the capped raw log. Exits 4 unless outcome is SUCCESS.",
         examples: [
             "dss code run --file inspect.py",
-            "dss code run --file inspect.py --env py39_pandas",
+            "dss code run --file inspect.py --env py311_pandas",
             "cat snippet.py | dss code run --stdin",
             "dss code run --file inspect.py --full-log",
         ],

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

@@ -1,4 +1,3 @@
-import * as fs from "node:fs";
 import { ClientValidationError, } from "../../errors.js";
 import { deepMerge, } from "../../utils/deep-merge.js";
 import { jsonInput, parseBooleanOption, } from "../coerce.js";
@@ -73,7 +72,7 @@ export const dashboardCommands = withUsage("dashboard", {
             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);
+            await Bun.write(outputPath, bytes);
             return {
                 path: outputPath,
                 bytes: bytes.length,

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

@@ -225,11 +225,13 @@ export const datasetCommands = withUsage("dataset", {
         handler: async (c, a, f) => {
             const previewUsage = commandUsage("dataset", "preview");
             requireArgs(a, 1, previewUsage);
-            const maxRows = num(f["max-rows"], "--max-rows");
-            if (maxRows !== undefined && (!Number.isSafeInteger(maxRows) || maxRows <= 0 || maxRows > 500)) {
-                throw new UsageError(`--max-rows must be a positive integer no greater than 500 (got "${String(f["max-rows"])}"). `
-                    + `Usage: ${previewUsage}`, "validation_failed");
+            const requestedRows = num(f["max-rows"], "--max-rows");
+            if (requestedRows !== undefined && (!Number.isSafeInteger(requestedRows) || requestedRows <= 0)) {
+                throw new UsageError(`--max-rows must be a positive integer (got "${String(f["max-rows"])}"). Usage: ${previewUsage}`, "validation_failed");
             }
+            // Agents ask for "all rows" with a large number; serve the 500-row public
+            // maximum instead of failing, and let the truncation warning say if more exist.
+            const maxRows = requestedRows === undefined ? undefined : Math.min(requestedRows, 500);
             const result = await c.datasets.preview(a[0], {
                 maxRows,
                 projectKey: f["project-key"],

package/dist/src/cli/commands/flow-zone.js

@@ -275,7 +275,7 @@ export const flowZoneCommands = withUsage("flow-zone", {
         handler: async (c, _a, f) => {
             const usage = commandUsage("flow-zone", "organize");
             const pk = f["project-key"];
-            const parsed = readFlowZoneOrganizePlan(f, usage);
+            const parsed = await readFlowZoneOrganizePlan(f, usage);
             const sync = f["sync"] === true;
             const validateObjects = f["validate-objects"] === true;
             const recreateOnMove = f["recreate-on-move"] === true;