@brixel_ai/artifact-sdk 1.0.1 → 1.0.3

package/README.md

@@ -104,24 +104,6 @@ if (import.meta.env.DEV) {
 }
 ```
 
-### Mock Host for Testing
-
-```tsx
-import { createMockBrixelHost } from "@brixel_ai/artifact-sdk";
-
-const host = createMockBrixelHost({
-  onComplete: (output) => console.debug("Completed:", output),
-  onCancel: (reason) => console.debug("Cancelled:", reason),
-  onResize: (height) => console.debug("Resize:", height),
-});
-
-// Send init
-host.init({ title: "Test" });
-
-// Later: cleanup
-host.destroy();
-```
-
 ## Render Modes
 
 ### Display Mode
@@ -175,26 +157,28 @@ interface BrixelContext {
 ## Executing Other UI Tasks
 
 The SDK allows UI Tasks to execute other UI Tasks programmatically using the `executeTask` function.
+On success, `executeTask` returns the action `result` directly. On failure, it returns an `ExecuteTaskError`.
 
 ### Basic Usage
 
 ```tsx
-import { useBrixelArtifact } from "@brixel_ai/artifact-sdk";
+import { isExecuteTaskError, useBrixelArtifact } from "@brixel_ai/artifact-sdk";
 
 function MyUITask() {
   const { executeTask } = useBrixelArtifact();
 
   const handleExecuteTask = async () => {
-    const result = await executeTask({
+    const result = await executeTask<{ message: string }>({
       taskId: "78c2482f-b47d-461c-9fd0-509476687be9",
       inputs: { name: "value" },
     });
 
-    if (result.success) {
-      console.debug("Task executed:", result.data);
-    } else {
-      console.error("Error:", result.error);
+    if (isExecuteTaskError(result)) {
+      console.error("Error:", result);
+      return;
     }
+
+    console.debug("Task executed:", result);
   };
 
   return <button onClick={handleExecuteTask}>Execute Task</button>;

package/dist/index.d.mts

@@ -241,17 +241,19 @@ interface ExecuteTaskParams {
     apiBaseUrl?: string;
 }
 /**
- * Response from the execute task API
+ * Error returned by executeTask when execution fails.
  */
-interface ExecuteTaskResponse<TOutput = unknown> {
-    success: boolean;
-    data?: TOutput;
-    error?: {
-        code: string;
-        message: string;
-        details?: unknown;
-    };
+interface ExecuteTaskError {
+    code: string;
+    message: string;
+    details?: unknown;
 }
+/**
+ * Return value from executeTask:
+ * - success: returns task result directly
+ * - failure: returns ExecuteTaskError
+ */
+type ExecuteTaskResponse<TOutput = unknown> = TOutput | ExecuteTaskError;
 /**
  * Parameters for uploading a file to Brixel
  */
@@ -347,6 +349,7 @@ declare function createExecuteTask(contextAuth?: {
 }): <TOutput = unknown>(params: Omit<ExecuteTaskParams, "conversationId" | "apiToken" | "apiBaseUrl"> & {
     organizationId?: string;
 }) => Promise<ExecuteTaskResponse<TOutput>>;
+declare function isExecuteTaskError(value: unknown): value is ExecuteTaskError;
 
 declare function uploadFile<TOutput = InternalFilePublicOut>(params: UploadFileParams): Promise<UploadFileResponse<TOutput>>;
 declare function createUploadFile(contextAuth?: {
@@ -373,10 +376,6 @@ declare function createGetFileContent(contextAuth?: {
  *
  * These utilities help simulate the Brixel host environment during development
  */
-/**
- * Default mock context for development
- */
-declare const mockContext: BrixelContext;
 /**
  * Simulate the Brixel host sending an INIT message
  *
@@ -413,40 +412,5 @@ declare function simulateBrixelInit<TInputs = unknown>(inputs: TInputs, options?
  * ```
  */
 declare function listenToUITaskMessages(callback: (message: unknown) => void): () => void;
-/**
- * Create a mock Brixel host for development
- *
- * @example
- * ```tsx
- * const host = createMockBrixelHost({
- *   onComplete: (output) => console.debug("Completed:", output),
- *   onCancel: (reason) => console.debug("Cancelled:", reason),
- * });
- *
- * // Send init
- * host.init({ title: "Test" });
- *
- * // Cleanup
- * host.destroy();
- * ```
- */
-declare function createMockBrixelHost<TInputs = unknown, TOutput = unknown>(options: {
-    onReady?: (version: string) => void;
-    onComplete?: (output: TOutput) => void;
-    onCancel?: (reason?: string) => void;
-    onResize?: (height: number | "auto") => void;
-    onLog?: (level: string, message: string, data?: unknown) => void;
-    onError?: (error: {
-        code: string;
-        message: string;
-        details?: unknown;
-    }) => void;
-}): {
-    init(inputs: TInputs, runId?: string, renderMode?: RenderMode): void;
-    updateInputs(inputs: Partial<TInputs>): void;
-    destroy(): void;
-    updateTheme(theme: BrixelContext["theme"]): void;
-    updateLocale(locale: string): void;
-};
 
-export { type ArtifactManifest, type BrixelContext, type CancelMessage, type CompleteMessage, type DestroyMessage, type ErrorMessage, type ExecuteTaskParams, type ExecuteTaskResponse, type FileContentData, type GetFileContentParams, type GetFileContentResponse, type HostToIframeMessage, type IframeToHostMessage, type InitMessage, type InternalFileMimeType, type InternalFilePublicOut, type LogMessage, type ReadyMessage, type RenderMode, type ResizeMessage, type TaskStatus, type UpdateInputsMessage, type UpdateLocaleMessage, type UpdateThemeMessage, type UploadFileParams, type UploadFileResponse, type UseBrixelTaskOptions, type UseBrixelTaskResult, createExecuteTask, createGetFileContent, createMockBrixelHost, createUploadFile, executeTask, getFileContent, listenToUITaskMessages, mockContext, simulateBrixelInit, uploadFile, useBrixelArtifact };
+export { type ArtifactManifest, type BrixelContext, type CancelMessage, type CompleteMessage, type DestroyMessage, type ErrorMessage, type ExecuteTaskError, type ExecuteTaskParams, type ExecuteTaskResponse, type FileContentData, type GetFileContentParams, type GetFileContentResponse, type HostToIframeMessage, type IframeToHostMessage, type InitMessage, type InternalFileMimeType, type InternalFilePublicOut, type LogMessage, type ReadyMessage, type RenderMode, type ResizeMessage, type TaskStatus, type UpdateInputsMessage, type UpdateLocaleMessage, type UpdateThemeMessage, type UploadFileParams, type UploadFileResponse, type UseBrixelTaskOptions, type UseBrixelTaskResult, createExecuteTask, createGetFileContent, createUploadFile, executeTask, getFileContent, isExecuteTaskError, listenToUITaskMessages, simulateBrixelInit, uploadFile, useBrixelArtifact };

package/dist/index.d.ts

@@ -241,17 +241,19 @@ interface ExecuteTaskParams {
     apiBaseUrl?: string;
 }
 /**
- * Response from the execute task API
+ * Error returned by executeTask when execution fails.
  */
-interface ExecuteTaskResponse<TOutput = unknown> {
-    success: boolean;
-    data?: TOutput;
-    error?: {
-        code: string;
-        message: string;
-        details?: unknown;
-    };
+interface ExecuteTaskError {
+    code: string;
+    message: string;
+    details?: unknown;
 }
+/**
+ * Return value from executeTask:
+ * - success: returns task result directly
+ * - failure: returns ExecuteTaskError
+ */
+type ExecuteTaskResponse<TOutput = unknown> = TOutput | ExecuteTaskError;
 /**
  * Parameters for uploading a file to Brixel
  */
@@ -347,6 +349,7 @@ declare function createExecuteTask(contextAuth?: {
 }): <TOutput = unknown>(params: Omit<ExecuteTaskParams, "conversationId" | "apiToken" | "apiBaseUrl"> & {
     organizationId?: string;
 }) => Promise<ExecuteTaskResponse<TOutput>>;
+declare function isExecuteTaskError(value: unknown): value is ExecuteTaskError;
 
 declare function uploadFile<TOutput = InternalFilePublicOut>(params: UploadFileParams): Promise<UploadFileResponse<TOutput>>;
 declare function createUploadFile(contextAuth?: {
@@ -373,10 +376,6 @@ declare function createGetFileContent(contextAuth?: {
  *
  * These utilities help simulate the Brixel host environment during development
  */
-/**
- * Default mock context for development
- */
-declare const mockContext: BrixelContext;
 /**
  * Simulate the Brixel host sending an INIT message
  *
@@ -413,40 +412,5 @@ declare function simulateBrixelInit<TInputs = unknown>(inputs: TInputs, options?
  * ```
  */
 declare function listenToUITaskMessages(callback: (message: unknown) => void): () => void;
-/**
- * Create a mock Brixel host for development
- *
- * @example
- * ```tsx
- * const host = createMockBrixelHost({
- *   onComplete: (output) => console.debug("Completed:", output),
- *   onCancel: (reason) => console.debug("Cancelled:", reason),
- * });
- *
- * // Send init
- * host.init({ title: "Test" });
- *
- * // Cleanup
- * host.destroy();
- * ```
- */
-declare function createMockBrixelHost<TInputs = unknown, TOutput = unknown>(options: {
-    onReady?: (version: string) => void;
-    onComplete?: (output: TOutput) => void;
-    onCancel?: (reason?: string) => void;
-    onResize?: (height: number | "auto") => void;
-    onLog?: (level: string, message: string, data?: unknown) => void;
-    onError?: (error: {
-        code: string;
-        message: string;
-        details?: unknown;
-    }) => void;
-}): {
-    init(inputs: TInputs, runId?: string, renderMode?: RenderMode): void;
-    updateInputs(inputs: Partial<TInputs>): void;
-    destroy(): void;
-    updateTheme(theme: BrixelContext["theme"]): void;
-    updateLocale(locale: string): void;
-};
 
-export { type ArtifactManifest, type BrixelContext, type CancelMessage, type CompleteMessage, type DestroyMessage, type ErrorMessage, type ExecuteTaskParams, type ExecuteTaskResponse, type FileContentData, type GetFileContentParams, type GetFileContentResponse, type HostToIframeMessage, type IframeToHostMessage, type InitMessage, type InternalFileMimeType, type InternalFilePublicOut, type LogMessage, type ReadyMessage, type RenderMode, type ResizeMessage, type TaskStatus, type UpdateInputsMessage, type UpdateLocaleMessage, type UpdateThemeMessage, type UploadFileParams, type UploadFileResponse, type UseBrixelTaskOptions, type UseBrixelTaskResult, createExecuteTask, createGetFileContent, createMockBrixelHost, createUploadFile, executeTask, getFileContent, listenToUITaskMessages, mockContext, simulateBrixelInit, uploadFile, useBrixelArtifact };
+export { type ArtifactManifest, type BrixelContext, type CancelMessage, type CompleteMessage, type DestroyMessage, type ErrorMessage, type ExecuteTaskError, type ExecuteTaskParams, type ExecuteTaskResponse, type FileContentData, type GetFileContentParams, type GetFileContentResponse, type HostToIframeMessage, type IframeToHostMessage, type InitMessage, type InternalFileMimeType, type InternalFilePublicOut, type LogMessage, type ReadyMessage, type RenderMode, type ResizeMessage, type TaskStatus, type UpdateInputsMessage, type UpdateLocaleMessage, type UpdateThemeMessage, type UploadFileParams, type UploadFileResponse, type UseBrixelTaskOptions, type UseBrixelTaskResult, createExecuteTask, createGetFileContent, createUploadFile, executeTask, getFileContent, isExecuteTaskError, listenToUITaskMessages, simulateBrixelInit, uploadFile, useBrixelArtifact };

package/dist/index.js

@@ -22,12 +22,11 @@ var index_exports = {};
 __export(index_exports, {
   createExecuteTask: () => createExecuteTask,
   createGetFileContent: () => createGetFileContent,
-  createMockBrixelHost: () => createMockBrixelHost,
   createUploadFile: () => createUploadFile,
   executeTask: () => executeTask,
   getFileContent: () => getFileContent,
+  isExecuteTaskError: () => isExecuteTaskError,
   listenToUITaskMessages: () => listenToUITaskMessages,
-  mockContext: () => mockContext,
   simulateBrixelInit: () => simulateBrixelInit,
   uploadFile: () => uploadFile,
   useBrixelArtifact: () => useBrixelArtifact
@@ -92,20 +91,14 @@ async function executeTask(params) {
   try {
     if (!organizationId) {
       return {
-        success: false,
-        error: {
-          code: "MISSING_ORGANIZATION_ID",
-          message: "organizationId is required to execute a task"
-        }
+        code: "MISSING_ORGANIZATION_ID",
+        message: "organizationId is required to execute a task"
       };
     }
     if (!taskId) {
       return {
-        success: false,
-        error: {
-          code: "MISSING_TASK_ID",
-          message: "taskId is required to execute a task"
-        }
+        code: "MISSING_TASK_ID",
+        message: "taskId is required to execute a task"
       };
     }
     const headers = {
@@ -129,20 +122,19 @@ async function executeTask(params) {
     );
     const data = await parseJsonOrText(response);
     if (!response.ok) {
-      return {
-        success: false,
-        error: toHttpError(response, data)
-      };
+      return toHttpError(response, data);
     }
-    return {
-      success: true,
-      data: data ?? void 0
-    };
+    if (isActionExecutePayload(data)) {
+      if (data.success === false) {
+        return toActionExecutionError(data);
+      }
+      if ("result" in data) {
+        return data.result;
+      }
+    }
+    return data ?? void 0;
   } catch (error) {
-    return {
-      success: false,
-      error: toNetworkError(error)
-    };
+    return toNetworkError(error);
   }
 }
 function createExecuteTask(contextAuth) {
@@ -157,6 +149,23 @@ function createExecuteTask(contextAuth) {
     });
   };
 }
+function isRecord(value) {
+  return typeof value === "object" && value !== null;
+}
+function isActionExecutePayload(value) {
+  return isRecord(value) && ("result" in value || "success" in value || "error" in value);
+}
+function toActionExecutionError(payload) {
+  const message = typeof payload.error === "string" && payload.error.trim() ? payload.error : "Task execution failed";
+  return {
+    code: "TASK_EXECUTION_FAILED",
+    message,
+    details: payload
+  };
+}
+function isExecuteTaskError(value) {
+  return isRecord(value) && typeof value.code === "string" && typeof value.message === "string";
+}
 
 // src/uploadFile.ts
 async function uploadFile(params) {
@@ -524,15 +533,6 @@ function useBrixelArtifact(options = {}) {
 }
 
 // src/devTools.ts
-var mockContext = {
-  runId: "dev-run-001",
-  stepId: "dev-step-001",
-  userId: "dev-user-001",
-  organizationId: "dev-org-001",
-  theme: "light",
-  locale: "en-US",
-  conversationId: "dev-conversation-001"
-};
 function simulateBrixelInit(inputs, options = {}) {
   const { runId = "dev-run-001", renderMode = "interaction", context = {}, delay = 100 } = options;
   const message = {
@@ -540,7 +540,7 @@ function simulateBrixelInit(inputs, options = {}) {
     payload: {
       runId,
       inputs,
-      context: { ...mockContext, ...context, runId },
+      context: { ...context, runId },
       renderMode
     }
   };
@@ -561,97 +561,15 @@ function listenToUITaskMessages(callback) {
     window.removeEventListener("message", handleMessage);
   };
 }
-function createMockBrixelHost(options) {
-  const { onReady, onComplete, onCancel, onResize, onLog, onError } = options;
-  let currentRunId = null;
-  const postMessage = (message) => window.postMessage(message, "*");
-  const getRunIdOrWarn = (action) => {
-    if (!currentRunId) {
-      console.warn(`[MockHost] Cannot ${action} - no active run`);
-      return null;
-    }
-    return currentRunId;
-  };
-  const handleMessage = (event) => {
-    const message = event.data;
-    if (!message || typeof message !== "object" || !message.type?.startsWith("BRIXEL_")) {
-      return;
-    }
-    switch (message.type) {
-      case "BRIXEL_READY":
-        onReady?.(message.payload?.version);
-        break;
-      case "BRIXEL_COMPLETE":
-        onComplete?.(message.payload?.output);
-        break;
-      case "BRIXEL_CANCEL":
-        onCancel?.(message.payload?.reason);
-        break;
-      case "BRIXEL_RESIZE":
-        onResize?.(message.payload?.height);
-        break;
-      case "BRIXEL_LOG":
-        onLog?.(message.payload?.level, message.payload?.message, message.payload?.data);
-        break;
-      case "BRIXEL_ERROR":
-        onError?.(message.payload?.error);
-        break;
-    }
-  };
-  window.addEventListener("message", handleMessage);
-  return {
-    init(inputs, runId = "mock-run-001", renderMode = "interaction") {
-      currentRunId = runId;
-      postMessage({
-        type: "BRIXEL_INIT",
-        payload: {
-          runId,
-          inputs,
-          context: { ...mockContext, runId },
-          renderMode
-        }
-      });
-    },
-    updateInputs(inputs) {
-      const runId = getRunIdOrWarn("update inputs");
-      if (!runId) {
-        return;
-      }
-      postMessage({ type: "BRIXEL_UPDATE_INPUTS", payload: { runId, inputs } });
-    },
-    destroy() {
-      if (currentRunId) {
-        postMessage({ type: "BRIXEL_DESTROY", payload: { runId: currentRunId } });
-      }
-      window.removeEventListener("message", handleMessage);
-      currentRunId = null;
-    },
-    updateTheme(theme) {
-      const runId = getRunIdOrWarn("update theme");
-      if (!runId) {
-        return;
-      }
-      postMessage({ type: "BRIXEL_UPDATE_THEME", payload: { runId, theme } });
-    },
-    updateLocale(locale) {
-      const runId = getRunIdOrWarn("update locale");
-      if (!runId) {
-        return;
-      }
-      postMessage({ type: "BRIXEL_UPDATE_LOCALE", payload: { runId, locale } });
-    }
-  };
-}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   createExecuteTask,
   createGetFileContent,
-  createMockBrixelHost,
   createUploadFile,
   executeTask,
   getFileContent,
+  isExecuteTaskError,
   listenToUITaskMessages,
-  mockContext,
   simulateBrixelInit,
   uploadFile,
   useBrixelArtifact

package/dist/index.mjs

@@ -56,20 +56,14 @@ async function executeTask(params) {
   try {
     if (!organizationId) {
       return {
-        success: false,
-        error: {
-          code: "MISSING_ORGANIZATION_ID",
-          message: "organizationId is required to execute a task"
-        }
+        code: "MISSING_ORGANIZATION_ID",
+        message: "organizationId is required to execute a task"
       };
     }
     if (!taskId) {
       return {
-        success: false,
-        error: {
-          code: "MISSING_TASK_ID",
-          message: "taskId is required to execute a task"
-        }
+        code: "MISSING_TASK_ID",
+        message: "taskId is required to execute a task"
       };
     }
     const headers = {
@@ -93,20 +87,19 @@ async function executeTask(params) {
     );
     const data = await parseJsonOrText(response);
     if (!response.ok) {
-      return {
-        success: false,
-        error: toHttpError(response, data)
-      };
+      return toHttpError(response, data);
     }
-    return {
-      success: true,
-      data: data ?? void 0
-    };
+    if (isActionExecutePayload(data)) {
+      if (data.success === false) {
+        return toActionExecutionError(data);
+      }
+      if ("result" in data) {
+        return data.result;
+      }
+    }
+    return data ?? void 0;
   } catch (error) {
-    return {
-      success: false,
-      error: toNetworkError(error)
-    };
+    return toNetworkError(error);
   }
 }
 function createExecuteTask(contextAuth) {
@@ -121,6 +114,23 @@ function createExecuteTask(contextAuth) {
     });
   };
 }
+function isRecord(value) {
+  return typeof value === "object" && value !== null;
+}
+function isActionExecutePayload(value) {
+  return isRecord(value) && ("result" in value || "success" in value || "error" in value);
+}
+function toActionExecutionError(payload) {
+  const message = typeof payload.error === "string" && payload.error.trim() ? payload.error : "Task execution failed";
+  return {
+    code: "TASK_EXECUTION_FAILED",
+    message,
+    details: payload
+  };
+}
+function isExecuteTaskError(value) {
+  return isRecord(value) && typeof value.code === "string" && typeof value.message === "string";
+}
 
 // src/uploadFile.ts
 async function uploadFile(params) {
@@ -488,15 +498,6 @@ function useBrixelArtifact(options = {}) {
 }
 
 // src/devTools.ts
-var mockContext = {
-  runId: "dev-run-001",
-  stepId: "dev-step-001",
-  userId: "dev-user-001",
-  organizationId: "dev-org-001",
-  theme: "light",
-  locale: "en-US",
-  conversationId: "dev-conversation-001"
-};
 function simulateBrixelInit(inputs, options = {}) {
   const { runId = "dev-run-001", renderMode = "interaction", context = {}, delay = 100 } = options;
   const message = {
@@ -504,7 +505,7 @@ function simulateBrixelInit(inputs, options = {}) {
     payload: {
       runId,
       inputs,
-      context: { ...mockContext, ...context, runId },
+      context: { ...context, runId },
       renderMode
     }
   };
@@ -525,96 +526,14 @@ function listenToUITaskMessages(callback) {
     window.removeEventListener("message", handleMessage);
   };
 }
-function createMockBrixelHost(options) {
-  const { onReady, onComplete, onCancel, onResize, onLog, onError } = options;
-  let currentRunId = null;
-  const postMessage = (message) => window.postMessage(message, "*");
-  const getRunIdOrWarn = (action) => {
-    if (!currentRunId) {
-      console.warn(`[MockHost] Cannot ${action} - no active run`);
-      return null;
-    }
-    return currentRunId;
-  };
-  const handleMessage = (event) => {
-    const message = event.data;
-    if (!message || typeof message !== "object" || !message.type?.startsWith("BRIXEL_")) {
-      return;
-    }
-    switch (message.type) {
-      case "BRIXEL_READY":
-        onReady?.(message.payload?.version);
-        break;
-      case "BRIXEL_COMPLETE":
-        onComplete?.(message.payload?.output);
-        break;
-      case "BRIXEL_CANCEL":
-        onCancel?.(message.payload?.reason);
-        break;
-      case "BRIXEL_RESIZE":
-        onResize?.(message.payload?.height);
-        break;
-      case "BRIXEL_LOG":
-        onLog?.(message.payload?.level, message.payload?.message, message.payload?.data);
-        break;
-      case "BRIXEL_ERROR":
-        onError?.(message.payload?.error);
-        break;
-    }
-  };
-  window.addEventListener("message", handleMessage);
-  return {
-    init(inputs, runId = "mock-run-001", renderMode = "interaction") {
-      currentRunId = runId;
-      postMessage({
-        type: "BRIXEL_INIT",
-        payload: {
-          runId,
-          inputs,
-          context: { ...mockContext, runId },
-          renderMode
-        }
-      });
-    },
-    updateInputs(inputs) {
-      const runId = getRunIdOrWarn("update inputs");
-      if (!runId) {
-        return;
-      }
-      postMessage({ type: "BRIXEL_UPDATE_INPUTS", payload: { runId, inputs } });
-    },
-    destroy() {
-      if (currentRunId) {
-        postMessage({ type: "BRIXEL_DESTROY", payload: { runId: currentRunId } });
-      }
-      window.removeEventListener("message", handleMessage);
-      currentRunId = null;
-    },
-    updateTheme(theme) {
-      const runId = getRunIdOrWarn("update theme");
-      if (!runId) {
-        return;
-      }
-      postMessage({ type: "BRIXEL_UPDATE_THEME", payload: { runId, theme } });
-    },
-    updateLocale(locale) {
-      const runId = getRunIdOrWarn("update locale");
-      if (!runId) {
-        return;
-      }
-      postMessage({ type: "BRIXEL_UPDATE_LOCALE", payload: { runId, locale } });
-    }
-  };
-}
 export {
   createExecuteTask,
   createGetFileContent,
-  createMockBrixelHost,
   createUploadFile,
   executeTask,
   getFileContent,
+  isExecuteTaskError,
   listenToUITaskMessages,
-  mockContext,
   simulateBrixelInit,
   uploadFile,
   useBrixelArtifact

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brixel_ai/artifact-sdk",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "SDK for building Brixel Artifacts - interactive React components that integrate with Brixel workflows",
   "main": "dist/index.js",
   "module": "dist/index.mjs",