lumiverse-spindle-types 0.4.56 → 0.4.58

package/package.json

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

package/src/api.ts

@@ -667,6 +667,78 @@ export interface WorldBookEntryCreateDTO {
 
 export type WorldBookEntryUpdateDTO = WorldBookEntryCreateDTO;
 
+// ─── Regex Script DTOs ──────────────────────────────────────────────────
+
+export type RegexPlacementDTO = "user_input" | "ai_output" | "world_info" | "reasoning";
+export type RegexScopeDTO = "global" | "character" | "chat";
+export type RegexTargetDTO = "prompt" | "response" | "display";
+export type RegexMacroModeDTO = "none" | "raw" | "escaped";
+
+export interface RegexScriptDTO {
+  id: string;
+  name: string;
+  script_id: string;
+  find_regex: string;
+  replace_string: string;
+  flags: string;
+  placement: RegexPlacementDTO[];
+  scope: RegexScopeDTO;
+  scope_id: string | null;
+  target: RegexTargetDTO;
+  min_depth: number | null;
+  max_depth: number | null;
+  trim_strings: string[];
+  run_on_edit: boolean;
+  substitute_macros: RegexMacroModeDTO;
+  disabled: boolean;
+  sort_order: number;
+  description: string;
+  folder: string;
+  metadata: Record<string, unknown>;
+  created_at: number;
+  updated_at: number;
+}
+
+export interface RegexScriptListOptionsDTO {
+  scope?: RegexScopeDTO;
+  scopeId?: string;
+  target?: RegexTargetDTO;
+  limit?: number;
+  offset?: number;
+  userId?: string;
+}
+
+export interface RegexScriptActiveOptionsDTO {
+  target: RegexTargetDTO;
+  characterId?: string;
+  chatId?: string;
+  userId?: string;
+}
+
+export interface RegexScriptCreateDTO {
+  name: string;
+  find_regex: string;
+  replace_string?: string;
+  flags?: string;
+  placement?: RegexPlacementDTO[];
+  scope?: RegexScopeDTO;
+  scope_id?: string | null;
+  target?: RegexTargetDTO;
+  min_depth?: number | null;
+  max_depth?: number | null;
+  trim_strings?: string[];
+  run_on_edit?: boolean;
+  substitute_macros?: RegexMacroModeDTO;
+  disabled?: boolean;
+  sort_order?: number;
+  description?: string;
+  folder?: string;
+  metadata?: Record<string, unknown>;
+  script_id?: string;
+}
+
+export type RegexScriptUpdateDTO = Partial<RegexScriptCreateDTO>;
+
 // ─── Databank DTOs ───────────────────────────────────────────────────────
 
 export type DatabankScopeDTO = "global" | "character" | "chat";
@@ -1911,6 +1983,13 @@ 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 }
+  // ─── 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 }
+  | { type: "regex_scripts_get_active"; requestId: string; target: RegexTargetDTO; characterId?: string; chatId?: string; userId?: string }
+  | { type: "regex_scripts_create"; requestId: string; input: RegexScriptCreateDTO; userId?: string }
+  | { type: "regex_scripts_update"; requestId: string; scriptId: string; input: RegexScriptUpdateDTO; userId?: string }
+  | { type: "regex_scripts_delete"; requestId: string; scriptId: string; userId?: string }
   // ─── Dry Run (gated: "generation") ────────────────────────────────
   | { type: "generate_dry_run"; requestId: string; input: DryRunRequestDTO; userId?: string }
   // ─── Chat Memories (gated: "chats") ───────────────────────────────

package/src/dom.ts

@@ -377,6 +377,83 @@ export interface SpindleConfirmResult {
   confirmed: boolean;
 }
 
+// ── UI Event Helpers ──
+
+export type SpindleUIDomActionEventType = "click" | "pointerdown" | "pointerup";
+
+export interface SpindleUIKeyboardState {
+  /** True when the host believes a virtual keyboard is currently visible. */
+  visible: boolean;
+  /** Safe bottom inset in CSS pixels that keeps content above the keyboard. */
+  insetBottom: number;
+  /** Current visual viewport width in CSS pixels. */
+  viewportWidth: number;
+  /** Current visual viewport height in CSS pixels. */
+  viewportHeight: number;
+}
+
+export interface SpindleUIDrawerState {
+  /** Whether the side drawer is currently visible. */
+  open: boolean;
+  /** Active drawer tab, if any. */
+  tabId: string | null;
+}
+
+export interface SpindleUISettingsState {
+  /** Whether the settings modal is currently visible. */
+  open: boolean;
+  /** Active settings view identifier. */
+  view: string;
+}
+
+export interface SpindleUIDomActionDetail {
+  /** Matched action identifier read from the target element. */
+  actionId: string;
+  /** DOM event type that triggered the callback. */
+  eventType: SpindleUIDomActionEventType;
+  /** Matched descendant element that carried the action identifier. */
+  element: HTMLElement;
+  /** Bound extension-owned root used for delegation. */
+  root: Element;
+  /** Native DOM event from the host document. */
+  originalEvent: Event;
+}
+
+export interface SpindleUIDomActionBindingOptions {
+  /** Attribute used to resolve action IDs. Default: `id`. */
+  attribute?: string;
+  /** Event types to listen for. Default: `["click"]`. */
+  events?: SpindleUIDomActionEventType[];
+}
+
+export interface SpindleUIEventsHelper {
+  /** Read the current virtual keyboard snapshot. */
+  getKeyboardState(): SpindleUIKeyboardState;
+  /** Subscribe to keyboard visibility / safe-area changes. */
+  onKeyboardChange(handler: (state: SpindleUIKeyboardState) => void): () => void;
+  /** Read the current side drawer snapshot. */
+  getDrawerState(): SpindleUIDrawerState;
+  /** Subscribe to side drawer open/close and tab changes. */
+  onDrawerChange(handler: (state: SpindleUIDrawerState) => void): () => void;
+  /** Read the current settings modal snapshot. */
+  getSettingsState(): SpindleUISettingsState;
+  /** Subscribe to settings modal open/close and active-view changes. */
+  onSettingsChange(handler: (state: SpindleUISettingsState) => void): () => void;
+  /**
+   * Delegate action handlers from extension-owned DOM.
+   *
+   * This is intended for non-sandbox UI where the extension injects or mounts
+   * host DOM directly and wants to react to user interaction without wiring
+   * global document listeners. By default the helper matches descendant
+   * elements by `id`, but `options.attribute` can be used instead.
+   */
+  bindActionHandlers(
+    target: string | Element,
+    handlers: Record<string, (detail: SpindleUIDomActionDetail) => void>,
+    options?: SpindleUIDomActionBindingOptions,
+  ): () => void;
+}
+
 // ── Frontend Process Lifecycle ──
 
 /** Controller passed to a frontend process instance spawned by the backend runtime. */
@@ -432,6 +509,7 @@ export interface SpindleFrontendContext {
     emit(event: string, payload: unknown): void;
   };
   ui: {
+    events: SpindleUIEventsHelper;
     mount(point: SpindleMountPoint): Element;
     registerDrawerTab(options: SpindleDrawerTabOptions): SpindleDrawerTabHandle;
     createFloatWidget(options?: SpindleFloatWidgetOptions): SpindleFloatWidgetHandle;

package/src/events.ts

@@ -36,6 +36,8 @@ export enum CoreEventType {
   CONNECTION_PROFILE_LOADED = "CONNECTION_PROFILE_LOADED",
   MAIN_API_CHANGED = "MAIN_API_CHANGED",
   WORLD_INFO_ACTIVATED = "WORLD_INFO_ACTIVATED",
+  REGEX_SCRIPT_CHANGED = "REGEX_SCRIPT_CHANGED",
+  REGEX_SCRIPT_DELETED = "REGEX_SCRIPT_DELETED",
   MESSAGE_TAG_INTERCEPTED = "MESSAGE_TAG_INTERCEPTED",
   TOOL_INVOCATION = "TOOL_INVOCATION",
 }

package/src/index.ts

@@ -42,6 +42,15 @@ export type {
   WorldBookEntryDTO,
   WorldBookEntryCreateDTO,
   WorldBookEntryUpdateDTO,
+  RegexPlacementDTO,
+  RegexScopeDTO,
+  RegexTargetDTO,
+  RegexMacroModeDTO,
+  RegexScriptDTO,
+  RegexScriptCreateDTO,
+  RegexScriptUpdateDTO,
+  RegexScriptListOptionsDTO,
+  RegexScriptActiveOptionsDTO,
   DatabankScopeDTO,
   DatabankDocumentStatusDTO,
   DatabankDTO,
@@ -156,11 +165,18 @@ export type {
   SpindleModalOptions,
   SpindleModalHandle,
    SpindleConfirmVariant,
-   SpindleConfirmOptions,
-   SpindleConfirmResult,
-   SpindleFrontendProcessContext,
-   SpindleFrontendProcessRegistry,
-} from "./dom";
+    SpindleConfirmOptions,
+    SpindleConfirmResult,
+    SpindleUIDomActionEventType,
+    SpindleUIKeyboardState,
+    SpindleUIDrawerState,
+    SpindleUISettingsState,
+    SpindleUIDomActionDetail,
+    SpindleUIDomActionBindingOptions,
+    SpindleUIEventsHelper,
+    SpindleFrontendProcessContext,
+    SpindleFrontendProcessRegistry,
+ } from "./dom";
 
 export type { ExtensionInfo } from "./extension-info";
 

package/src/permissions.ts

@@ -31,6 +31,7 @@ export type SpindlePermission =
   | "characters"
   | "chats"
   | "world_books"
+  | "regex_scripts"
   | "databanks"
   | "personas"
   | "push_notification"
@@ -54,6 +55,7 @@ export const ALL_PERMISSIONS: readonly SpindlePermission[] = [
   "characters",
   "chats",
   "world_books",
+  "regex_scripts",
   "databanks",
   "personas",
   "push_notification",

package/src/spindle-api.ts

@@ -27,6 +27,11 @@ import type {
   WorldBookEntryDTO,
   WorldBookEntryCreateDTO,
   WorldBookEntryUpdateDTO,
+  RegexScriptDTO,
+  RegexScriptCreateDTO,
+  RegexScriptUpdateDTO,
+  RegexScriptListOptionsDTO,
+  RegexScriptActiveOptionsDTO,
   DatabankDTO,
   DatabankCreateDTO,
   DatabankUpdateDTO,
@@ -741,6 +746,24 @@ export interface SpindleAPI {
     getActivated(chatId: string, userId?: string): Promise<ActivatedWorldInfoEntryDTO[]>;
   };
 
+  /**
+   * Regex Scripts CRUD (permission: "regex_scripts").
+   * Full access to regex scripts attached to the user's account, including
+   * global, character-scoped, and chat-scoped rules. Same shape Lumiverse uses
+   * internally during prompt assembly, response baking, and display rendering.
+   * For user-scoped extensions, userId is inferred from the extension owner.
+   * For operator-scoped extensions, pass userId to scope to a specific user.
+   */
+  regex_scripts: {
+    list(options?: RegexScriptListOptionsDTO): Promise<{ data: RegexScriptDTO[]; total: number }>;
+    get(scriptId: string, userId?: string): Promise<RegexScriptDTO | null>;
+    create(input: RegexScriptCreateDTO, userId?: string): Promise<RegexScriptDTO>;
+    update(scriptId: string, input: RegexScriptUpdateDTO, userId?: string): Promise<RegexScriptDTO>;
+    delete(scriptId: string, userId?: string): Promise<boolean>;
+    /** Resolve the enabled scripts that would actually fire for the given target + character/chat context, merged across global + character + chat scopes and ordered by scope tier then sort_order. */
+    getActive(options: RegexScriptActiveOptionsDTO): Promise<RegexScriptDTO[]>;
+  };
+
   /**
    * Databank CRUD (permission: "databanks").
    * Manage databanks plus the documents they contain.