dataiku-sdk 3.8.0 → 3.9.0

package/dist/src/cli/result-shapes.js

@@ -0,0 +1,235 @@
+/**
+ * Compact default results of the four large read commands (`job get`,
+ * `dataset info`, `dataset get`, `project get`), plus the single dispatch
+ * point for compacting command results (`shapeCommandResult`).
+ *
+ * The SDK resources keep returning the raw DSS objects; only the CLI compacts.
+ * `--full` returns the DSS object unchanged, and `--fields` projects DSS paths
+ * out of it (exactly like the compact `*.list` shapes in list-output.ts).
+ *
+ * Imports no schema graph: the discovery schemas below are plain data.
+ */
+import { isRecord, } from "../utils/records.js";
+import { shapeListResult, } from "./list-output.js";
+import { DATASET_GET_DROPPED_KEYS, PROJECT_GET_DROPPED_KEYS, } from "./read-shapes.js";
+function record(value) {
+    return isRecord(value) ? value : {};
+}
+function nonEmptyString(value) {
+    return typeof value === "string" && value.length > 0 ? value : undefined;
+}
+/** Drop `undefined` members so absent optional fields are omitted, never null. */
+function defined(fields) {
+    return Object.fromEntries(Object.entries(fields).filter(([, value,]) => value !== undefined));
+}
+/** `{ type, message }` of a DSS error object (`error`, `firstFailure`); undefined when empty. */
+function errorSummary(value) {
+    if (!isRecord(value))
+        return undefined;
+    const shaped = defined({
+        type: nonEmptyString(value["errorType"]),
+        message: nonEmptyString(value["detailedMessage"]) ?? nonEmptyString(value["message"]),
+    });
+    return Object.keys(shaped).length > 0 ? shaped : undefined;
+}
+/**
+ * Output id/project of a job output across DSS shapes: `targetDataset` +
+ * `targetDatasetProjectKey`, `targetManagedFolder`, `targetSavedModel`, ...
+ * and the plain `{ id, projectKey }` form.
+ */
+function outputTarget(output) {
+    const targetKey = Object.keys(output).find((key) => /^target[A-Z]/.test(key) && !key.endsWith("ProjectKey") && key !== "targetPartition"
+        && typeof output[key] === "string");
+    return {
+        id: targetKey === undefined ? output["id"] : output[targetKey],
+        projectKey: targetKey === undefined ? output["projectKey"] : output[`${targetKey}ProjectKey`],
+    };
+}
+function shapeJobOutput(output, jobProjectKey) {
+    const fields = record(output);
+    const { id, projectKey, } = outputTarget(fields);
+    const partition = fields["targetPartition"] ?? fields["partition"];
+    return defined({
+        type: fields["type"],
+        id,
+        projectKey: typeof projectKey === "string" && projectKey !== jobProjectKey
+            ? projectKey
+            : undefined,
+        partition: typeof partition === "string" && partition !== "NP" ? partition : undefined,
+    });
+}
+function shapeJobActivity(activity) {
+    const fields = record(activity);
+    return defined({
+        id: fields["activityId"],
+        recipe: fields["recipeName"],
+        recipeType: fields["recipeType"],
+        state: fields["state"],
+        totalTime: fields["totalTime"],
+        warnings: record(fields["warnings"])["totalCount"],
+        error: errorSummary(fields["firstFailure"]),
+        message: nonEmptyString(fields["message"]),
+    });
+}
+/** `job get`: state, outputs, progress, and the failure; never the log tail. */
+function shapeJobGet(result) {
+    if (!isRecord(result))
+        return result;
+    const base = record(result["baseStatus"]);
+    const def = record(base["def"]);
+    const activities = record(base["activities"]);
+    return defined({
+        id: def["id"],
+        name: def["name"],
+        type: def["type"],
+        state: base["state"],
+        initiator: nonEmptyString(def["initiator"])
+            ?? nonEmptyString(record(result["initiator"])["login"]),
+        triggeredFrom: def["triggeredFrom"],
+        startTime: base["jobStartTime"],
+        endTime: base["jobEndTime"],
+        outputs: Array.isArray(def["outputs"])
+            ? def["outputs"].map((output) => shapeJobOutput(output, def["projectKey"]))
+            : undefined,
+        progress: result["globalState"],
+        error: errorSummary(result["error"]),
+        activities: Object.values(activities).map(shapeJobActivity),
+    });
+}
+/** Extra column keys worth keeping when set (DSS sends most as ""/defaults). */
+const COLUMN_EXTRA_KEYS = ["meaning", "comment",];
+function shapeColumn(column) {
+    const fields = record(column);
+    const shaped = { name: fields["name"], type: fields["type"], };
+    for (const key of COLUMN_EXTRA_KEYS) {
+        const value = nonEmptyString(fields[key]);
+        if (value !== undefined)
+            shaped[key] = value;
+    }
+    return shaped;
+}
+function shapeLastBuild(value) {
+    if (!isRecord(value))
+        return undefined;
+    const shaped = defined({
+        jobId: value["jobId"],
+        success: value["buildSuccess"],
+        startTime: value["buildStartTime"],
+        endTime: value["buildEndTime"],
+    });
+    return Object.keys(shaped).length > 0 ? shaped : undefined;
+}
+/** `dataset info`: what the dataset is, its schema, flow neighbours, and freshness. */
+function shapeDatasetInfo(result) {
+    if (!isRecord(result))
+        return result;
+    const dataset = record(result["dataset"]);
+    const params = record(dataset["params"]);
+    const columns = record(dataset["schema"])["columns"];
+    const tags = dataset["tags"];
+    const quality = record(result["dataQualityStatus"]);
+    const versioning = record(result["versioning"]);
+    const timeline = record(result["timeline"]);
+    return defined({
+        name: result["name"] ?? dataset["name"],
+        type: result["type"] ?? dataset["type"],
+        managed: dataset["managed"],
+        connection: params["connection"] ?? params["uploadConnection"],
+        formatType: dataset["formatType"],
+        partitioned: result["partitioned"],
+        schema: Array.isArray(columns) ? columns.map(shapeColumn) : undefined,
+        recipes: Array.isArray(result["recipes"])
+            ? result["recipes"].map((recipe) => record(recipe)["name"])
+            : undefined,
+        buildable: result["buildable"],
+        upstreamBuildable: result["upstreamBuildable"],
+        downstreamBuildable: result["downstreamBuildable"],
+        tags: Array.isArray(tags) && tags.length > 0 ? tags : undefined,
+        dataQuality: Object.keys(quality).length > 0 && quality["numberItems"] !== 0
+            ? result["dataQualityStatus"]
+            : undefined,
+        lastBuild: shapeLastBuild(result["lastBuild"]),
+        lastModifiedOn: versioning["lastModifiedOn"] ?? timeline["lastModifiedOn"],
+        lastModifiedBy: record(versioning["lastModifiedBy"] ?? timeline["lastModifiedBy"])["login"],
+    });
+}
+/**
+ * Recursively remove empty strings, arrays and objects (including objects that
+ * become empty). `false`, `0` and `null` are kept. Array positions are
+ * preserved: an element that empties out stays as its empty value.
+ */
+function pruneEmpty(value) {
+    if (typeof value === "string")
+        return value.length === 0 ? undefined : value;
+    if (Array.isArray(value)) {
+        if (value.length === 0)
+            return undefined;
+        return value.map((item) => pruneEmpty(item) ?? (typeof item === "string" ? "" : Array.isArray(item) ? [] : {}));
+    }
+    if (isRecord(value)) {
+        const pruned = {};
+        for (const [key, member,] of Object.entries(value)) {
+            const kept = pruneEmpty(member);
+            if (kept !== undefined)
+                pruned[key] = kept;
+        }
+        return Object.keys(pruned).length === 0 ? undefined : pruned;
+    }
+    return value;
+}
+function withoutKeys(source, keys) {
+    return Object.fromEntries(Object.entries(source).filter(([key,]) => !keys.includes(key)));
+}
+/** `dataset get`: the settings object minus metadata and empty/default noise. */
+function shapeDatasetGet(result) {
+    if (!isRecord(result))
+        return result;
+    const settings = withoutKeys(result, DATASET_GET_DROPPED_KEYS);
+    const formatParams = settings["formatParams"];
+    if (isRecord(formatParams)) {
+        settings["formatParams"] = withoutKeys(formatParams, ["hiveSeparators",]);
+    }
+    return pruneEmpty(settings) ?? {};
+}
+const PERMISSION_KEY = /^can[A-Z]/;
+/**
+ * `project get`: as `dataset get`, with the boolean permission flags
+ * (`can*`, `isProjectAdmin`) collapsed to the denied ones. Absent from the
+ * list means granted, so nothing is lost.
+ */
+function shapeProjectGet(result) {
+    if (!isRecord(result))
+        return result;
+    const settings = withoutKeys(result, PROJECT_GET_DROPPED_KEYS);
+    const deniedPermissions = [];
+    for (const [key, value,] of Object.entries(settings)) {
+        if (typeof value !== "boolean" || !(PERMISSION_KEY.test(key) || key === "isProjectAdmin")) {
+            continue;
+        }
+        if (!value)
+            deniedPermissions.push(key);
+        delete settings[key];
+    }
+    const pruned = record(pruneEmpty(settings));
+    return { ...pruned, deniedPermissions, };
+}
+/** Compact read shapers by `resource.action`. */
+const READ_SHAPERS = {
+    "job.get": shapeJobGet,
+    "dataset.info": shapeDatasetInfo,
+    "dataset.get": shapeDatasetGet,
+    "project.get": shapeProjectGet,
+};
+/**
+ * Compact a command result for agents: `*.list` items (filter, cap, compact
+ * fields) and the four large read commands. `--full` and `--fields` bypass
+ * the read shapers so the DSS object (or a projection of it) is returned.
+ */
+export function shapeCommandResult(resource, action, result, flags) {
+    if (action === "list")
+        return shapeListResult(resource, result, flags);
+    const shaper = READ_SHAPERS[`${resource}.${action}`];
+    if (!shaper || flags["full"] === true || typeof flags["fields"] === "string")
+        return result;
+    return shaper(result);
+}

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

@@ -49,7 +49,7 @@ export declare function buildVersionPayload(input: {
 export declare const PACKAGE_ROOT: string | undefined;
 export declare const CLI_VERSION: string;
 export declare const CLI_GIT_REVISION: string | undefined;
-export declare const AGENT_CONTRACT_VERSION = 3;
+export declare const AGENT_CONTRACT_VERSION = 4;
 export declare const JSON_SCHEMA_DRAFT = "https://json-schema.org/draft/2020-12/schema";
-export declare const AGENT_CONTRACT_SCHEMA_ID = "https://clssck.github.io/dataiku-sdk/schemas/agent-contract-v3.json";
+export declare const AGENT_CONTRACT_SCHEMA_ID = "https://clssck.github.io/dataiku-sdk/schemas/agent-contract-v4.json";
 export declare function cliVersionResult(): CliVersionPayload;

package/dist/src/cli/version.js

@@ -204,9 +204,9 @@ export function buildVersionPayload(input) {
 export const PACKAGE_ROOT = findPackageRoot();
 export const CLI_VERSION = packageVersion(PACKAGE_ROOT);
 export const CLI_GIT_REVISION = gitRevision(PACKAGE_ROOT);
-export const AGENT_CONTRACT_VERSION = 3;
+export const AGENT_CONTRACT_VERSION = 4;
 export const JSON_SCHEMA_DRAFT = "https://json-schema.org/draft/2020-12/schema";
-export const AGENT_CONTRACT_SCHEMA_ID = "https://clssck.github.io/dataiku-sdk/schemas/agent-contract-v3.json";
+export const AGENT_CONTRACT_SCHEMA_ID = "https://clssck.github.io/dataiku-sdk/schemas/agent-contract-v4.json";
 export function cliVersionResult() {
     // Only code actually loaded from dist/ may report dist provenance; an
     // inherited DSS_LOAD_SOURCE on a source run is ignored.

package/dist/src/cli.js

@@ -7,8 +7,8 @@ import { commands, } from "./cli/commands/index.js";
 import { ambientProjectKey, loadEnvFile, } from "./cli/env.js";
 import { executionMode, FLAG_ALIASES, isFlagValueToken, parseArgs, rawPositionals, } from "./cli/flags.js";
 import { cleanupLedgerEntry, } from "./cli/helpers/cleanup.js";
-import { shapeListResult, } from "./cli/list-output.js";
 import { commandFailureExitCode, CommandResultFailure, enqueueCliWarning, flushCliWarnings, isFailedWaitResult, planResult, projectResultFields, setOutputFieldProjection, writeCommandResult, } from "./cli/output.js";
+import { shapeCommandResult, } from "./cli/result-shapes.js";
 import { currentCommandContext, resolveCredentials, resolveLoginCredentials, } from "./cli/runtime.js";
 import { commandSyntaxTree, commandUsage, } from "./cli/syntax.js";
 import { COMMANDS_RUN_HINT, inferRequiresProject, missingActionError, noCommandError, requireArgs, RESOURCE_NAMES, unknownActionError, unknownFlagError, unknownResourceError, UsageError, } from "./cli/usage.js";
@@ -1022,8 +1022,7 @@ async function runBatch(flags) {
                     await preflightCleanupLedgerForFlags(client, stepFlags);
                     const stepArgs = positional.slice(2);
                     result = await meta.handler(client, stepArgs, stepFlags);
-                    if (action === "list")
-                        result = shapeListResult(resource, result, stepFlags);
+                    result = shapeCommandResult(resource, action, result, stepFlags);
                     await recordCleanupLedgerEntry(client, resource, action, stepArgs, stepFlags, result, projectKey);
                 }
                 const failureExitCode = commandFailureExitCode(result);
@@ -1301,13 +1300,14 @@ function errorExitCode(err) {
 }
 function buildErrorReport(err, contextOverride) {
     const context = contextOverride ?? rawCommandContext();
+    // The envelope echoes only the resolved project; resource/action are known to the caller.
+    const scope = context.projectKey ? { projectKey: context.projectKey, } : {};
     const exitCode = errorExitCode(err);
     if (err instanceof ClientValidationError
         && (err.code === "ambiguous_outcome" || err.code === "assertion_failed"
             || err.code === "long_running_failure")) {
         return {
             type: "error",
-            ok: false,
             error: err.message,
             code: err.code,
             category: "dss",
@@ -1315,13 +1315,12 @@ function buildErrorReport(err, contextOverride) {
             retryable: false,
             ...(err.hint ? { hint: err.hint, } : {}),
             ...(err.details ? { details: err.details, } : {}),
-            ...context,
+            ...scope,
         };
     }
     if (err instanceof UsageError || err instanceof ClientValidationError) {
         return {
             type: "error",
-            ok: false,
             error: err.message,
             code: err.code,
             category: err.code === "target_absence_unverifiable"
@@ -1333,26 +1332,24 @@ function buildErrorReport(err, contextOverride) {
             ...(err.code === "target_absence_unverifiable" ? { retryable: false, } : {}),
             ...(err.hint ? { hint: err.hint, } : {}),
             ...(err.details ? { details: err.details, } : {}),
-            ...context,
+            ...scope,
         };
     }
     if (err instanceof CommandResultFailure) {
         return {
             type: "error",
-            ok: false,
             error: err.message,
             code: err.code,
             category: "dss",
             exitCode: err.exitCode,
             details: boundedFailureResult(err.result),
-            ...context,
+            ...scope,
         };
     }
     if (isAmbiguousMutationFailure(err, context)) {
         const method = err.retry?.method.toUpperCase() ?? "mutation";
         return {
             type: "error",
-            ok: false,
             error: `The ${method} request failed after dispatch; the mutation outcome is unknown.`,
             code: "ambiguous_outcome",
             category: "dss",
@@ -1369,7 +1366,7 @@ function buildErrorReport(err, contextOverride) {
                 ...err.details,
                 ...(err.retry ? { retry: err.retry, } : {}),
             },
-            ...context,
+            ...scope,
         };
     }
     if (err instanceof DataikuError) {
@@ -1391,7 +1388,6 @@ function buildErrorReport(err, contextOverride) {
                 : err.retryHint;
         return {
             type: "error",
-            ok: false,
             error: dssMessage ? `${err.safeMessage}: ${dssMessage}` : err.safeMessage,
             code: dataikuErrorCode(err.category),
             category: "dss",
@@ -1401,18 +1397,17 @@ function buildErrorReport(err, contextOverride) {
             retryable: err.retryable,
             requestId: err.requestId ?? requestIdFromBody(err.body),
             ...(Object.keys(details).length > 0 ? { details, } : {}),
-            ...context,
+            ...scope,
         };
     }
     const message = err instanceof Error ? err.message : String(err);
     return {
         type: "error",
-        ok: false,
         error: message,
         code: "internal_error",
         category: "internal",
         exitCode,
-        ...context,
+        ...scope,
     };
 }
 function writeErrorReport(err) {
@@ -1524,7 +1519,7 @@ async function main() {
     assertCleanupLedgerSupported(resource, action, flags);
     await preflightCleanupLedgerForFlags(client, flags);
     const handled = await actionMeta.handler(client, args, flags);
-    const result = action === "list" ? shapeListResult(resource, handled, flags) : handled;
+    const result = shapeCommandResult(resource, action, handled, flags);
     await recordCleanupLedgerEntry(client, resource, action, args, flags, result, projectKey);
     const failureExitCode = commandFailureExitCode(result);
     if (failureExitCode !== undefined)

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

@@ -363,6 +363,107 @@
                 }
             }
         },
+        "dataset.info": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "name"
+            ],
+            "properties": {
+                "name": {
+                    "type": "string"
+                },
+                "type": {
+                    "type": "string"
+                },
+                "managed": {
+                    "type": "boolean"
+                },
+                "connection": {
+                    "type": "string"
+                },
+                "formatType": {
+                    "type": "string"
+                },
+                "partitioned": {
+                    "type": "boolean"
+                },
+                "schema": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "required": [
+                            "name",
+                            "type"
+                        ],
+                        "properties": {
+                            "name": {
+                                "type": "string"
+                            },
+                            "type": {
+                                "type": "string"
+                            },
+                            "meaning": {
+                                "type": "string"
+                            },
+                            "comment": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                },
+                "recipes": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "buildable": {
+                    "type": "boolean"
+                },
+                "upstreamBuildable": {
+                    "type": "boolean"
+                },
+                "downstreamBuildable": {
+                    "type": "boolean"
+                },
+                "tags": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "dataQuality": {
+                    "type": "object",
+                    "additionalProperties": true
+                },
+                "lastBuild": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "jobId": {
+                            "type": "string"
+                        },
+                        "success": {
+                            "type": "boolean"
+                        },
+                        "startTime": {
+                            "type": "number"
+                        },
+                        "endTime": {
+                            "type": "number"
+                        }
+                    }
+                },
+                "lastModifiedOn": {
+                    "type": "number"
+                },
+                "lastModifiedBy": {
+                    "type": "string"
+                }
+            }
+        },
         "dataset.list": {
             "type": "array",
             "items": {
@@ -825,6 +926,121 @@
                 }
             }
         },
+        "job.get": {
+            "type": "object",
+            "additionalProperties": false,
+            "required": [
+                "id",
+                "state"
+            ],
+            "properties": {
+                "id": {
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "type": {
+                    "type": "string"
+                },
+                "state": {
+                    "type": "string"
+                },
+                "initiator": {
+                    "type": "string"
+                },
+                "triggeredFrom": {
+                    "type": "string"
+                },
+                "startTime": {
+                    "type": "number"
+                },
+                "endTime": {
+                    "type": "number"
+                },
+                "outputs": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "type": {
+                                "type": "string"
+                            },
+                            "id": {
+                                "type": "string"
+                            },
+                            "projectKey": {
+                                "type": "string"
+                            },
+                            "partition": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                },
+                "progress": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "number"
+                    }
+                },
+                "error": {
+                    "type": "object",
+                    "additionalProperties": false,
+                    "properties": {
+                        "type": {
+                            "type": "string"
+                        },
+                        "message": {
+                            "type": "string"
+                        }
+                    }
+                },
+                "activities": {
+                    "type": "array",
+                    "items": {
+                        "type": "object",
+                        "additionalProperties": false,
+                        "properties": {
+                            "id": {
+                                "type": "string"
+                            },
+                            "recipe": {
+                                "type": "string"
+                            },
+                            "recipeType": {
+                                "type": "string"
+                            },
+                            "state": {
+                                "type": "string"
+                            },
+                            "totalTime": {
+                                "type": "number"
+                            },
+                            "warnings": {
+                                "type": "number"
+                            },
+                            "error": {
+                                "type": "object",
+                                "additionalProperties": false,
+                                "properties": {
+                                    "type": {
+                                        "type": "string"
+                                    },
+                                    "message": {
+                                        "type": "string"
+                                    }
+                                }
+                            },
+                            "message": {
+                                "type": "string"
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "job.list": {
             "type": "array",
             "items": {
@@ -1519,7 +1735,8 @@
             "type": "object",
             "required": [
                 "projectKey",
-                "name"
+                "name",
+                "deniedPermissions"
             ],
             "properties": {
                 "projectKey": {
@@ -1537,25 +1754,6 @@
                 "projectAppType": {
                     "type": "string"
                 },
-                "creationTag": {
-                    "additionalProperties": true,
-                    "type": "object",
-                    "properties": {
-                        "versionNumber": {
-                            "type": "number"
-                        },
-                        "lastModifiedOn": {
-                            "anyOf": [
-                                {
-                                    "type": "number"
-                                },
-                                {
-                                    "type": "string"
-                                }
-                            ]
-                        }
-                    }
-                },
                 "ownerLogin": {
                     "type": "string"
                 },
@@ -1565,21 +1763,12 @@
                         "type": "string"
                     }
                 },
-                "versionTag": {
-                    "additionalProperties": true,
-                    "type": "object",
-                    "required": [
-                        "versionNumber",
-                        "lastModifiedOn"
-                    ],
-                    "properties": {
-                        "versionNumber": {
-                            "type": "number"
-                        },
-                        "lastModifiedOn": {
-                            "type": "number"
-                        }
-                    }
+                "deniedPermissions": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    },
+                    "description": "Permission flags DSS reports as false; absent flags are granted."
                 }
             }
         },