bc-deeplib 2.0.0 → 2.2.0

package/dist/deeplib.d.ts

@@ -125,6 +125,25 @@ declare module 'bc-deeplib/base/base_subscreen' {
        * Currently supports only images from the Club.
        */
       background?: string;
+      /**
+       * If `true`, the exit button will be shown on the subscreen.
+       * Defaults to `true`.
+       */
+      doShowExitButton?: boolean;
+      /**
+       * If `true`, the title will be shown on the subscreen.
+       * Defaults to `true`.
+       */
+      doShowTitle?: boolean;
+      /**
+       * The width of the settings div in canvas pixels.
+       * Defaults to 1000.
+       */
+      settingsWidth?: number;
+      /**
+       * If `true`, the character will be forced to the top of the screen.
+       */
+      forceUpCharacter?: boolean;
   };
   /**
    * Represents a constructor type for a subscreen.
@@ -233,46 +252,61 @@ declare module 'bc-deeplib/base/base_subscreen' {
 
 }
 declare module 'bc-deeplib/base/elements_typings' {
-  export type SettingElement = Button | Checkbox | Input | Label | Custom;
+  export type SettingElement = Button | Checkbox | Input | Label | Dropdown | Custom;
   export type BaseElementModel = {
       id: string;
       size?: [width: number | null, height: number | null] | (() => [width: number | null, height: number | null]);
       position?: [x: number, y: number] | (() => [x: number, y: number]);
       disabled?: boolean | (() => boolean);
   };
-  export type Button = Omit<BaseElementModel, 'id'> & {
+  export type Button = Prettify<{
       id: Parameters<typeof ElementButton.Create>[0];
       type: 'button';
       onClick?: Parameters<typeof ElementButton.Create>[1];
       options?: Parameters<typeof ElementButton.Create>[2];
       htmlOptions?: Parameters<typeof ElementButton.Create>[3];
-  };
-  export type Checkbox = BaseElementModel & {
+  } & Omit<BaseElementModel, 'id'>>;
+  export type Checkbox = Prettify<{
       type: 'checkbox';
       label?: string;
       description?: string;
       setElementValue?: () => boolean;
       setSettingValue?: (val: boolean) => void;
-      htmlOptions?: Omit<HTMLOptions<any>, 'tag'>;
-  };
-  export type Input = BaseElementModel & {
+      htmlOptions?: Partial<Record<'container' | 'checkbox' | 'label', Omit<HTMLOptions<any>, 'tag'>>> | null | undefined;
+  } & BaseElementModel>;
+  export type Input = Prettify<{
       type: 'text' | 'number' | 'color';
       label?: string;
       description?: string;
       setElementValue?: () => string;
       setSettingValue?: (val: string) => void;
-      htmlOptions?: Omit<HTMLOptions<any>, 'tag'>;
-  };
-  export type Label = BaseElementModel & {
+      htmlOptions?: Partial<Record<'container' | 'input' | 'label', Omit<HTMLOptions<any>, 'tag'>>> | null | undefined;
+  } & BaseElementModel>;
+  export type Dropdown = Prettify<{
+      id: Parameters<typeof ElementCreateDropdown>[0];
+      type: 'dropdown';
+      label?: string;
+      description?: string;
+      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'>>;
+      };
+  } & Omit<BaseElementModel, 'id' | 'disabled'>>;
+  export type Label = Prettify<{
       type: 'label';
       label?: string;
       description?: string;
       htmlOptions?: Omit<HTMLOptions<any>, 'tag'>;
-  };
-  export type Custom = BaseElementModel & {
+  } & BaseElementModel>;
+  export type Custom = Prettify<{
       type: 'custom';
       htmlOptions: HTMLOptions<keyof HTMLElementTagNameMap>;
-  };
+  } & BaseElementModel>;
 
 }
 declare module 'bc-deeplib/base/initialization' {
@@ -331,20 +365,6 @@ declare module 'bc-deeplib/base/initialization' {
    *  - Delaying initialization until login (if necessary)
    */
   export function initMod(options: InitOptions): void;
-  /**
-   * Fully initializes the mod after login.
-   * Handles:
-   *  - Preventing double-load
-   *  - Loading mod data
-   *  - Initializing localization
-   *  - Registering modules and migrators
-   *  - Running optional init functions
-   *  - Applying main menu changes
-   *  - Merging default settings into module settings
-   *
-   * @param options {InitOptions} Configuration for mod initialization.
-   */
-  export function init(options: InitOptions): Promise<void>;
   /**
    * Cleans up and removes the mod from memory.
    * Calls `unload()` on all modules and removes the global loaded flag.
@@ -416,6 +436,7 @@ declare module 'bc-deeplib/base/modules' {
 declare module 'bc-deeplib/deeplib' {
   export * from 'bc-deeplib/base/base_module';
   export * from 'bc-deeplib/base/base_subscreen';
+  export * from 'bc-deeplib/base/elements_typings';
   export * from 'bc-deeplib/base/initialization';
   export * from 'bc-deeplib/base/modules';
   export * from 'bc-deeplib/migrators/base_migrator';
@@ -563,7 +584,7 @@ declare module 'bc-deeplib/modules/gui' {
 declare module 'bc-deeplib/modules/version' {
   import { BaseMigrator, BaseModule } from 'bc-deeplib/deeplib';
   export type VersionModuleOptions = {
-      newVersionMessage: string;
+      newVersionMessage?: string;
       beforeEach?: () => void;
       afterEach?: () => void;
       beforeAll?: () => void;
@@ -586,7 +607,7 @@ declare module 'bc-deeplib/modules/version' {
       /** The current mod version (retrieved from `ModSdkManager.ModInfo.version`) */
       private static version;
       /** Message to display when a new version is detected */
-      private static newVersionMessage;
+      private static newVersionMessage?;
       /** List of registered migration handlers, sorted by version */
       private static migrators;
       /** Optional lifecycle hook. Runs before each migration */
@@ -744,12 +765,12 @@ declare module 'bc-deeplib/screens/main_menu' {
 }
 declare module 'bc-deeplib/utilities/common' {
   /**
-   * Deeply merges properties from `source` into `target`.
-   * - If both target and source properties are arrays, concatenates them.
-   * - If both are objects, recursively merges them.
-   * - Otherwise, source overwrites target.
+   * Deeply merges two values into a new value.
+   * - Arrays are concatenated.
+   * - Plain objects are merged recursively.
+   * - Other values are replaced by `source`.
    */
-  export function deepMerge(target: any, source: any): any;
+  export function deepMerge<T, U>(target: T, source: U): T & U;
   /**
    * Returns a new array with elements of the input array shuffled.
    * Uses something-something shuffle algorithm by splicing from a cloned array.
@@ -810,7 +831,7 @@ declare module 'bc-deeplib/utilities/data' {
 
 }
 declare module 'bc-deeplib/utilities/elements/elements' {
-  import { Button, Checkbox, Custom, Input, Label } from 'bc-deeplib/base/elements_typings';
+  import { Button, Checkbox, Custom, Dropdown, Input, Label } from 'bc-deeplib/base/elements_typings';
   /**
    * Collection of element creation utilities.
    * Provides convenience wrappers for generating commonly used UI elements.
@@ -821,6 +842,7 @@ declare module 'bc-deeplib/utilities/elements/elements' {
       createInput: typeof elementCreateInput;
       createLabel: typeof elementCreateLabel;
       createCustom: typeof elementCreateCustom;
+      createDropdown: typeof elementCreateDropdown;
       createTooltip: typeof elementCreateTooltip;
       getTooltip: typeof elementGetTooltip;
       setTooltip: typeof elementSetTooltip;
@@ -831,6 +853,7 @@ declare module 'bc-deeplib/utilities/elements/elements' {
   function elementCreateCustom(options: Omit<Custom, 'type'>): HTMLElement;
   function elementCreateInput(options: Input): HTMLElement;
   function elementCreateLabel(options: Omit<Label, 'type'>): HTMLElement;
+  function elementCreateDropdown(options: Omit<Dropdown, 'type'>): HTMLDivElement;
   function elementCreateTooltip(): HTMLDivElement;
   function elementGetTooltip(): HTMLElement | undefined;
   function elementSetTooltip(text: string): boolean;