@scml/sc2-modloader 1.0.0

package/README.md

@@ -0,0 +1,9 @@
+# @scml/sc2-modloader
+
+## Type definition source
+
+Type definitions are from the repository:
+
+- https://github.com/Lyoko-Jeremie/sugarcube-2-ModLoader
+
+Fetched from the `master` branch by default. Build: `pnpm run download && pnpm run build`.

package/package.json

@@ -0,0 +1,77 @@
+{
+  "name": "@scml/sc2-modloader",
+  "version": "1.0.0",
+  "private": false,
+  "description": "SugarCube 2 Mod Loader Workspace",
+  "license": "MIT",
+  "author": {
+    "name": "Rikka",
+    "email": "admin@rikka.cc",
+    "url": "https://github.com/Muromi-Rikka"
+  },
+  "files": [
+    "type-dist",
+    "README.md"
+  ],
+  "type": "module",
+  "types": "./type-dist/global.ts",
+  "exports": {
+    "./AddonPlugin": "./type-dist/AddonPlugin.d.ts",
+    "./DecoratorUtils": "./type-dist/DecoratorUtils.d.ts",
+    "./DependenceChecker": "./type-dist/DependenceChecker.d.ts",
+    "./export2window": "./type-dist/export2window.d.ts",
+    "./expose-loader": "./type-dist/expose-loader.d.ts",
+    "./extname": "./type-dist/extname.d.ts",
+    "./getGlobal": "./type-dist/getGlobal.d.ts",
+    "./HtmlTagSrcHook": "./type-dist/HtmlTagSrcHook.d.ts",
+    "./IdbKeyValRef": "./type-dist/IdbKeyValRef.d.ts",
+    "./JqueryInjector": "./type-dist/JqueryInjector.d.ts",
+    "./JsPreloader": "./type-dist/JsPreloader.d.ts",
+    "./JSZipLikeReadOnlyInterface": "./type-dist/JSZipLikeReadOnlyInterface.d.ts",
+    "./LanguageManager": "./type-dist/LanguageManager.d.ts",
+    "./MergeSC2DataInfoCache": "./type-dist/MergeSC2DataInfoCache.d.ts",
+    "./ModLoadController": "./type-dist/ModLoadController.d.ts",
+    "./ModLoader": "./type-dist/ModLoader.d.ts",
+    "./ModOrderContainer": "./type-dist/ModOrderContainer.d.ts",
+    "./ModZipReader": "./type-dist/ModZipReader.d.ts",
+    "./PassageTracer": "./type-dist/PassageTracer.d.ts",
+    "./polyfill": "./type-dist/polyfill.d.ts",
+    "./ReplacePatcher": "./type-dist/ReplacePatcher.d.ts",
+    "./SC2ApiRef": "./type-dist/SC2ApiRef.d.ts",
+    "./SC2DataInfoCache": "./type-dist/SC2DataInfoCache.d.ts",
+    "./SC2DataManager": "./type-dist/SC2DataManager.d.ts",
+    "./Sc2EventTracer": "./type-dist/Sc2EventTracer.d.ts",
+    "./SC2JsEvalContext": "./type-dist/SC2JsEvalContext.d.ts",
+    "./SimulateMerge": "./type-dist/SimulateMerge.d.ts",
+    "./SugarCube2": "./type-dist/SugarCube2.d.ts",
+    "./Utils": "./type-dist/Utils.d.ts",
+    "./WikifyTracer": "./type-dist/WikifyTracer.d.ts",
+    "./ModPack/ModMeta": "./type-dist/ModPack/ModMeta.d.ts",
+    "./ModPack/ModPack": "./type-dist/ModPack/ModPack.d.ts",
+    "./ModPack/ModPackFileReaderInterface": "./type-dist/ModPack/ModPackFileReaderInterface.d.ts",
+    "./ModPack/ModPackJsZipAdaptor": "./type-dist/ModPack/ModPackJsZipAdaptor.d.ts",
+    "./SemVer/InfiniteSemVer": "./type-dist/SemVer/InfiniteSemVer.d.ts",
+    "./Utils/LazyIteratorAdaptor.d.ts": "./type-dist/Utils/LazyIteratorAdaptor.d.ts",
+    "./WeakRefPool/WeakRefPool.d.ts": "./type-dist/WeakRefPool/WeakRefPool.d.ts"
+  },
+  "devDependencies": {
+    "@types/jquery": "^3.5.20",
+    "@types/libsodium-wrappers": "^0.7.11",
+    "@types/lodash": "^4.14.198",
+    "bson": "^6.10.4",
+    "idb": "^8.0.0",
+    "idb-keyval": "^6.2.1",
+    "json5": "^2.2.3",
+    "jszip": "^3.10.1",
+    "libsodium-wrappers-sumo": "^0.7.15",
+    "lru-cache": "^10.0.1",
+    "moment": "^2.29.4",
+    "uint8-to-base64": "^0.2.1",
+    "xxhash-wasm": "^1.1.0"
+  },
+  "scripts": {
+    "download": "tsx src/download.ts",
+    "build": "tsdown && tsx src/after-build.ts",
+    "typecheck": "tsc --noEmit"
+  }
+}

package/type-dist/AddonPlugin.d.ts

@@ -0,0 +1,155 @@
+import { Passage } from "./SugarCube2.js";
+import { ModZipReader } from "./ModZipReader.js";
+import { Sc2EventTracerCallback } from "./Sc2EventTracer.js";
+import { SC2DataManager } from "./SC2DataManager.js";
+import { ModLoadController } from "./ModLoadController.js";
+import { ModInfo } from "./ModLoader.js";
+import JSZip from "jszip";
+
+//#region remote/BeforeSC2/AddonPlugin.d.ts
+type AddonPluginHookType = () => Promise<any>;
+interface AddonPluginHookPoint {
+  afterInit?: AddonPluginHookType;
+  afterInjectEarlyLoad?: AddonPluginHookType;
+  afterModLoad?: AddonPluginHookType;
+  afterEarlyLoad?: AddonPluginHookType;
+  afterRegisterMod2Addon?: AddonPluginHookType;
+  beforePatchModToGame?: AddonPluginHookType;
+  afterPatchModToGame?: AddonPluginHookType;
+  afterPreload?: AddonPluginHookType;
+}
+type AddonPluginHookPoint_K = keyof AddonPluginHookPoint;
+type AddonPluginHookPointWhenSC2 = {
+  whenSC2StoryReady?: () => Promise<any>;
+  whenSC2PassageInit?: (passage: Passage) => Promise<any>;
+  whenSC2PassageStart?: (passage: Passage, content: HTMLDivElement) => Promise<any>;
+  whenSC2PassageRender?: (passage: Passage, content: HTMLDivElement) => Promise<any>;
+  whenSC2PassageDisplay?: (passage: Passage, content: HTMLDivElement) => Promise<any>;
+  whenSC2PassageEnd?: (passage: Passage, content: HTMLDivElement) => Promise<any>;
+};
+type AddonPluginHookPointWhenSC2_T = AddonPluginHookPointWhenSC2;
+type AddonPluginHookPointWhenSC2_K = keyof AddonPluginHookPointWhenSC2_T;
+type AddonPluginHookPointExOptional = {
+  /**
+   * registerMod() will be called when export debug data, this is a chance to export addon data for debug, like when addon change data in memory
+   *
+   * registerMod() 会在导出 debug data 时被调用，这是导出 addon 数据的机会，比如当 addon 在内存中改变了数据。
+   * 举个例子，衣服扩展框架可以收集所有衣服mod的数据，统一在文件或内存中修改衣服数据，如果是在文件中修改那么会被默认导出，但如果是在内存中修改，则最好使用这个 hook 来导出数据以便 debug
+   *
+   * @optional
+   * @param zip the zip file to storage debug data
+   * @return   return the same zip file or a new zip file, recommend return the same zip file
+   */
+  exportDataZip?: (zip: JSZip) => Promise<JSZip>;
+};
+type AddonPluginHookPointExMustImplement = {
+  /**
+   * registerMod() will be called when mod loaded and that mod require this addon, addon can read info from mod and do something
+   *
+   * registerMod() 会在 mod 加载完毕并且 mod 需要这个 addon 时被调用，addon 可以从 mod 读取信息并做一些事情。
+   * 举个例子，衣服扩展框架可以在这里读取衣服mod的数据，然后统一修改衣服数据，这样就可以避免多个不同的衣服mod前后修改衣服数组导致意外损坏衣服数组的数据。
+   * @mustImplement
+   * @param addonName the mod require this addon
+   * @param mod       the mod info
+   * @param modZip    the mod zip file reader
+   */
+  registerMod: (addonName: string, mod: ModInfo, modZip: ModZipReader) => Promise<any>;
+};
+/**
+ * AddonPluginHookPointEx is a interface for addon plugin to implement API Hook,
+ * addon plugin can implement any hook, but must implement registerMod(),
+ * addon can impl more API in there, to let mod call it to get more function.
+ *
+ * AddonPluginHookPointEx 是 addon plugin 用来实现 API Hook 的接口，
+ * addon plugin 可以实现任何 hook，但是必须实现 registerMod()，
+ * addon 可以在里面实现更多 API，让 mod 调用它来获得更多功能。
+ */
+interface AddonPluginHookPointEx extends AddonPluginHookPoint, AddonPluginHookPointExOptional, AddonPluginHookPointExMustImplement, AddonPluginHookPointWhenSC2 {}
+declare class AddonPlugin {
+  modName: string;
+  addonName: string;
+  hookPoint: AddonPluginHookPointEx;
+  constructor(modName: string, addonName: string, hookPoint: AddonPluginHookPointEx);
+}
+declare class AddonPluginManager implements Sc2EventTracerCallback {
+  gSC2DataManager: SC2DataManager;
+  gModLoadController: ModLoadController;
+  private addonPluginTable;
+  private log;
+  private passageTracer;
+  private sc2EventTracer;
+  constructor(gSC2DataManager: SC2DataManager, gModLoadController: ModLoadController);
+  /**
+   * inner use
+   */
+  whenSC2StoryReady(): Promise<any>;
+  /**
+   * inner use
+   */
+  whenSC2PassageInit(passage: Passage): Promise<any>;
+  /**
+   * inner use
+   */
+  whenSC2PassageStart(passage: Passage, content: HTMLDivElement): Promise<any>;
+  /**
+   * inner use
+   */
+  whenSC2PassageRender(passage: Passage, content: HTMLDivElement): Promise<any>;
+  /**
+   * inner use
+   */
+  whenSC2PassageDisplay(passage: Passage, content: HTMLDivElement): Promise<any>;
+  /**
+   * inner use
+   */
+  whenSC2PassageEnd(passage: Passage, content: HTMLDivElement): Promise<any>;
+  /**
+   * call by ModLoader (inner use)
+   *
+   * register a mod to addon plugin, after all mod loaded and after EarlyLoad executed.
+   *
+   * @param mod
+   * @param modZip
+   */
+  registerMod2Addon(mod: ModInfo, modZip: ModZipReader): Promise<void>;
+  /**
+   * call by ModLoaderGui (inner use)
+   * @param zip
+   */
+  exportDataZip(zip: JSZip): Promise<JSZip>;
+  /**
+   * call by ModLoader (inner use)
+   * @param hook
+   */
+  triggerHook(hook: AddonPluginHookPoint_K): Promise<void>;
+  /**
+   * call by ModLoader (inner use)
+   */
+  triggerHookWhenSC2<K extends AddonPluginHookPointWhenSC2_K>(hook: K, ...params: Parameters<NonNullable<AddonPluginHookPointWhenSC2_T[K]>>): Promise<void>;
+  /**
+   * check if a addon plugin is duplicate
+   * @param modName
+   * @param addonName
+   */
+  checkDuplicate(modName: string, addonName: string): boolean;
+  /**
+   * register a addon plugin, call by addon plugin,
+   * this call must be done when InjectEarlyLoad.
+   *
+   * 注册一个 addon plugin，由 addon plugin 调用，必须在 InjectEarlyLoad 时调用此函数注册 Addon。
+   * @param modName    addon plugin's mod name
+   * @param addonName  addon plugin's name
+   * @param hookPoint  addon plugin's hook point
+   */
+  registerAddonPlugin(modName: string, addonName: string, hookPoint: AddonPluginHookPointEx): void;
+  /**
+   * get a addon plugin, call by mod
+   *
+   * 获取一个 addon plugin，由 mod 调用。 mod 可以读取 addon plugin 的 hookPoint 来调用 addon plugin 的 API
+   * @param modName    addon plugin's mod name
+   * @param addonName  addon plugin's name
+   */
+  getAddonPlugin(modName: string, addonName: string): AddonPluginHookPointEx | undefined;
+}
+//#endregion
+export { AddonPlugin, AddonPluginHookPoint, AddonPluginHookPointEx, AddonPluginHookPointExMustImplement, AddonPluginHookPointExOptional, AddonPluginHookPointWhenSC2, AddonPluginHookPointWhenSC2_K, AddonPluginHookPointWhenSC2_T, AddonPluginHookPoint_K, AddonPluginManager };

package/type-dist/DecoratorUtils.d.ts

@@ -0,0 +1,36 @@
+//#region remote/BeforeSC2/DecoratorUtils.d.ts
+declare function sealed<Class extends abstract new (...args: any) => any>(target: Class, context: ClassDecoratorContext<Class>): void;
+declare namespace ClassDecoratorUtil {
+  interface InfoTypeItemConfig {
+    writable: false;
+    configurable: false;
+    enumerable: true;
+  }
+  interface InfoTypeItem {
+    info: ClassMemberDecoratorContext;
+    config: InfoTypeItemConfig;
+  }
+  interface ClassInfo {
+    seal?: boolean;
+  }
+  type InfoType = Map<string | symbol, InfoTypeItem>;
+  class InfoData {
+    configInfo: InfoType;
+    classInfo: ClassInfo;
+  }
+  type ThisClassType = {
+    [key: (string | symbol)]: any;
+    "ClassDecoratorUtil_InfoData": InfoData;
+  };
+  function finishClassDecorate(config: ClassInfo): <Class extends abstract new (...args: any) => any>(target: Class, context: ClassDecoratorContext<Class>) => Class;
+  function configField(config: InfoTypeItemConfig): <ThisClass extends ThisClassType>(value: undefined, context: ClassFieldDecoratorContext<ThisClass>) => <VType>(this: ThisClass, initialValue: VType) => VType;
+  function configMethod(config: InfoTypeItemConfig): <ThisClass extends ThisClassType, F extends (this: ThisClass, ...args: any) => any>(value: F, context: ClassMethodDecoratorContext<ThisClass, F>) => <VType>(this: ThisClass, initialValue: VType) => VType;
+}
+declare function sealedField<This>(value: undefined, context: ClassFieldDecoratorContext<This>): <VType>(this: This, initialValue: VType) => void;
+declare function sealedField2<VType>(initialValue: VType): <This>(value: undefined, context: ClassFieldDecoratorContext<This>) => (this: This) => void;
+declare function sealedMethod(): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+declare function enumerable(value: boolean): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+declare function configurable(value: boolean): (target: any, propertyKey: string, descriptor: PropertyDescriptor) => void;
+declare function loggedMethod<This, Args extends any[], Return>(target: (this: This, ...args: Args) => Return, context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return>): (this: This, ...args: Args) => Return;
+//#endregion
+export { ClassDecoratorUtil, configurable, enumerable, loggedMethod, sealed, sealedField, sealedField2, sealedMethod };

package/type-dist/DependenceChecker.d.ts

@@ -0,0 +1,46 @@
+import { isWithinRange, parseInfiniteSemVer, parseVersionRange } from "./SemVer/InfiniteSemVer.js";
+import { ModOrderContainer } from "./ModOrderContainer.js";
+import { ModUtils } from "./Utils.js";
+import { SC2DataManager } from "./SC2DataManager.js";
+import { LogWrapper } from "./ModLoadController.js";
+import { ModInfo } from "./ModLoader.js";
+
+//#region remote/BeforeSC2/DependenceChecker.d.ts
+declare class InfiniteSemVerApi {
+  parseRange: typeof parseVersionRange;
+  parseVersion: typeof parseInfiniteSemVer;
+  satisfies: typeof isWithinRange;
+}
+declare class DependenceChecker {
+  gSC2DataManager: SC2DataManager;
+  gModUtils: ModUtils;
+  log: LogWrapper;
+  constructor(gSC2DataManager: SC2DataManager, gModUtils: ModUtils);
+  getInfiniteSemVerApi(): InfiniteSemVerApi;
+  /**
+   * 检查指定mod是否满足指定mod集合作为前序mod的依赖关系
+   *
+   * check if the mod satisfies the dependencies of the specified mod set as the previous mod
+   *
+   * @param {ModInfo} mod - The mod to check for dependencies.
+   * @param {ModOrderContainer[]} modCaches - An array of mod order containers.
+   * @return {boolean} - Returns true if the mod satisfies its dependencies, false otherwise.
+   */
+  checkFor(mod: ModInfo, modCaches: ModOrderContainer[]): boolean;
+  /**
+   * 检查整个加载完毕的mod列表是否满足依赖约束
+   *
+   * Checks the dependencies of the mod order and verifies if they are satisfied.
+   *
+   * @return {boolean} - Returns true if all dependencies are satisfied, otherwise returns false.
+   */
+  check(): boolean;
+  /**
+   * this called by mod `CheckGameVersion`
+   * because the game version only can get after game loaded
+   * @param gameVersion
+   */
+  checkGameVersion(gameVersion: string): boolean;
+}
+//#endregion
+export { DependenceChecker, InfiniteSemVerApi };

package/type-dist/HtmlTagSrcHook.d.ts

@@ -0,0 +1,43 @@
+import { SC2DataManager } from "./SC2DataManager.js";
+import { LogWrapper } from "./ModLoadController.js";
+
+//#region remote/BeforeSC2/HtmlTagSrcHook.d.ts
+type HtmlTagSrcHookType = (el: HTMLImageElement | HTMLElement, mlSrc: string, field: string) => Promise<boolean>;
+type HtmlTagSrcReturnModeHookType = (mlSrc: string) => Promise<[boolean, string]>;
+type HtmlTagSrcHookCheckModType = (mlSrc: string) => boolean | undefined;
+/**
+ * this class replace html image tag src/href attribute ,
+ * redirect the image request to a mod like `ImgLoaderHooker` to load the image.
+ */
+declare class HtmlTagSrcHook {
+  gSC2DataManager: SC2DataManager;
+  logger: LogWrapper;
+  constructor(gSC2DataManager: SC2DataManager);
+  private hookTable;
+  private hookReturnModeTable;
+  private hookCheckExistTable;
+  addHook(hookKey: string, hook: HtmlTagSrcHookType): void;
+  addReturnModeHook(hookKey: string, hook: HtmlTagSrcReturnModeHookType): void;
+  addCheckExistHook(hookKey: string, hook: HtmlTagSrcHookCheckModType): void;
+  /**
+   * check image exist
+   *
+   * @param src
+   * @return true: exist ; false: not exist ; undefined: not exist but not sure (maybe exist but now not find.);
+   */
+  checkImageExist(src: string): boolean | undefined;
+  /**
+   * get image from mod
+   * @param src  image path
+   * @return image base64 string
+   */
+  requestImageBySrc(src: string): Promise<string | undefined>;
+  /**
+   * 归一化路径为相对路径格式
+   * @param path 待归一化的路径
+   * @returns 归一化后的相对路径（去除前导 / 和 ./）
+   */
+  normalizePath(path: string): string;
+}
+//#endregion
+export { HtmlTagSrcHook, HtmlTagSrcHookCheckModType, HtmlTagSrcHookType, HtmlTagSrcReturnModeHookType };

package/type-dist/IdbKeyValRef.d.ts

@@ -0,0 +1,26 @@
+import { clear, createStore, del, entries, get, keys, set, setMany, values } from "idb-keyval";
+import * as idbInstance from "idb";
+import { deleteDB, openDB } from "idb";
+
+//#region remote/BeforeSC2/IdbKeyValRef.d.ts
+declare class IdbRef {
+  get idb_openDB(): typeof openDB;
+  get idb_deleteDB(): typeof deleteDB;
+  get idbInstance(): typeof idbInstance;
+}
+declare class IdbKeyValRef {
+  get keyval_get(): typeof get;
+  get keyval_set(): typeof set;
+  get keyval_del(): typeof del;
+  get get(): typeof get;
+  get set(): typeof set;
+  get del(): typeof del;
+  get createStore(): typeof createStore;
+  get setMany(): typeof setMany;
+  get clear(): typeof clear;
+  get keys(): typeof keys;
+  get values(): typeof values;
+  get entries(): typeof entries;
+}
+//#endregion
+export { IdbKeyValRef, IdbRef };

package/type-dist/JSZipLikeReadOnlyInterface.d.ts

@@ -0,0 +1,41 @@
+import { ModPackFileReaderJsZipAdaptor } from "./ModPack/ModPackJsZipAdaptor.js";
+import JSZip from "jszip";
+
+//#region remote/BeforeSC2/JSZipLikeReadOnlyInterface.d.ts
+interface JSZipObjectLikeReadOnlyInterface {
+  async<T extends OutputType>(type: T, onUpdate?: any): Promise<OutputByType[T]>;
+  get name(): string;
+  get dir(): boolean;
+}
+interface InputByType {
+  base64: string;
+  string: string;
+  text: string;
+  binarystring: string;
+  array: number[];
+  uint8array: Uint8Array;
+  arraybuffer: ArrayBuffer;
+  blob: Blob;
+}
+interface OutputByType {
+  base64: string;
+  string: string;
+  uint8array: Uint8Array;
+  blob: Blob;
+}
+type InputFileFormat = InputByType[keyof InputByType] | Promise<InputByType[keyof InputByType]>;
+type OutputType = keyof OutputByType;
+interface JSZipLikeReadOnlyInterface {
+  file(path: string): JSZipObjectLikeReadOnlyInterface | null;
+  file(path: RegExp): JSZipObjectLikeReadOnlyInterface[] | null;
+  forEach(callback: (relativePath: string, file: JSZipObjectLikeReadOnlyInterface) => void): void;
+  filter(predicate: (relativePath: string, file: JSZipObjectLikeReadOnlyInterface) => boolean): JSZipObjectLikeReadOnlyInterface[];
+  loadAsync(data: InputFileFormat, options?: any): Promise<JSZipLikeReadOnlyInterface | undefined>;
+  is_JeremieModLoader_ModPack?: boolean;
+  hashString?: string;
+  generateAsync?: typeof JSZip['generateAsync'];
+  get files(): Record<string, JSZipObjectLikeReadOnlyInterface>;
+}
+declare function isModPackFileReaderJsZipAdaptor(obj: any): obj is ModPackFileReaderJsZipAdaptor;
+//#endregion
+export { InputFileFormat, JSZipLikeReadOnlyInterface, JSZipObjectLikeReadOnlyInterface, OutputType, isModPackFileReaderJsZipAdaptor };

package/type-dist/JqueryInjector.d.ts

@@ -0,0 +1,4 @@
+//#region remote/BeforeSC2/JqueryInjector.d.ts
+declare function Inject4Jquery(thisWin: Window): void;
+//#endregion
+export { Inject4Jquery };

package/type-dist/JsPreloader.d.ts

@@ -0,0 +1,28 @@
+import { ModUtils } from "./Utils.js";
+import { SC2DataManager } from "./SC2DataManager.js";
+import { LogWrapper } from "./ModLoadController.js";
+
+//#region remote/BeforeSC2/JsPreloader.d.ts
+declare class StackLike<T> {
+  private _data;
+  push(v: T): void;
+  pop(): T | undefined;
+  peek(): T | undefined;
+  get length(): number;
+  get data(): T[];
+  get empty(): boolean;
+  clear(): void;
+}
+declare class JsPreloader {
+  pSC2DataManager: SC2DataManager;
+  modUtils: ModUtils;
+  thisWin: Window;
+  logger: LogWrapper;
+  constructor(pSC2DataManager: SC2DataManager, modUtils: ModUtils, thisWin: Window);
+  startLoadCalled: boolean;
+  startLoad(): Promise<any>;
+  runningMod: StackLike<string>;
+  JsRunner(content: string, name: string, modName: string, stage: string, pSC2DataManager: SC2DataManager, thisWin: Window, logger: LogWrapper): Promise<any>;
+}
+//#endregion
+export { JsPreloader, StackLike };

package/type-dist/LanguageManager.d.ts

@@ -0,0 +1,21 @@
+import { SC2DataManager } from "./SC2DataManager.js";
+
+//#region remote/BeforeSC2/LanguageManager.d.ts
+declare const MainLanguageTypeEnum: readonly ["en", "zh"];
+declare class LanguageManager {
+  thisWin: Window;
+  gSC2DataManager: SC2DataManager;
+  private logger;
+  constructor(thisWin: Window, gSC2DataManager: SC2DataManager);
+  /**
+   * https://developer.mozilla.org/zh-CN/docs/Web/API/Navigator/language
+   * https://www.rfc-editor.org/rfc/bcp/bcp47.txt
+   * https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
+   *
+   * @return https://stackoverflow.com/questions/5580876/navigator-language-list-of-all-languages
+   */
+  getLanguage(): string;
+  mainLanguage: typeof MainLanguageTypeEnum[number];
+}
+//#endregion
+export { LanguageManager, MainLanguageTypeEnum };

package/type-dist/MergeSC2DataInfoCache.d.ts

@@ -0,0 +1,9 @@
+import { SC2DataInfo } from "./SC2DataInfoCache.js";
+
+//#region remote/BeforeSC2/MergeSC2DataInfoCache.d.ts
+declare function replaceMergeSC2DataInfoCache(...ic: SC2DataInfo[]): SC2DataInfo;
+declare function replaceMergeSC2DataInfoCacheForce(...ic: SC2DataInfo[]): SC2DataInfo;
+declare function concatMergeSC2DataInfoCache(...ic: SC2DataInfo[]): SC2DataInfo;
+declare function normalMergeSC2DataInfoCache(...ic: SC2DataInfo[]): SC2DataInfo;
+//#endregion
+export { concatMergeSC2DataInfoCache, normalMergeSC2DataInfoCache, replaceMergeSC2DataInfoCache, replaceMergeSC2DataInfoCacheForce };

package/type-dist/ModLoadController.d.ts

@@ -0,0 +1,122 @@
+import { JSZipLikeReadOnlyInterface } from "./JSZipLikeReadOnlyInterface.js";
+import { SC2DataManager } from "./SC2DataManager.js";
+import { ModBootJson, ModInfo } from "./ModLoader.js";
+import JSZip from "jszip";
+import moment from "moment/moment";
+
+//#region remote/BeforeSC2/ModLoadController.d.ts
+interface LogWrapper {
+  log: (s: string) => void;
+  warn: (s: string) => void;
+  error: (s: string) => void;
+}
+interface LifeTimeCircleHook extends Partial<ModLoadControllerCallback> {}
+interface ModLoadControllerCallback {
+  /**
+   * ban a mod use this, need register this hook in `InjectEarlyLoad`
+   * @param bootJson
+   * @param zip
+   */
+  canLoadThisMod(bootJson: ModBootJson, zip: JSZipLikeReadOnlyInterface): Promise<boolean>;
+  /**
+   * use this to modify a mod, like i18n a mod
+   * @param bootJson
+   * @param zip       carefully modify zip file
+   * @param modInfo   you can modify the all info in there. read: [ModZipReader.init()]
+   */
+  afterModLoad(bootJson: ModBootJson, zip: JSZipLikeReadOnlyInterface, modInfo: ModInfo): Promise<any>;
+  InjectEarlyLoad_start(modName: string, fileName: string): Promise<any>;
+  InjectEarlyLoad_end(modName: string, fileName: string): Promise<any>;
+  EarlyLoad_start(modName: string, fileName: string): Promise<any>;
+  EarlyLoad_end(modName: string, fileName: string): Promise<any>;
+  LazyLoad_start(modName: string): Promise<any>;
+  LazyLoad_end(modName: string): Promise<any>;
+  Load_start(modName: string, fileName: string): Promise<any>;
+  Load_end(modName: string, fileName: string): Promise<any>;
+  PatchModToGame_start(): Promise<any>;
+  PatchModToGame_end(): Promise<any>;
+  /**
+   * @deprecated
+   */
+  ReplacePatcher_start(modName: string, fileName: string): Promise<any>;
+  /**
+   * @deprecated
+   */
+  ReplacePatcher_end(modName: string, fileName: string): Promise<any>;
+  /**
+   * Latest Hook On ModLoader When ALL Load End
+   */
+  ModLoaderLoadEnd(): Promise<any>;
+  /**
+   * @useless useless for user
+   */
+  logError(s: string): void;
+  /**
+   * @useless useless for user
+   */
+  logInfo(s: string): void;
+  /**
+   * @useless useless for user
+   */
+  logWarning(s: string): void;
+  exportDataZip(zip: JSZip): Promise<JSZip>;
+}
+declare function getLogFromModLoadControllerCallback(c: ModLoadControllerCallback): LogWrapper;
+interface LogRecord {
+  type: 'info' | 'warning' | 'error';
+  time: moment.Moment;
+  message: string;
+}
+/**
+ * ModLoader lifetime circle system,
+ * mod can register hook to this system, to listen to the lifetime circle of MpdLoader and error log.
+ *
+ * ModLoader 生命周期系统，
+ * mod 可以注册 hook 到这个系统，来监听 ModLoader 的生命周期和错误日志。
+ */
+declare class ModLoadController implements ModLoadControllerCallback {
+  gSC2DataManager: SC2DataManager;
+  constructor(gSC2DataManager: SC2DataManager);
+  logRecordBeforeAnyLogHookRegister: LogRecord[];
+  LazyLoad_end: (modName: string) => Promise<any>;
+  LazyLoad_start: (modName: string) => Promise<any>;
+  EarlyLoad_end: (modName: string, fileName: string) => Promise<any>;
+  EarlyLoad_start: (modName: string, fileName: string) => Promise<any>;
+  InjectEarlyLoad_end: (modName: string, fileName: string) => Promise<any>;
+  InjectEarlyLoad_start: (modName: string, fileName: string) => Promise<any>;
+  Load_end: (modName: string, fileName: string) => Promise<any>;
+  Load_start: (modName: string, fileName: string) => Promise<any>;
+  PatchModToGame_end: () => Promise<any>;
+  PatchModToGame_start: () => Promise<any>;
+  ReplacePatcher_end: (modName: string, fileName: string) => Promise<any>;
+  ReplacePatcher_start: (modName: string, fileName: string) => Promise<any>;
+  logError: (s: string) => void;
+  logInfo: (s: string) => void;
+  logWarning: (s: string) => void;
+  ModLoaderLoadEnd: () => Promise<any>;
+  canLoadThisMod(bootJson: ModBootJson, zip: JSZipLikeReadOnlyInterface): Promise<boolean>;
+  afterModLoad(bootJson: ModBootJson, zip: JSZipLikeReadOnlyInterface, modInfo: ModInfo): Promise<any>;
+  /**
+   * call by ModLoaderGui (inner use)
+   * @param zip
+   */
+  exportDataZip(zip: JSZip): Promise<JSZip>;
+  private lifeTimeCircleHookTable;
+  addLifeTimeCircleHook(id: string, hook: LifeTimeCircleHook): void;
+  removeLifeTimeCircleHook(hook: LifeTimeCircleHook): void;
+  clearLifeTimeCircleHook(): void;
+  listModLocalStorage(): string[];
+  addModLocalStorage(name: string, modBase64String: string): void;
+  removeModLocalStorage(name: string): void;
+  checkModZipFileLocalStorage(modBase64String: string): Promise<string | ModBootJson>;
+  overwriteModIndexDBModList(modeList: string[]): Promise<void>;
+  overwriteModIndexDBHiddenModList(modeList: string[]): Promise<void>;
+  listModIndexDB(): Promise<string[]>;
+  loadHiddenModList(): Promise<string[]>;
+  addModIndexDB(name: string, modBase64String: string | Uint8Array): Promise<void>;
+  removeModIndexDB(name: string): Promise<void>;
+  checkModZipFileIndexDB(modBase64String: string | Uint8Array): Promise<string | ModBootJson>;
+  getLog(): LogWrapper;
+}
+//#endregion
+export { LifeTimeCircleHook, LogRecord, LogWrapper, ModLoadController, ModLoadControllerCallback, getLogFromModLoadControllerCallback };