lumiverse-spindle-types 0.6.12 → 0.6.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lumiverse-spindle-types",
-  "version": "0.6.12",
+  "version": "0.6.14",
   "types": "./src/index.ts",
   "keywords": [
     "lumiverse",

package/src/api.ts

@@ -779,6 +779,16 @@ export interface ImageGenRequestDTO {
   owner_character_id?: string;
   /** Optional chat ownership tag for the persisted result image. */
   owner_chat_id?: string;
+  /**
+   * Ask the host to omit the base64 `imageDataUrl` from the result.
+   *
+   * The host still needs the data URL to persist the image into the images
+   * table, so `imageId` / `imageUrl` remain populated. Only the
+   * extension-facing response drops the base64 field, which is the largest
+   * per-image RPC payload. The default (`includeDataUrl` omitted or `true`)
+   * keeps the data URL for backward compatibility.
+   */
+  includeDataUrl?: boolean;
   /** For operator-scoped extensions. */
   userId?: string;
 }

package/src/dom.ts

@@ -120,6 +120,23 @@ export type SpindleMountPoint =
 
 // ── Drawer Tab ──
 
+/**
+ * Contextual documentation displayed by Lumiverse using its native
+ * guide viewer.
+ *
+ * Guide Markdown is rendered and sanitized by the host application.
+ */
+export interface SpindleGuideDefinition {
+  /** Markdown content for the guide. */
+  markdown: string;
+
+  /**
+   * Optional title shown by the guide viewer.
+   * Falls back to the title of the owning tab.
+   */
+  title?: string;
+}
+
 export interface SpindleDrawerTabOptions {
   /** Unique tab identifier. Used internally for routing and state. */
   id: string;
@@ -133,6 +150,8 @@ export interface SpindleDrawerTabOptions {
   keywords?: string[];
   /** Title shown in the panel header navbar. Falls back to `title` if omitted. Useful when the header needs a shorter label than the command palette entry. */
   headerTitle?: string;
+  /** Optional contextual documentation for this tab. */
+  guide?: SpindleGuideDefinition;
   /** URL to a 16x16 or 24x24 icon image. Mutually exclusive with `iconSvg`. */
   iconUrl?: string;
   /** Inline SVG string for the tab icon. Mutually exclusive with `iconUrl`. */
@@ -159,6 +178,8 @@ export interface SpindleCharacterEditorTabOptions {
   id: string;
   /** Label shown in the character editor tab bar. */
   title: string;
+  /** Optional contextual documentation for this tab. */
+  guide?: SpindleGuideDefinition;
 }
 
 export interface SpindleCharacterEditorTabHandle {
@@ -210,6 +231,8 @@ export interface SpindlePresetEditorTabOptions {
   id: string;
   /** Label shown in the Loom preset editor tab bar. */
   title: string;
+  /** Optional contextual documentation for this tab. */
+  guide?: SpindleGuideDefinition;
 }
 
 export interface SpindlePresetEditorTabHandle {

package/src/index.ts

@@ -269,6 +269,7 @@ export type {
   SpindleFrontendContext,
   SpindleFrontendModule,
   SpindleFrontendTeardown,
+  SpindleGuideDefinition,
   SpindleDrawerTabOptions,
   SpindleDrawerTabHandle,
   SpindleCharacterEditorTabOptions,

package/src/spindle-api.ts

@@ -800,7 +800,9 @@ export interface SpindleAPI {
     /**
      * Generate an image using a connection profile.
      * If `connection_id` is omitted, uses the user's default image gen connection.
-     * Returns the image as a base64 data URL.
+     * Returns the image as a base64 data URL, unless `includeDataUrl: false` is
+     * passed and the host supports omitting it (the image is still persisted
+     * and `imageId` / `imageUrl` remain populated).
      */
     generate(input: ImageGenRequestDTO): Promise<ImageGenResultDTO>;
     /**