lumiverse-spindle-types 0.2.6 → 0.2.8

package/package.json

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

package/src/dom.ts

@@ -185,6 +185,35 @@ export interface SpindleTextEditorResult {
   cancelled: boolean;
 }
 
+// ── Context Menu ──
+
+export interface SpindleContextMenuOptions {
+  /** Screen position to render the menu at. */
+  position: { x: number; y: number };
+  /** Menu items. Items with `type: 'divider'` render as visual separators. */
+  items: SpindleContextMenuItemDef[];
+}
+
+export interface SpindleContextMenuItemDef {
+  /** Unique key returned when this item is selected. */
+  key: string;
+  /** Display label. Ignored for dividers. */
+  label: string;
+  /** Render as disabled (greyed out, not clickable). */
+  disabled?: boolean;
+  /** Render in danger/red style. */
+  danger?: boolean;
+  /** Render with active/highlighted style. */
+  active?: boolean;
+  /** Set to `'divider'` for a visual separator. Default: `'item'`. */
+  type?: "item" | "divider";
+}
+
+export interface SpindleContextMenuResult {
+  /** The `key` of the selected item, or `null` if the menu was dismissed without selection. */
+  selectedKey: string | null;
+}
+
 /** Context object provided to frontend extension modules */
 export interface SpindleFrontendContext {
   dom: SpindleDOMHelper;
@@ -199,26 +228,9 @@ export interface SpindleFrontendContext {
     requestDockPanel(options: SpindleDockPanelOptions): SpindleDockPanelHandle;
     mountApp(options?: SpindleAppMountOptions): SpindleAppMountHandle;
     registerInputBarAction(options: SpindleInputBarActionOptions): SpindleInputBarActionHandle;
-    /**
-     * Open the native Lumiverse expanded text editor modal.
-     * Provides macro syntax highlighting, macro insertion panel with search,
-     * and a full-screen editing experience.
-     *
-     * Returns a Promise that resolves when the user closes the editor.
-     *
-     * @example
-     * ```ts
-     * const result = await ctx.ui.openTextEditor({
-     *   title: 'Edit System Prompt',
-     *   value: currentText,
-     *   macros: true,
-     * })
-     * if (!result.cancelled) {
-     *   currentText = result.text
-     * }
-     * ```
-     */
-    openTextEditor(options?: SpindleTextEditorOptions): Promise<SpindleTextEditorResult>;
+    /** Show a themed context menu at the given position and wait for the user's selection.
+     *  Returns the `key` of the selected item, or `null` if the menu was dismissed. */
+    showContextMenu(options: SpindleContextMenuOptions): Promise<SpindleContextMenuResult>;
   };
   uploads: {
     pickFile(options?: {

package/src/index.ts

@@ -72,6 +72,9 @@ export type {
   SpindleAppMountHandle,
   SpindleInputBarActionOptions,
   SpindleInputBarActionHandle,
+  SpindleContextMenuOptions,
+  SpindleContextMenuItemDef,
+  SpindleContextMenuResult,
 } from "./dom";
 
 export type { ExtensionInfo } from "./extension-info";

package/src/spindle-api.ts

@@ -391,6 +391,10 @@ export interface SpindleAPI {
       body: string;
       tag?: string;
       url?: string;
+      /** Relative URL path to an icon image (e.g. `/api/v1/images/{id}?size=sm`). Must start with `/`. */
+      icon?: string;
+      /** When true, the notification title is used as-is without the extension name prefix. */
+      rawTitle?: boolean;
     }, userId?: string): Promise<{ sent: number }>;
     /**
      * Check if push notifications are available for a user.
@@ -402,6 +406,39 @@ export interface SpindleAPI {
     }>;
   };
 
+  /**
+   * Text editor (free tier — no permission needed).
+   * Opens the native Lumiverse expanded text editor modal on the user's
+   * frontend. Provides macro syntax highlighting, insertion panel, and
+   * full-screen editing. The call blocks until the user closes the editor.
+   */
+  textEditor: {
+    /**
+     * Open the text editor and wait for the user to close it.
+     *
+     * @example
+     * ```ts
+     * const result = await spindle.textEditor.open({
+     *   title: 'Edit System Prompt',
+     *   value: currentText,
+     * })
+     * if (!result.cancelled) {
+     *   currentText = result.text
+     * }
+     * ```
+     */
+    open(options?: {
+      title?: string;
+      value?: string;
+      placeholder?: string;
+      /** For operator-scoped extensions only. */
+      userId?: string;
+    }): Promise<{
+      text: string;
+      cancelled: boolean;
+    }>;
+  };
+
   /**
    * Macro resolution (free tier — no permission needed).
    * Resolve `{{macro}}` placeholders in arbitrary text using