bc-deeplib 2.2.0 → 2.3.0

package/dist/deeplib.d.ts

@@ -1,5 +1,5 @@
 declare module 'bc-deeplib/base/base_module' {
-  import { BaseSettingsModel, Subscreen } from 'bc-deeplib/deeplib';
+  import { BaseSettingsModel, SettingsModel, Subscreen } from 'bc-deeplib/deeplib';
   /**
    * An abstract foundation for modular systems that require:
    *  - Optional settings screens
@@ -57,7 +57,7 @@ declare module 'bc-deeplib/base/base_module' {
        * If some settings already exist, they will be merged with defaults.
        * Existing values will NOT be overwritten.
        */
-      registerDefaultSettings(): void;
+      registerDefaultSettings(target: SettingsModel): void;
       /**
        * Provides default settings for this module.
        * Subclasses should override this getter to return their defaults.
@@ -152,7 +152,7 @@ declare module 'bc-deeplib/base/base_subscreen' {
    */
   export type Subscreen = new (module?: BaseModule) => BaseSubscreen;
   /** Switches the active subscreen in the global `GUI` instance. */
-  export function setSubscreen(subscreen: BaseSubscreen | string | null): Promise<void>;
+  export function setSubscreen(subscreen: BaseSubscreen | string): Promise<void>;
   /**
    * Abstract base class for creating settings/configuration subscreens in a module.
    *
@@ -184,7 +184,7 @@ declare module 'bc-deeplib/base/base_subscreen' {
       protected static readonly subscreenOptions: SubscreenOptions;
       constructor(module?: BaseModule);
       /** Changes the currently active subscreen. */
-      setSubscreen(screen: BaseSubscreen | string | null): Promise<void>;
+      setSubscreen(screen: BaseSubscreen | string): Promise<void>;
       /** Gets this subscreen's settings object from its parent module. */
       get settings(): BaseSettingsModel;
       /** Updates this subscreen's settings in its parent module. */
@@ -310,7 +310,7 @@ declare module 'bc-deeplib/base/elements_typings' {
 
 }
 declare module 'bc-deeplib/base/initialization' {
-  import { BaseModule, ModSdkManager, BaseMigrator, ModStorage, MainMenuOptions, TranslationOptions } from 'bc-deeplib/deeplib';
+  import { BaseModule, ModSdkManager, ModStorage, MainMenuOptions, TranslationOptions, Logger } from 'bc-deeplib/deeplib';
   /** Configuration object for initializing a mod via `initMod`. */
   interface InitOptions {
       /**
@@ -327,11 +327,6 @@ declare module 'bc-deeplib/base/initialization' {
        * Modules are initialized, loaded, and run in order.
        */
       modules?: BaseModule[];
-      /**
-       * List of data migration handlers to register with the `VersionModule`.
-       * Each `BaseMigrator` handles upgrading data from one version to another.
-       */
-      migrators?: BaseMigrator[];
       /** Configuration for customizing the main menu when the mod is active. */
       mainMenuOptions?: MainMenuOptions;
       /**
@@ -357,6 +352,11 @@ declare module 'bc-deeplib/base/initialization' {
    * Initialized by `initMod()`.
    */
   export let sdk: ModSdkManager;
+  /**
+   * Mod specific logger instance.
+   * Initialized by `initMod()`.
+   */
+  export let logger: Logger;
   /**
    * Entry point for initializing a mod. Handles:
    *  - Setting up the Mod SDK
@@ -584,10 +584,20 @@ declare module 'bc-deeplib/modules/gui' {
 declare module 'bc-deeplib/modules/version' {
   import { BaseMigrator, BaseModule } from 'bc-deeplib/deeplib';
   export type VersionModuleOptions = {
+      /**
+       * List of data migration handlers to register with the `VersionModule`.
+       * Each `BaseMigrator` handles upgrading data from one version to another.
+       */
+      migrators?: BaseMigrator[];
+      /** Message to display when a new version is detected */
       newVersionMessage?: string;
+      /** Optional lifecycle hook. Runs before each migration */
       beforeEach?: () => void;
+      /** Optional lifecycle hook. Runs after each migration */
       afterEach?: () => void;
+      /** Optional lifecycle hook. Runs before all migrations */
       beforeAll?: () => void;
+      /** Optional lifecycle hook. Runs after all migrations */
       afterAll?: () => void;
   };
   /**
@@ -606,17 +616,12 @@ declare module 'bc-deeplib/modules/version' {
       private static isItNewVersion;
       /** The current mod version (retrieved from `ModSdkManager.ModInfo.version`) */
       private static version;
-      /** Message to display when a new version is detected */
       private static newVersionMessage?;
       /** List of registered migration handlers, sorted by version */
       private static migrators;
-      /** Optional lifecycle hook. Runs before each migration */
       private static beforeEach?;
-      /** Optional lifecycle hook. Runs after each migration */
       private static afterEach?;
-      /** Optional lifecycle hook. Runs before all migrations */
       private static beforeAll?;
-      /** Optional lifecycle hook. Runs after all migrations */
       private static afterAll?;
       constructor(options: VersionModuleOptions);
       /**
@@ -639,11 +644,6 @@ declare module 'bc-deeplib/modules/version' {
        * is newer than the previously stored version.
        */
       private static checkVersionMigration;
-      /**
-       * Registers a new migrator for handling version-specific changes.
-       * Migrators are sorted by their `MigrationVersion` in ascending order.
-       */
-      static registerMigrator(migrator: BaseMigrator): void;
       /** Sends the currently configured "new version" message to the local player. */
       static sendNewVersionMessage(): void;
       /**
@@ -705,7 +705,7 @@ declare module 'bc-deeplib/screens/import_export' {
       /** Imports mod data using the specified method. */
       dataImport(transferMethod: DataTransferMethod): Promise<void>;
       /** Saves data to a file using the browser's save dialog. */
-      exportToFile(data: string, defaultFileName: string): Promise<void>;
+      exportToFile(data: string, defaultFileName: string): Promise<boolean>;
       /** Opens a file picker and reads the selected file's contents, importing the data. */
       importFromFile(): Promise<string | null>;
       /** Copies the given data to the clipboard. */
@@ -850,7 +850,7 @@ declare module 'bc-deeplib/utilities/elements/elements' {
   };
   function elementCreateButton(options: Omit<Button, 'type'>): HTMLButtonElement;
   function elementCreateCheckbox(options: Omit<Checkbox, 'type'>): HTMLElement;
-  function elementCreateCustom(options: Omit<Custom, 'type'>): HTMLElement;
+  function elementCreateCustom(options: Omit<Custom, 'type'>): HTMLHeadElement;
   function elementCreateInput(options: Input): HTMLElement;
   function elementCreateLabel(options: Omit<Label, 'type'>): HTMLElement;
   function elementCreateDropdown(options: Omit<Dropdown, 'type'>): HTMLDivElement;

package/dist/deeplib.js

@@ -230,8 +230,10 @@ var BaseModule = class {
     if (!this.settingsStorage) return {};
     if (!modStorage.playerStorage) {
       Player[modName] = {};
-      this.registerDefaultSettings();
-    } else if (!modStorage.playerStorage[this.settingsStorage]) this.registerDefaultSettings();
+      this.registerDefaultSettings(modStorage.playerStorage);
+    } else if (!modStorage.playerStorage[this.settingsStorage]) {
+      this.registerDefaultSettings(modStorage.playerStorage);
+    }
     return modStorage.playerStorage[this.settingsStorage];
   }
   /**
@@ -244,8 +246,10 @@ var BaseModule = class {
     if (!this.settingsStorage) return;
     if (!storage.playerStorage) {
       Player[modName] = {};
-      this.registerDefaultSettings();
-    } else if (!storage.playerStorage[this.settingsStorage]) this.registerDefaultSettings();
+      this.registerDefaultSettings(modStorage.playerStorage);
+    } else if (!storage.playerStorage[this.settingsStorage]) {
+      this.registerDefaultSettings(modStorage.playerStorage);
+    }
     storage.playerStorage[this.settingsStorage] = value;
   }
   /**
@@ -254,7 +258,7 @@ var BaseModule = class {
    * Subclasses can override to perform additional setup.
    */
   init() {
-    this.registerDefaultSettings();
+    this.registerDefaultSettings(modStorage.playerStorage);
   }
   /**
    * Registers default settings for this module in persistent storage.
@@ -263,11 +267,11 @@ var BaseModule = class {
    * If some settings already exist, they will be merged with defaults.
    * Existing values will NOT be overwritten.
    */
-  registerDefaultSettings() {
+  registerDefaultSettings(target) {
     const storage = this.settingsStorage;
     const defaults = this.defaultSettings;
     if (!storage || !defaults) return;
-    Player[ModSdkManager.ModInfo.name][storage] = Object.assign(defaults, Player[ModSdkManager.ModInfo.name][storage] ?? {});
+    target[storage] = Object.assign(defaults, target[storage] ?? {});
   }
   /**
    * Provides default settings for this module.
@@ -422,7 +426,7 @@ var BaseSubscreen = class _BaseSubscreen {
   load() {
     for (const module of modules()) {
       if (!module.settingsScreen) continue;
-      if (!module.settings || !Object.keys(module.settings).length) module.registerDefaultSettings();
+      if (!module.settings || !Object.keys(module.settings).length) module.registerDefaultSettings(modStorage.playerStorage);
     }
     _BaseSubscreen.currentPage = 1;
     layout.getSubscreen();
@@ -568,8 +572,10 @@ var BaseSubscreen = class _BaseSubscreen {
     ElementSetFontSize(subscreen, "auto");
     ElementSetPosition(settingsDiv, 530 - offset, 170);
     ElementSetSize(settingsDiv, this.options.settingsWidth ?? 1e3 + offset, 660);
-    ElementSetPosition("deeplib-subscreen-title", 530 - offset, 75);
-    ElementSetSize("deeplib-subscreen-title", 800, 60);
+    if (this.options.doShowTitle) {
+      ElementSetPosition("deeplib-subscreen-title", 530 - offset, 75);
+      ElementSetSize("deeplib-subscreen-title", 800, 60);
+    }
     ElementSetPosition("deeplib-nav-menu", 1905, 75, "top-right");
     ElementSetSize("deeplib-nav-menu", null, 90);
     ElementSetPosition(advElement.getTooltip() || "", 250, 850);
@@ -938,16 +944,18 @@ var styles_default = `.deeplib-subscreen,
 // src/base/initialization.ts
 var modStorage;
 var sdk;
+var logger;
 function initMod(options) {
   sdk = new ModSdkManager(options.modInfo.info, options.modInfo.options);
   const MOD_NAME = ModSdkManager.ModInfo.name;
   modStorage = new ModStorage(ModSdkManager.ModInfo.name);
+  logger = new Logger(MOD_NAME);
   Style.injectInline("deeplib-style", styles_default);
-  deepLibLogger.debug(`Init wait for ${MOD_NAME}`);
+  logger.debug("Init wait");
   if (CurrentScreen == null || CurrentScreen === "Login") {
     options.beforeLogin?.();
     const removeHook = sdk.hookFunction("LoginResponse", 0, (args, next) => {
-      deepLibLogger.debug(`Init for ${MOD_NAME}! LoginResponse caught: `, args);
+      logger.debug("Init! LoginResponse caught: ", args);
       next(args);
       const response = args[0];
       if (response === "InvalidNamePassword") return next(args);
@@ -957,7 +965,7 @@ function initMod(options) {
       }
     });
   } else {
-    deepLibLogger.debug(`Already logged in, initing ${MOD_NAME}`);
+    logger.debug(`Already logged in, initing ${MOD_NAME}`);
     init(options);
   }
 }
@@ -972,11 +980,6 @@ async function init(options) {
     unloadMod();
     return;
   }
-  if (options.migrators) {
-    for (const m of options.migrators) {
-      VersionModule.registerMigrator(m);
-    }
-  }
   await options.initFunction?.();
   if (options.mainMenuOptions)
     MainMenu.setOptions(options.mainMenuOptions);
@@ -987,11 +990,10 @@ async function init(options) {
     }
   }
   window[MOD_NAME + "Loaded"] = true;
-  deepLibLogger.log(`Loaded ${MOD_NAME}! Version: ${MOD_VERSION}`);
+  logger.log(`Loaded! Version: ${MOD_VERSION}`);
 }
 __name(init, "init");
 function initModules(modulesToRegister) {
-  const MOD_NAME = ModSdkManager.ModInfo.name;
   for (const module of modulesToRegister) {
     registerModule(module);
   }
@@ -1004,7 +1006,7 @@ function initModules(modulesToRegister) {
   for (const module of modules()) {
     module.run();
   }
-  deepLibLogger.debug(`Modules Loaded for ${MOD_NAME}.`);
+  logger.debug("Modules Loaded.");
   return true;
 }
 __name(initModules, "initModules");
@@ -1012,7 +1014,7 @@ function unloadMod() {
   const MOD_NAME = ModSdkManager.ModInfo.name;
   unloadModules();
   delete window[MOD_NAME + "Loaded"];
-  deepLibLogger.debug(`Unloaded ${MOD_NAME}.`);
+  logger.debug("Unloaded.");
   return true;
 }
 __name(unloadMod, "unloadMod");
@@ -1040,7 +1042,7 @@ function getModule(moduleType) {
 __name(getModule, "getModule");
 
 // src/migrators/base_migrator.ts
-var BaseMigrator2 = class {
+var BaseMigrator = class {
   static {
     __name(this, "BaseMigrator");
   }
@@ -1125,21 +1127,20 @@ var VersionModule = class _VersionModule extends BaseModule {
   static isItNewVersion = false;
   /** The current mod version (retrieved from `ModSdkManager.ModInfo.version`) */
   static version;
-  /** Message to display when a new version is detected */
   static newVersionMessage = "";
   /** List of registered migration handlers, sorted by version */
   static migrators = [];
-  /** Optional lifecycle hook. Runs before each migration */
   static beforeEach;
-  /** Optional lifecycle hook. Runs after each migration */
   static afterEach;
-  /** Optional lifecycle hook. Runs before all migrations */
   static beforeAll;
-  /** Optional lifecycle hook. Runs after all migrations */
   static afterAll;
   constructor(options) {
     super();
     _VersionModule.newVersionMessage = options.newVersionMessage;
+    if (options.migrators) {
+      _VersionModule.migrators = options.migrators;
+      _VersionModule.migrators.sort((a, b) => a.migrationVersion.localeCompare(b.migrationVersion));
+    }
     _VersionModule.beforeEach = options.beforeEach;
     _VersionModule.afterEach = options.afterEach;
     _VersionModule.beforeAll = options.beforeAll;
@@ -1196,14 +1197,6 @@ var VersionModule = class _VersionModule extends BaseModule {
     }
     _VersionModule.afterAll?.();
   }
-  /**
-   * Registers a new migrator for handling version-specific changes.
-   * Migrators are sorted by their `MigrationVersion` in ascending order.
-   */
-  static registerMigrator(migrator) {
-    _VersionModule.migrators.push(migrator);
-    _VersionModule.migrators.sort((a, b) => a.migrationVersion.localeCompare(b.migrationVersion));
-  }
   /** Sends the currently configured "new version" message to the local player. */
   static sendNewVersionMessage() {
     if (!_VersionModule.newVersionMessage) return;
@@ -2250,7 +2243,7 @@ var MainMenu = class _MainMenu extends BaseSubscreen {
         PreferenceSubscreenExtensionsClear();
       });
     } else if (returnScreen instanceof BaseSubscreen) {
-      setSubscreen(returnScreen ?? null).then(() => {
+      setSubscreen(returnScreen).then(() => {
       });
     } else if (Array.isArray(returnScreen)) {
       CommonSetScreen(...returnScreen);
@@ -2340,7 +2333,10 @@ var GuiImportExport = class extends BaseSubscreen {
       if (transferMethod === "clipboard") {
         await this.exportToClipboard(data);
       } else if (transferMethod === "file") {
-        await this.exportToFile(data, "themed_settings");
+        if (!await this.exportToFile(data, "settings")) {
+          return;
+        }
+        ;
       }
       this.importExportOptions.onExport?.();
       ToastManager.success("Data exported successfully.");
@@ -2365,6 +2361,9 @@ var GuiImportExport = class extends BaseSubscreen {
       if (!data) {
         throw new Error("Invalid data.");
       }
+      for (const module of modules()) {
+        module.registerDefaultSettings(data);
+      }
       modStorage.playerStorage = data;
       this.importExportOptions.onImport?.();
       ToastManager.success("Data imported successfully.");
@@ -2391,13 +2390,14 @@ var GuiImportExport = class extends BaseSubscreen {
         const writable = await handle.createWritable();
         await writable.write(data);
         await writable.close();
+        return true;
       } catch (error) {
         throw new Error("File save cancelled or failed: " + error.message);
       }
     } else {
       const fileName = await Modal.prompt("Enter file name", suggestedName);
       if (fileName === null) {
-        return;
+        return false;
       } else if (fileName === "") {
         throw new Error("File name cannot be empty.");
       }
@@ -2411,6 +2411,7 @@ var GuiImportExport = class extends BaseSubscreen {
       });
       link.click();
       URL.revokeObjectURL(link.href);
+      return true;
     }
   }
   /** Opens a file picker and reads the selected file's contents, importing the data. */
@@ -3132,7 +3133,7 @@ var EventChannel = class {
   }
 };
 export {
-  BaseMigrator2 as BaseMigrator,
+  BaseMigrator,
   BaseModule,
   BaseSubscreen,
   EventChannel,
@@ -3161,6 +3162,7 @@ export {
   hasSetter,
   initMod,
   layout,
+  logger,
   modStorage,
   modules,
   modulesMap,