bc-deeplib 3.0.0 → 5.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;
@@ -119,7 +118,7 @@ declare module 'bc-deeplib/base/base_subscreen' {
        * If not configured, the default is the main menu for all screens, but main menu itself.
        * For main menu, the default is the Extensions menu
        */
-      returnScreen?: (() => ScreenSpecifier | BaseSubscreen) | ScreenSpecifier | BaseSubscreen;
+      returnScreen?: Thunk<ScreenSpecifier | BaseSubscreen>;
       /**
        * The background image for this subscreen.
        * Currently supports only images from the Club.
@@ -255,8 +254,9 @@ declare module 'bc-deeplib/base/base_subscreen' {
 }
 declare module 'bc-deeplib/base/elements_typings' {
   export type SettingElement = Button | Checkbox | Input | Label | Dropdown | Custom;
+  type ElementFlexDirection = 'row' | 'column' | 'rowReverse' | 'columnReverse';
   export type BaseElementModel = {
-      id: string;
+      id: string | null;
       size?: Thunk<[width: number | null, height: number | null]>;
       position?: Thunk<[x: number, y: number, anchor?: ElementHelp.AnchorXY]>;
       disabled?: Thunk<boolean>;
@@ -271,65 +271,62 @@ 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;
+      options?: {
+          direction?: ElementFlexDirection;
+      };
   } & BaseElementModel>;
   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;
+      options?: {
+          direction?: ElementFlexDirection;
+      };
   } & BaseElementModel>;
   export type Dropdown = Prettify<{
-      id: Parameters<typeof ElementCreateDropdown>[0];
+      id: Parameters<typeof ElementDropdown.CreateLabelled>[0];
       type: 'dropdown';
       label?: string;
-      description?: string;
-      optionsList: Parameters<typeof ElementCreateDropdown>[1];
+      optionsList: Parameters<typeof ElementDropdown.CreateLabelled>[1];
+      onChange?: Parameters<typeof ElementDropdown.CreateLabelled>[3];
+      description?: ElementButton.StaticNode;
       setElementValue?: () => string;
       setSettingValue?: (val: string) => void;
-      options?: Parameters<typeof ElementCreateDropdown>[3];
-      htmlOptions?: {
-          container?: Partial<Omit<HTMLOptions<any>, 'tag'>>;
-          select?: Parameters<typeof ElementCreateDropdown>[4];
-          label?: Partial<Omit<HTMLOptions<'label'>, 'tag'>>;
+      options?: Parameters<typeof ElementDropdown.CreateLabelled>[4] & {
+          direction?: ElementFlexDirection;
       };
+      htmlOptions?: Partial<Record<'label' | 'container' | 'select', Omit<HTMLOptions<any>, 'tag'>>> | null | undefined;
   } & Omit<BaseElementModel, 'id' | 'disabled'>>;
   export type Label = Prettify<{
       type: 'label';
       label?: string;
-      description?: string;
+      description?: ElementButton.StaticNode;
       htmlOptions?: Omit<HTMLOptions<any>, 'tag'>;
   } & BaseElementModel>;
   export type Custom = Prettify<{
       type: 'custom';
       htmlOptions: HTMLOptions<keyof HTMLElementTagNameMap>;
   } & BaseElementModel>;
+  export {};
 
 }
 declare module 'bc-deeplib/base/initialization' {
-  import { BaseModule, ModSdkManager, ModStorage, MainMenuOptions, TranslationOptions, Logger } from 'bc-deeplib/deeplib';
+  import { ModSdkManager, ModStorage, MainMenuOptions, TranslationOptions, ModulesList } from 'bc-deeplib/deeplib';
+  import { ILogger } from 'js-logger';
   /** Configuration object for initializing a mod via `initMod`. */
   interface InitOptions {
-      /**
-       * Name of the mod.
-       * Used to identify the mod in the Mod SDK and storage.
-       */
-      modName: string;
-      /**
-       * Repository URL for the mod.
-       * Used to register the mod with the Mod SDK and display in the main menu.
-       */
-      modRepository?: string;
       /**
        * 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.
@@ -362,8 +359,7 @@ declare module 'bc-deeplib/base/initialization' {
    * Mod specific logger instance.
    * Initialized by `initMod()`.
    */
-  export let modLogger: Logger;
-  export let MOD_NAME: string;
+  export let modLogger: ILogger;
   /**
    * Entry point for initializing a mod. Handles:
    *  - Setting up the Mod SDK
@@ -371,7 +367,7 @@ declare module 'bc-deeplib/base/initialization' {
    *  - Injecting required styles
    *  - Delaying initialization until login (if necessary)
    */
-  export function initMod(options: InitOptions): void;
+  export function initMod(options: InitOptions): Promise<void>;
   /**
    * Cleans up and removes the mod from memory.
    * Calls `unload()` on all modules and removes the global loaded flag.
@@ -381,7 +377,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 +401,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 +417,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 +433,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 +447,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';
@@ -502,12 +506,7 @@ declare module 'bc-deeplib/models/base' {
    * Represents the base settings structure for a mod.
    * Present for all mods.
    */
-  export type BaseSettingsModel = {
-      /** Whether the mod is currently active. */
-      modEnabled: boolean;
-      /** Whether to display a notification when a new version is detected. */
-      doShowNewVersionMessage: boolean;
-  };
+  export type BaseSettingsModel = Record<string, unknown>;
 
 }
 declare module 'bc-deeplib/models/settings' {
@@ -518,6 +517,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';
@@ -563,7 +585,7 @@ declare module 'bc-deeplib/modules/gui' {
       /** Returns all registered subscreens. */
       get subscreens(): BaseSubscreen[];
       /** Returns the main menu subscreen instance. */
-      get mainMenu(): MainMenu;
+      get mainMenu(): MainMenu | null;
       /**
        * Creates the GUI instance and initializes the main menu.
        *
@@ -663,9 +685,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 +826,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,9 +897,9 @@ 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;
+      id: string | null;
       initialLabel?: string;
       back: (arg0: PrevNextCallbacks) => void;
       initialPrevTooltip?: string;
@@ -911,6 +947,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 +962,7 @@ declare module 'bc-deeplib/utilities/elements/helpers' {
       vertical: boolean;
       horizontal: boolean;
   } | null;
+  function doRectsOverlap(rect1: DOMRect, rect2: DOMRect): boolean;
   export {};
 
 }
@@ -953,7 +995,7 @@ declare module 'bc-deeplib/utilities/elements/modal' {
       /** Button label text. */
       text: string;
       /** Action identifier returned when the button is clicked. */
-      action: T;
+      action: T | (() => void);
       /** Whether the button is disabled. */
       disabled?: boolean;
   };
@@ -986,21 +1028,43 @@ declare module 'bc-deeplib/utilities/elements/modal' {
       enterAction?: T;
       /** Modal ID. */
       modalId?: string;
+      /** Modal class list. */
+      modalClassList?: string[];
+      /** Callback function to be called when the modal is shown. */
+      onShow?: (this: HTMLDialogElement) => void;
   };
-  export interface AlertOptions {
+  export interface AlertOptions<T extends string = string> {
       /** Auto-close timeout in milliseconds. */
       timeoutMs?: number;
       /** Modal ID. */
       modalId?: string;
+      /** Modal class list. */
+      modalClassList?: string[];
+      /** Additional buttons to display in the modal. */
+      buttons?: ModalButton<T>[];
+      /** Callback function to be called when the modal is shown. */
+      onShow?: (this: HTMLDialogElement) => void;
   }
-  export interface ConfirmOptions {
+  export interface ConfirmOptions<T extends string = string> {
       /** Modal ID. */
       modalId?: string;
+      /** Modal class list. */
+      modalClassList?: string[];
+      /** Additional buttons to display in the modal. */
+      buttons?: ModalButton<T>[];
+      /** Callback function to be called when the modal is shown. */
+      onShow?: (this: HTMLDialogElement) => void;
   }
-  export interface PromptOptions {
+  export interface PromptOptions<T extends string = string> {
       defaultValue?: string;
       /** Modal ID. */
       modalId?: string;
+      /** Modal class list. */
+      modalClassList?: string[];
+      /** Additional buttons to display in the modal. */
+      buttons?: ModalButton<T>[];
+      /** Callback function to be called when the modal is shown. */
+      onShow?: (this: HTMLDialogElement) => void;
   }
   /**
    * Modal dialog implementation with queuing, buttons, optional input, and focus trapping.
@@ -1012,6 +1076,7 @@ declare module 'bc-deeplib/utilities/elements/modal' {
       private blocker;
       private inputEl?;
       private timeoutId?;
+      private updateIntervalId?;
       /** Static modal queue. */
       private static queue;
       /** Flag to indicate if a modal is currently being shown. */
@@ -1096,25 +1161,7 @@ declare module 'bc-deeplib/utilities/event_channel' {
 
 }
 declare module 'bc-deeplib/utilities/logger' {
-  type LogLevel = 'info' | 'log' | 'warn' | 'error' | 'debug';
-  interface LogEntry {
-      readonly args: readonly any[];
-      readonly date: Date;
-      readonly logLevel: LogLevel;
-  }
-  export class Logger extends Array<LogEntry> {
-      private ModName;
-      constructor(modName?: string);
-      private _Log;
-      info(...args: any[]): void;
-      log(...args: any[]): void;
-      warn(...args: any[]): void;
-      error(...args: any[]): void;
-      debug(...args: any[]): void;
-      static colorizeLog(logLevel: LogLevel): string;
-  }
-  export const deepLibLogger: Logger;
-  export {};
+  export const deepLibLogger: import("js-logger").ILogger;
 
 }
 declare module 'bc-deeplib/utilities/messages' {
@@ -1230,6 +1277,8 @@ declare module 'bc-deeplib/utilities/translation' {
       defaultLanguage?: string;
       /** If true, the localization will be fixed to the default language, ignoring user language settings. */
       fixedLanguage?: boolean;
+      /** If true, the localization will fetch the translations from the folder. */
+      fetchFolder?: boolean;
   }
   /**
    * Localization class handles loading and retrieving translation strings
@@ -1241,7 +1290,7 @@ declare module 'bc-deeplib/utilities/translation' {
       private static PathToModTranslation;
       private static PathToLibTranslation;
       private static DefaultLanguage;
-      /** Flag to prevent re-initialization */
+      private static FetchFolder;
       private static initialized;
       /** Initialize the localization system by loading translation files. */
       static init(initOptions?: TranslationOptions): Promise<void>;
@@ -1249,16 +1298,25 @@ declare module 'bc-deeplib/utilities/translation' {
       static getTextMod(srcTag: string): string | undefined;
       /** Get a translated string from library translations by source tag. */
       static getTextLib(srcTag: string): string | undefined;
+      private static fetchTranslation;
       /**
-       * Fetch and parse a language file from the given base URL and language code.
-       * Falls back to default language if the requested language file is unavailable.
+       * Fetch and parse a single translation file for a given language.
+       * Only requests `${baseUrl}${lang}.lang` and returns its parsed contents,
+       * or an empty dictionary if the file cannot be fetched.
        */
       private static fetchLanguageFile;
+      /**
+       * Fetch and parse all translation files from a language folder.
+       * First attempts to load a manifest file listing all translation files,
+       * then falls back to trying common file names.
+       * Returns empty dict if folder doesn't exist or has no valid files.
+       */
+      private static fetchLanguageFolder;
       /**
        * Parse the raw content of a language file into a TranslationDict.
        * Ignores empty lines and comments starting with '#'.
        */
-      private static parseLanguageFile;
+      private static parseTranslation;
   }
   /**
    * Retrieve a localized string for the given source tag.
@@ -1266,7 +1324,7 @@ declare module 'bc-deeplib/utilities/translation' {
    * then falls back to the library translation,
    * and if neither exist, returns the source tag itself.
    */
-  export const getText: (srcTag: string) => string;
+  export const getText: (srcTag: string, replacements?: Record<string, string | number | boolean>) => string;
 
 }
 declare module 'bc-deeplib' {