lumiverse-spindle-types 0.3.5 → 0.3.6

package/package.json

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

package/src/api.ts

@@ -867,6 +867,7 @@ export type WorkerToHost =
   | { type: "text_editor_open"; requestId: string; title?: string; value?: string; placeholder?: string; userId?: string }
   // ─── Modal (free tier) ────────────────────────────────────────────
   | { type: "modal_open"; requestId: string; title: string; items: SpindleModalItemDTO[]; width?: number; maxHeight?: number; persistent?: boolean; userId?: string }
+  | { type: "confirm_open"; requestId: string; title: string; message: string; variant?: "info" | "warning" | "danger" | "success"; confirmLabel?: string; cancelLabel?: string; userId?: string }
   // ─── Macro Resolution (free tier) ──────────────────────────────────
   | { type: "macros_resolve"; requestId: string; template: string; chatId?: string; characterId?: string; userId?: string }
   // ─── Image Generation (gated: "image_gen") ──────────────────────────

package/src/dom.ts

@@ -261,6 +261,43 @@ export interface SpindleModalHandle {
   onDismiss(handler: () => void): () => void;
 }
 
+// ── Confirmation Modal ──
+
+/** Visual variant for confirmation modals. Controls the accent color of the confirm button. */
+export type SpindleConfirmVariant = "info" | "warning" | "danger" | "success";
+
+/**
+ * Options for `ctx.ui.showConfirm()`.
+ * The host renders a system-themed confirmation modal with a message,
+ * variant-colored accent, and actionable buttons.
+ */
+export interface SpindleConfirmOptions {
+  /** Modal title displayed in the header. */
+  title: string;
+  /** Body text explaining what the user is confirming. */
+  message: string;
+  /**
+   * Visual variant that controls the confirm button's accent color.
+   * - `'info'` — neutral/blue (default)
+   * - `'warning'` — yellow/amber
+   * - `'danger'` — red — use for destructive or irreversible actions
+   * - `'success'` — green
+   */
+  variant?: SpindleConfirmVariant;
+  /** Label for the confirm (primary) button. Default: `"Confirm"`. */
+  confirmLabel?: string;
+  /** Label for the cancel (secondary) button. Default: `"Cancel"`. */
+  cancelLabel?: string;
+}
+
+/**
+ * Result returned by `ctx.ui.showConfirm()`.
+ */
+export interface SpindleConfirmResult {
+  /** `true` if the user clicked the confirm button, `false` if they cancelled or dismissed. */
+  confirmed: boolean;
+}
+
 /** Context object provided to frontend extension modules */
 export interface SpindleFrontendContext {
   dom: SpindleDOMHelper;
@@ -295,6 +332,30 @@ export interface SpindleFrontendContext {
      * ```
      */
     showModal(options: SpindleModalOptions): SpindleModalHandle;
+    /**
+     * Show a system-themed confirmation modal and wait for the user's response.
+     * Returns `{ confirmed: true }` if the user clicks the confirm button,
+     * or `{ confirmed: false }` if they cancel or dismiss the modal.
+     *
+     * The confirm button is styled according to the `variant` option
+     * (info, warning, danger, success) to signal intent to the user.
+     *
+     * Counts toward the **2 stacked modals** limit per extension.
+     *
+     * @example
+     * ```ts
+     * const { confirmed } = await ctx.ui.showConfirm({
+     *   title: 'Delete History',
+     *   message: 'This will permanently erase all nudge history for this character.',
+     *   variant: 'danger',
+     *   confirmLabel: 'Delete',
+     * })
+     * if (confirmed) {
+     *   ctx.sendToBackend({ type: 'delete_history', characterId })
+     * }
+     * ```
+     */
+    showConfirm(options: SpindleConfirmOptions): Promise<SpindleConfirmResult>;
   };
   uploads: {
     pickFile(options?: {

package/src/index.ts

@@ -89,6 +89,9 @@ export type {
   SpindleContextMenuResult,
   SpindleModalOptions,
   SpindleModalHandle,
+  SpindleConfirmVariant,
+  SpindleConfirmOptions,
+  SpindleConfirmResult,
 } from "./dom";
 
 export type { ExtensionInfo } from "./extension-info";

package/src/spindle-api.ts

@@ -685,6 +685,47 @@ export interface SpindleAPI {
       /** How the modal was dismissed. */
       dismissedBy: "user" | "extension" | "cleanup";
     }>;
+    /**
+     * Show a confirmation modal and wait for the user's response.
+     * The host renders a themed dialog with a message, variant-colored
+     * confirm button, and a cancel button. The call blocks until the
+     * user responds.
+     *
+     * Counts toward the 2 stacked modals limit per extension.
+     *
+     * @example
+     * ```ts
+     * const { confirmed } = await spindle.modal.confirm({
+     *   title: 'Clear History',
+     *   message: 'This will delete all nudge history. This action cannot be undone.',
+     *   variant: 'danger',
+     *   confirmLabel: 'Delete',
+     * })
+     * if (confirmed) {
+     *   await clearHistory()
+     * }
+     * ```
+     */
+    confirm(options: {
+      /** Header title. */
+      title: string;
+      /** Body text explaining what the user is confirming. */
+      message: string;
+      /**
+       * Visual variant for the confirm button.
+       * `'info'` (default) | `'warning'` | `'danger'` | `'success'`
+       */
+      variant?: "info" | "warning" | "danger" | "success";
+      /** Label for the confirm button. Default: `"Confirm"`. */
+      confirmLabel?: string;
+      /** Label for the cancel button. Default: `"Cancel"`. */
+      cancelLabel?: string;
+      /** For operator-scoped extensions only. */
+      userId?: string;
+    }): Promise<{
+      /** `true` if the user clicked confirm, `false` if cancelled or dismissed. */
+      confirmed: boolean;
+    }>;
   };
 
   /** This extension's manifest */