dataiku-sdk 0.10.1 → 0.12.0

package/dist/src/cli/commands/project-library.js

@@ -0,0 +1,197 @@
+import { readFileSync, writeFileSync, } from "node:fs";
+import { readStdinText, } from "../coerce.js";
+import { encodedProjectEndpoint, planResult, } from "../output.js";
+import { requireArgs, UsageError, } from "../usage.js";
+const PROJECT_LIBRARY_EXIT_CODES = { usage: 1, error: 2, transient: 3, };
+function normalizeLibraryPath(path) {
+    const normalized = path.replace(/^\/+/, "");
+    if (!normalized)
+        throw new Error("Project library path is required");
+    return normalized;
+}
+function normalizeLibraryDestinationPath(path) {
+    if (path === "/")
+        return "/";
+    return `/${normalizeLibraryPath(path)}`;
+}
+function encodeLibraryPath(path) {
+    return normalizeLibraryPath(path)
+        .split("/")
+        .map((segment) => encodeURIComponent(segment))
+        .join("/");
+}
+function projectLibraryContentsEndpoint(client, projectKey, path) {
+    return encodedProjectEndpoint(client, projectKey, `/libraries/contents/${encodeLibraryPath(path)}`);
+}
+function projectLibraryFolderEndpoint(client, projectKey, path) {
+    return encodedProjectEndpoint(client, projectKey, `/libraries/folders/${encodeLibraryPath(path)}`);
+}
+function projectLibraryActionEndpoint(client, projectKey, action) {
+    return encodedProjectEndpoint(client, projectKey, `/libraries/contents-actions/${action}`);
+}
+function projectLibraryPutPayload(flags) {
+    if (typeof flags["content"] === "string")
+        return { contentSource: "flag", };
+    if (typeof flags["file"] === "string")
+        return { contentSource: "file", file: flags["file"], };
+    return { contentSource: "stdin", };
+}
+function projectLibraryPlan(action, options) {
+    return planResult("project-library", action, {
+        ...options,
+        asyncKind: "none",
+        exitCodesOnFailure: PROJECT_LIBRARY_EXIT_CODES,
+        idempotency: "none",
+        plannedAndDryRun: true,
+    });
+}
+export const projectLibraryCommands = {
+    list: {
+        handler: (c, _a, f) => c.projectLibrary.listContents(f["project-key"]),
+        usage: "dss project-library list [--project-key KEY]",
+        description: "List the project code library (lib/) contents.",
+        examples: ["dss project-library list",],
+    },
+    get: {
+        handler: (c, a, f) => {
+            requireArgs(a, 1, "dss project-library get <path> [--project-key KEY]");
+            return c.projectLibrary.getFile(a[0], f["project-key"]);
+        },
+        usage: "dss project-library get <path> [--project-key KEY]",
+        description: "Print the text content of a project library file.",
+        examples: ["dss project-library get python/mylib/utils.py",],
+    },
+    "get-bytes": {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss project-library get-bytes <path> --output PATH [--project-key KEY]");
+            const out = f["output"];
+            if (!out)
+                throw new UsageError("--output PATH is required.", "missing_required_flag");
+            const bytes = await c.projectLibrary.getFileBytes(a[0], f["project-key"]);
+            writeFileSync(out, bytes);
+            return { path: out, bytes: bytes.length, };
+        },
+        usage: "dss project-library get-bytes <path> --output PATH [--project-key KEY]",
+        description: "Download a project library file's raw bytes to a local file.",
+        examples: ["dss project-library get-bytes static/logo.png --output ./logo.png",],
+    },
+    "create-file": {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss project-library create-file <path> [--dry-run] [--project-key KEY]");
+            const pk = f["project-key"];
+            if (f["dry-run"] === true) {
+                return projectLibraryPlan("create-file", {
+                    method: "POST",
+                    endpoint: projectLibraryContentsEndpoint(c, pk, a[0]),
+                    identifiers: { path: a[0], },
+                });
+            }
+            await c.projectLibrary.addFile(a[0], pk);
+            return { created: a[0], };
+        },
+        usage: "dss project-library create-file <path> [--dry-run] [--project-key KEY]",
+        description: "Create an empty file in the project library.",
+        examples: ["dss project-library create-file python/mylib/new.py",],
+    },
+    "create-folder": {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss project-library create-folder <path> [--dry-run] [--project-key KEY]");
+            const pk = f["project-key"];
+            if (f["dry-run"] === true) {
+                return projectLibraryPlan("create-folder", {
+                    method: "POST",
+                    endpoint: projectLibraryFolderEndpoint(c, pk, a[0]),
+                    identifiers: { path: a[0], },
+                });
+            }
+            await c.projectLibrary.addFolder(a[0], pk);
+            return { created: a[0], };
+        },
+        usage: "dss project-library create-folder <path> [--dry-run] [--project-key KEY]",
+        description: "Create a folder in the project library.",
+        examples: ["dss project-library create-folder python/mylib",],
+    },
+    put: {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss project-library put <path> (--content TEXT|--file PATH|--stdin) [--dry-run] [--project-key KEY]");
+            const pk = f["project-key"];
+            if (f["dry-run"] === true) {
+                return projectLibraryPlan("put", {
+                    method: "POST",
+                    endpoint: projectLibraryContentsEndpoint(c, pk, a[0]),
+                    identifiers: { path: a[0], },
+                    payload: projectLibraryPutPayload(f),
+                });
+            }
+            const content = typeof f["content"] === "string"
+                ? f["content"]
+                : typeof f["file"] === "string"
+                    ? readFileSync(f["file"], "utf-8")
+                    : await readStdinText();
+            await c.projectLibrary.addOrUpdateFile(a[0], content, pk);
+            return { updated: a[0], };
+        },
+        usage: "dss project-library put <path> (--content TEXT|--file PATH|--stdin) [--dry-run] [--project-key KEY]",
+        description: "Create or overwrite a project library file with raw text content.",
+        examples: ["dss project-library put python/mylib/utils.py --file ./utils.py",],
+    },
+    delete: {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss project-library delete <path> [--dry-run] [--project-key KEY]");
+            const pk = f["project-key"];
+            if (f["dry-run"] === true) {
+                return projectLibraryPlan("delete", {
+                    method: "DELETE",
+                    endpoint: projectLibraryContentsEndpoint(c, pk, a[0]),
+                    identifiers: { path: a[0], },
+                });
+            }
+            await c.projectLibrary.deleteFile(a[0], pk);
+            return { deleted: a[0], };
+        },
+        usage: "dss project-library delete <path> [--dry-run] [--project-key KEY]",
+        description: "Delete a project library file or folder.",
+        examples: ["dss project-library delete python/mylib/old.py",],
+    },
+    rename: {
+        handler: async (c, a, f) => {
+            requireArgs(a, 2, "dss project-library rename <path> <new-name> [--dry-run] [--project-key KEY]");
+            const pk = f["project-key"];
+            if (f["dry-run"] === true) {
+                return projectLibraryPlan("rename", {
+                    method: "POST",
+                    endpoint: projectLibraryActionEndpoint(c, pk, "rename/"),
+                    identifiers: { path: a[0], newName: a[1], },
+                    payload: { oldPath: `/${normalizeLibraryPath(a[0])}`, newName: a[1], },
+                });
+            }
+            await c.projectLibrary.rename(a[0], a[1], pk);
+            return { renamed: a[0], to: a[1], };
+        },
+        usage: "dss project-library rename <path> <new-name> [--dry-run] [--project-key KEY]",
+        description: "Rename a project library file or folder within its parent.",
+        examples: ["dss project-library rename python/mylib/old.py new.py",],
+    },
+    move: {
+        handler: async (c, a, f) => {
+            requireArgs(a, 2, "dss project-library move <path> <destination-folder> [--dry-run] [--project-key KEY]");
+            const pk = f["project-key"];
+            if (f["dry-run"] === true) {
+                return projectLibraryPlan("move", {
+                    method: "POST",
+                    endpoint: projectLibraryActionEndpoint(c, pk, "move"),
+                    identifiers: { path: a[0], destinationFolder: a[1], },
+                    payload: {
+                        oldPath: `/${normalizeLibraryPath(a[0])}`,
+                        newPath: normalizeLibraryDestinationPath(a[1]),
+                    },
+                });
+            }
+            await c.projectLibrary.move(a[0], a[1], pk);
+            return { moved: a[0], to: a[1], };
+        },
+        usage: "dss project-library move <path> <destination-folder> [--dry-run] [--project-key KEY]",
+        description: "Move a project library file or folder into another folder.",
+        examples: ["dss project-library move python/old.py python/mylib",],
+    },
+};

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

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

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

@@ -0,0 +1,133 @@
+import { deepMerge, } from "../../utils/deep-merge.js";
+import { jsonInput, num, requiredJsonInput, } from "../coerce.js";
+import { requireArgs, UsageError, } from "../usage.js";
+export const projectCommands = {
+    list: {
+        handler: (c) => c.projects.list(),
+        usage: "dss project list",
+        description: "List all accessible projects.",
+        examples: ["dss project list",],
+    },
+    get: {
+        handler: (c, _a, f) => c.projects.get(f["project-key"]),
+        usage: "dss project get [--project-key KEY]",
+        description: "Get project settings and metadata.",
+        examples: ["dss project get", "dss project get --project-key MYPROJ",],
+    },
+    metadata: {
+        handler: (c, _a, f) => c.projects.metadata(f["project-key"]),
+        usage: "dss project metadata [--project-key KEY]",
+        description: "Get project-level metadata (tags, labels, custom fields).",
+        examples: ["dss project metadata", "dss project metadata --project-key MYPROJ",],
+    },
+    flow: {
+        handler: (c, _a, f) => c.projects.flow(f["project-key"]),
+        usage: "dss project flow [--project-key KEY]",
+        description: "Get the raw flow graph (all datasets, recipes, and edges).",
+        examples: ["dss project flow", "dss project flow --project-key MYPROJ",],
+    },
+    map: {
+        handler: (c, _a, f) => c.projects.map({
+            projectKey: f["project-key"],
+            maxNodes: num(f["max-nodes"]),
+            maxEdges: num(f["max-edges"]),
+            includeRaw: f["include-raw"] === true,
+        }),
+        usage: "dss project map [--max-nodes N] [--max-edges N] [--include-raw] [--project-key KEY]",
+        description: "Get a summarized, truncated flow map.",
+        examples: [
+            "dss project map",
+            "dss project map --max-nodes 50 --max-edges 100",
+            "dss project map --include-raw",
+        ],
+    },
+    create: {
+        handler: (c, a, f) => {
+            const usage = "dss project create <projectKey> <name> --owner LOGIN [--data JSON|--data-file PATH|--stdin]";
+            requireArgs(a, 2, usage);
+            const owner = f["owner"];
+            if (!owner)
+                throw new UsageError(`--owner is required. Usage: ${usage}`);
+            return c.projects.createProject(a[0], a[1], owner, jsonInput(f));
+        },
+        usage: "dss project create <projectKey> <name> --owner LOGIN [--data JSON|--data-file PATH|--stdin]",
+        description: "Create a new project with owner login and optional settings.",
+        examples: ["dss project create MY_PROJ MyProject --owner alice",],
+    },
+    delete: {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss project delete <projectKey> [--drop-data]");
+            await c.projects.deleteProject(a[0], f["drop-data"] === true);
+            return { deleted: a[0], };
+        },
+        usage: "dss project delete <projectKey> [--drop-data]",
+        description: "Delete a project (destructive). --drop-data also clears managed datasets.",
+        examples: ["dss project delete MY_PROJ",],
+    },
+    duplicate: {
+        handler: (c, a, f) => {
+            requireArgs(a, 3, "dss project duplicate <sourceKey> <targetKey> <targetName> [--data JSON|--data-file PATH|--stdin]");
+            return c.projects.duplicate(a[0], a[1], a[2], jsonInput(f));
+        },
+        usage: "dss project duplicate <sourceKey> <targetKey> <targetName> [--data JSON|--data-file PATH|--stdin]",
+        description: "Duplicate a project into a new project key.",
+        examples: ["dss project duplicate SRC NEW NewProject",],
+    },
+    export: {
+        handler: async (c, a, f) => {
+            requireArgs(a, 1, "dss project export <projectKey> --output PATH [--data JSON|--data-file PATH|--stdin]");
+            const out = f["output"];
+            if (!out)
+                throw new UsageError("--output PATH is required.", "missing_required_flag");
+            await c.projects.exportArchive(a[0], out, jsonInput(f));
+            return { path: out, };
+        },
+        usage: "dss project export <projectKey> --output PATH [--data JSON|--data-file PATH|--stdin]",
+        description: "Export a project to a local archive (.zip).",
+        examples: ["dss project export MY_PROJ --output ./my_proj.zip",],
+    },
+    import: {
+        handler: async (c, a) => {
+            requireArgs(a, 1, "dss project import <filePath>");
+            return c.projects.importProjectFromArchive(a[0]);
+        },
+        usage: "dss project import <filePath>",
+        description: "Upload a project archive to prepare an import (returns a temporary import id).",
+        examples: ["dss project import ./my_proj.zip",],
+    },
+    "permissions-get": {
+        handler: (c, _a, f) => c.projects.getPermissions(f["project-key"]),
+        usage: "dss project permissions-get [--project-key KEY]",
+        description: "Get a project's permissions.",
+        examples: ["dss project permissions-get --project-key MY_PROJ",],
+    },
+    "permissions-set": {
+        handler: async (c, _a, f) => {
+            const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (permissions object).");
+            await c.projects.setPermissions(f["project-key"], body);
+            return { updated: true, };
+        },
+        usage: "dss project permissions-set (--data JSON|--data-file PATH|--stdin) [--project-key KEY]",
+        description: "Replace a project's permissions.",
+        examples: ["dss project permissions-set --data-file perms.json --project-key MY_PROJ",],
+    },
+    "settings-get": {
+        handler: (c, _a, f) => c.projects.getSettings(f["project-key"]),
+        usage: "dss project settings-get [--project-key KEY]",
+        description: "Get a project's settings.",
+        examples: ["dss project settings-get --project-key MY_PROJ",],
+    },
+    "settings-set": {
+        handler: async (c, _a, f) => {
+            const body = requiredJsonInput(f, "--data, --data-file, or --stdin is required (settings object).");
+            const projectKey = f["project-key"];
+            const current = await c.projects.getSettings(projectKey);
+            const next = deepMerge(current, body);
+            await c.projects.setSettings(projectKey, next);
+            return { updated: true, };
+        },
+        usage: "dss project settings-set (--data JSON|--data-file PATH|--stdin) [--project-key KEY]",
+        description: "Update a project's settings via JSON merge.",
+        examples: ["dss project settings-set --data-file settings.json --project-key MY_PROJ",],
+    },
+};

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

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