lumiverse-spindle-types 0.1.3 → 0.1.4

package/package.json

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

package/src/api.ts

@@ -62,6 +62,80 @@ export interface ConnectionProfileDTO {
   updated_at: number;
 }
 
+// ─── Character DTOs ─────────────────────────────────────────────────────
+
+/**
+ * Safe representation of a character exposed to extensions.
+ * Omits raw extensions blob — only exposes user-facing fields.
+ */
+export interface CharacterDTO {
+  id: string;
+  name: string;
+  description: string;
+  personality: string;
+  scenario: string;
+  first_mes: string;
+  mes_example: string;
+  creator_notes: string;
+  system_prompt: string;
+  post_history_instructions: string;
+  tags: string[];
+  alternate_greetings: string[];
+  creator: string;
+  image_id: string | null;
+  created_at: number;
+  updated_at: number;
+}
+
+export interface CharacterCreateDTO {
+  name: string;
+  description?: string;
+  personality?: string;
+  scenario?: string;
+  first_mes?: string;
+  mes_example?: string;
+  creator_notes?: string;
+  system_prompt?: string;
+  post_history_instructions?: string;
+  tags?: string[];
+  alternate_greetings?: string[];
+  creator?: string;
+}
+
+export interface CharacterUpdateDTO {
+  name?: string;
+  description?: string;
+  personality?: string;
+  scenario?: string;
+  first_mes?: string;
+  mes_example?: string;
+  creator_notes?: string;
+  system_prompt?: string;
+  post_history_instructions?: string;
+  tags?: string[];
+  alternate_greetings?: string[];
+  creator?: string;
+}
+
+// ─── Chat DTOs ──────────────────────────────────────────────────────────
+
+/**
+ * Safe representation of a chat session exposed to extensions.
+ */
+export interface ChatDTO {
+  id: string;
+  character_id: string;
+  name: string;
+  metadata: Record<string, unknown>;
+  created_at: number;
+  updated_at: number;
+}
+
+export interface ChatUpdateDTO {
+  name?: string;
+  metadata?: Record<string, unknown>;
+}
+
 /**
  * Structured error code included in permission-denied error messages.
  * Extensions can check `error.startsWith("PERMISSION_DENIED:")` to
@@ -246,7 +320,30 @@ export type WorkerToHost =
     }
   | { type: "tool_invocation_result"; requestId: string; result?: string; error?: string }
   | { type: "create_oauth_state"; requestId: string }
-  | { type: "log"; level: "info" | "warn" | "error"; message: string };
+  | { type: "log"; level: "info" | "warn" | "error"; message: string }
+  // ─── Variables (free tier) ──────────────────────────────────────────
+  | { type: "vars_get_local"; requestId: string; chatId: string; key: string }
+  | { type: "vars_set_local"; requestId: string; chatId: string; key: string; value: string }
+  | { type: "vars_delete_local"; requestId: string; chatId: string; key: string }
+  | { type: "vars_list_local"; requestId: string; chatId: string }
+  | { type: "vars_has_local"; requestId: string; chatId: string; key: string }
+  | { type: "vars_get_global"; requestId: string; key: string; userId?: string }
+  | { type: "vars_set_global"; requestId: string; key: string; value: string; userId?: string }
+  | { type: "vars_delete_global"; requestId: string; key: string; userId?: string }
+  | { type: "vars_list_global"; requestId: string; userId?: string }
+  | { type: "vars_has_global"; requestId: string; key: string; userId?: string }
+  // ─── Characters (gated: "characters") ──────────────────────────────
+  | { type: "characters_list"; requestId: string; limit?: number; offset?: number; userId?: string }
+  | { type: "characters_get"; requestId: string; characterId: string; userId?: string }
+  | { type: "characters_create"; requestId: string; input: CharacterCreateDTO; userId?: string }
+  | { type: "characters_update"; requestId: string; characterId: string; input: CharacterUpdateDTO; userId?: string }
+  | { type: "characters_delete"; requestId: string; characterId: string; userId?: string }
+  // ─── Chats (gated: "chats") ────────────────────────────────────────
+  | { type: "chats_list"; requestId: string; characterId?: string; limit?: number; offset?: number; userId?: string }
+  | { type: "chats_get"; requestId: string; chatId: string; userId?: string }
+  | { 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 };
 
 // ─── Host → Worker messages ──────────────────────────────────────────────
 

package/src/index.ts

@@ -20,6 +20,11 @@ export type {
   RequestInitDTO,
   ConnectionProfileDTO,
   PermissionDeniedDetail,
+  CharacterDTO,
+  CharacterCreateDTO,
+  CharacterUpdateDTO,
+  ChatDTO,
+  ChatUpdateDTO,
   WorkerToHost,
   HostToWorker,
 } from "./api";

package/src/permissions.ts

@@ -1,7 +1,7 @@
 /**
  * Gated permissions that extensions must declare in spindle.json.
  *
- * Free tier (no declaration needed): events, storage, macros, dom
+ * Free tier (no declaration needed): events, storage, macros, dom, variables
  *
  * Gated tier (must declare):
  * - "generation"       — fire generations on behalf of user
@@ -9,6 +9,8 @@
  * - "tools"            — register LLM tools
  * - "cors_proxy"       — use CORS proxy
  * - "context_handler"  — register global context middleware
+ * - "characters"       — CRUD on character cards
+ * - "chats"            — CRUD on chat sessions
  */
 export type SpindlePermission =
   | "generation"
@@ -21,7 +23,9 @@ export type SpindlePermission =
   | "event_tracking"
   | "ui_panels"
   | "app_manipulation"
-  | "oauth";
+  | "oauth"
+  | "characters"
+  | "chats";
 
 export const ALL_PERMISSIONS: readonly SpindlePermission[] = [
   "generation",
@@ -35,6 +39,8 @@ export const ALL_PERMISSIONS: readonly SpindlePermission[] = [
   "ui_panels",
   "app_manipulation",
   "oauth",
+  "characters",
+  "chats",
 ] as const;
 
 export function isValidPermission(p: string): p is SpindlePermission {

package/src/spindle-api.ts

@@ -7,6 +7,11 @@ import type {
   RequestInitDTO,
   ConnectionProfileDTO,
   PermissionDeniedDetail,
+  CharacterDTO,
+  CharacterCreateDTO,
+  CharacterUpdateDTO,
+  ChatDTO,
+  ChatUpdateDTO,
 } from "./api";
 
 /** The global `spindle` object available in backend extension workers */
@@ -228,6 +233,52 @@ export interface SpindleAPI {
     get(connectionId: string, userId?: string): Promise<ConnectionProfileDTO | null>;
   };
 
+  /**
+   * Local (chat-scoped) and global variable access (free tier — no permission needed).
+   * Uses the same storage as built-in {{getvar}}/{{setgvar}} macros.
+   */
+  variables: {
+    local: {
+      get(chatId: string, key: string): Promise<string>;
+      set(chatId: string, key: string, value: string): Promise<void>;
+      delete(chatId: string, key: string): Promise<void>;
+      list(chatId: string): Promise<Record<string, string>>;
+      has(chatId: string, key: string): Promise<boolean>;
+    };
+    global: {
+      get(key: string): Promise<string>;
+      set(key: string, value: string): Promise<void>;
+      delete(key: string): Promise<void>;
+      list(): Promise<Record<string, string>>;
+      has(key: string): Promise<boolean>;
+    };
+  };
+
+  /**
+   * Character CRUD (permission: "characters").
+   * Returns safe DTO representations — raw extensions blob is not exposed.
+   */
+  characters: {
+    list(options?: { limit?: number; offset?: number }): Promise<{ data: CharacterDTO[]; total: number }>;
+    get(characterId: string): Promise<CharacterDTO | null>;
+    create(input: CharacterCreateDTO): Promise<CharacterDTO>;
+    update(characterId: string, input: CharacterUpdateDTO): Promise<CharacterDTO>;
+    delete(characterId: string): Promise<boolean>;
+  };
+
+  /**
+   * Chat session CRUD (permission: "chats").
+   * Separate from `chat` (message-level mutation) — this operates on chat entities.
+   */
+  chats: {
+    list(options?: { characterId?: string; limit?: number; offset?: number }): Promise<{ data: ChatDTO[]; total: number }>;
+    get(chatId: string): Promise<ChatDTO | null>;
+    /** Get the user's currently active chat (as tracked by the frontend). Returns null if none. */
+    getActive(): Promise<ChatDTO | null>;
+    update(chatId: string, input: ChatUpdateDTO): Promise<ChatDTO>;
+    delete(chatId: string): Promise<boolean>;
+  };
+
   permissions: {
     getGranted(): Promise<string[]>;
     /**