dataiku-sdk 3.4.0 → 3.6.0

package/dist/src/cli/commands/data-collection.js

@@ -1,24 +1,23 @@
 import { requiredJsonInput, } from "../coerce.js";
 import { executionMode, } from "../flags.js";
 import { planResult, } from "../output.js";
+import { commandUsage, withUsage, } from "../syntax.js";
 import { requireArgs, UsageError, } from "../usage.js";
 const PLAN_FAILURE_CODES = { usage: 1, error: 2, transient: 3, };
 function collectionEndpoint(dataCollectionId, suffix = "") {
     return `/public/api/data-collections/${encodeURIComponent(dataCollectionId)}${suffix}`;
 }
-export const dataCollectionCommands = {
+export const dataCollectionCommands = withUsage("data-collection", {
     list: {
         handler: (c) => c.dataCollections.list(),
-        usage: "dss data-collection list",
         description: "List data collections on which the API key has READ privilege.",
         examples: ["dss data-collection list",],
     },
     get: {
         handler: (c, a) => {
-            requireArgs(a, 1, "dss data-collection get <dataCollectionId>");
+            requireArgs(a, 1, commandUsage("data-collection", "get"));
             return c.dataCollections.get(a[0]);
         },
-        usage: "dss data-collection get <dataCollectionId>",
         description: "Get collection settings. Permissions are omitted for non-admins.",
         examples: ["dss data-collection get OjVsTQ3O",],
     },
@@ -38,7 +37,6 @@ export const dataCollectionCommands = {
             }
             return c.dataCollections.create(body);
         },
-        usage: "dss data-collection create (--data JSON|--data-file PATH|--stdin) [--dry-run]",
         description: "Create a collection (creator becomes admin; requires mayCreateDataCollections).",
         examples: [
             'dss data-collection create --data \'{"displayName":"My Collection"}\'',
@@ -46,7 +44,7 @@ export const dataCollectionCommands = {
     },
     "settings-set": {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss data-collection settings-set <dataCollectionId> (--data JSON|--data-file PATH|--stdin) [--dry-run]");
+            requireArgs(a, 1, commandUsage("data-collection", "settings-set"));
             const settings = requiredJsonInput(f, "--data, --data-file, or --stdin is required (collection settings).");
             if (executionMode(f).dryRun) {
                 return planResult("data-collection", "settings-set", {
@@ -63,7 +61,6 @@ export const dataCollectionCommands = {
             const updated = await c.dataCollections.update(a[0], settings);
             return { updated: a[0], resource: "data-collection", ...updated, };
         },
-        usage: "dss data-collection settings-set <dataCollectionId> (--data JSON|--data-file PATH|--stdin) [--dry-run]",
         description: "Update collection settings; only send settings obtained through get. Admin required.",
         examples: [
             "dss data-collection settings-set OjVsTQ3O --data-file settings.json",
@@ -71,7 +68,7 @@ export const dataCollectionCommands = {
     },
     delete: {
         validate: (a) => {
-            const usage = "dss data-collection delete <dataCollectionId> [--dry-run]";
+            const usage = commandUsage("data-collection", "delete");
             requireArgs(a, 1, usage);
             if (a[0].trim().length === 0) {
                 throw new UsageError(`<dataCollectionId> must be a non-empty identifier. Usage: ${usage}`);
@@ -92,16 +89,14 @@ export const dataCollectionCommands = {
             await c.dataCollections.delete(a[0]);
             return { deleted: a[0], resource: "data-collection", };
         },
-        usage: "dss data-collection delete <dataCollectionId> [--dry-run]",
         description: "Permanently delete a collection. Admin required.",
         examples: ["dss data-collection delete OjVsTQ3O --dry-run",],
     },
     "list-objects": {
         handler: (c, a) => {
-            requireArgs(a, 1, "dss data-collection list-objects <dataCollectionId>");
+            requireArgs(a, 1, commandUsage("data-collection", "list-objects"));
             return c.dataCollections.listObjects(a[0]);
         },
-        usage: "dss data-collection list-objects <dataCollectionId>",
         description: "List the objects in a collection.",
         examples: ["dss data-collection list-objects OjVsTQ3O",],
     },
@@ -111,7 +106,7 @@ export const dataCollectionCommands = {
             const collectionId = a[0]
                 ?? (typeof object.dataCollectionId === "string" ? object.dataCollectionId : undefined);
             if (!collectionId) {
-                throw new UsageError("Usage: dss data-collection add-object <dataCollectionId> (--data JSON|--data-file PATH|--stdin)");
+                throw new UsageError(`Usage: ${commandUsage("data-collection", "add-object")}`);
             }
             const reference = { ...object, };
             delete reference.dataCollectionId;
@@ -130,7 +125,6 @@ export const dataCollectionCommands = {
             await c.dataCollections.addObject(collectionId, reference);
             return { added: reference.id, dataCollectionId: collectionId, resource: "data-collection", };
         },
-        usage: "dss data-collection add-object <dataCollectionId> (--data JSON|--data-file PATH|--stdin) [--dry-run]",
         description: "Add an object (e.g. {type:'DATASET',projectKey:'K',id:'name'}) to a collection. Contributor required.",
         examples: [
             'dss data-collection add-object OjVsTQ3O --data \'{"type":"DATASET","projectKey":"MYPROJECT","id":"orders"}\'',
@@ -138,7 +132,7 @@ export const dataCollectionCommands = {
     },
     "remove-dataset": {
         handler: async (c, a, f) => {
-            requireArgs(a, 3, "dss data-collection remove-dataset <dataCollectionId> <projectKey> <datasetName> [--dry-run]");
+            requireArgs(a, 3, commandUsage("data-collection", "remove-dataset"));
             if (executionMode(f).dryRun) {
                 return planResult("data-collection", "remove-dataset", {
                     asyncKind: "none",
@@ -157,8 +151,7 @@ export const dataCollectionCommands = {
             await c.dataCollections.removeDataset(a[0], a[1], a[2]);
             return { removed: a[2], projectKey: a[1], dataCollectionId: a[0], resource: "data-collection", };
         },
-        usage: "dss data-collection remove-dataset <dataCollectionId> <projectKey> <datasetName> [--dry-run]",
         description: "Remove a dataset from a collection. Contributor required.",
         examples: ["dss data-collection remove-dataset OjVsTQ3O MYPROJECT DATASET1",],
     },
-};
+});

package/dist/src/cli/commands/data-quality.js

@@ -2,6 +2,7 @@ import { deepMerge, } from "../../utils/deep-merge.js";
 import { num, parseBooleanOption, requiredJsonInput, } from "../coerce.js";
 import { executionMode, } from "../flags.js";
 import { encodedProjectEndpoint, readIfExists, skipResult, } from "../output.js";
+import { commandUsage, withUsage, } from "../syntax.js";
 import { requireArgs, UsageError, } from "../usage.js";
 /**
  * A data quality result counts as passing only when it actually carries a
@@ -15,37 +16,34 @@ function resultReportsOk(result) {
         .map((value) => value.trim().toUpperCase());
     return verdicts.length > 0 && verdicts.every((value) => value === "OK");
 }
-export const dataQualityCommands = {
+export const dataQualityCommands = withUsage("data-quality", {
     rules: {
         handler: (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality rules <dataset>");
+            requireArgs(a, 1, commandUsage("data-quality", "rules"));
             return c.dataQuality.listRules(a[0], f["project-key"]);
         },
-        usage: "dss data-quality rules <dataset> [--project-key KEY]",
         description: "List data quality rules for a dataset.",
         examples: ["dss data-quality rules orders",],
     },
     "get-rule": {
         handler: (c, a, f) => {
-            requireArgs(a, 2, "dss data-quality get-rule <dataset> <rule-id>");
+            requireArgs(a, 2, commandUsage("data-quality", "get-rule"));
             return c.dataQuality.getRule(a[0], a[1], f["project-key"]);
         },
-        usage: "dss data-quality get-rule <dataset> <rule-id> [--project-key KEY]",
         description: "Get one data quality rule by id.",
         examples: ["dss data-quality get-rule orders RULE_ID",],
     },
     status: {
         handler: (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality status <dataset>");
+            requireArgs(a, 1, commandUsage("data-quality", "status"));
             return c.dataQuality.status(a[0], f["project-key"]);
         },
-        usage: "dss data-quality status <dataset> [--project-key KEY]",
         description: "Get the aggregate data quality status for a dataset.",
         examples: ["dss data-quality status orders",],
     },
     "create-rule": {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality create-rule <dataset> --data JSON");
+            requireArgs(a, 1, commandUsage("data-quality", "create-rule"));
             const config = requiredJsonInput(f, "--data, --data-file, or --stdin is required.");
             const pk = f["project-key"];
             const identity = typeof config.id === "string"
@@ -88,7 +86,6 @@ export const dataQualityCommands = {
                 ...created,
             };
         },
-        usage: "dss data-quality create-rule <dataset> (--data JSON|--data-file PATH|--stdin) [--if-not-exists] [--dry-run] [--project-key KEY]",
         description: "Create a data quality rule from raw rule config.",
         examples: [
             'dss data-quality create-rule orders --data \'{"type":"RecordCountInRangeRule","softMinimum":1,"softMinimumEnabled":true,"displayName":"Has rows"}\' --dry-run',
@@ -96,7 +93,7 @@ export const dataQualityCommands = {
     },
     "update-rule": {
         handler: async (c, a, f) => {
-            requireArgs(a, 2, "dss data-quality update-rule <dataset> <rule-id> --data JSON");
+            requireArgs(a, 2, commandUsage("data-quality", "update-rule"));
             const data = requiredJsonInput(f, "--data, --data-file, or --stdin is required.");
             if (executionMode(f).dryRun) {
                 const current = await c.dataQuality.getRule(a[0], a[1], f["project-key"]);
@@ -116,7 +113,6 @@ export const dataQualityCommands = {
                 projectKey: f["project-key"],
             });
         },
-        usage: "dss data-quality update-rule <dataset> <rule-id> (--data JSON|--data-file PATH|--stdin) [--dry-run] [--project-key KEY]",
         description: "Update a data quality rule via GET-before-PUT merge.",
         examples: [
             "dss data-quality update-rule orders RULE_ID --data '{\"enabled\":false}' --dry-run",
@@ -124,7 +120,7 @@ export const dataQualityCommands = {
     },
     "delete-rule": {
         handler: async (c, a, f) => {
-            requireArgs(a, 2, "dss data-quality delete-rule <dataset> <rule-id>");
+            requireArgs(a, 2, commandUsage("data-quality", "delete-rule"));
             const pk = f["project-key"];
             if (executionMode(f).dryRun || f["if-exists"] === true) {
                 const current = await readIfExists(() => c.dataQuality.getRule(a[0], a[1], pk));
@@ -144,38 +140,35 @@ export const dataQualityCommands = {
             await c.dataQuality.deleteRule(a[0], a[1], pk);
             return { deleted: a[1], dataset: a[0], resource: "data-quality", };
         },
-        usage: "dss data-quality delete-rule <dataset> <rule-id> [--if-exists] [--dry-run] [--project-key KEY]",
         description: "Delete a data quality rule.",
         examples: ["dss data-quality delete-rule orders RULE_ID --dry-run",],
     },
     "status-by-partition": {
         handler: (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality status-by-partition <dataset>");
+            requireArgs(a, 1, commandUsage("data-quality", "status-by-partition"));
             return c.dataQuality.statusByPartition(a[0], {
                 includeAllPartitions: f["include-all-partitions"] === true,
                 projectKey: f["project-key"],
             });
         },
-        usage: "dss data-quality status-by-partition <dataset> [--include-all-partitions] [--project-key KEY]",
         description: "Get data quality status by dataset partition.",
         examples: ["dss data-quality status-by-partition orders --include-all-partitions",],
     },
     "last-results": {
         handler: (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality last-results <dataset>");
+            requireArgs(a, 1, commandUsage("data-quality", "last-results"));
             return c.dataQuality.lastResults(a[0], {
                 partition: f["partition"],
                 ruleId: f["rule-id"],
                 projectKey: f["project-key"],
             });
         },
-        usage: "dss data-quality last-results <dataset> [--partition P] [--rule-id ID] [--project-key KEY]",
         description: "Get latest data quality rule results for a dataset.",
         examples: ["dss data-quality last-results orders",],
     },
     "assert-results": {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality assert-results <dataset>");
+            requireArgs(a, 1, commandUsage("data-quality", "assert-results"));
             const ruleId = f["rule-id"];
             const pk = f["project-key"];
             const results = await c.dataQuality.lastResults(a[0], { ruleId, projectKey: pk, });
@@ -196,7 +189,6 @@ export const dataQualityCommands = {
                 ...(selected.length === 0 ? { reason: "no_results", } : {}),
             };
         },
-        usage: "dss data-quality assert-results <dataset> [--rule-id ID] [--project-key KEY]",
         description: "Assert the latest data quality results: at least one selected rule must exist and every selected result must report OK. Returns { satisfied, checked, failed } with failed rule ids/outcomes only; a failed assertion exits 4 with assertion_failed.",
         examples: [
             "dss data-quality assert-results orders",
@@ -205,7 +197,7 @@ export const dataQualityCommands = {
     },
     history: {
         handler: (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality history <dataset>");
+            requireArgs(a, 1, commandUsage("data-quality", "history"));
             return c.dataQuality.history(a[0], {
                 minTimestamp: num(f["min-timestamp"], "--min-timestamp"),
                 maxTimestamp: num(f["max-timestamp"], "--max-timestamp"),
@@ -215,7 +207,6 @@ export const dataQualityCommands = {
                 projectKey: f["project-key"],
             });
         },
-        usage: "dss data-quality history <dataset> [--rule-id ID] [--min-timestamp MS] [--max-timestamp MS] [--results-per-page N] [--page N] [--project-key KEY]",
         description: "Get data quality rule execution history.",
         examples: ["dss data-quality history orders --results-per-page 100",],
     },
@@ -224,7 +215,6 @@ export const dataQualityCommands = {
             onlyMonitored: parseBooleanOption(f["only-monitored"], "--only-monitored"),
             projectKey: f["project-key"],
         }),
-        usage: "dss data-quality project-status [--only-monitored true|false] [--project-key KEY]",
         description: "Get project-level data quality status by dataset.",
         examples: ["dss data-quality project-status --only-monitored false",],
     },
@@ -234,13 +224,12 @@ export const dataQualityCommands = {
             maxTimestamp: num(f["max-timestamp"], "--max-timestamp"),
             projectKey: f["project-key"],
         }),
-        usage: "dss data-quality project-timeline [--min-timestamp MS] [--max-timestamp MS] [--project-key KEY]",
         description: "Get project-level data quality timeline aggregates.",
         examples: ["dss data-quality project-timeline --min-timestamp 1714521600000",],
     },
     compute: {
         handler: async (c, a, f) => {
-            requireArgs(a, 1, "dss data-quality compute <dataset>");
+            requireArgs(a, 1, commandUsage("data-quality", "compute"));
             const pk = f["project-key"];
             const options = {
                 partition: f["partition"],
@@ -268,11 +257,10 @@ export const dataQualityCommands = {
                 return c.dataQuality.computeRulesAndWait(a[0], options);
             return c.dataQuality.computeRules(a[0], options);
         },
-        usage: "dss data-quality compute <dataset> [--partition P] [--rule-id ID] [--wait] [--timeout MS] [--poll-interval MS] [--dry-run] [--project-key KEY]",
         description: "Start data quality rule computation, optionally waiting on the returned DSS future.",
         examples: [
             "dss data-quality compute orders --dry-run",
             "dss data-quality compute orders --wait",
         ],
     },
-};
+});