dataiku-sdk 3.7.0 → 3.8.0

package/dist/build-metadata.json

@@ -1 +1 @@
-{"format":1,"buildRevision":"a980b6ec9bd11f68d319f7034152d7f9dd4ccd83"}
+{"format":1,"buildRevision":"6814ed4e3da988eccd85f9f50d79e1da66253b0a"}

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

@@ -124,6 +124,7 @@ export declare const DatasetCreateOptionsSchema: import("@sinclair/typebox").TOb
     table: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     dbSchema: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     catalog: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    query: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     formatType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     formatParams: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>>;
     managed: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
@@ -184,10 +185,18 @@ export declare const RecipeCreateOptionsSchema: import("@sinclair/typebox").TObj
     dropColumns: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
     /** Prepare: the only columns to keep. */
     keepColumns: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    /**
+     * Prepare: order of the option groups (`rename`, `fillEmpty`, `formula`, `filter`,
+     * `dropColumns`, `keepColumns`); the CLI passes the order the flags were typed in.
+     * Groups left out follow in that default order.
+     */
+    stepOrder: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
 }>;
 export type RecipeCreateOptions = Static<typeof RecipeCreateOptionsSchema>;
 export declare const RecipeCreateResultSchema: import("@sinclair/typebox").TObject<{
     recipeName: import("@sinclair/typebox").TString;
+    /** The `--name` that was asked for, present only when DSS created the recipe under a different name. */
+    requestedName: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     type: import("@sinclair/typebox").TString;
     createdDatasets: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
     joinConfigured: import("@sinclair/typebox").TBoolean;
@@ -530,14 +539,15 @@ export declare const FlowZoneCreateOptionsSchema: import("@sinclair/typebox").TO
     }>>;
 }>;
 export type FlowZoneCreateOptions = Static<typeof FlowZoneCreateOptionsSchema>;
+/**
+ * DSS's public `PUT /flow/zones/{id}` persists name and color but silently
+ * ignores `position`; repositioning an existing zone goes through
+ * `flowZones.recreate`, which creates a replacement zone at the new position.
+ */
 export declare const FlowZoneUpdateOptionsSchema: import("@sinclair/typebox").TObject<{
     name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     color: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     projectKey: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
-    position: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
-        x: import("@sinclair/typebox").TNumber;
-        y: import("@sinclair/typebox").TNumber;
-    }>>;
 }>;
 export type FlowZoneUpdateOptions = Static<typeof FlowZoneUpdateOptionsSchema>;
 export declare const FolderCreateOptionsSchema: import("@sinclair/typebox").TObject<{
@@ -675,10 +685,24 @@ export declare const WikiSettingsSchema: import("@sinclair/typebox").TObject<{
     homeArticleId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>;
 export type WikiSettings = Static<typeof WikiSettingsSchema>;
+/** One entry of a wiki article's `attachments` (uploaded FILE or linked DSS object). */
+export declare const WikiArticleAttachmentSchema: import("@sinclair/typebox").TObject<{
+    attachmentType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    smartId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    taggableType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    details: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>>;
+}>;
+export type WikiArticleAttachment = Static<typeof WikiArticleAttachmentSchema>;
 export declare const WikiArticleMetadataSchema: import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TString;
     name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     projectKey: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    attachments: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        attachmentType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        smartId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        taggableType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        details: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>>;
+    }>>>;
 }>;
 export type WikiArticleMetadata = Static<typeof WikiArticleMetadataSchema>;
 export declare const WikiArticleDataSchema: import("@sinclair/typebox").TObject<{
@@ -686,6 +710,12 @@ export declare const WikiArticleDataSchema: import("@sinclair/typebox").TObject<
         id: import("@sinclair/typebox").TString;
         name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
         projectKey: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        attachments: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            attachmentType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            smartId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            taggableType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            details: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>>;
+        }>>>;
     }>;
     payload: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>;
@@ -1071,6 +1101,12 @@ export declare const WikiArticleDataArraySchema: import("@sinclair/typebox").TAr
         id: import("@sinclair/typebox").TString;
         name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
         projectKey: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        attachments: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+            attachmentType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            smartId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            taggableType: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+            details: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TUnknown>>;
+        }>>>;
     }>;
     payload: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>>;

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

@@ -169,6 +169,7 @@ export const DatasetCreateOptionsSchema = Type.Object({
     table: Type.Optional(Type.String()),
     dbSchema: Type.Optional(Type.String()),
     catalog: Type.Optional(Type.String()),
+    query: Type.Optional(Type.String()),
     formatType: Type.Optional(Type.String()),
     formatParams: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
     managed: Type.Optional(Type.Boolean()),
@@ -229,9 +230,17 @@ export const RecipeCreateOptionsSchema = Type.Object({
     dropColumns: Type.Optional(Type.Array(Type.String())),
     /** Prepare: the only columns to keep. */
     keepColumns: Type.Optional(Type.Array(Type.String())),
+    /**
+     * Prepare: order of the option groups (`rename`, `fillEmpty`, `formula`, `filter`,
+     * `dropColumns`, `keepColumns`); the CLI passes the order the flags were typed in.
+     * Groups left out follow in that default order.
+     */
+    stepOrder: Type.Optional(Type.Array(Type.String())),
 });
 export const RecipeCreateResultSchema = Type.Object({
     recipeName: Type.String(),
+    /** The `--name` that was asked for, present only when DSS created the recipe under a different name. */
+    requestedName: Type.Optional(Type.String()),
     type: Type.String(),
     createdDatasets: Type.Array(Type.String()),
     joinConfigured: Type.Boolean(),
@@ -500,11 +509,15 @@ export const FlowZoneCreateOptionsSchema = Type.Object({
     projectKey: Type.Optional(Type.String()),
     position: Type.Optional(FlowZonePositionSchema),
 }, { additionalProperties: false, });
+/**
+ * DSS's public `PUT /flow/zones/{id}` persists name and color but silently
+ * ignores `position`; repositioning an existing zone goes through
+ * `flowZones.recreate`, which creates a replacement zone at the new position.
+ */
 export const FlowZoneUpdateOptionsSchema = Type.Object({
     name: Type.Optional(Type.String()),
     color: Type.Optional(Type.String()),
     projectKey: Type.Optional(Type.String()),
-    position: Type.Optional(FlowZonePositionSchema),
 }, { additionalProperties: false, });
 // ---------------------------------------------------------------------------
 // Folders
@@ -631,10 +644,18 @@ export const WikiSettingsSchema = Type.Object({
     taxonomy: Type.Optional(Type.Array(WikiTaxonomyNodeSchema)),
     homeArticleId: Type.Optional(Type.String()),
 }, { additionalProperties: true, });
+/** One entry of a wiki article's `attachments` (uploaded FILE or linked DSS object). */
+export const WikiArticleAttachmentSchema = Type.Object({
+    attachmentType: Type.Optional(Type.String()),
+    smartId: Type.Optional(Type.String()),
+    taggableType: Type.Optional(Type.String()),
+    details: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
+}, { additionalProperties: true, });
 export const WikiArticleMetadataSchema = Type.Object({
     id: Type.String(),
     name: Type.Optional(Type.String()),
     projectKey: Type.Optional(Type.String()),
+    attachments: Type.Optional(Type.Array(WikiArticleAttachmentSchema)),
 }, { additionalProperties: true, });
 export const WikiArticleDataSchema = Type.Object({
     article: WikiArticleMetadataSchema,

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

@@ -20,6 +20,7 @@ export declare function expectJsonObject(value: unknown, source: string): Record
 export declare function parseJsonObject(text: string, source: string): Record<string, unknown>;
 export declare function json(v: string | boolean | undefined, source?: string): Record<string, unknown> | undefined;
 export declare function readStdinText(): string;
+export declare function readInputText(path: string, flag: string): string;
 export declare function seenJsonInputCredentials(): readonly string[];
 export declare function jsonInput(flags: Record<string, string | boolean>): Record<string, unknown> | undefined;
 export declare function unknownJsonInput(flags: Record<string, string | boolean>): unknown;

package/dist/src/cli/coerce.js

@@ -165,7 +165,7 @@ function selectSingleSource(flags, sourceFlags) {
     }
     return provided[0];
 }
-function readInputText(path, flag) {
+export function readInputText(path, flag) {
     try {
         return readFileSync(path, "utf-8");
     }

package/dist/src/cli/command-syntax.json

@@ -4227,6 +4227,48 @@
                     ]
                 ]
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "table",
+                            "value": "TABLE"
+                        },
+                        {
+                            "optional": [
+                                [
+                                    {
+                                        "flag": "schema",
+                                        "value": "SCHEMA"
+                                    }
+                                ]
+                            ]
+                        },
+                        {
+                            "optional": [
+                                [
+                                    {
+                                        "flag": "catalog",
+                                        "value": "CATALOG"
+                                    }
+                                ]
+                            ]
+                        }
+                    ],
+                    [
+                        {
+                            "flag": "query",
+                            "value": "SQL"
+                        }
+                    ],
+                    [
+                        {
+                            "flag": "query-file",
+                            "value": "PATH"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -5550,6 +5592,15 @@
                     ]
                 ]
             },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "recreate-on-move"
+                        }
+                    ]
+                ]
+            },
             {
                 "optional": [
                     [
@@ -17184,6 +17235,36 @@
                 ]
             }
         ],
+        "wiki.attach": [
+            "dss",
+            "wiki",
+            "attach",
+            {
+                "arg": "id-or-name"
+            },
+            {
+                "arg": "localPath"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "dry-run"
+                        }
+                    ]
+                ]
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "project-key",
+                            "value": "KEY"
+                        }
+                    ]
+                ]
+            }
+        ],
         "wiki.create": [
             "dss",
             "wiki",
@@ -17283,6 +17364,45 @@
                 ]
             }
         ],
+        "wiki.detach": [
+            "dss",
+            "wiki",
+            "detach",
+            {
+                "arg": "id-or-name"
+            },
+            {
+                "arg": "smartId"
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "if-exists"
+                        }
+                    ]
+                ]
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "dry-run"
+                        }
+                    ]
+                ]
+            },
+            {
+                "optional": [
+                    [
+                        {
+                            "flag": "project-key",
+                            "value": "KEY"
+                        }
+                    ]
+                ]
+            }
+        ],
         "wiki.get": [
             "dss",
             "wiki",

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

@@ -1,10 +1,10 @@
-import { assertDatasetTypeCreatable, } from "../../resources/dataset-create.js";
+import { assertDatasetTypeCreatable, buildDatasetCreateBody, } from "../../resources/dataset-create.js";
 import { deepMerge, } from "../../utils/deep-merge.js";
 import { isRecord, } from "../../utils/records.js";
 import { compareStrings, stableHash, } from "../../utils/stable-hash.js";
 import { jsonInput, num, schemaColumnsInput, splitCsvFlag, unknownJsonInput, } from "../coerce.js";
 import { executionMode, } from "../flags.js";
-import { datasetSourceSummary, } from "../helpers/dataset.js";
+import { datasetSourceSummary, datasetSqlSourceFromFlags, } from "../helpers/dataset.js";
 import { moveCreatedItemsToZone, resolveFlowZoneIdFromFlags, } from "../helpers/flow-zone.js";
 import { enqueueCliWarning, readIfExists, skipResult, } from "../output.js";
 import { commandUsage, withUsage, } from "../syntax.js";
@@ -366,11 +366,14 @@ export const datasetCommands = withUsage("dataset", {
             if (!connection && dsType.toLowerCase() !== "uploadedfiles") {
                 throw new UsageError("--connection is required unless --type is UploadedFiles.");
             }
+            const sqlSource = datasetSqlSourceFromFlags(f, dsType);
+            const hasSqlSource = sqlSource.table !== undefined || sqlSource.query !== undefined;
             const payload = {
                 datasetName: name,
                 connection,
                 dsType,
                 projectKey: pk,
+                ...sqlSource,
             };
             const zoneId = await resolveFlowZoneIdFromFlags(c, f, pk);
             if (f["if-not-exists"] === true || executionMode(f).dryRun) {
@@ -386,20 +389,53 @@ export const datasetCommands = withUsage("dataset", {
                         resource: "dataset",
                         name,
                         payload,
+                        ...(hasSqlSource
+                            ? {
+                                request: {
+                                    method: "POST",
+                                    endpoint: `/public/api/projects/${encodeURIComponent(c.resolveProjectKey(pk))}/datasets/`,
+                                    body: buildDatasetCreateBody({
+                                        ...payload,
+                                        projectKey: c.resolveProjectKey(pk),
+                                    }),
+                                },
+                                schemaDetection: "After the POST, DSS detects the schema (POST /actions/testAndDetectSettings/externalSQL) and it is stored (PUT /schema).",
+                            }
+                            : {}),
                         ...(existing ? { current: existing, } : {}),
                         ...(zoneId ? { zoneId, zoneMove: [{ objectId: name, objectType: "DATASET", },], } : {}),
                     };
                 }
             }
             await c.datasets.create(payload);
+            const detection = hasSqlSource ? await c.datasets.detectSqlSchema(name, pk) : undefined;
+            if (detection && !detection.detected) {
+                enqueueCliWarning({
+                    code: "dataset_schema_not_detected",
+                    dataset: name,
+                    error: detection.error,
+                    hint: `The dataset was kept without columns. Fix the connection, table, or query, then set the columns with dss dataset refresh-schema ${name}.`,
+                });
+            }
             const moved = await moveCreatedItemsToZone(c, f, [{ objectId: name, objectType: "DATASET", },], pk);
-            return { created: name, resource: "dataset", ...moved, };
+            return {
+                created: name,
+                resource: "dataset",
+                ...(detection
+                    ? {
+                        schemaDetected: detection.detected,
+                        columns: detection.columns,
+                        ...(detection.error !== undefined ? { schemaError: detection.error, } : {}),
+                    }
+                    : {}),
+                ...moved,
+            };
         },
-        description: "Create a new dataset. UploadedFiles uses the server's default upload connection when omitted.",
+        description: "Create a dataset. SQL types: --table or --query, schema auto-detected.",
         examples: [
             "dss dataset create --name uploads --type UploadedFiles",
-            "dss dataset create --name orders --connection filesystem --type Filesystem",
-            "dss dataset create --name orders --connection filesystem --type Filesystem --zone Experiments --dry-run",
+            "dss dataset create --name sales --type Snowflake --connection sf --table SALES --schema PUBLIC",
+            "dss dataset create --name big --type PostgreSQL --connection pg --query-file big.sql --dry-run",
         ],
     },
     "create-managed": {