bc-deeplib 4.0.0 → 5.0.1

package/dist/deeplib.d.ts

@@ -118,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.
@@ -254,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>;
@@ -274,6 +275,9 @@ declare module 'bc-deeplib/base/elements_typings' {
       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';
@@ -282,21 +286,23 @@ declare module 'bc-deeplib/base/elements_typings' {
       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;
+      optionsList: Parameters<typeof ElementDropdown.CreateLabelled>[1];
+      onChange?: Parameters<typeof ElementDropdown.CreateLabelled>[3];
       description?: ElementButton.StaticNode;
-      optionsList: Parameters<typeof ElementCreateDropdown>[1];
       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';
@@ -308,22 +314,14 @@ declare module 'bc-deeplib/base/elements_typings' {
       type: 'custom';
       htmlOptions: HTMLOptions<keyof HTMLElementTagNameMap>;
   } & BaseElementModel>;
+  export {};
 
 }
 declare module 'bc-deeplib/base/initialization' {
-  import { ModSdkManager, ModStorage, MainMenuOptions, TranslationOptions, Logger, ModulesList } 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.
@@ -361,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
@@ -370,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.
@@ -509,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' {
@@ -593,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.
        *
@@ -907,7 +899,7 @@ declare module 'bc-deeplib/utilities/elements/elements' {
   function elementGetTooltip(): HTMLElement | undefined;
   function elementSetTooltip(text: ElementButton.StaticNode, position?: 'top' | 'bottom'): boolean;
   interface PrevNext {
-      id: string;
+      id: string | null;
       initialLabel?: string;
       back: (arg0: PrevNextCallbacks) => void;
       initialPrevTooltip?: string;
@@ -1003,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;
   };
@@ -1036,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.
@@ -1062,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. */
@@ -1146,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' {
@@ -1280,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
@@ -1291,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>;
@@ -1299,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.
@@ -1316,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' {