dataiku-sdk 0.6.1 → 0.7.0

package/dist/src/client.d.ts

@@ -35,7 +35,7 @@ export interface DataikuClientConfig {
     caCertPath?: string;
     /**
      * Called when an API response fails schema validation but data is still usable.
-     * Default: writes to stderr. Set to a throwing function for strict mode.
+     * Default: ignored. Set to a recording or throwing function for strict mode.
      * @param method - resource method that triggered the warning (e.g. "datasets.list")
      * @param errors - human-readable validation error strings
      */
@@ -50,23 +50,23 @@ export declare class DataikuClient {
     private readonly verbose;
     private readonly tlsOptions;
     private readonly onValidationWarning;
-    private _projects?;
-    private _datasets?;
-    private _recipes?;
-    private _dashboards?;
-    private _dataQuality?;
-    private _jobs?;
+    private projectsResource?;
+    private datasetsResource?;
+    private recipesResource?;
+    private dashboardsResource?;
+    private dataQualityResource?;
+    private jobsResource?;
     private futuresResource?;
-    private _scenarios?;
-    private _folders?;
-    private _flowZones?;
-    private _variables?;
-    private _connections?;
-    private _codeEnvs?;
-    private _insights?;
-    private _sql?;
-    private _notebooks?;
-    private _wiki?;
+    private scenariosResource?;
+    private foldersResource?;
+    private flowZonesResource?;
+    private variablesResource?;
+    private connectionsResource?;
+    private codeEnvsResource?;
+    private insightsResource?;
+    private sqlResource?;
+    private notebooksResource?;
+    private wikiResource?;
     get projects(): ProjectsResource;
     get datasets(): DatasetsResource;
     get dashboards(): DashboardsResource;
@@ -113,6 +113,7 @@ export declare class DataikuClient {
     safeParse<S extends TSchema>(schema: S, data: unknown, method: string): Static<S>;
     /** Emit a validation warning via the configured callback. */
     warn(method: string, errors: string[]): void;
+    private requestIdFromHeaders;
     private parseJsonResponse;
     private fetchWithRetry;
 }

package/dist/src/client.js

@@ -31,8 +31,7 @@ const DEFAULT_REQUEST_TIMEOUT_MS = 30_000;
 /* ------------------------------------------------------------------ */
 /*  Helpers                                                            */
 /* ------------------------------------------------------------------ */
-function defaultValidationWarning(method, errors) {
-    process.stderr.write(`[dataiku-sdk] Schema validation warning in ${method}:\n  ${errors.join("\n  ")}\n`);
+function defaultValidationWarning(_method, _errors) {
 }
 function sleep(ms) {
     return new Promise((r) => setTimeout(r, ms));
@@ -92,73 +91,73 @@ export class DataikuClient {
     tlsOptions;
     onValidationWarning;
     /* Resource namespaces — lazily initialized to break circular imports */
-    _projects;
-    _datasets;
-    _recipes;
-    _dashboards;
-    _dataQuality;
-    _jobs;
+    projectsResource;
+    datasetsResource;
+    recipesResource;
+    dashboardsResource;
+    dataQualityResource;
+    jobsResource;
     futuresResource;
-    _scenarios;
-    _folders;
-    _flowZones;
-    _variables;
-    _connections;
-    _codeEnvs;
-    _insights;
-    _sql;
-    _notebooks;
-    _wiki;
+    scenariosResource;
+    foldersResource;
+    flowZonesResource;
+    variablesResource;
+    connectionsResource;
+    codeEnvsResource;
+    insightsResource;
+    sqlResource;
+    notebooksResource;
+    wikiResource;
     get projects() {
-        return (this._projects ??= new ProjectsResource(this));
+        return (this.projectsResource ??= new ProjectsResource(this));
     }
     get datasets() {
-        return (this._datasets ??= new DatasetsResource(this));
+        return (this.datasetsResource ??= new DatasetsResource(this));
     }
     get dashboards() {
-        return (this._dashboards ??= new DashboardsResource(this));
+        return (this.dashboardsResource ??= new DashboardsResource(this));
     }
     get dataQuality() {
-        return (this._dataQuality ??= new DataQualityResource(this));
+        return (this.dataQualityResource ??= new DataQualityResource(this));
     }
     get recipes() {
-        return (this._recipes ??= new RecipesResource(this));
+        return (this.recipesResource ??= new RecipesResource(this));
     }
     get jobs() {
-        return (this._jobs ??= new JobsResource(this));
+        return (this.jobsResource ??= new JobsResource(this));
     }
     get futures() {
         return (this.futuresResource ??= new FuturesResource(this));
     }
     get scenarios() {
-        return (this._scenarios ??= new ScenariosResource(this));
+        return (this.scenariosResource ??= new ScenariosResource(this));
     }
     get folders() {
-        return (this._folders ??= new FoldersResource(this));
+        return (this.foldersResource ??= new FoldersResource(this));
     }
     get flowZones() {
-        return (this._flowZones ??= new FlowZonesResource(this));
+        return (this.flowZonesResource ??= new FlowZonesResource(this));
     }
     get variables() {
-        return (this._variables ??= new VariablesResource(this));
+        return (this.variablesResource ??= new VariablesResource(this));
     }
     get connections() {
-        return (this._connections ??= new ConnectionsResource(this));
+        return (this.connectionsResource ??= new ConnectionsResource(this));
     }
     get codeEnvs() {
-        return (this._codeEnvs ??= new CodeEnvsResource(this));
+        return (this.codeEnvsResource ??= new CodeEnvsResource(this));
     }
     get insights() {
-        return (this._insights ??= new InsightsResource(this));
+        return (this.insightsResource ??= new InsightsResource(this));
     }
     get sql() {
-        return (this._sql ??= new SqlResource(this));
+        return (this.sqlResource ??= new SqlResource(this));
     }
     get notebooks() {
-        return (this._notebooks ??= new NotebooksResource(this));
+        return (this.notebooksResource ??= new NotebooksResource(this));
     }
     get wiki() {
-        return (this._wiki ??= new WikiResource(this));
+        return (this.wikiResource ??= new WikiResource(this));
     }
     constructor(config) {
         const url = config.url?.trim();
@@ -298,6 +297,20 @@ export class DataikuClient {
         this.onValidationWarning(method, errors);
     }
     /* ---- private: JSON parsing ---- */
+    requestIdFromHeaders(headers) {
+        for (const name of [
+            "x-request-id",
+            "x-dku-request-id",
+            "x-dataiku-request-id",
+            "x-correlation-id",
+            "x-amzn-requestid",
+        ]) {
+            const value = headers.get(name);
+            if (value)
+                return value;
+        }
+        return undefined;
+    }
     async parseJsonResponse(res) {
         const text = await res.text();
         // SAFETY: Empty 2xx responses from DSS are surfaced to callers as undefined
@@ -310,7 +323,7 @@ export class DataikuClient {
         }
         catch {
             const summary = text.length > 300 ? `${text.slice(0, 300)}…` : text;
-            throw new DataikuError(res.status, res.statusText || "Invalid JSON response", `Expected JSON response body but got non-JSON content: ${summary}`);
+            throw new DataikuError(res.status, res.statusText || "Invalid JSON response", `Expected JSON response body but got non-JSON content: ${summary}`, undefined, this.requestIdFromHeaders(res.headers));
         }
     }
     /* ---- private: retry loop ---- */
@@ -347,7 +360,7 @@ export class DataikuClient {
                         await sleep(delayMs);
                         continue;
                     }
-                    throw new DataikuError(res.status, res.statusText, text, buildRetryMetadata(method, retryEnabled, maxAttempts, attempt, delaysMs, false));
+                    throw new DataikuError(res.status, res.statusText, text, buildRetryMetadata(method, retryEnabled, maxAttempts, attempt, delaysMs, false), this.requestIdFromHeaders(res.headers));
                 }
                 return res;
             }

package/dist/src/config.d.ts

@@ -9,5 +9,3 @@ export declare function getConfigDir(): string;
 export declare function getCredentialsPath(): string;
 export declare function loadCredentials(): DssCredentials | null;
 export declare function saveCredentials(creds: DssCredentials): void;
-export declare function deleteCredentials(): void;
-export declare function maskApiKey(apiKey: string): string;

package/dist/src/config.js

@@ -1,4 +1,4 @@
-import { chmodSync, mkdirSync, readFileSync, unlinkSync, writeFileSync, } from "node:fs";
+import { chmodSync, mkdirSync, readFileSync, writeFileSync, } from "node:fs";
 import { homedir, } from "node:os";
 import { dirname, join, resolve, } from "node:path";
 export function getConfigDir() {
@@ -56,18 +56,3 @@ export function saveCredentials(creds) {
     writeFileSync(path, `${JSON.stringify(data, null, 2)}\n`, "utf-8");
     chmodSync(path, 0o600);
 }
-export function deleteCredentials() {
-    try {
-        unlinkSync(getCredentialsPath());
-    }
-    catch (err) {
-        if (err.code === "ENOENT")
-            return;
-        throw err;
-    }
-}
-export function maskApiKey(apiKey) {
-    if (apiKey.length <= 12)
-        return "***";
-    return `${apiKey.slice(0, 6)}...${apiKey.slice(-6)}`;
-}

package/dist/src/errors.d.ts

@@ -24,7 +24,8 @@ export declare class DataikuError extends Error {
     retryable: boolean;
     retryHint: string;
     retry?: DataikuRetryMetadata;
-    constructor(status: number, statusText: string, body: string, retry?: DataikuRetryMetadata);
+    requestId?: string;
+    constructor(status: number, statusText: string, body: string, retry?: DataikuRetryMetadata, requestId?: string);
     private static extractSummary;
     private static formatRetryMetadata;
     private static buildDetails;

package/dist/src/errors.js

@@ -152,7 +152,8 @@ export class DataikuError extends Error {
     retryable;
     retryHint;
     retry;
-    constructor(status, statusText, body, retry) {
+    requestId;
+    constructor(status, statusText, body, retry, requestId) {
         const details = DataikuError.buildDetails(status, statusText, body, retry);
         super(details.message);
         this.status = status;
@@ -163,6 +164,7 @@ export class DataikuError extends Error {
         this.retryable = details.retryable;
         this.retryHint = details.retryHint;
         this.retry = retry;
+        this.requestId = requestId;
     }
     static extractSummary(_status, _statusText, body) {
         try {

package/dist/src/index.d.ts

@@ -1,6 +1,6 @@
 export { DataikuClient, type DataikuClientConfig, } from "./client.js";
 export { type CredentialValidationOptions, type CredentialValidationResult, validateCredentials, } from "./auth.js";
-export { deleteCredentials, type DssCredentials, getConfigDir, getCredentialsPath, loadCredentials, maskApiKey, saveCredentials, } from "./config.js";
+export { type DssCredentials, getConfigDir, getCredentialsPath, loadCredentials, saveCredentials, } from "./config.js";
 export { DataikuError, type DataikuErrorCategory, type DataikuErrorTaxonomy, type DataikuRetryMetadata, } from "./errors.js";
 export { CodeEnvsResource, } from "./resources/code-envs.js";
 export { type ConnectionSchemaListOptions, ConnectionsResource, type ConnectionTableListOptions, } from "./resources/connections.js";
@@ -15,13 +15,13 @@ export { computeNextPollDelayMs, type JobBuildAndWaitOptions, type JobBuildOptio
 export { NotebooksResource, } from "./resources/notebooks.js";
 export { type FlowMapResult, ProjectsResource, } from "./resources/projects.js";
 export { type RecipeCloneOptions, type RecipeCloneResult, type RecipeGraphReference, type RecipeGraphValidationResult, type RecipeRunOptions, type RecipeRunOutput, type RecipeRunResult, RecipesResource, } from "./resources/recipes.js";
-export { normalizeScenarioUpdateData, SCENARIO_CANONICAL_EDITABLE_FIELDS, type ScenarioFieldChange, type ScenarioFieldMismatch, ScenariosResource, type ScenarioUpdateNormalization, type ScenarioUpdatePreview, scenarioUpdatePreview, type ScenarioUpdateResult, } from "./resources/scenarios.js";
+export { normalizeScenarioUpdateData, SCENARIO_CANONICAL_EDITABLE_FIELDS, type ScenarioFieldChange, type ScenarioFieldMismatch, type ScenarioScriptRunResult, ScenariosResource, type ScenarioUpdateNormalization, type ScenarioUpdatePreview, scenarioUpdatePreview, type ScenarioUpdateResult, } from "./resources/scenarios.js";
 export { SqlResource, } from "./resources/sql.js";
 export { VariablesResource, } from "./resources/variables.js";
 export { WikiResource, } from "./resources/wiki.js";
-export { BuildModeSchema, CodeEnvActionResultSchema, CodeEnvCreateOptionsSchema, CodeEnvDetailsSchema, CodeEnvPackageListSchema, CodeEnvSetPackagesOptionsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, CodeEnvUpdatePackagesOptionsSchema, CodeEnvUsageArraySchema, CodeEnvWaitOptionsSchema, ConnectionSummarySchema, DashboardDetailsSchema, DashboardSummaryArraySchema, DashboardSummarySchema, DataQualityComputeResultSchema, DataQualityProjectStatusSchema, DataQualityRuleArraySchema, DataQualityRuleResultArraySchema, DataQualityRuleResultSchema, DataQualityRuleSchema, DataQualityRulesSchema, DataQualityStatusByPartitionSchema, DataQualityStatusSchema, DataQualityTimelineEntrySchema, DataQualityTimelineSchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FlowZoneArraySchema, FlowZoneCreateOptionsSchema, FlowZoneItemSchema, FlowZoneObjectTypeSchema, FlowZoneSchema, FlowZoneUpdateOptionsSchema, FolderCreateOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, FutureStateSchema, FutureWaitResultSchema, InsightDetailsSchema, InsightSummaryArraySchema, InsightSummarySchema, 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, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "./schemas.js";
+export { BuildModeSchema, CodeEnvActionResultSchema, CodeEnvCreateOptionsSchema, CodeEnvDetailsSchema, CodeEnvPackageListSchema, CodeEnvSetPackagesOptionsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, CodeEnvUpdatePackagesOptionsSchema, CodeEnvUsageArraySchema, CodeEnvWaitOptionsSchema, ConnectionSummarySchema, DashboardDetailsSchema, DashboardSummaryArraySchema, DashboardSummarySchema, DataQualityComputeResultSchema, DataQualityProjectStatusSchema, DataQualityRuleArraySchema, DataQualityRuleResultArraySchema, DataQualityRuleResultSchema, DataQualityRuleSchema, DataQualityRulesSchema, DataQualityStatusByPartitionSchema, DataQualityStatusSchema, DataQualityTimelineEntrySchema, DataQualityTimelineSchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FlowZoneArraySchema, FlowZoneCreateOptionsSchema, FlowZoneItemSchema, FlowZoneObjectTypeSchema, FlowZonePositionSchema, FlowZoneSchema, FlowZoneUpdateOptionsSchema, FolderCreateOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, FutureStateSchema, FutureWaitResultSchema, InsightDetailsSchema, InsightSummaryArraySchema, InsightSummarySchema, 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, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "./schemas.js";
 export type { SafeParseResult, } from "./schemas.js";
-export type { BuildMode, CodeEnvActionResult, CodeEnvCreateOptions, CodeEnvDetails, CodeEnvPackageList, CodeEnvSetPackagesOptions, CodeEnvSummary, CodeEnvUpdatePackagesOptions, CodeEnvUsage, CodeEnvWaitOptions, ConnectionSummary, DashboardDetails, DashboardSummary, DataQualityComputeResult, DataQualityProjectStatus, DataQualityRule, DataQualityRuleResult, DataQualityRules, DataQualityStatus, DataQualityStatusByPartition, DataQualityTimeline, DataQualityTimelineEntry, DatasetCreateOptions, DatasetDetails, DatasetSchema, DatasetSummary, FlowMapOptions, FlowZone, FlowZoneCreateOptions, FlowZoneItem, FlowZoneObjectType, FlowZoneUpdateOptions, FolderCreateOptions, FolderDetails, FolderItem, FolderSummary, FutureState, FutureWaitResult, InsightDetails, InsightSummary, JobSummary, JobWaitResult, JupyterCell, JupyterNotebookContent, JupyterNotebookSummary, NotebookSession, ProjectDetails, ProjectMetadata, ProjectSummary, ProjectVariables, RecipeCreateOptions, RecipeCreateResult, RecipeDetails, RecipeSummary, ScenarioDetails, ScenarioStatus, ScenarioSummary, SqlNotebookCell, SqlNotebookContent, SqlNotebookSummary, SqlQueryResponse, SqlQueryResult, SqlQuerySchema, WikiArticleData, WikiArticleMetadata, WikiSettings, WikiTaxonomyNode, } from "./schemas.js";
+export type { BuildMode, CodeEnvActionResult, CodeEnvCreateOptions, CodeEnvDetails, CodeEnvPackageList, CodeEnvSetPackagesOptions, CodeEnvSummary, CodeEnvUpdatePackagesOptions, CodeEnvUsage, CodeEnvWaitOptions, ConnectionSummary, DashboardDetails, DashboardSummary, DataQualityComputeResult, DataQualityProjectStatus, DataQualityRule, DataQualityRuleResult, DataQualityRules, DataQualityStatus, DataQualityStatusByPartition, DataQualityTimeline, DataQualityTimelineEntry, DatasetCreateOptions, DatasetDetails, DatasetSchema, DatasetSummary, FlowMapOptions, FlowZone, FlowZoneCreateOptions, FlowZoneItem, FlowZoneObjectType, FlowZonePosition, FlowZoneUpdateOptions, FolderCreateOptions, FolderDetails, FolderItem, FolderSummary, FutureState, FutureWaitResult, InsightDetails, InsightSummary, JobSummary, JobWaitResult, JupyterCell, JupyterNotebookContent, JupyterNotebookSummary, NotebookSession, ProjectDetails, ProjectMetadata, ProjectSummary, ProjectVariables, RecipeCreateOptions, RecipeCreateResult, RecipeDetails, RecipeSummary, ScenarioDetails, ScenarioStatus, ScenarioSummary, ScenarioWaitResult, SqlNotebookCell, SqlNotebookContent, SqlNotebookSummary, SqlQueryResponse, SqlQueryResult, SqlQuerySchema, WikiArticleData, WikiArticleMetadata, WikiSettings, WikiTaxonomyNode, } from "./schemas.js";
 export { deepMerge, } from "./utils/deep-merge.js";
 export { type NormalizedFlowEdge, type NormalizedFlowMap, type NormalizedFlowNode, normalizeFlowGraph, } from "./utils/flow-map.js";
 export { sanitizeFileName, } from "./utils/sanitize.js";

package/dist/src/index.js

@@ -2,7 +2,7 @@
 export { DataikuClient, } from "./client.js";
 // Auth & Config
 export { validateCredentials, } from "./auth.js";
-export { deleteCredentials, getConfigDir, getCredentialsPath, loadCredentials, maskApiKey, saveCredentials, } from "./config.js";
+export { getConfigDir, getCredentialsPath, loadCredentials, saveCredentials, } from "./config.js";
 // Errors
 export { DataikuError, } from "./errors.js";
 // Resources (for advanced use / extension)
@@ -24,7 +24,7 @@ export { SqlResource, } from "./resources/sql.js";
 export { VariablesResource, } from "./resources/variables.js";
 export { WikiResource, } from "./resources/wiki.js";
 // Schemas (TypeBox schema objects for runtime validation)
-export { BuildModeSchema, CodeEnvActionResultSchema, CodeEnvCreateOptionsSchema, CodeEnvDetailsSchema, CodeEnvPackageListSchema, CodeEnvSetPackagesOptionsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, CodeEnvUpdatePackagesOptionsSchema, CodeEnvUsageArraySchema, CodeEnvWaitOptionsSchema, ConnectionSummarySchema, DashboardDetailsSchema, DashboardSummaryArraySchema, DashboardSummarySchema, DataQualityComputeResultSchema, DataQualityProjectStatusSchema, DataQualityRuleArraySchema, DataQualityRuleResultArraySchema, DataQualityRuleResultSchema, DataQualityRuleSchema, DataQualityRulesSchema, DataQualityStatusByPartitionSchema, DataQualityStatusSchema, DataQualityTimelineEntrySchema, DataQualityTimelineSchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FlowZoneArraySchema, FlowZoneCreateOptionsSchema, FlowZoneItemSchema, FlowZoneObjectTypeSchema, FlowZoneSchema, FlowZoneUpdateOptionsSchema, FolderCreateOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, FutureStateSchema, FutureWaitResultSchema, InsightDetailsSchema, InsightSummaryArraySchema, InsightSummarySchema, 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, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "./schemas.js";
+export { BuildModeSchema, CodeEnvActionResultSchema, CodeEnvCreateOptionsSchema, CodeEnvDetailsSchema, CodeEnvPackageListSchema, CodeEnvSetPackagesOptionsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, CodeEnvUpdatePackagesOptionsSchema, CodeEnvUsageArraySchema, CodeEnvWaitOptionsSchema, ConnectionSummarySchema, DashboardDetailsSchema, DashboardSummaryArraySchema, DashboardSummarySchema, DataQualityComputeResultSchema, DataQualityProjectStatusSchema, DataQualityRuleArraySchema, DataQualityRuleResultArraySchema, DataQualityRuleResultSchema, DataQualityRuleSchema, DataQualityRulesSchema, DataQualityStatusByPartitionSchema, DataQualityStatusSchema, DataQualityTimelineEntrySchema, DataQualityTimelineSchema, DatasetCreateOptionsSchema, DatasetDetailsSchema, DatasetSchemaSchema, DatasetSummaryArraySchema, DatasetSummarySchema, FlowMapOptionsSchema, FlowZoneArraySchema, FlowZoneCreateOptionsSchema, FlowZoneItemSchema, FlowZoneObjectTypeSchema, FlowZonePositionSchema, FlowZoneSchema, FlowZoneUpdateOptionsSchema, FolderCreateOptionsSchema, FolderDetailsSchema, FolderItemArraySchema, FolderItemSchema, FolderSummaryArraySchema, FolderSummarySchema, FutureStateSchema, FutureWaitResultSchema, InsightDetailsSchema, InsightSummaryArraySchema, InsightSummarySchema, 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, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "./schemas.js";
 // Utilities
 export { deepMerge, } from "./utils/deep-merge.js";
 export { normalizeFlowGraph, } from "./utils/flow-map.js";

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

@@ -47,9 +47,9 @@ export declare class DatasetsResource extends BaseResource {
     /** Replace dataset schema columns directly through the schema endpoint. */
     updateSchema(datasetName: string, columns: DatasetSchemaColumnInput[], projectKey?: string): Promise<void>;
     /**
-     * Preview dataset data as CSV text.
-     * Streams TSV from the API, converts to CSV, and returns up to `maxRows`
-     * data rows (plus header).
+     * Preview dataset rows as structured data: column names plus row arrays,
+     * mirroring the sql query shape ({ columns, rows, rowCount }). Streams TSV
+     * from the API and returns up to `maxRows` data rows.
      *
      * If `validateColumns` is provided, the first TSV row (header) is checked
      * against the column names. Mismatches emit a warning via onValidationWarning.
@@ -61,12 +61,20 @@ export declare class DatasetsResource extends BaseResource {
             name: string;
         }[];
         timeoutMs?: number;
-    }): Promise<string>;
+    }): Promise<{
+        columns: Array<{
+            name: string;
+        }>;
+        rows: string[][];
+        rowCount: number;
+    }>;
     /** Get dataset metadata (tags, custom fields, checklists). */
     metadata(datasetName: string, projectKey?: string): Promise<Record<string, unknown>>;
     /**
-     * Download dataset data as a gzipped CSV file.
-     * Returns the absolute path of the written file.
+     * Download dataset rows as a gzipped (or .csv) file, capped at `limit` rows
+     * (default 100k). Returns the written path, the number of data rows written,
+     * whether the dataset had more rows than the cap (truncated), and the limit
+     * used — so callers can detect truncation instead of silently getting a sample.
      */
     download(datasetName: string, opts?: {
         outputPath?: string;
@@ -74,7 +82,13 @@ export declare class DatasetsResource extends BaseResource {
         validateColumns?: {
             name: string;
         }[];
-    }): Promise<string>;
+        limit?: number;
+    }): Promise<{
+        path: string;
+        rows: number;
+        truncated: boolean;
+        limit: number;
+    }>;
     /**
      * Create a new dataset.
      *

package/dist/src/resources/datasets.js

@@ -133,22 +133,6 @@ export function validateStreamColumns(headerRow, expectedColumns) {
     }
     return warnings;
 }
-function emitCsvLineWithLimit(row, maxDataRows, emittedRows, onLine, onHeader) {
-    if (isBlankRow(row))
-        return false;
-    const isHeader = emittedRows.value === 0;
-    if (isHeader && onHeader)
-        onHeader(row);
-    if (!isHeader && emittedRows.value - 1 >= maxDataRows) {
-        return true;
-    }
-    onLine(rowToCsv(row));
-    emittedRows.value += 1;
-    if (!isHeader && emittedRows.value - 1 >= maxDataRows) {
-        return true;
-    }
-    return false;
-}
 function buildPreviewTimeoutError(timeoutMs) {
     return new DataikuError(0, "Request Timeout", `Dataset preview timed out after ${timeoutMs}ms while waiting for rows.`);
 }
@@ -167,13 +151,29 @@ async function readChunkWithTimeout(reader, remainingMs, timeoutMs) {
         });
     });
 }
-async function collectPreviewCsv(body, maxDataRows, timeoutMs, onHeader) {
+async function collectPreviewRows(body, maxDataRows, timeoutMs, onHeader) {
     const state = createTsvStreamState();
-    const emittedRows = { value: 0, };
-    const lines = [];
+    let columns;
+    const rows = [];
     let done = false;
     const startedAt = Date.now();
     const reader = body.getReader();
+    const handleRow = (row) => {
+        if (done || isBlankRow(row))
+            return;
+        if (columns === undefined) {
+            columns = row;
+            onHeader?.(row);
+            return;
+        }
+        if (rows.length >= maxDataRows) {
+            done = true;
+            return;
+        }
+        rows.push(row);
+        if (rows.length >= maxDataRows)
+            done = true;
+    };
     try {
         while (true) {
             if (done) {
@@ -186,64 +186,53 @@ async function collectPreviewCsv(body, maxDataRows, timeoutMs, onHeader) {
             const result = await readChunkWithTimeout(reader, remainingMs, timeoutMs);
             if (result.done)
                 break;
-            consumeTsvChunk(Buffer.from(result.value).toString("utf-8"), state, (row) => {
-                if (done)
-                    return;
-                done = emitCsvLineWithLimit(row, maxDataRows, emittedRows, (line) => {
-                    lines.push(line);
-                }, onHeader);
-            });
-        }
-        if (!done) {
-            flushTsvStream(state, (row) => {
-                if (done)
-                    return;
-                done = emitCsvLineWithLimit(row, maxDataRows, emittedRows, (line) => {
-                    lines.push(line);
-                }, onHeader);
-            });
+            consumeTsvChunk(Buffer.from(result.value).toString("utf-8"), state, handleRow);
         }
-        return lines.join("\n");
+        if (!done)
+            flushTsvStream(state, handleRow);
+        return { columns: columns ?? [], rows, };
     }
     finally {
         reader.releaseLock();
     }
 }
-function tsvToCsvTransform(maxDataRows, onHeader) {
+function tsvToCsvTransform(maxDataRows, stats, onHeader) {
     const state = createTsvStreamState();
-    const emittedRows = { value: 0, };
-    let done = false;
     const maxRows = Math.max(1, maxDataRows);
+    let headerSeen = false;
+    let done = false;
+    const handleRow = (row, push) => {
+        if (done || isBlankRow(row))
+            return;
+        if (!headerSeen) {
+            headerSeen = true;
+            onHeader?.(row);
+            push(`${rowToCsv(row)}\n`);
+            return;
+        }
+        if (stats.rows >= maxRows) {
+            stats.truncated = true;
+            done = true;
+            return;
+        }
+        push(`${rowToCsv(row)}\n`);
+        stats.rows += 1;
+    };
     return new Transform({
         transform(chunk, _encoding, callback) {
             if (done) {
                 callback();
                 return;
             }
-            consumeTsvChunk(chunk.toString("utf-8"), state, (row) => {
-                if (done)
-                    return;
-                done = emitCsvLineWithLimit(row, maxRows, emittedRows, (line) => {
-                    this.push(`${line}\n`);
-                }, onHeader);
-            });
-            if (done) {
+            consumeTsvChunk(chunk.toString("utf-8"), state, (row) => handleRow(row, (line) => this.push(line)));
+            if (done)
                 this.push(null);
-            }
             callback();
         },
         flush(callback) {
-            if (done) {
-                callback();
-                return;
+            if (!done) {
+                flushTsvStream(state, (row) => handleRow(row, (line) => this.push(line)));
             }
-            flushTsvStream(state, (row) => {
-                if (done)
-                    return;
-                done = emitCsvLineWithLimit(row, maxRows, emittedRows, (line) => {
-                    this.push(`${line}\n`);
-                }, onHeader);
-            });
             callback();
         },
     });
@@ -306,9 +295,31 @@ function buildDatasetCreateBody(opts) {
         managed: opts.managed ?? true,
     };
 }
+const DATASET_CLONE_PARAM_KEYS = [
+    "connection",
+    "path",
+    "table",
+    "schema",
+    "catalog",
+    "folderSmartId",
+    "metastoreTableName",
+    "mode",
+];
+function cloneDatasetParams(params) {
+    const sourceParams = params && typeof params === "object" && !Array.isArray(params)
+        ? params
+        : {};
+    const cloned = {};
+    for (const key of DATASET_CLONE_PARAM_KEYS) {
+        const value = sourceParams[key];
+        if (value !== undefined)
+            cloned[key] = value;
+    }
+    return cloned;
+}
 export function buildDatasetCloneSettings(source, targetName, projectKey, opts) {
     const params = {
-        ...source.params,
+        ...cloneDatasetParams(source.params),
         ...(opts.path !== undefined ? { path: opts.path, } : {}),
         ...(opts.table !== undefined ? { table: opts.table, mode: "table", } : {}),
         ...(opts.metastoreTableName !== undefined
@@ -365,9 +376,9 @@ export class DatasetsResource extends BaseResource {
         await this.client.put(`/public/api/projects/${this.enc(projectKey)}/datasets/${dsEnc}/schema`, { columns, });
     }
     /**
-     * Preview dataset data as CSV text.
-     * Streams TSV from the API, converts to CSV, and returns up to `maxRows`
-     * data rows (plus header).
+     * Preview dataset rows as structured data: column names plus row arrays,
+     * mirroring the sql query shape ({ columns, rows, rowCount }). Streams TSV
+     * from the API and returns up to `maxRows` data rows.
      *
      * If `validateColumns` is provided, the first TSV row (header) is checked
      * against the column names. Mismatches emit a warning via onValidationWarning.
@@ -386,8 +397,9 @@ export class DatasetsResource extends BaseResource {
             }
             : undefined;
         if (!res.body)
-            return "";
-        return collectPreviewCsv(res.body, maxRows, timeoutMs, onHeader);
+            return { columns: [], rows: [], rowCount: 0, };
+        const { columns, rows, } = await collectPreviewRows(res.body, maxRows, timeoutMs, onHeader);
+        return { columns: columns.map((name) => ({ name, })), rows, rowCount: rows.length, };
     }
     /** Get dataset metadata (tags, custom fields, checklists). */
     async metadata(datasetName, projectKey) {
@@ -395,13 +407,15 @@ export class DatasetsResource extends BaseResource {
         return this.client.get(`/public/api/projects/${this.enc(projectKey)}/datasets/${dsEnc}/metadata`);
     }
     /**
-     * Download dataset data as a gzipped CSV file.
-     * Returns the absolute path of the written file.
+     * Download dataset rows as a gzipped (or .csv) file, capped at `limit` rows
+     * (default 100k). Returns the written path, the number of data rows written,
+     * whether the dataset had more rows than the cap (truncated), and the limit
+     * used — so callers can detect truncation instead of silently getting a sample.
      */
     async download(datasetName, opts) {
-        const downloadLimit = 100_000;
+        const limit = Math.max(1, opts?.limit ?? 100_000);
         const dsEnc = encodeURIComponent(datasetName);
-        const res = await this.client.stream(`/public/api/projects/${this.enc(opts?.projectKey)}/datasets/${dsEnc}/data/?format=tsv-excel-header&limit=${downloadLimit}`);
+        const res = await this.client.stream(`/public/api/projects/${this.enc(opts?.projectKey)}/datasets/${dsEnc}/data/?format=tsv-excel-header&limit=${limit + 1}`);
         const safeDatasetName = sanitizeFileName(datasetName, "dataset");
         const filePath = opts?.outputPath?.endsWith(".gz") || opts?.outputPath?.endsWith(".csv")
             ? resolve(opts.outputPath)
@@ -415,8 +429,9 @@ export class DatasetsResource extends BaseResource {
             }
             : undefined;
         const shouldGzip = filePath.endsWith(".gz");
+        const stats = { rows: 0, truncated: false, };
         const nodeStream = Readable.fromWeb(res.body);
-        const csvTransform = tsvToCsvTransform(downloadLimit, onHeader);
+        const csvTransform = tsvToCsvTransform(limit, stats, onHeader);
         const fileOut = createWriteStream(filePath);
         if (shouldGzip) {
             const gzip = createGzip();
@@ -425,7 +440,7 @@ export class DatasetsResource extends BaseResource {
         else {
             await pipeline(nodeStream, csvTransform, fileOut);
         }
-        return filePath;
+        return { path: filePath, rows: stats.rows, truncated: stats.truncated, limit, };
     }
     /**
      * Create a new dataset.

package/dist/src/resources/flow-zones.d.ts

@@ -12,7 +12,7 @@ export declare class FlowZonesResource extends BaseResource {
     get(zoneId: string, projectKey?: string): Promise<FlowZone>;
     /** Create a flow zone. */
     create(opts: FlowZoneCreateOptions): Promise<FlowZone>;
-    /** Update flow zone settings such as name and color. */
+    /** Update flow zone settings such as name, color, and manual position. */
     update(zoneId: string, opts: FlowZoneUpdateOptions): Promise<FlowZone>;
     /** Delete a flow zone. DSS moves its items back to the default zone. */
     delete(zoneId: string, projectKey?: string): Promise<void>;