lumiverse-spindle-types 0.4.3 → 0.4.10

package/package.json

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

package/src/api.ts

@@ -8,6 +8,17 @@ export interface LlmMessageDTO {
   name?: string;
 }
 
+/**
+ * Return type for interceptor handlers.
+ * Interceptors may return either a plain `LlmMessageDTO[]` (backwards-compatible)
+ * or this object to also inject generation parameters (requires `generation_parameters` permission).
+ */
+export interface InterceptorResultDTO {
+  messages: LlmMessageDTO[];
+  /** Provider parameters merged into the outgoing LLM request. Requires `generation_parameters` permission. */
+  parameters?: Record<string, unknown>;
+}
+
 export interface MacroDefinitionDTO {
   name: string;
   category: string;
@@ -753,7 +764,7 @@ export type WorkerToHost =
   | { type: "unregister_macro"; name: string }
   | { type: "update_macro_value"; name: string; value: string }
   | { type: "register_interceptor"; priority?: number }
-  | { type: "intercept_result"; requestId: string; messages: LlmMessageDTO[] }
+  | { type: "intercept_result"; requestId: string; messages: LlmMessageDTO[]; parameters?: Record<string, unknown> }
   | { type: "register_tool"; tool: ToolRegistrationDTO }
   | { type: "unregister_tool"; name: string }
   | { type: "request_generation"; requestId: string; input: GenerationRequestDTO }
@@ -973,6 +984,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: "modal_close"; requestId: string; userId?: string }
   | { type: "confirm_open"; requestId: string; title: string; message: string; variant?: "info" | "warning" | "danger" | "success"; confirmLabel?: string; cancelLabel?: string; userId?: string }
   | { type: "input_prompt_open"; requestId: string; title: string; message?: string; placeholder?: string; defaultValue?: string; submitLabel?: string; cancelLabel?: string; multiline?: boolean; userId?: string }
   // ─── Macro Resolution (free tier) ──────────────────────────────────

package/src/index.ts

@@ -14,6 +14,7 @@ export { SpindleEvent, CoreEventType } from "./events";
 
 export type {
   LlmMessageDTO,
+  InterceptorResultDTO,
   MacroDefinitionDTO,
   ToolRegistrationDTO,
   ToolSchemaDTO,

package/src/permissions.ts

@@ -9,6 +9,7 @@
  * - "tools"            — register LLM tools
  * - "cors_proxy"       — use CORS proxy
  * - "context_handler"  — register global context middleware
+ * - "generation_parameters" — inject parameters into in-flight generations via interceptors
  * - "characters"       — CRUD on character cards
  * - "chats"            — CRUD on chat sessions
  * - "personas"         — CRUD on personas
@@ -30,7 +31,8 @@ export type SpindlePermission =
   | "world_books"
   | "personas"
   | "push_notification"
-  | "image_gen";
+  | "image_gen"
+  | "generation_parameters";
 
 export const ALL_PERMISSIONS: readonly SpindlePermission[] = [
   "generation",
@@ -50,6 +52,7 @@ export const ALL_PERMISSIONS: readonly SpindlePermission[] = [
   "personas",
   "push_notification",
   "image_gen",
+  "generation_parameters",
 ] as const;
 
 export function isValidPermission(p: string): p is SpindlePermission {

package/src/spindle-api.ts

@@ -1,6 +1,7 @@
 import type { SpindleManifest } from "./manifest";
 import type {
   LlmMessageDTO,
+  InterceptorResultDTO,
   MacroDefinitionDTO,
   ToolRegistrationDTO,
   GenerationRequestDTO,
@@ -57,12 +58,22 @@ export interface SpindleAPI {
    */
   updateMacroValue(name: string, value: string): void;
 
-  /** Register an interceptor for pre-generation prompt modification */
+  /**
+   * Register an interceptor for pre-generation prompt modification.
+   *
+   * The handler receives the assembled messages and a context object, and may
+   * return either a plain `LlmMessageDTO[]` (backwards-compatible) or an
+   * `InterceptorResultDTO` to also inject generation parameters into the
+   * outgoing LLM request.
+   *
+   * Returning `parameters` requires the `generation_parameters` permission.
+   * Without it, returned parameters are silently stripped.
+   */
   registerInterceptor(
     handler: (
       messages: LlmMessageDTO[],
       context: unknown
-    ) => Promise<LlmMessageDTO[]>,
+    ) => Promise<LlmMessageDTO[] | InterceptorResultDTO>,
     priority?: number
   ): void;
 
@@ -719,6 +730,12 @@ export interface SpindleAPI {
       /** How the modal was dismissed. */
       dismissedBy: "user" | "extension" | "cleanup";
     }>;
+    /**
+     * Programmatically close a modal that was opened with `spindle.modal.open()`.
+     * `openRequestId` is the request ID returned alongside the modal handle.
+     * Resolves immediately after the dismiss event is emitted.
+     */
+    close(openRequestId: string, userId?: string): Promise<void>;
     /**
      * Show a confirmation modal and wait for the user's response.
      * The host renders a themed dialog with a message, variant-colored