dataiku-sdk 3.0.0 → 3.2.0

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

@@ -1,5 +1,17 @@
+import { ClientValidationError, } from "../../errors.js";
+import { writeResponseToFile, } from "../../utils/response-file.js";
+import { stableHash, } from "../../utils/stable-hash.js";
 import { requiredJsonInput, } from "../coerce.js";
+import { executionMode, } from "../flags.js";
 import { requireArgs, UsageError, } from "../usage.js";
+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 API service settings 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 apiServiceCommands = {
     list: {
         handler: (c, _a, f) => c.apiServices.list(f["project-key"]),
@@ -26,14 +38,42 @@ export const apiServiceCommands = {
         examples: ["dss api-service get-settings my-service",],
     },
     "save-settings": {
-        handler: (c, a, f) => {
-            requireArgs(a, 1, "dss api-service save-settings <serviceId> (--data JSON|--data-file PATH|--stdin) [--project-key KEY]");
+        handler: async (c, a, f) => {
+            const usage = "dss api-service save-settings <serviceId> (--data JSON|--data-file PATH|--stdin) [--expect-hash SHA256] [--dry-run] [--project-key KEY]";
+            requireArgs(a, 1, usage);
             const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (service settings).");
-            return c.apiServices.saveSettings(a[0], body, f["project-key"]);
+            const projectKey = f["project-key"];
+            const expectHash = validateExpectHash(f["expect-hash"]);
+            if (executionMode(f).dryRun) {
+                const current = await c.apiServices.getSettings(a[0], projectKey);
+                const currentHash = stableHash(current);
+                if (expectHash !== undefined && currentHash !== expectHash.toLowerCase()) {
+                    throw new ClientValidationError(`The API service ${JSON.stringify(a[0])} changed since it was read.`, "validation_failed", "Re-read the service settings and retry with the current hash value.", {
+                        serviceId: a[0],
+                        expectedHash: expectHash.toLowerCase(),
+                        actualHash: currentHash,
+                    });
+                }
+                return {
+                    dryRun: true,
+                    action: "save-settings",
+                    resource: "api-service",
+                    serviceId: a[0],
+                    current,
+                    next: body,
+                    currentHash,
+                    nextHash: stableHash(body),
+                    ...(expectHash !== undefined
+                        ? { expectHash: expectHash.toLowerCase(), provenanceVerified: true, }
+                        : {}),
+                };
+            }
+            const saved = await c.apiServices.saveSettings(a[0], body, projectKey, { expectHash, });
+            return { saved: a[0], ...saved, };
         },
-        usage: "dss api-service save-settings <serviceId> (--data JSON|--data-file PATH|--stdin) [--project-key KEY]",
-        description: "Save an API service's settings.",
-        examples: ["dss api-service save-settings my-service --data-file service.json",],
+        usage: "dss api-service save-settings <serviceId> (--data JSON|--data-file PATH|--stdin) [--expect-hash SHA256] [--dry-run] [--project-key KEY]",
+        description: "Replace an API service's settings wholesale (explicit replacement: the supplied object is PUT as-is, so fetch get-settings first). --expect-hash refuses the write when the stored settings changed since they were fetched; --dry-run reports current, next, and both hashes without writing.",
+        examples: ["dss api-service save-settings my-service --data-file service.json --dry-run",],
     },
     "add-prediction-endpoint": {
         handler: async (c, a, f) => {
@@ -43,7 +83,7 @@ export const apiServiceCommands = {
                 type: "STD_PREDICTION",
                 modelRef: a[2],
             };
-            if (f["dry-run"] === true)
+            if (executionMode(f).dryRun)
                 return endpoint;
             return c.apiServices.addPredictionEndpoint(a[0], a[1], a[2], f["project-key"]);
         },
@@ -75,12 +115,15 @@ export const apiServiceCommands = {
     },
     "create-package": {
         handler: (c, a, f) => {
-            requireArgs(a, 2, "dss api-service create-package <serviceId> <packageId> [--project-key KEY]");
-            return c.apiServices.createPackage(a[0], a[1], f["project-key"]);
+            requireArgs(a, 2, "dss api-service create-package <serviceId> <packageId> [--release-notes TEXT] [--project-key KEY]");
+            return c.apiServices.createPackage(a[0], a[1], f["project-key"], typeof f["release-notes"] === "string" ? { releaseNotes: f["release-notes"], } : {});
         },
-        usage: "dss api-service create-package <serviceId> <packageId> [--project-key KEY]",
-        description: "Build a deployable package from the current service state.",
-        examples: ["dss api-service create-package my-service v1",],
+        usage: "dss api-service create-package <serviceId> <packageId> [--release-notes TEXT] [--project-key KEY]",
+        description: "Build a deployable package from the current service state; --release-notes forwards the documented releaseNotes query parameter.",
+        examples: [
+            "dss api-service create-package my-service v1",
+            "dss api-service create-package my-service v1 --release-notes='Adds churn endpoint'",
+        ],
     },
     "delete-package": {
         handler: async (c, a, f) => {
@@ -102,7 +145,7 @@ export const apiServiceCommands = {
             if (!res.body) {
                 throw new Error("apiServices.downloadPackageArchive response did not include a body");
             }
-            const bytes = await Bun.write(out, new Response(res.body), { createPath: false, });
+            const bytes = await writeResponseToFile(out, res);
             return { path: out, bytes, };
         },
         usage: "dss api-service download-package <serviceId> <packageId> --output PATH [--project-key KEY]",
@@ -111,11 +154,16 @@ export const apiServiceCommands = {
     },
     "publish-package": {
         handler: (c, a, f) => {
-            requireArgs(a, 2, "dss api-service publish-package <serviceId> <packageId> [--project-key KEY]");
-            return c.apiServices.publishPackage(a[0], a[1], f["project-key"]);
+            requireArgs(a, 2, "dss api-service publish-package <serviceId> <packageId> [--published-service-id ID] [--project-key KEY]");
+            return c.apiServices.publishPackage(a[0], a[1], f["project-key"], typeof f["published-service-id"] === "string"
+                ? { publishedServiceId: f["published-service-id"], }
+                : {});
         },
-        usage: "dss api-service publish-package <serviceId> <packageId> [--project-key KEY]",
-        description: "Publish a package to the API Deployer.",
-        examples: ["dss api-service publish-package my-service v1",],
+        usage: "dss api-service publish-package <serviceId> <packageId> [--published-service-id ID] [--project-key KEY]",
+        description: "Publish a package to the API Deployer; --published-service-id forwards the documented publishedServiceId query parameter (a new published service is created when no match exists; the service's own id is the server-side default).",
+        examples: [
+            "dss api-service publish-package my-service v1",
+            "dss api-service publish-package my-service v1 --published-service-id=prod-churn",
+        ],
     },
 };

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

@@ -1,6 +1,7 @@
 import { ClientValidationError, DataikuError, } from "../../errors.js";
 import { projectIncarnationHash, } from "../../utils/project-incarnation.js";
 import { jsonInput, num, parseBooleanOption, plainRecord, requiredJsonInput, requiredStringFlag, stringField, } from "../coerce.js";
+import { executionMode, } from "../flags.js";
 import { appPermissionsHash, appPermissionsVerificationError, assertAppPermissionsSnapshotBinding, buildAppPermissionsSnapshot, diffAppPermissions, readAppPermissionsSnapshot, writeAppPermissionsSnapshot, } from "../helpers/app-permissions.js";
 import { createSuccessorInstance, futureTargetIdentity, isDefinitiveRejection, preflightSuccessorInstance, requireAbsentProjectTarget, safeErrorSummary, verifyAppInstance, VISUAL_UI_GATE, } from "../helpers/app-successor.js";
 import { CommandResultFailure, } from "../output.js";
@@ -385,7 +386,7 @@ export const appCommands = {
                 to: requiredStringFlag(f, "to", CREATE_SUCCESSOR_USAGE),
                 ...(f["name"] !== undefined ? { name: f["name"], } : {}),
                 copyPermissions: parseBooleanOption(f["copy-permissions"], "--copy-permissions") ?? false,
-                dryRun: parseBooleanOption(f["dry-run"], "--dry-run") ?? false,
+                dryRun: executionMode(f).dryRun,
                 timeoutMs: num(f["timeout"], "--timeout"),
                 pollIntervalMs: num(f["poll-interval"], "--poll-interval"),
             }, CREATE_SUCCESSOR_USAGE);
@@ -445,7 +446,7 @@ export const appCommands = {
                 ...(version !== undefined ? { version, } : {}),
                 ...(versionNotes !== undefined ? { versionNotes, } : {}),
                 ...(f["expect-hash"] !== undefined ? { expectHash: f["expect-hash"], } : {}),
-                dryRun: parseBooleanOption(f["dry-run"], "--dry-run") ?? false,
+                dryRun: executionMode(f).dryRun,
             }, f["project-key"]);
             if (result.outcome === "indeterminate") {
                 // The PUT may or may not have landed. Fail nonzero without
@@ -756,7 +757,7 @@ export const appCommands = {
             assertAppPermissionsSnapshotBinding(snapshot, projectKey, c.getBaseUrl());
             const currentProjectIncarnationHash = await requireProjectIncarnationHash(c, projectKey);
             assertAppPermissionsSnapshotBinding(snapshot, projectKey, c.getBaseUrl(), currentProjectIncarnationHash);
-            const dryRun = parseBooleanOption(f["dry-run"], "--dry-run") ?? false;
+            const dryRun = executionMode(f).dryRun;
             const before = await c.projects.getPermissions(projectKey);
             await assertProjectIncarnationHash(c, projectKey, snapshot.projectIncarnationHash);
             const beforeHash = appPermissionsHash(before);

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

@@ -1,3 +1,5 @@
+import { writeResponseToFile, } from "../../utils/response-file.js";
+import { json, parseBooleanOption, } from "../coerce.js";
 import { requireArgs, UsageError, } from "../usage.js";
 export const bundleCommands = {
     "list-exported": {
@@ -8,13 +10,24 @@ export const bundleCommands = {
     },
     export: {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss bundle export <bundleId> [--project-key KEY]");
-            await c.bundles.exportBundle(a[0], f["project-key"]);
+            const usage = "dss bundle export <bundleId> [--release-notes TEXT] [--evaluate-standards-checks true|false] [--project-key KEY]";
+            requireArgs(a, 1, usage);
+            await c.bundles.exportBundle(a[0], f["project-key"], {
+                ...(typeof f["release-notes"] === "string" ? { releaseNotes: f["release-notes"], } : {}),
+                ...(f["evaluate-standards-checks"] !== undefined
+                    ? {
+                        evaluateProjectStandardsChecks: parseBooleanOption(f["evaluate-standards-checks"], "--evaluate-standards-checks") ?? true,
+                    }
+                    : {}),
+            });
             return { exported: a[0], };
         },
-        usage: "dss bundle export <bundleId> [--project-key KEY]",
-        description: "Create (or overwrite) an exported Design-node bundle.",
-        examples: ["dss bundle export v1",],
+        usage: "dss bundle export <bundleId> [--release-notes TEXT] [--evaluate-standards-checks true|false] [--project-key KEY]",
+        description: "Create (or overwrite) an exported Design-node bundle. --release-notes forwards the documented releaseNotes parameter; --evaluate-standards-checks toggles the documented Project Standards Checks evaluation (default true).",
+        examples: [
+            "dss bundle export v1",
+            "dss bundle export v1 --release-notes='Adds churn model' --evaluate-standards-checks=false",
+        ],
     },
     "delete-exported": {
         handler: async (c, a, f) => {
@@ -36,7 +49,7 @@ export const bundleCommands = {
             if (!res.body) {
                 throw new Error("bundles.downloadExportedArchive response did not include a body");
             }
-            const bytes = await Bun.write(out, new Response(res.body), { createPath: false, });
+            const bytes = await writeResponseToFile(out, res);
             return { path: out, bytes, };
         },
         usage: "dss bundle download-exported <bundleId> --output PATH [--project-key KEY]",
@@ -45,12 +58,18 @@ export const bundleCommands = {
     },
     publish: {
         handler: (c, a, f) => {
-            requireArgs(a, 1, "dss bundle publish <bundleId> [--project-key KEY]");
-            return c.bundles.publish(a[0], f["project-key"]);
+            const usage = "dss bundle publish <bundleId> [--published-project-key KEY] [--project-key KEY]";
+            requireArgs(a, 1, usage);
+            return c.bundles.publish(a[0], f["project-key"], typeof f["published-project-key"] === "string"
+                ? { publishedProjectKey: f["published-project-key"], }
+                : {});
         },
-        usage: "dss bundle publish <bundleId> [--project-key KEY]",
-        description: "Publish a Design-node bundle to the Project Deployer.",
-        examples: ["dss bundle publish v1",],
+        usage: "dss bundle publish <bundleId> [--published-project-key KEY] [--project-key KEY]",
+        description: "Publish a Design-node bundle to the Project Deployer; --published-project-key forwards the documented publishedProjectKey query parameter (a new published project is created when no match exists; the source project's key is the server-side default).",
+        examples: [
+            "dss bundle publish v1",
+            "dss bundle publish v1 --published-project-key=PROD-CHURN",
+        ],
     },
     "list-imported": {
         handler: (c, _a, f) => c.bundles.listImported(f["project-key"]),
@@ -79,12 +98,28 @@ export const bundleCommands = {
     },
     activate: {
         handler: (c, a, f) => {
-            requireArgs(a, 1, "dss bundle activate <bundleId> [--project-key KEY]");
-            return c.bundles.activate(a[0], f["project-key"]);
+            const usage = "dss bundle activate <bundleId> [--scenarios JSON] [--project-key KEY]";
+            requireArgs(a, 1, usage);
+            const rawScenarios = f["scenarios"];
+            let scenariosToEnable;
+            if (rawScenarios !== undefined && rawScenarios !== false) {
+                const parsed = json(rawScenarios);
+                if (typeof parsed !== "object"
+                    || parsed === null
+                    || Array.isArray(parsed)
+                    || !Object.values(parsed).every((value) => typeof value === "boolean")) {
+                    throw new UsageError("--scenarios must be a JSON object mapping scenario IDs to true|false. Usage: dss bundle activate <bundleId> --scenarios '{\"daily_build\":true}'");
+                }
+                scenariosToEnable = parsed;
+            }
+            return c.bundles.activate(a[0], f["project-key"], scenariosToEnable !== undefined ? { scenariosToEnable, } : {});
         },
-        usage: "dss bundle activate <bundleId> [--project-key KEY]",
-        description: "Activate an imported Automation-node bundle.",
-        examples: ["dss bundle activate v1",],
+        usage: "dss bundle activate <bundleId> [--scenarios JSON] [--project-key KEY]",
+        description: "Activate an imported Automation-node bundle; --scenarios forwards the documented scenario-ID-to-enabled dict as the scenariosActiveOnActivation body.",
+        examples: [
+            "dss bundle activate v1",
+            'dss bundle activate v1 --scenarios=\'{"daily_build":true,"hourly_retrain":false}\'',
+        ],
     },
     preload: {
         handler: (c, a, f) => {