dataiku-sdk 3.0.0 → 3.2.0

package/dist/src/resources/projects.js

@@ -1,5 +1,7 @@
 import { ClientValidationError, DataikuError, } from "../errors.js";
+import { writeResponseToFile, } from "../utils/response-file.js";
 import { ProjectDetailsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, } from "../schemas.js";
+import { analyzeFlowMap, flowTopologyFingerprint, renderFlowMap, } from "../utils/flow-analysis.js";
 import { normalizeFlowGraph, } from "../utils/flow-map.js";
 import { assertImportableProjectArchive, } from "../utils/project-archive.js";
 import { projectIncarnationHash, } from "../utils/project-incarnation.js";
@@ -103,21 +105,6 @@ const DEFAULT_MAX_EDGES = 600;
 const DEFAULT_METADATA_TIMEOUT_MS = 1_500;
 const PROJECT_IMPORT_AMBIGUOUS_REMEDIATION = "Import processing left DSS state indeterminate. Inspect the archive with `dss project inspect-archive <file>` and the live projects with `dss project list` before retrying the import.";
 export class ProjectsResource extends BaseResource {
-    httpInternals() {
-        return this.client;
-    }
-    async postStream(path, body) {
-        const http = this.httpInternals();
-        return http.fetchWithRetry(`${http.baseUrl}${path}`, {
-            method: "POST",
-            headers: {
-                Authorization: `Bearer ${http.apiKey}`,
-                Accept: "*/*",
-                "Content-Type": "application/json",
-            },
-            body: JSON.stringify(body),
-        });
-    }
     /** Create a new project. */
     async createProject(projectKey, name, ownerLogin, settings) {
         return this.client.post("/public/api/projects/", {
@@ -154,10 +141,10 @@ export class ProjectsResource extends BaseResource {
     }
     /** Export a project archive to a local file. */
     async exportArchive(projectKey, filePath, options) {
-        const res = await this.postStream(`/public/api/projects/${encodeURIComponent(projectKey)}/export`, options ?? {});
+        const res = await this.client.postStream(`/public/api/projects/${encodeURIComponent(projectKey)}/export`, options ?? {});
         if (!res.body)
             throw new Error("projects.exportArchive response did not include a body");
-        await Bun.write(filePath, new Response(res.body), { createPath: false, });
+        await writeResponseToFile(filePath, res);
     }
     /** Upload a project archive and return its temporary import handle. */
     async prepareProjectImport(filePath) {
@@ -320,6 +307,12 @@ export class ProjectsResource extends BaseResource {
         const enc = this.enc(projectKey);
         return this.client.get(`/public/api/projects/${enc}/flow/graph/`);
     }
+    /** Compute a stable fingerprint of flow nodes and edges, excluding visual metadata. */
+    async topologyFingerprint(projectKey) {
+        const pk = this.resolveProjectKey(projectKey);
+        const rawGraph = await this.flow(pk);
+        return flowTopologyFingerprint(normalizeFlowGraph(rawGraph, pk));
+    }
     /**
      * Build a normalized, optionally truncated flow map for a project.
      *
@@ -331,11 +324,12 @@ export class ProjectsResource extends BaseResource {
         const enc = this.enc(opts?.projectKey);
         const pk = this.resolveProjectKey(opts?.projectKey);
         const timeoutMs = DEFAULT_METADATA_TIMEOUT_MS;
-        const [rawGraph, foldersMeta, datasetsMeta, recipesMeta,] = await Promise.all([
+        const [rawGraph, foldersMeta, datasetsMeta, recipesMeta, zonesMeta,] = await Promise.all([
             this.client.get(`/public/api/projects/${enc}/flow/graph/`),
             fetchWithTimeout("Managed folders", timeoutMs, () => this.client.get(`/public/api/projects/${enc}/managedfolders/`)),
             fetchWithTimeout("Datasets", timeoutMs, () => this.client.get(`/public/api/projects/${enc}/datasets/`)),
             fetchWithTimeout("Recipes", timeoutMs, () => this.client.get(`/public/api/projects/${enc}/recipes/`)),
+            fetchWithTimeout("Flow zones", timeoutMs, () => this.client.flowZones.list(pk)),
         ]);
         // Build folder name lookup
         const folderNamesById = {};
@@ -364,6 +358,7 @@ export class ProjectsResource extends BaseResource {
             foldersMeta.warning,
             datasetsMeta.warning,
             recipesMeta.warning,
+            zonesMeta.warning,
         ].filter((w) => typeof w === "string" && w.length > 0);
         const normalized = metadataWarnings.length > 0
             ? {
@@ -374,8 +369,15 @@ export class ProjectsResource extends BaseResource {
         // Truncate
         const effectiveMaxNodes = opts?.maxNodes ?? DEFAULT_MAX_NODES;
         const effectiveMaxEdges = opts?.maxEdges ?? DEFAULT_MAX_EDGES;
+        const topologyFingerprint = flowTopologyFingerprint(normalizeFlowGraph(rawGraph, pk));
         const { map, truncation, } = truncateFlowMap(normalized, effectiveMaxNodes, effectiveMaxEdges);
-        const result = { map, truncation, };
+        const analyzed = analyzeFlowMap(map, zonesMeta.value ?? [], {
+            topologyFingerprint,
+            truncated: truncation.truncated,
+        });
+        const result = { map: analyzed, truncation, };
+        if (opts?.render)
+            result.rendering = renderFlowMap(analyzed, opts.render);
         if (opts?.includeRaw) {
             result.raw = rawGraph;
         }

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

@@ -31,6 +31,25 @@ export interface ScenarioUpdateResult extends ScenarioUpdatePreview {
     verified: true;
     mismatches: [];
 }
+export interface ScenarioScriptRunCleanup {
+    status: "deleted" | "kept" | "failed";
+    error?: string;
+}
+/** Cleanup failure carried on errors thrown from {@link ScenariosResource.runScript}. */
+export interface ScenarioScriptRunCleanupFailure {
+    scenarioId: string;
+    error: string;
+}
+/**
+ * Wraps a primary code-run failure so the original error (and its taxonomy:
+ * category, exit-code semantics) stays intact while the concurrent throwaway
+ * cleanup failure remains observable via {@link cleanupFailure}.
+ */
+export declare class ScenarioScriptRunWithCleanupFailureError extends Error {
+    readonly cause: unknown;
+    readonly cleanupFailure: ScenarioScriptRunCleanupFailure;
+    constructor(cause: unknown, cleanupFailure: ScenarioScriptRunCleanupFailure);
+}
 export interface ScenarioScriptRunResult {
     scenarioId: string;
     runId: string;
@@ -43,6 +62,10 @@ export interface ScenarioScriptRunResult {
     logTruncated: boolean;
     maxLogBytes: number;
     envName?: string;
+    timedOut?: boolean;
+    timeoutMs?: number;
+    /** Observable throwaway-scenario cleanup outcome; never silently swallowed here. */
+    cleanup: ScenarioScriptRunCleanup;
 }
 export declare function normalizeScenarioUpdateData(data: Record<string, unknown>): {
     normalizedData: Record<string, unknown>;
@@ -95,4 +118,11 @@ export declare class ScenariosResource extends BaseResource {
         keepScenario?: boolean;
         maxLogBytes?: number;
     }): Promise<ScenarioScriptRunResult>;
+    /**
+     * Delete the throwaway scenario at the end of a code run, or report the
+     * explicit keep outcome. Never throws: delete failures are surfaced in the
+     * returned cleanup outcome instead of being swallowed. A 404 is idempotent
+     * success — the scenario is already gone.
+     */
+    private removeThrowawayScenario;
 }

package/dist/src/resources/scenarios.js

@@ -12,6 +12,21 @@ export const SCENARIO_CANONICAL_EDITABLE_FIELDS = [
     "active",
     "name",
 ];
+/**
+ * Wraps a primary code-run failure so the original error (and its taxonomy:
+ * category, exit-code semantics) stays intact while the concurrent throwaway
+ * cleanup failure remains observable via {@link cleanupFailure}.
+ */
+export class ScenarioScriptRunWithCleanupFailureError extends Error {
+    cause;
+    cleanupFailure;
+    constructor(cause, cleanupFailure) {
+        super("Code run failed and its throwaway scenario cleanup also failed.");
+        this.cause = cause;
+        this.cleanupFailure = cleanupFailure;
+        this.name = "ScenarioScriptRunWithCleanupFailureError";
+    }
+}
 const DEFAULT_CODE_RUN_MAX_LOG_BYTES = 1_048_576;
 const CODE_RUN_OUTPUT_START = "<<<DSS_CODE_RUN_OUTPUT_b7e3a1>>>";
 const CODE_RUN_OUTPUT_END = "<<<DSS_CODE_RUN_OUTPUT_END_b7e3a1>>>";
@@ -421,6 +436,13 @@ export class ScenariosResource extends BaseResource {
         const adaptivePolling = opts?.pollIntervalMs === undefined;
         const timeout = Math.max(baseIntervalMs, opts?.timeoutMs ?? 120_000);
         const maxLogBytes = Math.max(0, Math.floor(opts?.maxLogBytes ?? DEFAULT_CODE_RUN_MAX_LOG_BYTES));
+        let outcome = "UNKNOWN";
+        let runId = "";
+        let pollCount = 0;
+        let timedOut = false;
+        let log = "";
+        let logTruncated = false;
+        let primaryError;
         try {
             await this.client.post(`/public/api/projects/${pkEnc}/scenarios/`, {
                 id: scenarioId,
@@ -438,12 +460,10 @@ export class ScenariosResource extends BaseResource {
                 throw new DataikuError(500, "Scenario run not started", `Scenario "${scenarioId}" run trigger returned no run id; cannot track the run.`);
             }
             const trigQuery = `triggerId=${encodeURIComponent(triggerId)}&triggerRunId=${encodeURIComponent(triggerRunId)}`;
-            let runId = "";
-            let outcome = "UNKNOWN";
-            let pollCount = 0;
             while (true) {
                 if (Date.now() - startedAt >= timeout) {
                     outcome = "TIMEOUT";
+                    timedOut = true;
                     break;
                 }
                 pollCount += 1;
@@ -465,37 +485,63 @@ export class ScenariosResource extends BaseResource {
                 });
                 await new Promise((r) => setTimeout(r, Math.min(nextDelayMs, Math.max(1, timeout - (Date.now() - startedAt)))));
             }
-            let log = "";
-            let logTruncated = false;
             if (runId && outcome !== "TIMEOUT") {
                 const limitedLog = await this.client.getTextLimited(`${base}/${encodeURIComponent(runId)}/log`, maxLogBytes);
                 log = limitedLog.text;
                 logTruncated = limitedLog.truncated;
             }
-            const output = extractCodeRunOutput(log);
-            return {
-                scenarioId,
-                runId,
-                outcome,
-                success: outcome === "SUCCESS",
-                elapsedMs: Date.now() - startedAt,
-                pollCount,
-                output,
-                log,
-                logTruncated,
-                maxLogBytes,
-                ...(opts?.envName ? { envName: opts.envName, } : {}),
-            };
         }
-        finally {
-            if (opts?.keepScenario !== true) {
-                try {
-                    await this.client.del(base);
-                }
-                catch {
-                    // Best-effort cleanup of the throwaway scenario.
-                }
+        catch (error) {
+            primaryError = error;
+        }
+        const cleanup = await this.removeThrowawayScenario(base, opts?.keepScenario === true);
+        if (primaryError !== undefined) {
+            if (cleanup.status === "failed") {
+                throw new ScenarioScriptRunWithCleanupFailureError(primaryError, {
+                    scenarioId,
+                    error: cleanup.error ?? "unknown cleanup error",
+                });
             }
+            throw primaryError;
+        }
+        const output = extractCodeRunOutput(log);
+        return {
+            scenarioId,
+            runId,
+            outcome,
+            success: outcome === "SUCCESS",
+            elapsedMs: Date.now() - startedAt,
+            pollCount,
+            output,
+            log,
+            logTruncated,
+            maxLogBytes,
+            ...(opts?.envName ? { envName: opts.envName, } : {}),
+            ...(timedOut ? { timedOut: true, timeoutMs: timeout, } : {}),
+            cleanup,
+        };
+    }
+    /**
+     * Delete the throwaway scenario at the end of a code run, or report the
+     * explicit keep outcome. Never throws: delete failures are surfaced in the
+     * returned cleanup outcome instead of being swallowed. A 404 is idempotent
+     * success — the scenario is already gone.
+     */
+    async removeThrowawayScenario(base, keep) {
+        if (keep)
+            return { status: "kept", };
+        try {
+            await this.client.del(base);
+            return { status: "deleted", };
+        }
+        catch (error) {
+            if (error instanceof DataikuError && error.category === "not_found") {
+                return { status: "deleted", };
+            }
+            return {
+                status: "failed",
+                error: error instanceof Error ? error.message : String(error),
+            };
         }
     }
 }

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

@@ -25,6 +25,12 @@ export declare class SqlResource extends BaseResource {
     startQuery(opts: SqlQueryOptions): Promise<SqlQueryResult>;
     /**
      * Stream results of a started query as parsed JSON (array of arrays).
+     *
+     * The result body is buffered under the client's response body limit
+     * (default 50 MiB, `maxResponseBodyBytes`) and the request deadline. A
+     * response exceeding the limit is cancelled and rejected instead of being
+     * parsed — otherwise a collaborator-controlled result set (or a stalled
+     * stream) could exhaust client memory or hang unbounded.
      */
     streamResults(queryId: string): Promise<unknown[][]>;
     /**

package/dist/src/resources/sql.js

@@ -1,6 +1,12 @@
 import { ClientValidationError, DataikuError, } from "../errors.js";
 import { BaseResource, } from "./base.js";
 const UNSUPPORTED_SQL_DATASET_CONNECTION_DETAIL = "neither of sql nor hdfs type";
+/**
+ * Cap on the finish-streaming status text behind the client's response body
+ * limit: the payload is a short status message, so any larger body is a
+ * misbehaving endpoint and must not be buffered further.
+ */
+const MAX_SQL_FINISH_TEXT_BYTES = 1024 * 1024;
 function isUnsupportedSqlDatasetConnectionError(error) {
     if (!(error instanceof DataikuError))
         return false;
@@ -95,7 +101,7 @@ function withSqlErrorContext(error) {
             catch {
                 body = `SQL query failed: ${detail}\n${error.body}`;
             }
-            throw new DataikuError(error.status, error.statusText, body, error.retry);
+            throw new DataikuError(error.status, error.statusText, body, error.retry, error.requestId, { target: error.trustedTarget, elapsedMs: error.trustedElapsedMs, });
         }
     }
     throw error;
@@ -135,10 +141,20 @@ export class SqlResource extends BaseResource {
     }
     /**
      * Stream results of a started query as parsed JSON (array of arrays).
+     *
+     * The result body is buffered under the client's response body limit
+     * (default 50 MiB, `maxResponseBodyBytes`) and the request deadline. A
+     * response exceeding the limit is cancelled and rejected instead of being
+     * parsed — otherwise a collaborator-controlled result set (or a stalled
+     * stream) could exhaust client memory or hang unbounded.
      */
     async streamResults(queryId) {
         const id = encodeURIComponent(queryId);
-        const text = await this.client.getText(`/public/api/sql/queries/${id}/stream?format=json`);
+        const maxBytes = this.client.getMaxResponseBodyBytes();
+        const { text, truncated, } = await this.client.getTextLimited(`/public/api/sql/queries/${id}/stream?format=json`, maxBytes);
+        if (truncated) {
+            throw new DataikuError(0, "Response Too Large", `SQL stream results exceeded the ${maxBytes}-byte response limit and were not parsed.`);
+        }
         return JSON.parse(text);
     }
     /**
@@ -147,7 +163,11 @@ export class SqlResource extends BaseResource {
      */
     async finishStreaming(queryId) {
         const id = encodeURIComponent(queryId);
-        const text = await this.client.getText(`/public/api/sql/queries/${id}/finish-streaming`);
+        const maxBytes = Math.min(this.client.getMaxResponseBodyBytes(), MAX_SQL_FINISH_TEXT_BYTES);
+        const { text, truncated, } = await this.client.getTextLimited(`/public/api/sql/queries/${id}/finish-streaming`, maxBytes);
+        if (truncated) {
+            throw new DataikuError(0, "Response Too Large", `SQL finish-streaming response exceeded the ${maxBytes}-byte response limit.`);
+        }
         if (text.length > 0) {
             throw new Error(`SQL query ${queryId} failed: ${text}`);
         }

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

@@ -1,3 +1,4 @@
+import type { FutureWaitResult } from "../schemas.js";
 import { BaseResource } from "./base.js";
 export interface WebappListItem {
     id?: string;
@@ -9,6 +10,20 @@ export interface WebappListItem {
 export interface WebappCreateResult {
     webAppId: string;
 }
+/**
+ * 64-hex SHA-256 hash of the webapp object as last fetched, used as a
+ * non-atomic stale-read guard: the write is refused when the object already
+ * differs at the verification read. DSS exposes no conditional write (no
+ * ETag, no If-Match), so a writer committing between that read and the PUT
+ * is still not detected.
+ */
+export interface WebappUpdateOptions {
+    expectHash?: string;
+}
+export interface WebappWaitOptions {
+    pollIntervalMs?: number;
+    timeoutMs?: number;
+}
 export declare class WebappsResource extends BaseResource {
     /** List all webapps in a project. */
     list(projectKey?: string): Promise<WebappListItem[]>;
@@ -16,12 +31,28 @@ export declare class WebappsResource extends BaseResource {
     getSettings(webappId: string, projectKey?: string): Promise<Record<string, unknown>>;
     /** Create a webapp. */
     create(body: Record<string, unknown>, projectKey?: string): Promise<WebappCreateResult>;
-    /** Update one webapp's settings. */
-    updateSettings(webappId: string, body: Record<string, unknown>, projectKey?: string): Promise<Record<string, unknown>>;
+    /**
+     * Update one webapp's settings via GET-merge-PUT. The public API requires
+     * the object passed to a PUT call to have been obtained from a GET call at
+     * the same URL, so the current object is fetched first, the supplied
+     * fields are merged over it (fields absent from `body` are preserved), and
+     * the whole merged object is PUT back.
+     *
+     * With `expectHash` armed, the fresh GET doubles as the stale-read guard:
+     * the stable hash of the fetched object must match, or the write is
+     * refused before any PUT.
+     */
+    updateSettings(webappId: string, body: Record<string, unknown>, projectKey?: string, options?: WebappUpdateOptions): Promise<Record<string, unknown>>;
     /** Stop a webapp backend. */
     stopBackend(webappId: string, projectKey?: string): Promise<void>;
-    /** Start or restart a webapp backend. */
-    startOrRestartBackend(webappId: string, projectKey?: string): Promise<void>;
+    /**
+     * Start or restart a webapp backend. The documented endpoint returns a
+     * reference to a future, which is surfaced as-is; settle it with
+     * {@link restartBackendAndWait} or `client.futures.wait`.
+     */
+    startOrRestartBackend(webappId: string, projectKey?: string): Promise<Record<string, unknown>>;
+    /** Restart a webapp backend and wait for the returned future to settle. */
+    restartBackendAndWait(webappId: string, projectKey?: string, options?: WebappWaitOptions): Promise<FutureWaitResult>;
     /** Get a webapp backend's state. */
     getBackendState(webappId: string, projectKey?: string): Promise<Record<string, unknown>>;
 }

package/dist/src/resources/webapps.js

@@ -1,4 +1,22 @@
+import { ClientValidationError, } from "../errors.js";
+import { deepMerge, } from "../utils/deep-merge.js";
+import { stableHash, } from "../utils/stable-hash.js";
 import { BaseResource, } from "./base.js";
+const EXPECT_HASH_PATTERN = /^[0-9a-fA-F]{64}$/;
+function assertExpectedHash(id, expectHash, current, projectKey) {
+    if (!EXPECT_HASH_PATTERN.test(expectHash)) {
+        throw new ClientValidationError("Expected webapp hash must be a 64-character SHA-256 hex digest.", "validation_failed", "Use the hash value returned by a previous read.", { projectKey, id, });
+    }
+    const actual = stableHash(current);
+    if (actual !== expectHash.toLowerCase()) {
+        throw new ClientValidationError(`The webapp ${JSON.stringify(id)} changed since it was read.`, "validation_failed", "Re-read the webapp settings and retry with the current hash value.", {
+            projectKey,
+            id,
+            expectedHash: expectHash.toLowerCase(),
+            actualHash: actual,
+        });
+    }
+}
 export class WebappsResource extends BaseResource {
     /** List all webapps in a project. */
     async list(projectKey) {
@@ -13,20 +31,51 @@ export class WebappsResource extends BaseResource {
     async create(body, projectKey) {
         return this.client.post(`/public/api/projects/${this.enc(projectKey)}/webapps/`, body);
     }
-    /** Update one webapp's settings. */
-    async updateSettings(webappId, body, projectKey) {
+    /**
+     * Update one webapp's settings via GET-merge-PUT. The public API requires
+     * the object passed to a PUT call to have been obtained from a GET call at
+     * the same URL, so the current object is fetched first, the supplied
+     * fields are merged over it (fields absent from `body` are preserved), and
+     * the whole merged object is PUT back.
+     *
+     * With `expectHash` armed, the fresh GET doubles as the stale-read guard:
+     * the stable hash of the fetched object must match, or the write is
+     * refused before any PUT.
+     */
+    async updateSettings(webappId, body, projectKey, options = {}) {
+        const current = await this.getSettings(webappId, projectKey);
+        if (options.expectHash !== undefined) {
+            assertExpectedHash(webappId, options.expectHash, current, projectKey);
+        }
+        const next = deepMerge(current, body);
         const id = encodeURIComponent(webappId);
-        return this.client.put(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}`, body);
+        return this.client.put(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}`, next);
     }
     /** Stop a webapp backend. */
     async stopBackend(webappId, projectKey) {
         const id = encodeURIComponent(webappId);
         await this.client.putVoid(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}/backend/actions/stop`, {});
     }
-    /** Start or restart a webapp backend. */
+    /**
+     * Start or restart a webapp backend. The documented endpoint returns a
+     * reference to a future, which is surfaced as-is; settle it with
+     * {@link restartBackendAndWait} or `client.futures.wait`.
+     */
     async startOrRestartBackend(webappId, projectKey) {
         const id = encodeURIComponent(webappId);
-        await this.client.putVoid(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}/backend/actions/restart`, {});
+        return this.client.put(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}/backend/actions/restart`, {});
+    }
+    /** Restart a webapp backend and wait for the returned future to settle. */
+    async restartBackendAndWait(webappId, projectKey, options = {}) {
+        const future = await this.startOrRestartBackend(webappId, projectKey);
+        const jobId = future.jobId;
+        if (typeof jobId !== "string" || jobId.length === 0) {
+            throw new Error("Webapp backend restart did not return a future jobId.");
+        }
+        return this.client.futures.wait(jobId, {
+            pollIntervalMs: options.pollIntervalMs,
+            timeoutMs: options.timeoutMs,
+        });
     }
     /** Get a webapp backend's state. */
     async getBackendState(webappId, projectKey) {

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, 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, ProjectGitActionResultSchema, ProjectGitDiffResultSchema, ProjectGitFutureResponseSchema, ProjectGitFutureStateSchema, ProjectGitLibrariesSchema, ProjectGitLibrarySchema, ProjectGitLogResultSchema, ProjectGitRemoteSchema, ProjectGitStatusSchema, ProjectGitTagSchema, ProjectGitTagsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioStepRunSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, ScenarioWaitResultSchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "../packages/types/src/index.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, ProjectGitActionResult, ProjectGitDiffResult, ProjectGitFutureResponse, ProjectGitFutureState, ProjectGitLibraries, ProjectGitLibrary, ProjectGitLogResult, ProjectGitRemote, ProjectGitStatus, ProjectGitTag, ProjectGitTags, ProjectMetadata, ProjectSummary, ProjectVariables, RecipeCreateOptions, RecipeCreateResult, RecipeDetails, RecipeSummary, SafeParseResult, ScenarioDetails, ScenarioStatus, ScenarioStepRun, ScenarioSummary, ScenarioWaitResult, SqlNotebookCell, SqlNotebookContent, SqlNotebookSummary, SqlQueryResponse, SqlQueryResult, SqlQuerySchema, WikiArticleData, WikiArticleMetadata, WikiSettings, WikiTaxonomyNode, } from "../packages/types/src/index.js";
+export { BuildModeSchema, CodeEnvActionResultSchema, CodeEnvCreateOptionsSchema, CodeEnvDetailsSchema, CodeEnvGetLogOptionsSchema, CodeEnvLogResultSchema, CodeEnvLogSummaryArraySchema, CodeEnvLogSummarySchema, CodeEnvPackageListSchema, CodeEnvSetPackagesOptionsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, CodeEnvUpdateImagesOptionsSchema, CodeEnvUpdatePackagesOptionsSchema, CodeEnvUsageArraySchema, CodeEnvVersionForProjectSchema, 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, ProjectGitActionResultSchema, ProjectGitDiffResultSchema, ProjectGitFutureResponseSchema, ProjectGitFutureStateSchema, ProjectGitLibrariesSchema, ProjectGitLibrarySchema, ProjectGitLogResultSchema, ProjectGitRemoteSchema, ProjectGitStatusSchema, ProjectGitTagSchema, ProjectGitTagsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioStepRunSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, ScenarioWaitResultSchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookHistorySchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "../packages/types/src/index.js";
+export type { BuildMode, CodeEnvActionResult, CodeEnvCreateOptions, CodeEnvDetails, CodeEnvGetLogOptions, CodeEnvLogResult, CodeEnvLogSummary, CodeEnvPackageList, CodeEnvSetPackagesOptions, CodeEnvSummary, CodeEnvUpdateImagesOptions, CodeEnvUpdatePackagesOptions, CodeEnvUsage, CodeEnvVersionForProject, 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, ProjectGitActionResult, ProjectGitDiffResult, ProjectGitFutureResponse, ProjectGitFutureState, ProjectGitLibraries, ProjectGitLibrary, ProjectGitLogResult, ProjectGitRemote, ProjectGitStatus, ProjectGitTag, ProjectGitTags, ProjectMetadata, ProjectSummary, ProjectVariables, RecipeCreateOptions, RecipeCreateResult, RecipeDetails, RecipeSummary, SafeParseResult, ScenarioDetails, ScenarioStatus, ScenarioStepRun, ScenarioSummary, ScenarioWaitResult, SqlNotebookCell, SqlNotebookContent, SqlNotebookHistory, SqlNotebookSummary, SqlQueryResponse, SqlQueryResult, SqlQuerySchema, WikiArticleData, WikiArticleMetadata, WikiSettings, WikiTaxonomyNode, } 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, 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, ProjectGitActionResultSchema, ProjectGitDiffResultSchema, ProjectGitFutureResponseSchema, ProjectGitFutureStateSchema, ProjectGitLibrariesSchema, ProjectGitLibrarySchema, ProjectGitLogResultSchema, ProjectGitRemoteSchema, ProjectGitStatusSchema, ProjectGitTagSchema, ProjectGitTagsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioStepRunSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, ScenarioWaitResultSchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "../packages/types/src/index.js";
+export { BuildModeSchema, CodeEnvActionResultSchema, CodeEnvCreateOptionsSchema, CodeEnvDetailsSchema, CodeEnvGetLogOptionsSchema, CodeEnvLogResultSchema, CodeEnvLogSummaryArraySchema, CodeEnvLogSummarySchema, CodeEnvPackageListSchema, CodeEnvSetPackagesOptionsSchema, CodeEnvSummaryArraySchema, CodeEnvSummarySchema, CodeEnvUpdateImagesOptionsSchema, CodeEnvUpdatePackagesOptionsSchema, CodeEnvUsageArraySchema, CodeEnvVersionForProjectSchema, 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, ProjectGitActionResultSchema, ProjectGitDiffResultSchema, ProjectGitFutureResponseSchema, ProjectGitFutureStateSchema, ProjectGitLibrariesSchema, ProjectGitLibrarySchema, ProjectGitLogResultSchema, ProjectGitRemoteSchema, ProjectGitStatusSchema, ProjectGitTagSchema, ProjectGitTagsSchema, ProjectMetadataSchema, ProjectSummaryArraySchema, ProjectSummarySchema, ProjectVariablesSchema, RecipeCreateOptionsSchema, RecipeCreateResultSchema, RecipeDetailsSchema, RecipeSummaryArraySchema, RecipeSummarySchema, safeParseSchema, ScenarioDetailsSchema, ScenarioStatusSchema, ScenarioStepRunSchema, ScenarioSummaryArraySchema, ScenarioSummarySchema, ScenarioWaitResultSchema, SqlNotebookCellSchema, SqlNotebookContentSchema, SqlNotebookHistorySchema, SqlNotebookSummaryArraySchema, SqlNotebookSummarySchema, SqlQueryResponseSchema, SqlQueryResultSchema, SqlQuerySchemaSchema, WikiArticleDataArraySchema, WikiArticleDataSchema, WikiArticleMetadataSchema, WikiSettingsSchema, WikiTaxonomyNodeSchema, } from "../packages/types/src/index.js";

package/dist/src/skill.d.ts

@@ -28,10 +28,28 @@ export declare function detectAgents(): DetectedAgent[];
  * Agent config directories are install targets, not workspace roots.
  */
 export declare function findWorkspaceRoot(startDir: string): string;
+export type SkillStatus = "missing" | "stale" | "current";
+export interface InstalledSkillFile {
+    relativePath: string;
+    path: string;
+    status: SkillStatus;
+    changed: boolean;
+    expectedSha256: string;
+    actualSha256?: string;
+}
 export interface InstallResult {
     agent: string;
     path: string;
     via: DetectedAgent["via"];
+    /** Missing entrypoint, incomplete/different bundle, or entirely current bundle. */
+    status: SkillStatus;
+    /** Whether any bundled file would (or did) change. Unmanaged files are preserved. */
+    changed: boolean;
+    /** SHA-256 of the canonical SKILL.md entrypoint, not the whole bundle. */
+    expectedSha256: string;
+    /** Hash of the existing entrypoint; absent when that file is missing. */
+    actualSha256?: string;
+    files: InstalledSkillFile[];
 }
 export declare function planSkillInstalls(agents: DetectedAgent[], opts: {
     global: boolean;