dataiku-sdk 0.8.0 → 0.10.0

package/dist/src/resources/webapps.js

@@ -0,0 +1,36 @@
+import { BaseResource, } from "./base.js";
+export class WebappsResource extends BaseResource {
+    /** List all webapps in a project. */
+    async list(projectKey) {
+        return this.client.get(`/public/api/projects/${this.enc(projectKey)}/webapps/`);
+    }
+    /** Get one webapp's settings. */
+    async getSettings(webappId, projectKey) {
+        const id = encodeURIComponent(webappId);
+        return this.client.get(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}`);
+    }
+    /** Create a webapp. */
+    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) {
+        const id = encodeURIComponent(webappId);
+        return this.client.put(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}`, body);
+    }
+    /** 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. */
+    async startOrRestartBackend(webappId, projectKey) {
+        const id = encodeURIComponent(webappId);
+        await this.client.putVoid(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}/backend/actions/restart`, {});
+    }
+    /** Get a webapp backend's state. */
+    async getBackendState(webappId, projectKey) {
+        const id = encodeURIComponent(webappId);
+        return this.client.get(`/public/api/projects/${this.enc(projectKey)}/webapps/${id}/backend/state`);
+    }
+}

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

@@ -0,0 +1,59 @@
+import { BaseResource } from "./base.js";
+export type WorkspaceObjectReferenceType = "DATASET" | "ARTICLE" | "DASHBOARD" | (string & {});
+export interface WorkspacePermissionItem extends Record<string, unknown> {
+    group?: string;
+    user?: string;
+    admin?: boolean;
+    write?: boolean;
+    read?: boolean;
+}
+export interface WorkspaceListItem extends Record<string, unknown> {
+    workspaceKey?: string;
+    displayName?: string;
+    color?: string | null;
+    description?: string | null;
+}
+export interface WorkspaceSettings extends WorkspaceListItem {
+    permissions?: WorkspacePermissionItem[] | null;
+}
+export interface WorkspaceCreateRequest extends Record<string, unknown> {
+    workspaceKey: string;
+    displayName: string;
+    color?: string | null;
+    description?: string | null;
+    permissions?: WorkspacePermissionItem[] | null;
+}
+export interface WorkspaceObjectReference extends Record<string, unknown> {
+    projectKey?: string;
+    type?: WorkspaceObjectReferenceType;
+    id?: string;
+    workspaceKey?: string;
+}
+export interface WorkspaceHtmlLinkObject extends Record<string, unknown> {
+    name: string;
+    url: string;
+    description?: string | null;
+}
+export interface WorkspaceObject extends Record<string, unknown> {
+    id?: string;
+    reference?: WorkspaceObjectReference;
+    appId?: string;
+    htmlLink?: WorkspaceHtmlLinkObject;
+}
+export type WorkspaceObjectInput = WorkspaceObject;
+export declare class WorkspacesResource extends BaseResource {
+    /** List workspaces visible to the API key. */
+    list(): Promise<WorkspaceListItem[]>;
+    /** Get workspace settings. */
+    get(workspaceKey: string): Promise<WorkspaceSettings>;
+    /** Create a workspace. DSS returns a text confirmation. */
+    create(body: WorkspaceCreateRequest): Promise<string>;
+    /** Replace workspace settings. */
+    updateSettings(workspaceKey: string, body: WorkspaceSettings): Promise<void>;
+    /** Delete a workspace. */
+    delete(workspaceKey: string): Promise<void>;
+    /** List objects in a workspace. */
+    listObjects(workspaceKey: string): Promise<WorkspaceObject[]>;
+    /** Add an object to a workspace. */
+    addObject(workspaceKey: string, object: WorkspaceObjectInput): Promise<WorkspaceObject>;
+}

package/dist/src/resources/workspaces.js

@@ -0,0 +1,31 @@
+import { BaseResource, } from "./base.js";
+export class WorkspacesResource extends BaseResource {
+    /** List workspaces visible to the API key. */
+    async list() {
+        return this.client.get("/public/api/workspaces/");
+    }
+    /** Get workspace settings. */
+    async get(workspaceKey) {
+        return this.client.get(`/public/api/workspaces/${encodeURIComponent(workspaceKey)}`);
+    }
+    /** Create a workspace. DSS returns a text confirmation. */
+    async create(body) {
+        return this.client.postText("/public/api/workspaces/", body);
+    }
+    /** Replace workspace settings. */
+    async updateSettings(workspaceKey, body) {
+        await this.client.putVoid(`/public/api/workspaces/${encodeURIComponent(workspaceKey)}`, body);
+    }
+    /** Delete a workspace. */
+    async delete(workspaceKey) {
+        await this.client.del(`/public/api/workspaces/${encodeURIComponent(workspaceKey)}`);
+    }
+    /** List objects in a workspace. */
+    async listObjects(workspaceKey) {
+        return this.client.get(`/public/api/workspaces/${encodeURIComponent(workspaceKey)}/objects`);
+    }
+    /** Add an object to a workspace. */
+    async addObject(workspaceKey, object) {
+        return this.client.post(`/public/api/workspaces/${encodeURIComponent(workspaceKey)}/objects`, object);
+    }
+}

package/dist/src/skill.js

@@ -11,8 +11,8 @@ If the installed \`dss\` binary is unavailable but the repository checkout is th
 ## Contract
 
 - Success writes exactly one JSON result to stdout.
-- Failure writes exactly one JSON error envelope to stderr with \`ok:false\`, \`error\`, \`code\`, and \`exitCode\`.
-- \`--verbose\` may add HTTP trace lines to stderr.
+- Failure writes exactly one JSONL error event to stderr with \`type:"error"\`, \`ok:false\`, \`error\`, \`code\`, and \`exitCode\`.
+- Non-fatal warnings and \`--verbose\` HTTP traces are JSONL stderr events (\`type:"warning"\` / \`type:"trace"\`), never prose.
 - No prompts, help screens, tables, banners, or prose output are part of the contract.
 - Exit codes: 0 success, 1 usage/configuration error, 2 DSS or internal error, 3 transient/retryable DSS error, 4 completed command with failed long-running DSS work.
 - \`--raw\` is the only stdout escape hatch: recipe payload commands emit raw bytes to stdout unless \`--output PATH\` is also set; with \`--output\`, stdout is the JSON string equal to \`PATH\` and the file receives exact raw bytes.
@@ -21,10 +21,11 @@ If the installed \`dss\` binary is unavailable but the repository checkout is th
 ## Discover commands
 
 \`\`\`bash
+dss agent contract
 dss commands run
 \`\`\`
 
-The registry is the canonical schema for resources, actions, flags, positional arguments, side effects, auth requirements, output shape, idempotency, dry-run support, payload schemas, cleanup hints, and exit codes. Use it before choosing command syntax.
+Use \`dss agent contract\` once to check \`agentContractVersion\`, stderr event schemas, non-JSON escape hatches, and compatibility rules. The command registry from \`dss commands run\` is the canonical schema for resources, actions, flags, positional arguments, side effects, auth requirements, output shape, idempotency, dry-run support, structured examples, payload schemas, unsafe outputs, cleanup hints, and exit codes. Use it before choosing command syntax.
 Credential lookup order is flags first, then \`DATAIKU_*\` environment variables, then saved credentials.
 Set \`DATAIKU_DISABLE_ENV=1\` when a test must ignore both \`.env\` files and \`DATAIKU_*\` environment variables.
 When \`.env\` loading is enabled, the CLI reads \`.env\` from the command's current working directory first and then the CLI build/root directory; the invocation directory wins on conflicting keys. Put test-specific \`.env\` files in the directory where you invoke \`dss\`.
@@ -91,10 +92,11 @@ Mutations print a small JSON ack to stdout and exit 0 on success (e.g. \`{"updat
 
 ## Error envelope
 
-Parse stderr as JSON when exit code is non-zero:
+Parse each stderr line as JSON; on non-zero exit the final line is an error event:
 
 \`\`\`json
 {
+  "type": "error",
   "ok": false,
   "error": "Missing API key.",
   "code": "usage_error",

package/package.json

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