lumiverse-spindle-types 0.5.22 → 0.5.23

package/package.json

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

package/src/api.ts

@@ -1175,6 +1175,8 @@ export interface WorldInfoInterceptorEntryDTO {
   readonly delay_until_recursion: boolean;
   readonly scan_depth: number | null;
   readonly order_value: number;
+  /** Attachment scope that contributed the entry's book to this chat. */
+  readonly book_source?: WorldBookSourceDTO;
 }
 
 /**
@@ -1353,6 +1355,13 @@ export interface PersonaUpdateDTO {
 
 // ─── Activated World Info DTOs ─────────────────────────────────────────
 
+/**
+ * Which attachment scope contributed a world book to prompt assembly.
+ * When a book is attached at multiple scopes the narrowest one wins:
+ * character → persona → chat → global.
+ */
+export type WorldBookSourceDTO = "character" | "persona" | "chat" | "global";
+
 /**
  * Lightweight summary of an activated world info entry.
  * Safe subset — no raw entry content or internal fields exposed.
@@ -1363,6 +1372,17 @@ export interface ActivatedWorldInfoEntryDTO {
   keys: string[];
   source: "keyword" | "vector";
   score?: number;
+  /** ID of the world book the entry belongs to. */
+  bookId?: string;
+  /** Attachment scope that contributed the entry's book. */
+  bookSource?: WorldBookSourceDTO;
+}
+
+/** Payload of the `WORLD_INFO_ACTIVATED` event. */
+export interface WorldInfoActivatedEventDTO {
+  chatId: string;
+  entries: ActivatedWorldInfoEntryDTO[];
+  stats?: Record<string, unknown>;
 }
 
 // ─── Dry Run DTOs ──────────────────────────────────────────────────────
@@ -2669,6 +2689,11 @@ export type WorkerToHost =
   | { type: "council_get_available_lumia_items"; requestId: string; userId?: string }
   // ─── Activated World Info (gated: "world_books") ───────────────────
   | { type: "world_books_get_activated"; requestId: string; chatId: string; userId?: string }
+  // ─── Global World Books (gated: "world_books") ───────────────────────
+  | { type: "world_books_get_global"; requestId: string; userId?: string }
+  | { type: "world_books_set_global"; requestId: string; worldBookIds: string[]; userId?: string }
+  | { type: "world_books_activate_global"; requestId: string; worldBookId: string; userId?: string }
+  | { type: "world_books_deactivate_global"; requestId: string; worldBookId: string; userId?: string }
   // ─── Regex Scripts (gated: "regex_scripts") ────────────────────────
   | { type: "regex_scripts_list"; requestId: string; scope?: RegexScopeDTO; scopeId?: string; target?: RegexTargetDTO; limit?: number; offset?: number; userId?: string }
   | { type: "regex_scripts_get"; requestId: string; scriptId: string; userId?: string }

package/src/index.ts

@@ -98,6 +98,8 @@ export type {
   PersonaCreateDTO,
   PersonaUpdateDTO,
   ActivatedWorldInfoEntryDTO,
+  WorldBookSourceDTO,
+  WorldInfoActivatedEventDTO,
   DryRunRequestDTO,
   DryRunResultDTO,
   AssemblyBreakdownEntryDTO,

package/src/spindle-api.ts

@@ -877,6 +877,27 @@ export interface SpindleAPI {
     };
     /** Get activated world info entries (keyword + vector) for a chat. */
     getActivated(chatId: string, userId?: string): Promise<ActivatedWorldInfoEntryDTO[]>;
+    /**
+     * Get the IDs of the user's globally-active world books (the
+     * "globalWorldBooks" setting). Global books apply to every chat.
+     */
+    getGlobal(userId?: string): Promise<string[]>;
+    /**
+     * Replace the set of globally-active world books. IDs that don't
+     * resolve to an existing world book are dropped. Returns the applied
+     * ID list.
+     */
+    setGlobal(worldBookIds: string[], userId?: string): Promise<string[]>;
+    /**
+     * Activate a single world book globally (atomic add). Throws if the
+     * book does not exist. Returns the updated global ID list.
+     */
+    activateGlobal(worldBookId: string, userId?: string): Promise<string[]>;
+    /**
+     * Deactivate a single globally-active world book (atomic remove).
+     * No-op if the book wasn't active. Returns the updated global ID list.
+     */
+    deactivateGlobal(worldBookId: string, userId?: string): Promise<string[]>;
   };
 
   /**