lumiverse-spindle-types 0.4.65 → 0.4.68

package/package.json

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

package/src/api.ts

@@ -9,6 +9,8 @@ export interface LlmMessageDTO {
   name?: string;
 }
 
+export type SpindleUserRoleDTO = "operator" | "admin" | "user";
+
 /**
  * Optional metadata returned by an interceptor so Lumiverse can surface
  * extension-injected prompt messages as first-class items in Prompt Breakdown.
@@ -255,6 +257,29 @@ export interface GenerationRequestDTO {
   signal?: AbortSignal;
 }
 
+/** Options passed to chat generation when `spindle.chat.appendMessage()` starts a normal reply. */
+export interface ChatAppendGenerationOptionsDTO {
+  /** Omit to use the user's default connection profile. */
+  connection_id?: string;
+  /** Omit to use the user's active persona setting. */
+  persona_id?: string;
+  persona_addon_states?: Record<string, boolean>;
+  /** Omit to use the user's active Loom preset; if unset, the connection preset is used. */
+  preset_id?: string;
+  force_preset_id?: boolean;
+  parameters?: Record<string, unknown>;
+  target_character_id?: string;
+  retain_council?: boolean;
+}
+
+/** Optional third argument for `spindle.chat.appendMessage()`. */
+export type ChatAppendMessageOptionsDTO =
+  | boolean
+  | {
+      triggerGeneration?: boolean;
+      generation?: ChatAppendGenerationOptionsDTO;
+    };
+
 /**
  * Streamed chunk yielded by `spindle.generate.rawStream()` and
  * `spindle.generate.quietStream()`.
@@ -1884,6 +1909,7 @@ export type WorkerToHost =
         content: string;
         metadata?: Record<string, unknown>;
       };
+      options?: ChatAppendMessageOptionsDTO;
     }
   | {
       type: "chat_update_message";
@@ -2118,8 +2144,9 @@ export type WorkerToHost =
   // ─── Push Notifications (gated: "push_notification") ────────────────
   | { type: "push_send"; requestId: string; title: string; body: string; tag?: string; url?: string; userId?: string; icon?: string; rawTitle?: boolean; image?: string }
   | { type: "push_get_status"; requestId: string; userId?: string }
-  // ─── User Visibility (free tier) ───────────────────────────────────
+  // ─── User Context (free tier) ──────────────────────────────────────
   | { type: "user_is_visible"; requestId: string; userId?: string }
+  | { type: "user_get_role"; requestId: string; userId?: string }
   // ─── Text Editor (free tier) ───────────────────────────────────────
   | { type: "text_editor_open"; requestId: string; title?: string; value?: string; placeholder?: string; userId?: string }
   // ─── Modal (free tier) ────────────────────────────────────────────

package/src/index.ts

@@ -14,6 +14,7 @@ export { SpindleEvent, CoreEventType } from "./events";
 
 export type {
   LlmMessageDTO,
+  SpindleUserRoleDTO,
   InterceptorBreakdownEntryDTO,
   InterceptorResultDTO,
   MacroDefinitionDTO,
@@ -24,6 +25,8 @@ export type {
   ToolSchemaDTO,
   ToolCallDTO,
   GenerationRequestDTO,
+  ChatAppendGenerationOptionsDTO,
+  ChatAppendMessageOptionsDTO,
   StreamChunkDTO,
   RequestInitDTO,
   ConnectionProfileDTO,

package/src/spindle-api.ts

@@ -11,6 +11,7 @@ import type {
   MacroResolveResultDTO,
   ToolRegistrationDTO,
   GenerationRequestDTO,
+  ChatAppendMessageOptionsDTO,
   RequestInitDTO,
   ConnectionProfileDTO,
   PermissionDeniedDetail,
@@ -60,6 +61,7 @@ import type {
   ThemePaletteConfigDTO,
   ThemeVariablesConfigDTO,
   ColorExtractionResult,
+  SpindleUserRoleDTO,
   SpindleModalItemDTO,
   SpindleCommandDTO,
   SpindleCommandContextDTO,
@@ -472,8 +474,9 @@ export interface SpindleAPI {
         role: "system" | "user" | "assistant";
         content: string;
         metadata?: Record<string, unknown>;
-      }
-    ): Promise<{ id: string }>;
+      },
+      options?: ChatAppendMessageOptionsDTO
+    ): Promise<{ id: string; generationId?: string }>;
     /**
      * Patch an existing message. All fields are optional; `undefined` leaves
      * the field untouched. Precedence rules:
@@ -1183,11 +1186,7 @@ export interface SpindleAPI {
     ): Promise<MacroResolveResultDTO>;
   };
 
-  /**
-   * User presence queries (free tier — no permission needed).
-   * Check whether a user currently has the Lumiverse app visible/focused
-   * in at least one browser tab or PWA window.
-   */
+  /** User context queries (free tier — no permission needed). */
   users: {
     /**
      * Returns true if the user has the app visible in at least one session.
@@ -1197,6 +1196,14 @@ export interface SpindleAPI {
      * For operator-scoped extensions, pass userId explicitly.
      */
     isVisible(userId?: string): Promise<boolean>;
+    /**
+     * Return the user's Lumiverse role as exposed to extensions.
+     * Internal owners are reported as `operator`; admins remain `admin`;
+     * everyone else is `user`.
+     * For user-scoped extensions, userId is inferred from the extension owner.
+     * For operator-scoped extensions, pass userId explicitly.
+     */
+    getRole(userId?: string): Promise<SpindleUserRoleDTO>;
   };
 
   /** Show toast notifications in the frontend UI (free tier — no permission needed) */