dataiku-sdk 3.0.0 → 3.1.0

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

@@ -1,18 +1,42 @@
 import { readFileSync, } from "node:fs";
-import { mkdir, writeFile, } from "node:fs/promises";
+import { writeFile, } from "node:fs/promises";
 import { join, } from "node:path";
 import { deepMerge, } from "../../utils/deep-merge.js";
 import { jobLogFilterFromFlag, jsonInput, maxLogLinesFromFlags, normalizeLineEndings, num, recipeInputDatasetsFromFlags, requiredStringFlag, rewritePairsFromFlags, sha256Hex, splitCsvFlag, stableHash, } from "../coerce.js";
 import { moveCreatedItemsToZone, resolveFlowZoneIdFromFlags, } from "../helpers/flow-zone.js";
-import { readRecipeBackup, recipeBackupDocument, recipeBackupPath, recipeCodeEnv, recipeGraph, recipeInputItemRef, recipeRoleInputItems, recipeRunShouldWait, } from "../helpers/recipe.js";
+import { ensureRecipeBackupDir, readRecipeBackup, recipeBackupDocument, recipeBackupPath, recipeCodeEnv, recipeGraph, recipeInputItemRef, recipeRoleInputItems, recipeRunShouldWait, writeRecipeBackup, } from "../helpers/recipe.js";
 import { encodedProjectEndpoint, readIfExists, skipResult, } from "../output.js";
 import { requireArgs, UsageError, } from "../usage.js";
+/** Read a local recipe file before any DSS request, mapping read failures to usage validation. */
+function readRecipeFile(filePath, flagName) {
+    try {
+        return readFileSync(filePath, "utf-8");
+    }
+    catch (error) {
+        const reason = error instanceof Error ? error.message : String(error);
+        throw new UsageError(`Could not read ${flagName} ${filePath}: ${reason}.`, "not_found", "Verify the file path and that it is readable.");
+    }
+}
+/** Read a set-payload backup file before any DSS request, mapping read failures to usage validation. */
+function readRecipeBackupFile(backupPath) {
+    try {
+        return readRecipeBackup(backupPath);
+    }
+    catch (error) {
+        const reason = error instanceof Error ? error.message : String(error);
+        throw new UsageError(`Could not read --backup ${backupPath}: ${reason}.`, "not_found", "Verify the backup file path and that it is readable.");
+    }
+}
 function formatLineDiff(remoteName, localPath, remoteContent, localContent) {
-    if (localContent === remoteContent) {
+    // Line-ending differences are not content differences: compare and split on
+    // CRLF-normalized text, mirroring assert-unchanged's normalized payload hash.
+    const normalizedLocal = normalizeLineEndings(localContent);
+    const normalizedRemote = normalizeLineEndings(remoteContent);
+    if (normalizedLocal === normalizedRemote) {
         return "No differences.";
     }
-    const localLines = localContent.split("\n");
-    const remoteLines = remoteContent.split("\n");
+    const localLines = normalizedLocal.split("\n");
+    const remoteLines = normalizedRemote.split("\n");
     const lines = [`--- remote:${remoteName}`, `+++ local:${localPath}`, "",];
     const maxLen = Math.max(localLines.length, remoteLines.length);
     for (let i = 0; i < maxLen; i++) {
@@ -104,7 +128,7 @@ export const recipeCommands = {
             return c.recipes.run(a[0], options);
         },
         usage: "dss recipe run <name> [--wait|--no-wait] [--build-mode MODE] [--include-logs] [--log-filter stdout|stderr|user|errors] [--summary] [--max-log-lines N] [--timeout MS] [--poll-interval MS] [--partition PARTITION] [--dry-run] [--project-key KEY]",
-        description: "Run a recipe by resolving its outputs and submitting the correct dataset or managed-folder build job.",
+        description: "Run a recipe by resolving its outputs and submitting the correct dataset or managed-folder build job. --timeout defaults to 120000 ms and --poll-interval to 2000 ms.",
         examples: [
             "dss recipe run compute_orders --wait",
             "dss recipe run compute_exports --include-logs --log-filter stdout --summary --timeout 600000",
@@ -344,6 +368,8 @@ export const recipeCommands = {
             if (!filePath) {
                 throw new UsageError("--file is required. Usage: dss recipe diff <name> --file PATH");
             }
+            // Read and validate the local file before any DSS request.
+            const localContent = readRecipeFile(filePath, "--file");
             const result = await c.recipes.get(a[0], {
                 includePayload: true,
                 projectKey: f["project-key"],
@@ -351,7 +377,6 @@ export const recipeCommands = {
             if (!result.payload) {
                 throw new Error(`Recipe "${a[0]}" has no code payload to diff.`);
             }
-            const localContent = readFileSync(filePath, "utf-8");
             return formatLineDiff(a[0], filePath, result.payload, localContent);
         },
         usage: "dss recipe diff <name> --file PATH [--project-key KEY]",
@@ -506,7 +531,7 @@ export const recipeCommands = {
             const filePath = f["file"];
             if (!filePath)
                 throw new UsageError("--file is required.");
-            const content = readFileSync(filePath, "utf-8");
+            const content = readRecipeFile(filePath, "--file");
             const pk = f["project-key"];
             const shouldBackup = f["no-backup"] !== true;
             const backupDir = shouldBackup
@@ -530,8 +555,8 @@ export const recipeCommands = {
                 };
             }
             if (backupDir && backupPath) {
-                await mkdir(backupDir, { recursive: true, });
-                await writeFile(backupPath, `${JSON.stringify(recipeBackupDocument(a[0], pk, current), null, 2)}\n`, "utf-8");
+                ensureRecipeBackupDir(backupDir);
+                writeRecipeBackup(backupPath, `${JSON.stringify(recipeBackupDocument(a[0], pk, current), null, 2)}\n`);
             }
             await c.recipes.replace(a[0], { ...current, payload: content, }, pk);
             return {
@@ -555,7 +580,7 @@ export const recipeCommands = {
             const usage = "dss recipe restore <name> --backup FILE [--payload-only] [--dry-run] [--project-key KEY]";
             requireArgs(a, 1, usage);
             const backupPath = requiredStringFlag(f, "backup", usage);
-            const backup = readRecipeBackup(backupPath);
+            const backup = readRecipeBackupFile(backupPath);
             const payload = typeof backup.payload === "string" ? backup.payload : "";
             const pk = f["project-key"];
             const current = await c.recipes.get(a[0], { includePayload: true, projectKey: pk, });
@@ -598,7 +623,7 @@ export const recipeCommands = {
             const usage = "dss recipe assert-unchanged <name> --since BACKUP [--project-key KEY]";
             requireArgs(a, 1, usage);
             const backupPath = requiredStringFlag(f, "since", usage);
-            const backup = readRecipeBackup(backupPath);
+            const backup = readRecipeBackupFile(backupPath);
             const current = await c.recipes.get(a[0], {
                 includePayload: true,
                 projectKey: f["project-key"],

package/dist/src/cli/commands/sql.d.ts

@@ -1,2 +1,12 @@
 import type { CommandMeta } from "../types.js";
+export declare function resolveSqlInput(args: string[], flags: Record<string, string | boolean>): string;
+export interface SqlQueryInvocation {
+    query: string;
+    connection?: string;
+    datasetFullName?: string;
+    database?: string;
+    projectKey?: string;
+    type: "sql";
+}
+export declare function resolveSqlQueryInvocation(args: string[], flags: Record<string, string | boolean>, projectKeyOverride?: string): SqlQueryInvocation;
 export declare const sqlCommands: Record<string, CommandMeta>;

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

@@ -2,6 +2,7 @@ import { readFileSync, } from "node:fs";
 import { mkdir, writeFile, } from "node:fs/promises";
 import { dirname, resolve, } from "node:path";
 import { readStdinText, stripUtf8Bom, } from "../coerce.js";
+import { enqueueCliWarning, } from "../output.js";
 import { UsageError, } from "../usage.js";
 const SQL_QUERY_USAGE = "dss sql query (SQL | --sql QUERY | --sql-file PATH | --sql - | --stdin) (--connection CONN | --dataset FULL_NAME) [--database DB] [--output PATH|--output-file PATH] [--preview N] [--start-retries N] [--request-timeout MS] [--project-key KEY]";
 const DEFAULT_SQL_PREVIEW_ROWS = 5;
@@ -34,7 +35,7 @@ function parseSqlStartRetries(value) {
     }
     return parsed;
 }
-function resolveSqlInput(args, flags) {
+export function resolveSqlInput(args, flags) {
     const sources = [];
     if (typeof flags["sql"] === "string") {
         sources.push({
@@ -69,34 +70,55 @@ function resolveSqlInput(args, flags) {
     }
     return query;
 }
+export function resolveSqlQueryInvocation(args, flags, projectKeyOverride) {
+    const connection = flags["connection"];
+    const datasetFullName = flags["dataset"];
+    if ((connection ? 1 : 0) + (datasetFullName ? 1 : 0) !== 1) {
+        throw new UsageError(`Pass exactly one of --connection or --dataset. Usage: ${SQL_QUERY_USAGE}`);
+    }
+    return {
+        query: resolveSqlInput(args, flags),
+        connection,
+        datasetFullName,
+        database: flags["database"],
+        projectKey: projectKeyOverride ?? flags["project-key"],
+        type: "sql",
+    };
+}
 export const sqlCommands = {
     query: {
         handler: async (c, a, f) => {
-            const connection = f["connection"];
-            const datasetFullName = f["dataset"];
-            if ((connection ? 1 : 0) + (datasetFullName ? 1 : 0) !== 1) {
-                throw new UsageError(`Pass exactly one of --connection or --dataset. Usage: ${SQL_QUERY_USAGE}`);
-            }
             const outputFile = f["output"]
                 ?? f["output-file"];
             const previewProvided = f["preview"] !== undefined;
-            if (previewProvided && !outputFile) {
-                throw new UsageError(`--preview requires --output or --output-file. Usage: ${SQL_QUERY_USAGE}`, "validation_failed");
-            }
             const previewCount = previewProvided
                 ? parseSqlPreviewCount(f["preview"])
                 : DEFAULT_SQL_PREVIEW_ROWS;
-            const query = resolveSqlInput(a, f);
             const result = await c.sql.query({
-                query,
-                connection,
-                datasetFullName,
-                database: f["database"],
-                projectKey: f["project-key"],
+                ...resolveSqlQueryInvocation(a, f),
                 retryMaxAttempts: parseSqlStartRetries(f["start-retries"]),
             });
-            if (!outputFile)
+            if (!outputFile && !previewProvided)
                 return result;
+            if (!outputFile) {
+                const truncated = result.rows.length > previewCount;
+                if (truncated) {
+                    enqueueCliWarning({
+                        code: "sql_preview_truncated",
+                        rowCount: result.rows.length,
+                        previewRows: previewCount,
+                        hint: "Use --output PATH to write the full result without placing it on stdout.",
+                    });
+                }
+                return {
+                    queryId: result.queryId,
+                    schema: result.schema,
+                    columns: result.columns ?? result.schema,
+                    rowCount: result.rows.length,
+                    preview: result.rows.slice(0, previewCount),
+                    truncated,
+                };
+            }
             const outputPath = resolve(outputFile);
             await mkdir(dirname(outputPath), { recursive: true, });
             await writeFile(outputPath, `${JSON.stringify(result, null, 2)}\n`, "utf-8");
@@ -111,7 +133,7 @@ export const sqlCommands = {
             };
         },
         usage: SQL_QUERY_USAGE,
-        description: "Run a SQL query against a DSS connection or dataset. --start-retries may execute the SQL more than once; use it only when repetition is safe.",
+        description: "Run potentially mutating SQL against a DSS connection or dataset. Use --preview N for bounded stdout or --output PATH for full rows. --start-retries may execute SQL more than once; use it only when repetition is safe.",
         examples: [
             "dss sql query 'SELECT * FROM orders LIMIT 10' --connection my_pg",
             "dss sql query --sql-file query.sql --connection my_pg",

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

@@ -1,5 +1,18 @@
-import { requiredJsonInput, } from "../coerce.js";
+import { ClientValidationError, } from "../../errors.js";
+import { deepMerge, } from "../../utils/deep-merge.js";
+import { stableHash, } from "../../utils/stable-hash.js";
+import { num, requiredJsonInput, } from "../coerce.js";
 import { requireArgs, } from "../usage.js";
+const UPDATE_SETTINGS_USAGE = "dss webapp update-settings <webappId> (--data JSON|--data-file PATH|--stdin) [--expect-hash SHA256] [--dry-run] [--project-key KEY]";
+const RESTART_USAGE = "dss webapp restart-backend <webappId> [--wait] [--timeout MS] [--poll-interval MS] [--project-key KEY]";
+function validateExpectHash(value) {
+    if (value === undefined || value === false)
+        return undefined;
+    if (typeof value !== "string" || !/^[0-9a-fA-F]{64}$/.test(value)) {
+        throw new ClientValidationError("Expected webapp hash must be a 64-character SHA-256 hex digest.", "validation_failed", "Run this update with --dry-run and capture currentHash before retrying.");
+    }
+    return value;
+}
 export const webappCommands = {
     list: {
         handler: (c, _a, f) => c.webapps.list(f["project-key"]),
@@ -26,14 +39,45 @@ export const webappCommands = {
         examples: ["dss webapp create --data-file webapp.json",],
     },
     "update-settings": {
-        handler: (c, a, f) => {
-            requireArgs(a, 1, "dss webapp update-settings <webappId> (--data JSON|--data-file PATH|--stdin) [--project-key KEY]");
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, UPDATE_SETTINGS_USAGE);
             const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (webapp settings).");
-            return c.webapps.updateSettings(a[0], body, f["project-key"]);
+            const projectKey = f["project-key"];
+            const expectHash = validateExpectHash(f["expect-hash"]);
+            if (f["dry-run"] === true) {
+                const current = await c.webapps.getSettings(a[0], projectKey);
+                const currentHash = stableHash(current);
+                if (expectHash !== undefined && currentHash !== expectHash.toLowerCase()) {
+                    throw new ClientValidationError(`The webapp ${JSON.stringify(a[0])} changed since it was read.`, "validation_failed", "Re-read the webapp settings and retry with the current hash value.", {
+                        id: a[0],
+                        expectedHash: expectHash.toLowerCase(),
+                        actualHash: currentHash,
+                    });
+                }
+                const next = deepMerge(current, body);
+                return {
+                    dryRun: true,
+                    action: "update-settings",
+                    resource: "webapp",
+                    id: a[0],
+                    current,
+                    next,
+                    currentHash,
+                    nextHash: stableHash(next),
+                    ...(expectHash !== undefined
+                        ? { expectHash: expectHash.toLowerCase(), provenanceVerified: true, }
+                        : {}),
+                };
+            }
+            const updated = await c.webapps.updateSettings(a[0], body, projectKey, { expectHash, });
+            return { updated: a[0], ...updated, };
         },
-        usage: "dss webapp update-settings <webappId> (--data JSON|--data-file PATH|--stdin) [--project-key KEY]",
-        description: "Replace a webapp's settings.",
-        examples: ["dss webapp update-settings WEBAPP_ID --data-file webapp.json",],
+        usage: UPDATE_SETTINGS_USAGE,
+        description: "Merge supplied fields into a webapp's settings (GET-merge-PUT) and PUT the full object, so fields outside the patch are never dropped. --expect-hash refuses the write when the object changed since it was fetched; --dry-run reports current, next, and both hashes without writing.",
+        examples: [
+            "dss webapp update-settings WEBAPP_ID --data-file webapp.json",
+            'dss webapp update-settings WEBAPP_ID --dry-run --data=\'{"params":{"designOptions":{"namingRule":"x"}}}\'',
+        ],
     },
     "stop-backend": {
         handler: async (c, a, f) => {
@@ -47,13 +91,23 @@ export const webappCommands = {
     },
     "restart-backend": {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss webapp restart-backend <webappId> [--project-key KEY]");
-            await c.webapps.startOrRestartBackend(a[0], f["project-key"]);
-            return { restarted: true, };
+            requireArgs(a, 1, RESTART_USAGE);
+            const projectKey = f["project-key"];
+            if (f["wait"] === true) {
+                return c.webapps.restartBackendAndWait(a[0], projectKey, {
+                    pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
+                    timeoutMs: num(f["timeout"], "--timeout"),
+                });
+            }
+            const future = await c.webapps.startOrRestartBackend(a[0], projectKey);
+            return { restarted: true, future, };
         },
-        usage: "dss webapp restart-backend <webappId> [--project-key KEY]",
-        description: "Start or restart a webapp's backend.",
-        examples: ["dss webapp restart-backend WEBAPP_ID",],
+        usage: RESTART_USAGE,
+        description: "Start or restart a webapp's backend. The documented endpoint returns a restart future; --wait settles it and returns the FutureWaitResult.",
+        examples: [
+            "dss webapp restart-backend WEBAPP_ID",
+            "dss webapp restart-backend WEBAPP_ID --wait --timeout=60000",
+        ],
     },
     "backend-state": {
         handler: (c, a, f) => {

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

@@ -32,6 +32,17 @@ export type CommandFlagMetadata = {
     aliases?: string[];
     allowEmptyValue?: boolean;
 };
+export interface CommandPositionalMetadata {
+    name: string;
+    required: boolean;
+}
+export interface CommandRequiredInputAlternative {
+    flags?: string[];
+    positionals?: string[];
+}
+export interface CommandRequiredInputGroup {
+    oneOf: CommandRequiredInputAlternative[];
+}
 export interface CommandStructuredExample {
     shell: string;
     argv?: string[];
@@ -57,6 +68,7 @@ export interface CommandRegistryEntry {
     structuredExamples: CommandStructuredExample[];
     flags: CommandFlagMetadata[];
     positionals: string[];
+    positionalArguments: CommandPositionalMetadata[];
     sideEffect: CommandSideEffect;
     requiresAuth: boolean;
     requiresProject: boolean;
@@ -70,6 +82,7 @@ export interface CommandRegistryEntry {
     dryRun: boolean;
     requiredFlags: string[];
     requiredOneOf?: CommandFlagChoice[];
+    requiredInputGroups?: CommandRequiredInputGroup[];
     optionalFlags: string[];
     payloadSchema?: CommandPayloadSchema;
     schemas: CommandAgentSchemas;
@@ -96,10 +109,12 @@ export declare function commandActionSummary(registry: Record<string, Record<str
 export declare function buildAgentContract(): Record<string, unknown>;
 export declare function commandPlanShape(resource: string, action: string, args: string[], flags: Record<string, string | boolean>, entry: CommandRegistryEntry, projectKey: string | undefined): {
     endpoint?: string;
+    exact?: boolean;
     identifiers?: Record<string, unknown>;
     method?: string;
     payload?: unknown;
     localWrites?: unknown;
+    reason?: string;
     wait?: unknown;
     requests?: unknown;
 };