dataiku-sdk 0.3.1 → 0.4.0

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

@@ -233,6 +233,16 @@ export declare const ScenarioStatusSchema: import("@sinclair/typebox").TObject<{
     }>>;
 }>;
 export type ScenarioStatus = Static<typeof ScenarioStatusSchema>;
+export declare const ScenarioWaitResultSchema: import("@sinclair/typebox").TObject<{
+    scenarioId: import("@sinclair/typebox").TString;
+    runId: import("@sinclair/typebox").TString;
+    outcome: import("@sinclair/typebox").TString;
+    success: import("@sinclair/typebox").TBoolean;
+    elapsedMs: import("@sinclair/typebox").TNumber;
+    pollCount: import("@sinclair/typebox").TNumber;
+    timedOut: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+}>;
+export type ScenarioWaitResult = Static<typeof ScenarioWaitResultSchema>;
 export declare const FolderSummarySchema: import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TString;
     name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;

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

@@ -284,6 +284,15 @@ export const ScenarioStatusSchema = Type.Object({
         }, { additionalProperties: true, })),
     }, { additionalProperties: true, })),
 }, { additionalProperties: true, });
+export const ScenarioWaitResultSchema = Type.Object({
+    scenarioId: Type.String(),
+    runId: Type.String(),
+    outcome: Type.String(),
+    success: Type.Boolean(),
+    elapsedMs: Type.Number(),
+    pollCount: Type.Number(),
+    timedOut: Type.Optional(Type.Boolean()),
+});
 // ---------------------------------------------------------------------------
 // Folders
 // ---------------------------------------------------------------------------

package/dist/src/cli.js

@@ -222,6 +222,8 @@ const BOOLEAN_FLAGS = new Set([
     "include-payload",
     "include-logs",
     "replace",
+    "dry-run",
+    "if-not-exists",
 ]);
 const SHORT_FLAGS = {
     h: "help",
@@ -302,18 +304,26 @@ const commands = {
         list: {
             handler: (c) => c.projects.list(),
             usage: "dss project list",
+            description: "List all accessible projects.",
+            examples: ["dss project list", "dss project list -f table",],
         },
         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 -f quiet",],
         },
         map: {
             handler: (c, _a, f) => c.projects.map({
@@ -322,12 +332,24 @@ const commands = {
                 includeRaw: f["include-raw"] === true,
             }),
             usage: "dss project map [--max-nodes N] [--max-edges N] [--include-raw]",
+            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",
+            ],
         },
     },
     dataset: {
         list: {
             handler: (c, _a, f) => c.datasets.list(f["project-key"]),
             usage: "dss dataset list [--project-key KEY]",
+            description: "List all datasets in a project.",
+            examples: [
+                "dss dataset list",
+                "dss dataset list -f table",
+                "dss dataset list --project-key MYPROJ",
+            ],
         },
         get: {
             handler: (c, a, f) => {
@@ -335,6 +357,8 @@ const commands = {
                 return c.datasets.get(a[0], f["project-key"]);
             },
             usage: "dss dataset get <name> [--project-key KEY]",
+            description: "Get full settings for a dataset.",
+            examples: ["dss dataset get orders", "dss dataset get orders --project-key MYPROJ",],
         },
         schema: {
             handler: (c, a, f) => {
@@ -342,6 +366,8 @@ const commands = {
                 return c.datasets.schema(a[0], f["project-key"]);
             },
             usage: "dss dataset schema <name> [--project-key KEY]",
+            description: "Show the column schema of a dataset.",
+            examples: ["dss dataset schema orders", "dss dataset schema orders -f table",],
         },
         preview: {
             handler: (c, a, f) => {
@@ -353,6 +379,8 @@ const commands = {
                 });
             },
             usage: "dss dataset preview <name> [--max-rows N] [--project-key KEY] [--timeout MS]",
+            description: "Preview dataset rows.",
+            examples: ["dss dataset preview orders", "dss dataset preview orders --max-rows 5",],
         },
         metadata: {
             handler: (c, a, f) => {
@@ -360,6 +388,8 @@ const commands = {
                 return c.datasets.metadata(a[0], f["project-key"]);
             },
             usage: "dss dataset metadata <name> [--project-key KEY]",
+            description: "Get dataset-level metadata.",
+            examples: ["dss dataset metadata orders",],
         },
         download: {
             handler: (c, a, f) => {
@@ -370,39 +400,69 @@ const commands = {
                 });
             },
             usage: "dss dataset download <name> [--output PATH] [--project-key KEY]",
+            description: "Download dataset contents as CSV.",
+            examples: ["dss dataset download orders", "dss dataset download orders --output ./data/",],
         },
         create: {
-            handler: (c, _a, f) => c.datasets.create({
-                datasetName: f["name"],
-                connection: f["connection"],
-                dsType: f["type"],
-                projectKey: f["project-key"],
-            }),
+            handler: async (c, _a, f) => {
+                const pk = f["project-key"];
+                const name = f["name"];
+                if (f["if-not-exists"] === true) {
+                    const list = await c.datasets.list(pk);
+                    const existing = list.find((d) => d.name === name);
+                    if (existing)
+                        return { exists: true, ...existing, };
+                }
+                return c.datasets.create({
+                    datasetName: name,
+                    connection: f["connection"],
+                    dsType: f["type"],
+                    projectKey: pk,
+                });
+            },
             usage: "dss dataset create --name NAME --connection CONN --type TYPE [--project-key KEY]",
+            description: "Create a new dataset.",
+            examples: ["dss dataset create --name orders --connection filesystem --type Filesystem",],
         },
         delete: {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss dataset delete <name>");
-                return c.datasets.delete(a[0], f["project-key"]);
+                const pk = f["project-key"];
+                if (f["dry-run"] === true) {
+                    const current = await c.datasets.get(a[0], pk);
+                    return { dryRun: true, action: "delete", resource: "dataset", name: a[0], current, };
+                }
+                await c.datasets.delete(a[0], pk);
+                return { deleted: a[0], resource: "dataset", };
             },
             usage: "dss dataset delete <name> [--project-key KEY]",
+            description: "Delete a dataset.",
+            examples: ["dss dataset delete orders",],
         },
         update: {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss dataset update <name> [--data '{...}' | --data-file PATH | --stdin]");
                 const data = jsonInput(f);
                 if (!data) {
                     throw new UsageError("--data, --data-file, or --stdin is required. Usage: dss dataset update <name> [--data '{...}' | --data-file PATH | --stdin]");
                 }
-                return c.datasets.update(a[0], data, f["project-key"]);
+                await c.datasets.update(a[0], data, f["project-key"]);
+                return { updated: a[0], resource: "dataset", };
             },
             usage: "dss dataset update <name> [--data '{...}' | --data-file PATH | --stdin] [--project-key KEY]",
+            description: "Update dataset settings via JSON merge.",
+            examples: [
+                'dss dataset update orders --data \'{"tags":["production"]}\'',
+                "echo '{\"tags\":[]}' | dss dataset update orders --stdin",
+            ],
         },
     },
     recipe: {
         list: {
             handler: (c, _a, f) => c.recipes.list(f["project-key"]),
             usage: "dss recipe list [--project-key KEY]",
+            description: "List all recipes in a project.",
+            examples: ["dss recipe list", "dss recipe list -f table",],
         },
         get: {
             handler: (c, a, f) => {
@@ -412,13 +472,23 @@ const commands = {
                 });
             },
             usage: "dss recipe get <name> [--include-payload]",
+            description: "Get recipe settings.",
+            examples: ["dss recipe get compute_orders", "dss recipe get compute_orders --include-payload",],
         },
         delete: {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss recipe delete <name>");
-                return c.recipes.delete(a[0], f["project-key"]);
+                const pk = f["project-key"];
+                if (f["dry-run"] === true) {
+                    const current = await c.recipes.get(a[0]);
+                    return { dryRun: true, action: "delete", resource: "recipe", name: a[0], current, };
+                }
+                await c.recipes.delete(a[0], pk);
+                return { deleted: a[0], resource: "recipe", };
             },
             usage: "dss recipe delete <name> [--project-key KEY]",
+            description: "Delete a recipe.",
+            examples: ["dss recipe delete compute_orders",],
         },
         download: {
             handler: (c, a, f) => {
@@ -429,6 +499,11 @@ const commands = {
                 });
             },
             usage: "dss recipe download <name> [--output PATH] [--project-key KEY]",
+            description: "Download recipe definition as JSON.",
+            examples: [
+                "dss recipe download compute_orders",
+                "dss recipe download compute_orders -o recipe.json",
+            ],
         },
         "download-code": {
             handler: (c, a, f) => {
@@ -439,9 +514,14 @@ const commands = {
                 });
             },
             usage: "dss recipe download-code <name> [--output PATH] [--project-key KEY]",
+            description: "Download the code payload of a recipe.",
+            examples: [
+                "dss recipe download-code compute_orders",
+                "dss recipe download-code compute_orders -o code.py",
+            ],
         },
         create: {
-            handler: (c, _a, f) => {
+            handler: async (c, _a, f) => {
                 const type = f["type"];
                 if (!type) {
                     throw new UsageError("--type is required. Usage: dss recipe create --type TYPE --input DS --output DS");
@@ -450,16 +530,29 @@ const commands = {
                 if (!outputDataset) {
                     throw new UsageError("--output is required. Usage: dss recipe create --type TYPE --input DS --output DS");
                 }
+                const name = f["name"];
+                const pk = f["project-key"];
+                if (f["if-not-exists"] === true && name) {
+                    const list = await c.recipes.list(pk);
+                    const existing = list.find((r) => r.name === name);
+                    if (existing)
+                        return { exists: true, ...existing, };
+                }
                 return c.recipes.create({
                     type,
-                    name: f["name"],
+                    name,
                     inputDatasets: f["input"] ? [f["input"],] : undefined,
                     outputDataset,
                     outputConnection: f["output-connection"],
-                    projectKey: f["project-key"],
+                    projectKey: pk,
                 });
             },
             usage: "dss recipe create --type TYPE --input DS --output DS [--output-connection CONN] [--project-key KEY]",
+            description: "Create a new recipe.",
+            examples: [
+                "dss recipe create --type python --input orders --output orders_clean",
+                "dss recipe create --type python --input orders --output orders_clean --output-connection filesystem",
+            ],
         },
         diff: {
             handler: async (c, a, f) => {
@@ -479,17 +572,25 @@ const commands = {
                 return formatLineDiff(a[0], filePath, result.payload, localContent);
             },
             usage: "dss recipe diff <name> --file PATH [--project-key KEY]",
+            description: "Show differences between local file and remote recipe code.",
+            examples: ["dss recipe diff compute_orders --file code.py",],
         },
         update: {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss recipe update <name> [--data '{...}' | --data-file PATH | --stdin]");
                 const data = jsonInput(f);
                 if (!data) {
                     throw new UsageError("--data, --data-file, or --stdin is required. Usage: dss recipe update <name> [--data '{...}' | --data-file PATH | --stdin]");
                 }
-                return c.recipes.update(a[0], data, f["project-key"]);
+                await c.recipes.update(a[0], data, f["project-key"]);
+                return { updated: a[0], resource: "recipe", };
             },
             usage: "dss recipe update <name> [--data '{...}' | --data-file PATH | --stdin] [--project-key KEY]",
+            description: "Update recipe settings via JSON merge.",
+            examples: [
+                "dss recipe update compute_orders --data-file settings.json",
+                "cat settings.json | dss recipe update compute_orders --stdin",
+            ],
         },
         "get-payload": {
             handler: async (c, a, f) => {
@@ -504,6 +605,11 @@ const commands = {
                 return payload;
             },
             usage: "dss recipe get-payload <name> [--output PATH] [--project-key KEY]",
+            description: "Print the recipe code payload to stdout.",
+            examples: [
+                "dss recipe get-payload compute_orders",
+                "dss recipe get-payload compute_orders -o code.py",
+            ],
         },
         "set-payload": {
             handler: async (c, a, f) => {
@@ -515,14 +621,19 @@ const commands = {
                 await c.recipes.setPayload(a[0], content, {
                     projectKey: f["project-key"],
                 });
+                return { updated: a[0], resource: "recipe", file: filePath, };
             },
             usage: "dss recipe set-payload <name> --file PATH [--project-key KEY]",
+            description: "Upload recipe code from a local file.",
+            examples: ["dss recipe set-payload compute_orders --file code.py",],
         },
     },
     job: {
         list: {
             handler: (c, _a, f) => c.jobs.list(f["project-key"]),
             usage: "dss job list [--project-key KEY]",
+            description: "List recent jobs.",
+            examples: ["dss job list", "dss job list -f table",],
         },
         get: {
             handler: (c, a, f) => {
@@ -530,6 +641,8 @@ const commands = {
                 return c.jobs.get(a[0], f["project-key"]);
             },
             usage: "dss job get <id> [--project-key KEY]",
+            description: "Get job details.",
+            examples: ["dss job get JOB_ID",],
         },
         log: {
             handler: (c, a, f) => {
@@ -540,6 +653,8 @@ const commands = {
                 });
             },
             usage: "dss job log <id> [--activity NAME] [--max-lines N]",
+            description: "Get log output for a job.",
+            examples: ["dss job log JOB_ID", "dss job log JOB_ID --activity main --max-lines 200",],
         },
         build: {
             handler: (c, a, f) => {
@@ -549,6 +664,8 @@ const commands = {
                 });
             },
             usage: "dss job build <dataset> [--build-mode MODE]",
+            description: "Start a dataset build (returns immediately).",
+            examples: ["dss job build orders", "dss job build orders --build-mode RECURSIVE_BUILD",],
         },
         "build-and-wait": {
             handler: (c, a, f) => {
@@ -560,6 +677,12 @@ const commands = {
                 });
             },
             usage: "dss job build-and-wait <dataset> [--build-mode MODE] [--include-logs] [--timeout MS]",
+            description: "Build a dataset and wait for completion.",
+            examples: [
+                "dss job build-and-wait orders",
+                "dss job build-and-wait orders --include-logs",
+                "dss job build-and-wait orders --timeout 300000",
+            ],
         },
         wait: {
             handler: (c, a, f) => {
@@ -570,6 +693,8 @@ const commands = {
                 });
             },
             usage: "dss job wait <id> [--include-logs] [--timeout MS]",
+            description: "Wait for an existing job to complete.",
+            examples: ["dss job wait JOB_ID", "dss job wait JOB_ID --include-logs --timeout 60000",],
         },
         abort: {
             handler: (c, a, f) => {
@@ -577,12 +702,16 @@ const commands = {
                 return c.jobs.abort(a[0], f["project-key"]);
             },
             usage: "dss job abort <id> [--project-key KEY]",
+            description: "Abort a running job.",
+            examples: ["dss job abort JOB_ID",],
         },
     },
     scenario: {
         list: {
             handler: (c, _a, f) => c.scenarios.list(f["project-key"]),
             usage: "dss scenario list [--project-key KEY]",
+            description: "List all scenarios in a project.",
+            examples: ["dss scenario list", "dss scenario list -f table",],
         },
         get: {
             handler: (c, a, _f) => {
@@ -590,6 +719,8 @@ const commands = {
                 return c.scenarios.get(a[0]);
             },
             usage: "dss scenario get <id>",
+            description: "Get scenario definition.",
+            examples: ["dss scenario get my_scenario",],
         },
         run: {
             handler: (c, a, f) => {
@@ -597,6 +728,23 @@ const commands = {
                 return c.scenarios.run(a[0], f["project-key"]);
             },
             usage: "dss scenario run <id> [--project-key KEY]",
+            description: "Trigger a scenario run (returns immediately).",
+            examples: ["dss scenario run my_scenario",],
+        },
+        "run-and-wait": {
+            handler: (c, a, f) => {
+                requireArgs(a, 1, "dss scenario run-and-wait <id>");
+                return c.scenarios.runAndWait(a[0], {
+                    timeoutMs: num(f["timeout"]),
+                    projectKey: f["project-key"],
+                });
+            },
+            usage: "dss scenario run-and-wait <id> [--timeout MS] [--project-key KEY]",
+            description: "Run a scenario and wait for completion.",
+            examples: [
+                "dss scenario run-and-wait my_scenario",
+                "dss scenario run-and-wait my_scenario --timeout 300000",
+            ],
         },
         status: {
             handler: (c, a, f) => {
@@ -604,40 +752,68 @@ const commands = {
                 return c.scenarios.status(a[0], f["project-key"]);
             },
             usage: "dss scenario status <id> [--project-key KEY]",
+            description: "Get the current run status of a scenario.",
+            examples: ["dss scenario status my_scenario",],
         },
         delete: {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss scenario delete <id>");
-                return c.scenarios.delete(a[0], f["project-key"]);
+                const pk = f["project-key"];
+                if (f["dry-run"] === true) {
+                    const current = await c.scenarios.get(a[0]);
+                    return { dryRun: true, action: "delete", resource: "scenario", id: a[0], current, };
+                }
+                await c.scenarios.delete(a[0], pk);
+                return { deleted: a[0], resource: "scenario", };
             },
             usage: "dss scenario delete <id> [--project-key KEY]",
+            description: "Delete a scenario.",
+            examples: ["dss scenario delete my_scenario",],
         },
         create: {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 2, "dss scenario create <id> <name>");
-                return c.scenarios.create(a[0], a[1], {
+                const pk = f["project-key"];
+                if (f["if-not-exists"] === true) {
+                    const list = await c.scenarios.list(pk);
+                    const existing = list.find((s) => s.id === a[0]);
+                    if (existing)
+                        return { exists: true, ...existing, };
+                }
+                await c.scenarios.create(a[0], a[1], {
                     scenarioType: f["type"],
-                    projectKey: f["project-key"],
+                    projectKey: pk,
                 });
+                return { created: a[0], name: a[1], resource: "scenario", };
             },
             usage: "dss scenario create <id> <name> [--type step_based|custom_python] [--project-key KEY]",
+            description: "Create a new scenario.",
+            examples: [
+                'dss scenario create my_scenario "My Scenario"',
+                'dss scenario create my_scenario "My Scenario" --type custom_python',
+            ],
         },
         update: {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss scenario update <id> [--data '{...}' | --data-file PATH | --stdin]");
                 const data = jsonInput(f);
                 if (!data) {
                     throw new UsageError("--data, --data-file, or --stdin is required. Usage: dss scenario update <id> [--data '{...}' | --data-file PATH | --stdin]");
                 }
-                return c.scenarios.update(a[0], data, f["project-key"]);
+                await c.scenarios.update(a[0], data, f["project-key"]);
+                return { updated: a[0], resource: "scenario", };
             },
             usage: "dss scenario update <id> [--data '{...}' | --data-file PATH | --stdin] [--project-key KEY]",
+            description: "Update scenario settings via JSON merge.",
+            examples: ["dss scenario update my_scenario --data-file settings.json",],
         },
     },
     folder: {
         list: {
             handler: (c, _a, f) => c.folders.list(f["project-key"]),
             usage: "dss folder list [--project-key KEY]",
+            description: "List managed folders in a project.",
+            examples: ["dss folder list", "dss folder list -f table",],
         },
         get: {
             handler: async (c, a, f) => {
@@ -645,6 +821,8 @@ const commands = {
                 return c.folders.get(await resolveFolderId(c, a[0], f), f["project-key"]);
             },
             usage: "dss folder get <name-or-id> [--project-key KEY]",
+            description: "Get managed folder settings.",
+            examples: ["dss folder get my_folder",],
         },
         contents: {
             handler: async (c, a, f) => {
@@ -654,6 +832,8 @@ const commands = {
                 });
             },
             usage: "dss folder contents <name-or-id> [--project-key KEY]",
+            description: "List files in a managed folder.",
+            examples: ["dss folder contents my_folder",],
         },
         download: {
             handler: async (c, a, f) => {
@@ -665,26 +845,42 @@ const commands = {
                 });
             },
             usage: "dss folder download <name-or-id> <remote-path> [local-path] [--output PATH] [--project-key KEY]",
+            description: "Download a file from a managed folder.",
+            examples: [
+                "dss folder download my_folder /data/report.csv",
+                "dss folder download my_folder /data/report.csv ./report.csv",
+            ],
         },
         upload: {
             handler: async (c, a, f) => {
                 requireArgs(a, 3, "dss folder upload <name-or-id> <path> <localPath>");
-                return c.folders.upload(await resolveFolderId(c, a[0], f), a[1], a[2], f["project-key"]);
+                await c.folders.upload(await resolveFolderId(c, a[0], f), a[1], a[2], f["project-key"]);
+                return { uploaded: a[1], folder: a[0], localPath: a[2], resource: "folder", };
             },
             usage: "dss folder upload <name-or-id> <path> <localPath> [--project-key KEY]",
+            description: "Upload a local file to a managed folder.",
+            examples: ["dss folder upload my_folder /data/report.csv ./report.csv",],
         },
         "delete-file": {
             handler: async (c, a, f) => {
                 requireArgs(a, 2, "dss folder delete-file <name-or-id> <path>");
-                return c.folders.deleteFile(await resolveFolderId(c, a[0], f), a[1], f["project-key"]);
+                if (f["dry-run"] === true) {
+                    return { dryRun: true, action: "delete-file", resource: "folder", folder: a[0], path: a[1], };
+                }
+                await c.folders.deleteFile(await resolveFolderId(c, a[0], f), a[1], f["project-key"]);
+                return { deleted: a[1], folder: a[0], resource: "folder", };
             },
             usage: "dss folder delete-file <name-or-id> <path> [--project-key KEY]",
+            description: "Delete a file from a managed folder.",
+            examples: ["dss folder delete-file my_folder /data/report.csv",],
         },
     },
     variable: {
         get: {
             handler: (c, _a, f) => c.variables.get(f["project-key"]),
             usage: "dss variable get [--project-key KEY]",
+            description: "Get project variables (standard and local).",
+            examples: ["dss variable get", "dss variable get --project-key MYPROJ",],
         },
         set: {
             handler: (c, _a, f) => c.variables.set({
@@ -693,19 +889,28 @@ const commands = {
                 replace: f["replace"] === true,
                 projectKey: f["project-key"],
             }),
-            usage: 'dss variable set --standard \'{"k":"v"}\' --local \'{"k":"v"}\' [--replace] [--project-key KEY]',
+            usage: `dss variable set --standard '{"k":"v"}' --local '{"k":"v"}' [--replace] [--project-key KEY]`,
+            description: "Set project variables via JSON merge (or full replace with --replace).",
+            examples: [
+                'dss variable set --standard \'{"env":"staging"}\'',
+                "dss variable set --local '{\"debug\":true}' --replace",
+            ],
         },
     },
     connection: {
         list: {
             handler: (c) => c.connections.list(),
             usage: "dss connection list",
+            description: "List all connection names.",
+            examples: ["dss connection list",],
         },
         infer: {
             handler: (c, _a, f) => c.connections.infer({
                 mode: f["mode"],
             }),
             usage: "dss connection infer [--mode fast|rich]",
+            description: "List connections with inferred types and metadata.",
+            examples: ["dss connection infer", "dss connection infer --mode rich",],
         },
     },
     "code-env": {
@@ -714,6 +919,8 @@ const commands = {
                 envLang: f["lang"],
             }),
             usage: "dss code-env list [--lang LANG]",
+            description: "List code environments.",
+            examples: ["dss code-env list", "dss code-env list --lang PYTHON",],
         },
         get: {
             handler: (c, a) => {
@@ -721,6 +928,8 @@ const commands = {
                 return c.codeEnvs.get(a[0], a[1]);
             },
             usage: "dss code-env get <lang> <name>",
+            description: "Get code environment details.",
+            examples: ["dss code-env get PYTHON my_env",],
         },
     },
     sql: {
@@ -741,12 +950,20 @@ const commands = {
                 });
             },
             usage: SQL_QUERY_USAGE,
+            description: "Run a SQL query against a DSS connection or dataset.",
+            examples: [
+                "dss sql query 'SELECT * FROM orders LIMIT 10' --connection my_pg",
+                "dss sql query --sql-file query.sql --connection my_pg",
+                "echo 'SELECT 1' | dss sql query --stdin --dataset MYPROJ.orders",
+            ],
         },
     },
     notebook: {
         "list-jupyter": {
             handler: (c, _a, f) => c.notebooks.listJupyter(f["project-key"]),
             usage: "dss notebook list-jupyter [--project-key KEY]",
+            description: "List Jupyter notebooks.",
+            examples: ["dss notebook list-jupyter",],
         },
         "get-jupyter": {
             handler: (c, a, _f) => {
@@ -754,20 +971,32 @@ const commands = {
                 return c.notebooks.getJupyter(a[0]);
             },
             usage: "dss notebook get-jupyter <name>",
+            description: "Get a Jupyter notebook.",
+            examples: ["dss notebook get-jupyter my_notebook",],
         },
         "delete-jupyter": {
-            handler: (c, a, _f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss notebook delete-jupyter <name>");
-                return c.notebooks.deleteJupyter(a[0]);
+                if (f["dry-run"] === true) {
+                    const current = await c.notebooks.getJupyter(a[0]);
+                    return { dryRun: true, action: "delete", resource: "jupyter-notebook", name: a[0], current, };
+                }
+                await c.notebooks.deleteJupyter(a[0]);
+                return { deleted: a[0], resource: "jupyter-notebook", };
             },
             usage: "dss notebook delete-jupyter <name>",
+            description: "Delete a Jupyter notebook.",
+            examples: ["dss notebook delete-jupyter my_notebook",],
         },
         "clear-jupyter-outputs": {
-            handler: (c, a, _f) => {
+            handler: async (c, a, _f) => {
                 requireArgs(a, 1, "dss notebook clear-jupyter-outputs <name>");
-                return c.notebooks.clearJupyterOutputs(a[0]);
+                await c.notebooks.clearJupyterOutputs(a[0]);
+                return { cleared: a[0], resource: "jupyter-notebook", };
             },
             usage: "dss notebook clear-jupyter-outputs <name>",
+            description: "Clear all cell outputs from a Jupyter notebook.",
+            examples: ["dss notebook clear-jupyter-outputs my_notebook",],
         },
         "sessions-jupyter": {
             handler: (c, a, _f) => {
@@ -775,17 +1004,24 @@ const commands = {
                 return c.notebooks.listJupyterSessions(a[0]);
             },
             usage: "dss notebook sessions-jupyter <name>",
+            description: "List active kernel sessions for a Jupyter notebook.",
+            examples: ["dss notebook sessions-jupyter my_notebook",],
         },
         "unload-jupyter": {
-            handler: (c, a, _f) => {
+            handler: async (c, a, _f) => {
                 requireArgs(a, 2, "dss notebook unload-jupyter <name> <sessionId>");
-                return c.notebooks.unloadJupyter(a[0], a[1]);
+                await c.notebooks.unloadJupyter(a[0], a[1]);
+                return { unloaded: a[0], sessionId: a[1], resource: "jupyter-notebook", };
             },
             usage: "dss notebook unload-jupyter <name> <sessionId>",
+            description: "Unload a Jupyter notebook kernel session.",
+            examples: ["dss notebook unload-jupyter my_notebook SESSION_ID",],
         },
         "list-sql": {
             handler: (c, _a, f) => c.notebooks.listSql(f["project-key"]),
             usage: "dss notebook list-sql [--project-key KEY]",
+            description: "List SQL notebooks.",
+            examples: ["dss notebook list-sql",],
         },
         "get-sql": {
             handler: (c, a, _f) => {
@@ -793,13 +1029,22 @@ const commands = {
                 return c.notebooks.getSql(a[0]);
             },
             usage: "dss notebook get-sql <id>",
+            description: "Get a SQL notebook.",
+            examples: ["dss notebook get-sql my_sql_notebook",],
         },
         "delete-sql": {
-            handler: (c, a, _f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss notebook delete-sql <id>");
-                return c.notebooks.deleteSql(a[0]);
+                if (f["dry-run"] === true) {
+                    const current = await c.notebooks.getSql(a[0]);
+                    return { dryRun: true, action: "delete", resource: "sql-notebook", id: a[0], current, };
+                }
+                await c.notebooks.deleteSql(a[0]);
+                return { deleted: a[0], resource: "sql-notebook", };
             },
             usage: "dss notebook delete-sql <id>",
+            description: "Delete a SQL notebook.",
+            examples: ["dss notebook delete-sql my_sql_notebook",],
         },
         "history-sql": {
             handler: (c, a, _f) => {
@@ -807,39 +1052,56 @@ const commands = {
                 return c.notebooks.getSqlHistory(a[0]);
             },
             usage: "dss notebook history-sql <id>",
+            description: "Get query history for a SQL notebook.",
+            examples: ["dss notebook history-sql my_sql_notebook",],
         },
         "save-jupyter": {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss notebook save-jupyter <name> [--data '{...}' | --data-file PATH | --stdin]");
                 const data = jsonInput(f);
                 if (!data) {
                     throw new UsageError("--data, --data-file, or --stdin is required (notebook JSON content).");
                 }
-                return c.notebooks.saveJupyter(a[0], data, f["project-key"]);
+                await c.notebooks.saveJupyter(a[0], data, f["project-key"]);
+                return { saved: a[0], resource: "jupyter-notebook", };
             },
             usage: "dss notebook save-jupyter <name> [--data '{...}' | --data-file PATH | --stdin] [--project-key KEY]",
+            description: "Save content to a Jupyter notebook.",
+            examples: [
+                "dss notebook save-jupyter my_notebook --data-file notebook.json",
+                "cat notebook.json | dss notebook save-jupyter my_notebook --stdin",
+            ],
         },
         "save-sql": {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss notebook save-sql <id> [--data '{...}' | --data-file PATH | --stdin]");
                 const data = jsonInput(f);
                 if (!data) {
                     throw new UsageError("--data, --data-file, or --stdin is required (SQL notebook content JSON).");
                 }
-                return c.notebooks.saveSql(a[0], data, f["project-key"]);
+                await c.notebooks.saveSql(a[0], data, f["project-key"]);
+                return { saved: a[0], resource: "sql-notebook", };
             },
             usage: "dss notebook save-sql <id> [--data '{...}' | --data-file PATH | --stdin] [--project-key KEY]",
+            description: "Save content to a SQL notebook.",
+            examples: ["dss notebook save-sql my_sql_notebook --data-file content.json",],
         },
         "clear-sql-history": {
-            handler: (c, a, f) => {
+            handler: async (c, a, f) => {
                 requireArgs(a, 1, "dss notebook clear-sql-history <id>");
-                return c.notebooks.clearSqlHistory(a[0], {
+                await c.notebooks.clearSqlHistory(a[0], {
                     cellId: f["cell-id"],
                     numRunsToRetain: num(f["retain"]),
                     projectKey: f["project-key"],
                 });
+                return { cleared: a[0], resource: "sql-notebook", };
             },
             usage: "dss notebook clear-sql-history <id> [--cell-id CID] [--retain N] [--project-key KEY]",
+            description: "Clear query history for a SQL notebook.",
+            examples: [
+                "dss notebook clear-sql-history my_sql_notebook",
+                "dss notebook clear-sql-history my_sql_notebook --cell-id CELL1 --retain 5",
+            ],
         },
     },
 };
@@ -860,7 +1122,10 @@ function printTopLevelHelp() {
         "      --url URL            Dataiku DSS base URL (env: DATAIKU_URL)",
         "      --api-key KEY        API key              (env: DATAIKU_API_KEY)",
         "      --project-key KEY    Default project key   (env: DATAIKU_PROJECT_KEY)",
-        "      --timeout MS         Request timeout in ms  (default: 30000)",
+        "      --timeout MS         Operation timeout (build-and-wait, run-and-wait)",
+        "      --request-timeout MS HTTP request timeout in ms (default: 30000)",
+        "      --dry-run            Preview destructive actions without executing",
+        "      --if-not-exists      Skip create if resource already exists",
         "      --insecure           Disable TLS certificate verification",
         "      --ca-cert PATH       Extra PEM CA bundle (env: NODE_EXTRA_CA_CERTS)",
         "",
@@ -884,11 +1149,14 @@ function printResourceHelp(resource) {
     const actions = commands[resource];
     if (!actions)
         return;
+    const maxName = Math.max(...Object.keys(actions).map((n) => n.length));
     const lines = [
         `Usage: dss ${resource} <action> [args...] [--flags]`,
         "",
         "Actions:",
-        ...Object.entries(actions).map(([name, meta,]) => `  ${name}  →  ${meta.usage}`),
+        ...Object.entries(actions).map(([name, meta,]) => `  ${name.padEnd(maxName + 2)}${meta.description ?? meta.usage}`),
+        "",
+        `Run 'dss ${resource} <action> --help' for details and examples.`,
     ];
     process.stderr.write(`${lines.join("\n")}\n`);
 }
@@ -896,7 +1164,16 @@ function printActionHelp(resource, action) {
     const meta = commands[resource]?.[action];
     if (!meta)
         return;
-    process.stderr.write(`Usage: ${meta.usage}\n`);
+    const lines = [];
+    if (meta.description)
+        lines.push(meta.description, "");
+    lines.push(`Usage: ${meta.usage}`);
+    if (meta.examples && meta.examples.length > 0) {
+        lines.push("", "Examples:");
+        for (const ex of meta.examples)
+            lines.push(`  ${ex}`);
+    }
+    process.stderr.write(`${lines.join("\n")}\n`);
 }
 // ---------------------------------------------------------------------------
 // Validation
@@ -977,13 +1254,18 @@ const AUTH_ACTIONS = {
             process.stderr.write(`Credentials saved to ${getCredentialsPath()}\n`);
         },
         usage: "dss auth login [--url URL] [--api-key KEY] [--project-key KEY] [--insecure] [--ca-cert PATH]",
+        description: "Save DSS credentials (interactive or via flags).",
+        examples: [
+            "dss auth login --url https://dss.example.com --api-key YOUR_KEY",
+            "dss auth login --url https://dss.example.com --api-key YOUR_KEY --project-key MYPROJ",
+        ],
     },
     status: {
         handler: async (flags) => {
             const creds = loadCredentials();
             if (!creds) {
                 process.stderr.write("No saved credentials. Run: dss auth login\n");
-                return;
+                process.exit(1);
             }
             const tlsSettings = resolveTlsSettings(flags, creds);
             const lines = [
@@ -1001,10 +1283,14 @@ const AUTH_ACTIONS = {
             }
             else {
                 process.stderr.write(`Connection:  ✗ Failed (${result.error ?? "unknown error"})\n`);
+                process.stderr.write(`Config:      ${getCredentialsPath()}\n`);
+                process.exit(1);
             }
             process.stderr.write(`Config:      ${getCredentialsPath()}\n`);
         },
         usage: "dss auth status [--insecure] [--ca-cert PATH]",
+        description: "Show saved credentials and verify the connection.",
+        examples: ["dss auth status",],
     },
     logout: {
         handler: async (_flags) => {
@@ -1012,6 +1298,8 @@ const AUTH_ACTIONS = {
             process.stderr.write("Credentials removed.\n");
         },
         usage: "dss auth logout",
+        description: "Remove saved credentials.",
+        examples: ["dss auth logout",],
     },
 };
 // ---------------------------------------------------------------------------
@@ -1089,12 +1377,15 @@ async function main() {
     // Auth commands — dispatched before client creation
     if (resource === "auth") {
         const action = positional[1];
-        if (!action || flags["help"] === true) {
+        if (!action) {
+            const maxName = Math.max(...Object.keys(AUTH_ACTIONS).map((n) => n.length));
             const lines = [
                 "Usage: dss auth <action> [--flags]",
                 "",
                 "Actions:",
-                ...Object.entries(AUTH_ACTIONS).map(([name, meta,]) => `  ${name}  \u2192  ${meta.usage}`),
+                ...Object.entries(AUTH_ACTIONS).map(([name, meta,]) => `  ${name.padEnd(maxName + 2)}${meta.description ?? meta.usage}`),
+                "",
+                "Run 'dss auth <action> --help' for details and examples.",
             ];
             process.stderr.write(`${lines.join("\n")}\n`);
             process.exit(flags["help"] === true ? 0 : 1);
@@ -1104,6 +1395,19 @@ async function main() {
             process.stderr.write(`Unknown action: auth ${action}\nAvailable: ${Object.keys(AUTH_ACTIONS).join(", ")}\n`);
             process.exit(1);
         }
+        if (flags["help"] === true) {
+            const lines = [];
+            if (authMeta.description)
+                lines.push(authMeta.description, "");
+            lines.push(`Usage: ${authMeta.usage}`);
+            if (authMeta.examples && authMeta.examples.length > 0) {
+                lines.push("", "Examples:");
+                for (const ex of authMeta.examples)
+                    lines.push(`  ${ex}`);
+            }
+            process.stderr.write(`${lines.join("\n")}\n`);
+            process.exit(0);
+        }
         await authMeta.handler(flags);
         return;
     }
@@ -1167,6 +1471,30 @@ async function main() {
         }
         return;
     }
+    // commands — machine-readable introspection (no auth needed)
+    if (resource === "commands") {
+        const registry = {};
+        for (const [res, actions,] of Object.entries(commands)) {
+            registry[res] = {};
+            for (const [act, meta,] of Object.entries(actions)) {
+                registry[res][act] = {
+                    usage: meta.usage,
+                    description: meta.description,
+                    examples: meta.examples,
+                };
+            }
+        }
+        registry["auth"] = {};
+        for (const [act, meta,] of Object.entries(AUTH_ACTIONS)) {
+            registry["auth"][act] = {
+                usage: meta.usage,
+                description: meta.description,
+                examples: meta.examples,
+            };
+        }
+        process.stdout.write(`${JSON.stringify(registry, null, 2)}\n`);
+        process.exit(0);
+    }
     // Unknown resource
     if (!commands[resource]) {
         if (flags["help"]) {
@@ -1205,7 +1533,7 @@ async function main() {
     if (!apiKey) {
         throw new UsageError("Missing API key. Set DATAIKU_API_KEY, pass --api-key, or run: dss auth login");
     }
-    const requestTimeoutMs = num(flags["timeout"]) ?? undefined;
+    const requestTimeoutMs = num(flags["request-timeout"]) ?? num(flags["timeout"]) ?? undefined;
     const client = new DataikuClient({
         url,
         apiKey,
@@ -1222,7 +1550,7 @@ async function main() {
 }
 main().catch((err) => {
     if (err instanceof UsageError) {
-        process.stderr.write(`${err.message} \n`);
+        process.stderr.write(`${JSON.stringify({ error: err.message, code: "usage", }, null, 2)}\n`);
         process.exit(1);
     }
     if (err instanceof DataikuError) {

package/dist/src/resources/scenarios.d.ts

@@ -1,4 +1,4 @@
-import type { ScenarioDetails, ScenarioStatus, ScenarioSummary } from "../schemas.js";
+import type { ScenarioDetails, ScenarioStatus, ScenarioSummary, ScenarioWaitResult } from "../schemas.js";
 import { BaseResource } from "./base.js";
 export declare class ScenariosResource extends BaseResource {
     /** List all scenarios in a project. */
@@ -23,4 +23,13 @@ export declare class ScenariosResource extends BaseResource {
     update(scenarioId: string, data: Record<string, unknown>, projectKey?: string): Promise<void>;
     /** Delete a scenario. */
     delete(scenarioId: string, projectKey?: string): Promise<void>;
+    /**
+     * Run a scenario and poll until it finishes or times out.
+     * Returns `{ success: false, timedOut: true }` on timeout rather than throwing.
+     */
+    runAndWait(scenarioId: string, opts?: {
+        pollIntervalMs?: number;
+        timeoutMs?: number;
+        projectKey?: string;
+    }): Promise<ScenarioWaitResult>;
 }

package/dist/src/resources/scenarios.js

@@ -1,6 +1,7 @@
 import { ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioSummaryArraySchema, } from "../schemas.js";
 import { deepMerge, } from "../utils/deep-merge.js";
 import { BaseResource, } from "./base.js";
+import { computeNextPollDelayMs, } from "./jobs.js";
 export class ScenariosResource extends BaseResource {
     /** List all scenarios in a project. */
     async list(projectKey) {
@@ -54,4 +55,50 @@ export class ScenariosResource extends BaseResource {
         const scEnc = encodeURIComponent(scenarioId);
         await this.client.del(`/public/api/projects/${this.enc(projectKey)}/scenarios/${scEnc}/`);
     }
+    /**
+     * Run a scenario and poll until it finishes or times out.
+     * Returns `{ success: false, timedOut: true }` on timeout rather than throwing.
+     */
+    async runAndWait(scenarioId, opts) {
+        const { runId, } = await this.run(scenarioId, opts?.projectKey);
+        const baseIntervalMs = Math.max(1, opts?.pollIntervalMs ?? 2_000);
+        const adaptivePolling = opts?.pollIntervalMs === undefined;
+        const timeout = Math.max(baseIntervalMs, opts?.timeoutMs ?? 120_000);
+        const startedAt = Date.now();
+        let pollCount = 0;
+        while (true) {
+            pollCount += 1;
+            const st = await this.status(scenarioId, opts?.projectKey);
+            const elapsedMs = Date.now() - startedAt;
+            // Scenario finished when it's no longer running and lastRun matches our runId
+            if (!st.running && st.lastRun?.runId === runId) {
+                const outcome = st.lastRun?.outcome ?? "UNKNOWN";
+                return {
+                    scenarioId,
+                    runId,
+                    outcome,
+                    success: outcome === "SUCCESS",
+                    elapsedMs,
+                    pollCount,
+                };
+            }
+            if (elapsedMs >= timeout) {
+                return {
+                    scenarioId,
+                    runId,
+                    outcome: "TIMEOUT",
+                    success: false,
+                    elapsedMs,
+                    pollCount,
+                    timedOut: true,
+                };
+            }
+            const nextDelayMs = computeNextPollDelayMs({
+                pollCount,
+                baseIntervalMs,
+                adaptiveEnabled: adaptivePolling,
+            });
+            await new Promise((r) => setTimeout(r, Math.min(nextDelayMs, timeout - elapsedMs)));
+        }
+    }
 }

package/dist/src/schemas.d.ts

@@ -3,5 +3,5 @@
  * The types package (packages/types/) owns the TypeBox schema definitions.
  * SDK consumers get everything through this re-export.
  */
-export { BuildModeSchema, CodeEnvDetailsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, ConnectionSummarySchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, JobSummaryArraySchema, JobSummarySchema, JobWaitResultSchema, JupyterCellSchema, JupyterNotebookContentSchema, JupyterNotebookSummaryArraySchema, JupyterNotebookSummarySchema, NotebookSessionArraySchema, NotebookSessionSchema, parseSchema, ProjectDetailsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, } from "../packages/types/src/index.js";
-export type { BuildMode, CodeEnvDetails, CodeEnvSummary, ConnectionSummary, DatasetCreateOptions, DatasetDetails, DatasetSchema, DatasetSummary, FlowMapOptions, FolderDetails, FolderItem, FolderSummary, JobSummary, JobWaitResult, JupyterCell, JupyterNotebookContent, JupyterNotebookSummary, NotebookSession, ProjectDetails, ProjectMetadata, ProjectSummary, ProjectVariables, RecipeCreateOptions, RecipeCreateResult, RecipeDetails, RecipeSummary, SafeParseResult, ScenarioDetails, ScenarioStatus, ScenarioSummary, SqlNotebookCell, SqlNotebookContent, SqlNotebookSummary, SqlQueryResponse, SqlQueryResult, SqlQuerySchema, } from "../packages/types/src/index.js";
+export { BuildModeSchema, CodeEnvDetailsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, ConnectionSummarySchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, JobSummaryArraySchema, JobSummarySchema, JobWaitResultSchema, JupyterCellSchema, JupyterNotebookContentSchema, JupyterNotebookSummaryArraySchema, JupyterNotebookSummarySchema, NotebookSessionArraySchema, NotebookSessionSchema, parseSchema, ProjectDetailsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, ScenarioWaitResultSchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, } from "../packages/types/src/index.js";
+export type { BuildMode, CodeEnvDetails, CodeEnvSummary, ConnectionSummary, DatasetCreateOptions, DatasetDetails, DatasetSchema, DatasetSummary, FlowMapOptions, FolderDetails, FolderItem, FolderSummary, JobSummary, JobWaitResult, JupyterCell, JupyterNotebookContent, JupyterNotebookSummary, NotebookSession, ProjectDetails, ProjectMetadata, ProjectSummary, ProjectVariables, RecipeCreateOptions, RecipeCreateResult, RecipeDetails, RecipeSummary, SafeParseResult, ScenarioDetails, ScenarioStatus, ScenarioSummary, ScenarioWaitResult, SqlNotebookCell, SqlNotebookContent, SqlNotebookSummary, SqlQueryResponse, SqlQueryResult, SqlQuerySchema, } from "../packages/types/src/index.js";

package/dist/src/schemas.js

@@ -3,4 +3,4 @@
  * The types package (packages/types/) owns the TypeBox schema definitions.
  * SDK consumers get everything through this re-export.
  */
-export { BuildModeSchema, CodeEnvDetailsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, ConnectionSummarySchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, JobSummaryArraySchema, JobSummarySchema, JobWaitResultSchema, JupyterCellSchema, JupyterNotebookContentSchema, JupyterNotebookSummaryArraySchema, JupyterNotebookSummarySchema, NotebookSessionArraySchema, NotebookSessionSchema, parseSchema, ProjectDetailsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, } from "../packages/types/src/index.js";
+export { BuildModeSchema, CodeEnvDetailsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, ConnectionSummarySchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, JobSummaryArraySchema, JobSummarySchema, JobWaitResultSchema, JupyterCellSchema, JupyterNotebookContentSchema, JupyterNotebookSummaryArraySchema, JupyterNotebookSummarySchema, NotebookSessionArraySchema, NotebookSessionSchema, parseSchema, ProjectDetailsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, ScenarioWaitResultSchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, } from "../packages/types/src/index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "dataiku-sdk",
-	"version": "0.3.1",
+	"version": "0.4.0",
 	"description": "Dataiku DSS SDK and CLI for programmatic access to DSS REST APIs",
 	"type": "module",
 	"workspaces": [

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

@@ -233,6 +233,16 @@ export declare const ScenarioStatusSchema: import("@sinclair/typebox").TObject<{
     }>>;
 }>;
 export type ScenarioStatus = Static<typeof ScenarioStatusSchema>;
+export declare const ScenarioWaitResultSchema: import("@sinclair/typebox").TObject<{
+    scenarioId: import("@sinclair/typebox").TString;
+    runId: import("@sinclair/typebox").TString;
+    outcome: import("@sinclair/typebox").TString;
+    success: import("@sinclair/typebox").TBoolean;
+    elapsedMs: import("@sinclair/typebox").TNumber;
+    pollCount: import("@sinclair/typebox").TNumber;
+    timedOut: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
+}>;
+export type ScenarioWaitResult = Static<typeof ScenarioWaitResultSchema>;
 export declare const FolderSummarySchema: import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TString;
     name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;

package/packages/types/dist/index.js

@@ -284,6 +284,15 @@ export const ScenarioStatusSchema = Type.Object({
         }, { additionalProperties: true, })),
     }, { additionalProperties: true, })),
 }, { additionalProperties: true, });
+export const ScenarioWaitResultSchema = Type.Object({
+    scenarioId: Type.String(),
+    runId: Type.String(),
+    outcome: Type.String(),
+    success: Type.Boolean(),
+    elapsedMs: Type.Number(),
+    pollCount: Type.Number(),
+    timedOut: Type.Optional(Type.Boolean()),
+});
 // ---------------------------------------------------------------------------
 // Folders
 // ---------------------------------------------------------------------------