bc-deeplib 3.0.0 → 4.0.0

package/dist/deeplib.d.ts

@@ -46,7 +46,6 @@ declare module 'bc-deeplib/base/base_module' {
       set settings(value: BaseSettingsModel | null);
       /**
        * Initializes the module.
-       * Default implementation registers default settings immediately.
        * Subclasses can override to perform additional setup.
        */
       init(): void;
@@ -271,7 +270,7 @@ declare module 'bc-deeplib/base/elements_typings' {
   export type Checkbox = Prettify<{
       type: 'checkbox';
       label?: string;
-      description?: string;
+      description?: ElementButton.StaticNode;
       setElementValue?: () => boolean;
       setSettingValue?: (val: boolean) => void;
       htmlOptions?: Partial<Record<'container' | 'checkbox' | 'label', Omit<HTMLOptions<any>, 'tag'>>> | null | undefined;
@@ -279,7 +278,7 @@ declare module 'bc-deeplib/base/elements_typings' {
   export type Input = Prettify<{
       type: 'text' | 'number' | 'color';
       label?: string;
-      description?: string;
+      description?: ElementButton.StaticNode;
       setElementValue?: () => string;
       setSettingValue?: (val: string) => void;
       htmlOptions?: Partial<Record<'container' | 'input' | 'label', Omit<HTMLOptions<any>, 'tag'>>> | null | undefined;
@@ -288,7 +287,7 @@ declare module 'bc-deeplib/base/elements_typings' {
       id: Parameters<typeof ElementCreateDropdown>[0];
       type: 'dropdown';
       label?: string;
-      description?: string;
+      description?: ElementButton.StaticNode;
       optionsList: Parameters<typeof ElementCreateDropdown>[1];
       setElementValue?: () => string;
       setSettingValue?: (val: string) => void;
@@ -302,7 +301,7 @@ declare module 'bc-deeplib/base/elements_typings' {
   export type Label = Prettify<{
       type: 'label';
       label?: string;
-      description?: string;
+      description?: ElementButton.StaticNode;
       htmlOptions?: Omit<HTMLOptions<any>, 'tag'>;
   } & BaseElementModel>;
   export type Custom = Prettify<{
@@ -312,7 +311,7 @@ declare module 'bc-deeplib/base/elements_typings' {
 
 }
 declare module 'bc-deeplib/base/initialization' {
-  import { BaseModule, ModSdkManager, ModStorage, MainMenuOptions, TranslationOptions, Logger } from 'bc-deeplib/deeplib';
+  import { ModSdkManager, ModStorage, MainMenuOptions, TranslationOptions, Logger, ModulesList } from 'bc-deeplib/deeplib';
   /** Configuration object for initializing a mod via `initMod`. */
   interface InitOptions {
       /**
@@ -329,7 +328,7 @@ declare module 'bc-deeplib/base/initialization' {
        * List of modules (`BaseModule` subclasses) to register with the mod system.
        * Modules are initialized, loaded, and run in order.
        */
-      modules?: BaseModule[];
+      modules?: Partial<ModulesList>;
       /**
        * Configuration for customizing the main menu when the mod is active.
        * Does nothing if GUI module is not loaded.
@@ -381,7 +380,14 @@ declare module 'bc-deeplib/base/initialization' {
 
 }
 declare module 'bc-deeplib/base/modules' {
-  import { BaseModule } from 'bc-deeplib/deeplib';
+  import { GUI, VersionModule } from 'bc-deeplib/deeplib';
+  import { DebugModule } from 'bc-deeplib/modules/debug';
+  export interface ModulesList {
+      VersionModule: VersionModule;
+      GUI: GUI;
+      DebugModule: DebugModule;
+  }
+  export type ModuleKey = Prettify<keyof ModulesList>;
   /**
    * Retrieves all registered module instances.
    *
@@ -398,7 +404,7 @@ declare module 'bc-deeplib/base/modules' {
    * }
    * ```
    */
-  export function modules(): BaseModule[];
+  export function modules(): ModulesList[ModuleKey][];
   /**
    * Registers a module instance in the global registry.
    *
@@ -414,7 +420,7 @@ declare module 'bc-deeplib/base/modules' {
    * registerModule(new MyGlobalModule());
    * ```
    */
-  export function registerModule<T extends BaseModule>(module: T): T;
+  export function registerModule<K extends ModuleKey>(key: K, module: ModulesList[K]): ModulesList[K];
   /**
    * Retrieves a registered module by its type name.
    *
@@ -430,7 +436,7 @@ declare module 'bc-deeplib/base/modules' {
    * themeModule?.reloadTheme();
    * ```
    */
-  export function getModule<T extends BaseModule>(moduleType: string): T | undefined;
+  export function getModule<K extends ModuleKey>(key: K): ModulesList[K];
 
 }
 declare module 'bc-deeplib/deeplib' {
@@ -444,6 +450,7 @@ declare module 'bc-deeplib/deeplib' {
   export * from 'bc-deeplib/models/settings';
   export * from 'bc-deeplib/modules/gui';
   export * from 'bc-deeplib/modules/version';
+  export * from 'bc-deeplib/modules/debug';
   export * from 'bc-deeplib/screens/debug';
   export * from 'bc-deeplib/screens/main_menu';
   export * from 'bc-deeplib/screens/import_export';
@@ -518,6 +525,29 @@ declare module 'bc-deeplib/models/settings' {
       Version: string;
   };
 
+}
+declare module 'bc-deeplib/modules/debug' {
+  import { BaseModule } from 'bc-deeplib/deeplib';
+  interface DebugSettings {
+      showRawTranslations: boolean;
+      showFileNames: boolean;
+      showIncomingServerTransactions: boolean;
+      incomingMessageFilterMode: 'include' | 'exclude';
+      incomingMessageTypes: string;
+      showOutcomingServerTransactions: boolean;
+      outcomingMessageFilterMode: 'include' | 'exclude';
+      outcomingMessageTypes: string;
+      showRawActivityNames: boolean;
+      showRawAssetNames: boolean;
+  }
+  export class DebugModule extends BaseModule {
+      debugSettings: DebugSettings;
+      load(): void;
+      unload(): void;
+      saveDebugSettings(): void;
+  }
+  export {};
+
 }
 declare module 'bc-deeplib/modules/gui' {
   import { BaseModule, BaseSubscreen, MainMenu } from 'bc-deeplib/deeplib';
@@ -663,9 +693,12 @@ declare module 'bc-deeplib/modules/version' {
 declare module 'bc-deeplib/screens/debug' {
   import { SettingElement } from 'bc-deeplib/base/elements_typings';
   import { BaseSubscreen, SubscreenOptions } from 'bc-deeplib/deeplib';
+  import { DebugModule } from 'bc-deeplib/modules/debug';
   export class GuiDebug extends BaseSubscreen {
       protected static subscreenOptions: SubscreenOptions;
+      readonly module: DebugModule;
       get pageStructure(): SettingElement[][];
+      exit(): void;
   }
 
 }
@@ -801,6 +834,17 @@ declare module 'bc-deeplib/utilities/common' {
    * Converts bytes to kilobytes.
    */
   export const byteToKB: (nByte: number) => number;
+  export type Ok<T> = {
+      ok: true;
+      value: T;
+  };
+  export type Err<E = unknown> = {
+      ok: false;
+      error: E;
+  };
+  export type Result<T, E = unknown> = Ok<T> | Err<E>;
+  export function tryCatch<T, E = unknown>(fn: () => T, mapError?: (e: unknown) => E): Result<T, E>;
+  export function tryCatchAsync<T, E = unknown>(fn: () => Promise<T>, mapError?: (e: unknown) => E): Promise<Result<T, E>>;
 
 }
 declare module 'bc-deeplib/utilities/data' {
@@ -861,7 +905,7 @@ declare module 'bc-deeplib/utilities/elements/elements' {
   function elementCreateDropdown(options: Omit<Dropdown, 'type'>): HTMLLabelElement;
   function elementCreateTooltip(): HTMLDivElement;
   function elementGetTooltip(): HTMLElement | undefined;
-  function elementSetTooltip(text: string): boolean;
+  function elementSetTooltip(text: ElementButton.StaticNode, position?: 'top' | 'bottom'): boolean;
   interface PrevNext {
       id: string;
       initialLabel?: string;
@@ -911,6 +955,11 @@ declare module 'bc-deeplib/utilities/elements/helpers' {
        * Returns null if the element is not found.
        */
       hasOverflow: typeof hasOverflow;
+      /**
+       * Checks if two rectangles overlap.
+       * Returns true if the rectangles overlap, false otherwise.
+       */
+      doRectsOverlap: typeof doRectsOverlap;
   };
   function autoSetPosition(_: ElementHelp.ElementOrId, position: SettingElement['position']): void;
   function autoSetSize(_: ElementHelp.ElementOrId, size: SettingElement['size']): void;
@@ -921,6 +970,7 @@ declare module 'bc-deeplib/utilities/elements/helpers' {
       vertical: boolean;
       horizontal: boolean;
   } | null;
+  function doRectsOverlap(rect1: DOMRect, rect2: DOMRect): boolean;
   export {};
 
 }