lumiverse-spindle-types 0.4.73 → 0.4.75

package/package.json

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

package/src/api.ts

@@ -627,6 +627,108 @@ export interface ChatChangedPayloadDTO {
   changedFields?: string[];
 }
 
+// ─── User Preset DTOs ───────────────────────────────────────────────────
+
+export type PromptVariableDefDTO =
+  | {
+      id: string;
+      name: string;
+      label: string;
+      type: "text";
+      defaultValue: string;
+      description?: string;
+    }
+  | {
+      id: string;
+      name: string;
+      label: string;
+      type: "textarea";
+      defaultValue: string;
+      rows?: number;
+      description?: string;
+    }
+  | {
+      id: string;
+      name: string;
+      label: string;
+      type: "number";
+      defaultValue: number;
+      min?: number;
+      max?: number;
+      step?: number;
+      description?: string;
+    }
+  | {
+      id: string;
+      name: string;
+      label: string;
+      type: "slider";
+      defaultValue: number;
+      min: number;
+      max: number;
+      step?: number;
+      description?: string;
+    };
+
+export type PromptVariableValueDTO = string | number;
+export type PromptVariableValuesDTO = Record<string, Record<string, PromptVariableValueDTO>>;
+export type PromptBlockRoleDTO = "system" | "user" | "assistant" | "user_append" | "assistant_append";
+export type PromptBlockPositionDTO = "pre_history" | "post_history" | "in_history";
+export type PromptBlockCategoryModeDTO = "radio" | "checkbox" | null;
+
+export interface PromptBlockDTO {
+  id: string;
+  name: string;
+  content: string;
+  role: PromptBlockRoleDTO;
+  enabled: boolean;
+  position: PromptBlockPositionDTO;
+  depth: number;
+  /** `"category"` marks a structural category header; other strings are structural insertion markers. */
+  marker: string | null;
+  isLocked: boolean;
+  color: string | null;
+  injectionTrigger: string[];
+  group: string | null;
+  /** Only meaningful when `marker === "category"`. Radio categories allow one enabled child; checkbox categories allow many. */
+  categoryMode?: PromptBlockCategoryModeDTO;
+  variables?: PromptVariableDefDTO[];
+}
+
+export interface PromptBlockCategoryGroupDTO {
+  /** The category header block, or null for uncategorized leading blocks. */
+  categoryBlock: PromptBlockDTO | null;
+  /** Non-category blocks after the header until the next category header. */
+  children: PromptBlockDTO[];
+}
+
+export interface UserPresetDTO {
+  id: string;
+  name: string;
+  provider: string;
+  engine: string;
+  parameters: Record<string, unknown>;
+  prompt_order: PromptBlockDTO[];
+  prompts: Record<string, unknown>;
+  metadata: Record<string, unknown>;
+  created_at: number;
+  updated_at: number;
+}
+
+export interface UserPresetCreateDTO {
+  name: string;
+  provider: string;
+  engine?: string;
+  parameters?: Record<string, unknown>;
+  prompt_order?: PromptBlockDTO[];
+  prompts?: Record<string, unknown>;
+  metadata?: Record<string, unknown>;
+}
+
+export type UserPresetUpdateDTO = Partial<UserPresetCreateDTO>;
+export type PromptBlockCreateDTO = Partial<PromptBlockDTO>;
+export type PromptBlockUpdateDTO = Partial<Omit<PromptBlockDTO, "id">>;
+
 // ─── World Book DTOs ─────────────────────────────────────────────────────
 
 /**
@@ -2114,6 +2216,18 @@ export type WorkerToHost =
   | { type: "chats_get_active"; requestId: string; userId?: string }
   | { type: "chats_update"; requestId: string; chatId: string; input: ChatUpdateDTO; userId?: string }
   | { type: "chats_delete"; requestId: string; chatId: string; userId?: string }
+  // ─── User Presets (gated: "presets") ────────────────────────────────
+  | { type: "presets_list"; requestId: string; limit?: number; offset?: number; userId?: string }
+  | { type: "presets_get"; requestId: string; presetId: string; userId?: string }
+  | { type: "presets_create"; requestId: string; input: UserPresetCreateDTO; userId?: string }
+  | { type: "presets_update"; requestId: string; presetId: string; input: UserPresetUpdateDTO; userId?: string }
+  | { type: "presets_delete"; requestId: string; presetId: string; userId?: string }
+  | { type: "preset_blocks_list"; requestId: string; presetId: string; userId?: string }
+  | { type: "preset_blocks_get"; requestId: string; presetId: string; blockId: string; userId?: string }
+  | { type: "preset_blocks_create"; requestId: string; presetId: string; input: PromptBlockCreateDTO; index?: number; userId?: string }
+  | { type: "preset_blocks_update"; requestId: string; presetId: string; blockId: string; input: PromptBlockUpdateDTO; userId?: string }
+  | { type: "preset_blocks_delete"; requestId: string; presetId: string; blockId: string; userId?: string }
+  | { type: "preset_categories_list"; requestId: string; presetId: string; userId?: string }
   // ─── World Books (gated: "world_books") ──────────────────────────────
   | { type: "world_books_list"; requestId: string; limit?: number; offset?: number; userId?: string }
   | { type: "world_books_get"; requestId: string; worldBookId: string; userId?: string }

package/src/dom.ts

@@ -132,7 +132,7 @@ export interface SpindleDockPanelHandle {
 
 export interface SpindleAppMountOptions {
   className?: string;
-  position?: "start" | "end";
+  position?: "start" | "end" | "app-overlay";
 }
 
 export interface SpindleAppMountHandle {

package/src/index.ts

@@ -36,11 +36,24 @@ export type {
   CharacterCreateDTO,
   CharacterAvatarUploadDTO,
   CharacterUpdateDTO,
-   ChatDTO,
-   ChatUpdateDTO,
-   ChatSwitchedPayloadDTO,
-   ChatChangedPayloadDTO,
-   WorldBookDTO,
+    ChatDTO,
+    ChatUpdateDTO,
+    ChatSwitchedPayloadDTO,
+    ChatChangedPayloadDTO,
+    PromptVariableDefDTO,
+    PromptVariableValueDTO,
+    PromptVariableValuesDTO,
+    PromptBlockRoleDTO,
+    PromptBlockPositionDTO,
+    PromptBlockCategoryModeDTO,
+    PromptBlockDTO,
+    PromptBlockCreateDTO,
+    PromptBlockUpdateDTO,
+    PromptBlockCategoryGroupDTO,
+    UserPresetDTO,
+    UserPresetCreateDTO,
+    UserPresetUpdateDTO,
+    WorldBookDTO,
   WorldBookCreateDTO,
   WorldBookUpdateDTO,
   WorldBookEntryDTO,

package/src/permissions.ts

@@ -12,6 +12,7 @@
  * - "generation_parameters" — inject parameters into in-flight generations via interceptors
  * - "characters"           — CRUD on character cards
  * - "chats"                — CRUD on chat sessions
+ * - "presets"              — CRUD on user presets and prompt blocks
  * - "personas"             — CRUD on personas
  * - "databanks"            — CRUD on databanks and their documents
  * - "macro_interceptor"    — transform raw templates before macro parsing/dispatch
@@ -30,6 +31,7 @@ export type SpindlePermission =
   | "oauth"
   | "characters"
   | "chats"
+  | "presets"
   | "world_books"
   | "regex_scripts"
   | "databanks"
@@ -54,6 +56,7 @@ export const ALL_PERMISSIONS: readonly SpindlePermission[] = [
   "oauth",
   "characters",
   "chats",
+  "presets",
   "world_books",
   "regex_scripts",
   "databanks",

package/src/spindle-api.ts

@@ -22,6 +22,13 @@ import type {
   CharacterUpdateDTO,
   ChatDTO,
   ChatUpdateDTO,
+  UserPresetDTO,
+  UserPresetCreateDTO,
+  UserPresetUpdateDTO,
+  PromptBlockDTO,
+  PromptBlockCreateDTO,
+  PromptBlockUpdateDTO,
+  PromptBlockCategoryGroupDTO,
   WorldBookDTO,
   WorldBookCreateDTO,
   WorldBookUpdateDTO,
@@ -730,6 +737,34 @@ export interface SpindleAPI {
     getMemories(chatId: string, options?: { topK?: number; userId?: string }): Promise<ChatMemoryResultDTO>;
   };
 
+  /**
+   * User Presets CRUD (permission: "presets").
+   * Preset categories are structural prompt blocks where `marker === "category"`;
+   * their children are the following non-category prompt blocks until the next
+   * category marker. Use `categories.list()` for the host-derived grouping, and
+   * use block CRUD to create/update/delete both normal prompt blocks and category
+   * marker blocks.
+   * For user-scoped extensions, userId is inferred from the extension owner.
+   * For operator-scoped extensions, pass userId to scope to a specific user.
+   */
+  presets: {
+    list(options?: { limit?: number; offset?: number; userId?: string }): Promise<{ data: UserPresetDTO[]; total: number }>;
+    get(presetId: string, userId?: string): Promise<UserPresetDTO | null>;
+    create(input: UserPresetCreateDTO, userId?: string): Promise<UserPresetDTO>;
+    update(presetId: string, input: UserPresetUpdateDTO, userId?: string): Promise<UserPresetDTO>;
+    delete(presetId: string, userId?: string): Promise<boolean>;
+    blocks: {
+      list(presetId: string, userId?: string): Promise<PromptBlockDTO[]>;
+      get(presetId: string, blockId: string, userId?: string): Promise<PromptBlockDTO | null>;
+      create(presetId: string, input: PromptBlockCreateDTO, options?: { index?: number; userId?: string }): Promise<PromptBlockDTO>;
+      update(presetId: string, blockId: string, input: PromptBlockUpdateDTO, userId?: string): Promise<PromptBlockDTO>;
+      delete(presetId: string, blockId: string, userId?: string): Promise<boolean>;
+    };
+    categories: {
+      list(presetId: string, userId?: string): Promise<PromptBlockCategoryGroupDTO[]>;
+    };
+  };
+
   /**
    * World Books CRUD (permission: "world_books").
    * Full access to world books and their entries.