@scml/sc2-modloader 1.0.0

package/type-dist/Utils.d.ts

@@ -0,0 +1,172 @@
+import { SimulateMergeResult } from "./SimulateMerge.js";
+import { SemVerToolsType } from "./SemVer/InfiniteSemVer.js";
+import { ModMeta } from "./ModPack/ModMeta.js";
+import { JSZipLikeReadOnlyInterface } from "./JSZipLikeReadOnlyInterface.js";
+import { IndexDBLoader, LocalLoader, LocalStorageLoader, ModZipReader, RemoteLoader, Twee2PassageR } from "./ModZipReader.js";
+import { LanguageManager } from "./LanguageManager.js";
+import { IdbKeyValRef, IdbRef } from "./IdbKeyValRef.js";
+import { ModLoadFromSourceType } from "./ModOrderContainer.js";
+import { SC2DataManager } from "./SC2DataManager.js";
+import { LogWrapper, ModLoadController } from "./ModLoadController.js";
+import { PassageDataItem, SC2DataInfo, SC2DataInfoCache } from "./SC2DataInfoCache.js";
+import { ModBootJsonAddonPlugin, ModInfo, ModLoader } from "./ModLoader.js";
+import { AddonPluginManager } from "./AddonPlugin.js";
+import _ from "lodash";
+
+//#region remote/BeforeSC2/Utils.d.ts
+declare class ModUtils {
+  pSC2DataManager: SC2DataManager;
+  thisWin: Window;
+  get version(): string;
+  constructor(pSC2DataManager: SC2DataManager, thisWin: Window);
+  getThisWindow(): Window;
+  /**
+   * 获取所有mod的名字
+   * 以mod加载顺序为序
+   */
+  getModListName(): string[];
+  getModListNameNoAlias(): string[];
+  getAnyModByNameNoAlias(name: string): ModInfo | undefined;
+  /**
+   * 获取指定mod的信息
+   * @param name ModName
+   * @return ModInfo | undefined
+   */
+  getMod(name: string): ModInfo | undefined;
+  getModAndFromInfo(name: string): undefined | {
+    name: string;
+    mod: ModInfo;
+    from: ModLoadFromSourceType;
+  };
+  getAllModInfoByFromType(from: ModLoadFromSourceType): {
+    name: string;
+    mod: ModInfo;
+    from: ModLoadFromSourceType;
+  }[];
+  /**
+   * 获取指定mod的Zip
+   * @param modName ModName
+   * @return ModZipReader | undefined
+   */
+  getModZip(modName: string): ModZipReader | undefined;
+  /**
+   * 获取指定Passage的信息
+   * @param name PassageName
+   * @return PassageDataItem | undefined
+   */
+  getPassageData(name: string): PassageDataItem | undefined;
+  /**
+   * 获取所有Passage的信息
+   * @return PassageDataItem[]
+   */
+  getAllPassageData(): PassageDataItem[];
+  /**
+   * 获取当前最新的SC2DataInfo，其中存储了所有SC2引擎的数据，包括js/css/passage
+   * @return SC2DataInfo
+   */
+  createNewSC2DataInfoFromNow(): SC2DataInfoCache;
+  /**
+   * 批量更新passage数据，如果存在则覆盖，如果不存在则创建
+   * @param pd 需要更新的passage列表
+   * @param replaceForce 强制覆盖而不提示警告
+   */
+  updatePassageDataMany(pd: PassageDataItem[], replaceForce?: boolean): void;
+  replaceFollowSC2DataInfo(newSC2Data: SC2DataInfo, oldSC2DataCache: SC2DataInfoCache): void;
+  /**
+   * 更新passage数据，如果存在则覆盖，如果不存在则创建
+   * @param name passageName
+   * @param content passageContent
+   * @param tags passageTags [] OR ['widget']
+   * @param pid passagePid 默认是 0 ， 如果不是故意覆盖已有的passage那么就填 0 即可
+   * @deprecated use `CodeExample/how-to-modify-sc2data.ts` instead
+   */
+  updatePassageData(name: string, content: string, tags?: string[], pid?: undefined | number): void;
+  /**
+   * 从一个twee文件中分离出多个passage，工具函数
+   * @param fileString 文件内容字符串
+   */
+  splitPassageFromTweeFile(fileString: string): Twee2PassageR[];
+  /**
+   * 获取mod冲突及覆盖的计算结果，可获知mod之间是否有互相覆盖的情况，如果没有mod则返回空数组
+   *
+   * 注意，此处只能获取模拟计算mod添加的文件互相的冲突关系，且不包含mod的js动态修改的内容，实际结果可能与这里不一致，
+   *
+   * @return { mod: SC2DataInfo, result: SimulateMergeResult }[]
+   *              mod    mod添加的内容，其中 dataSource 是 modName
+   *              result 覆盖结果，其中的 ResultItem[conflict] (Set<string>) 就是互相覆盖的部分的名字（passageName或js/css文件名）
+   */
+  getModConflictInfo(): {
+    mod: SC2DataInfo;
+    result: SimulateMergeResult;
+  }[];
+  /**
+   * 将字符串对正则表达式转义，用于直接将字符串用在正则表达式匹配前的消毒处理
+   * @param pattern   需要转义的字符串
+   * @return string   转义后的字符串
+   */
+  escapedPatternString(pattern: string): string;
+  /**
+   * 尝试在指定位置附近替换字符串
+   * @param content       原始字符串
+   * @param searchString  需要查找的字符串
+   * @param replaceString     需要替换的字符串
+   * @param positionHint      查找的位置
+   * @param tolerance1        第一阶快速查找容差 见 @ref tryStringSearch
+   * @param tolerance2Negative    第二阶正则查找（负方向）容差 见 @ref tryStringSearch
+   * @param tolerance2Positive    第二阶正则查找（正方向）容差 见 @ref tryStringSearch
+   * @return  string  替换后的字符串
+   */
+  tryStringReplace(content: string, searchString: string, replaceString: string, positionHint: number, tolerance1?: number, tolerance2Negative?: number, tolerance2Positive?: number): string;
+  /**
+   * 尝试在指定位置附近查找字符串
+   * @param content  原始字符串
+   * @param searchString  需要查找的字符串
+   * @param positionHint  查找的位置
+   * @param tolerance1    第一阶快速查找容差，（常数字符串比对），如果为0则不使用。此方法可在正负tolerance1个位置范围下查找
+   * @param tolerance2Negative    第二阶正则查找（负方向）容差，（正则字符串比对）。
+   * @param tolerance2Positive    第二阶正则查找（正方向）容差，（正则字符串比对）。如果正负都为0则不使用。此方法可在正负tolerance2Negative个位置范围下查找。
+   * @return  number  查找到的位置，如果没有找到则返回undefined
+   */
+  tryStringSearch(content: string, searchString: string, positionHint: number, tolerance1?: number, tolerance2Negative?: number, tolerance2Positive?: number): number | undefined;
+  /**
+   * 在指定位置插入字符串
+   * @param content  原始字符串
+   * @param insertString  需要插入的字符串
+   * @param position  插入的位置
+   * @return string   插入后的字符串
+   */
+  insertStringInPosition(content: string, insertString: string, position: number): string;
+  getLodash(): _.LoDashStatic;
+  getModLoadController(): ModLoadController;
+  getModLoader(): ModLoader;
+  getAddonPluginManager(): AddonPluginManager;
+  getLogger(): LogWrapper;
+  lazyRegisterNewModZipData(data: ArgumentTypes<JSZipLikeReadOnlyInterface['loadAsync']>[0], options?: any): Promise<boolean>;
+  parseModPack(modPackBuffer: Uint8Array, password?: string | undefined): Promise<ModMeta>;
+  getNowRunningModName(): string | undefined;
+  getSemVerTools(): SemVerToolsType;
+  getModZipReaderStaticClassRef: () => {
+    LocalStorageLoader: typeof LocalStorageLoader;
+    IndexDBLoader: typeof IndexDBLoader;
+    LocalLoader: typeof LocalLoader;
+    RemoteLoader: typeof RemoteLoader;
+  };
+  getImage(imagePath: string): Promise<string | undefined>;
+  getLanguageManager(): LanguageManager;
+  getNowMainLanguage(): 'en' | 'zh' | string;
+  getIdbKeyValRef(): IdbKeyValRef;
+  getIdbRef(): IdbRef;
+  /**
+   *
+   * const modAddonPluginsParams = window.modUtils.getAddonParamsFromModInfo(modInfo, 'BeautySelectorAddon', 'BeautySelectorAddon');
+   *
+   * @param modInfo   params 2 of registerMod callback
+   * @param addonPluginModName params 1 of registerAddonPlugin
+   * @param addonName  params 2 of registerAddonPlugin
+   */
+  getAddonParamsFromModInfo<P>(modInfo: ModInfo, addonPluginModName: string, addonName: string): P | undefined;
+  getAddonParamsFromModInfo(modInfo: ModInfo, addonPluginModName: string, addonName: string): ModBootJsonAddonPlugin['params'] | undefined;
+}
+type ArgumentTypes<F extends Function> = F extends ((...args: infer A) => any) ? A : never;
+//#endregion
+export { ArgumentTypes, ModUtils };

package/type-dist/WeakRefPool/WeakRefPool.d.ts

@@ -0,0 +1,11 @@
+//#region remote/BeforeSC2/WeakRefPool/WeakRefPool.d.ts
+declare function newWeakPoolRef<T>(v: T): WeakPoolRef<T>;
+declare class WeakPoolRef<T> {
+  constructor();
+  get deref(): T | undefined;
+}
+declare class WeakRefPool<T> {
+  pool: WeakMap<WeakPoolRef<T>, T>;
+}
+//#endregion
+export { WeakPoolRef, WeakRefPool, newWeakPoolRef };

package/type-dist/WikifyTracer.d.ts

@@ -0,0 +1,85 @@
+import { SC2Passage } from "./SC2ApiRef.js";
+import { SC2DataManager } from "./SC2DataManager.js";
+
+//#region remote/BeforeSC2/WikifyTracer.d.ts
+interface WikifyTracerCallback {
+  /**
+   * 可以修改输入文本内容
+   * @param text              原始文本内容
+   * @param passageTitle      passage标题
+   * @param passageObj        passage对象
+   * @return string           返回修改后的文本内容
+   */
+  beforePassage?: (text: string, passageTitle: string, passageObj: SC2Passage) => string;
+  /**
+   * 可以修改输出后的html树，只会在passage结束后调用
+   * @param text          原始文本内容
+   * @param passageTitle  passage标题
+   * @param passageObj    passage对象
+   * @param node          最终输出的html树
+   */
+  afterPassage?: (text: string, passageTitle: string, passageObj: SC2Passage, node: DocumentFragment) => void;
+  beforeWikify?: (text: string) => string;
+  /**
+   * 可以修改输出后的html树，会在每一次wikify后调用，包括passage以及每个text节点
+   * @param text      原始文本内容
+   * @param node      最终输出的html树
+   */
+  afterWikify?: (text: string, node: DocumentFragment) => void;
+  /**
+   * 可以修改输入文本内容
+   * @param text              原始文本内容
+   * @param widgetName        widget名称
+   * @param passageTitle      passage标题
+   * @param passageObj        passage对象
+   */
+  beforeWidget?: (text: string, widgetName: string, passageTitle?: string, passageObj?: SC2Passage) => string;
+  /**
+   * 可以修改输出后的html树，会在每一次widget后调用
+   * @param text              原始文本内容
+   * @param widgetName        widget名称
+   * @param passageTitle      passage标题
+   * @param passageObj        passage对象
+   * @param node              最终输出的html树
+   */
+  afterWidget?: (text: string, widgetName: string, passageTitle: string | undefined, passageObj: SC2Passage | undefined, node: DocumentFragment) => void;
+}
+declare class WikifyTracerCallbackOrder {
+  beforePassage: string[];
+  afterPassage: string[];
+  beforeWikify: string[];
+  afterWikify: string[];
+  beforeWidget: string[];
+  afterWidget: string[];
+  addCallback(key: string, c: WikifyTracerCallback): void;
+  removeCallback(key: string, c: WikifyTracerCallback): void;
+}
+declare class WikifyTracerCallbackCount {
+  beforePassage: number;
+  afterPassage: number;
+  beforeWikify: number;
+  afterWikify: number;
+  beforeWidget: number;
+  afterWidget: number;
+  order: WikifyTracerCallbackOrder;
+  addCallback(key: string, c: WikifyTracerCallback): void;
+  removeCallback(key: string, c: WikifyTracerCallback): void;
+  checkDataValid(): boolean;
+}
+declare class WikifyTracer {
+  gSC2DataManager: SC2DataManager;
+  private logger;
+  constructor(gSC2DataManager: SC2DataManager);
+  private callbackTable;
+  private callbackOrder;
+  private callbackCount;
+  addCallback(key: string, callback: WikifyTracerCallback): void;
+  beforePassage(text: string, passageTitle: string, passageObj: SC2Passage): string;
+  afterPassage(text: string, passageTitle: string, passageObj: SC2Passage, node: DocumentFragment): void;
+  beforeWikify(text: string): string;
+  afterWikify(text: string, node: DocumentFragment): void;
+  beforeWidget(text: string, widgetName: string, passageTitle?: string, passageObj?: SC2Passage): string;
+  afterWidget(text: string, widgetName: string, passageTitle: string | undefined, passageObj: SC2Passage | undefined, node: DocumentFragment): void;
+}
+//#endregion
+export { WikifyTracer, WikifyTracerCallback, WikifyTracerCallbackCount, WikifyTracerCallbackOrder };

package/type-dist/export2window.d.ts

@@ -0,0 +1,6 @@
+//#region remote/BeforeSC2/export2window.d.ts
+declare global {
+  interface window {
+    modSC2DataManager: SC2DataManager;
+  }
+}

package/type-dist/expose-loader.d.ts

@@ -0,0 +1,2 @@
+//#region remote/BeforeSC2/expose-loader.d.ts
+declare module "expose-loader?exposes=$,jQuery!jquery";

package/type-dist/extname.d.ts

@@ -0,0 +1,4 @@
+//#region remote/BeforeSC2/extname.d.ts
+declare function extname(path: string): string;
+//#endregion
+export { extname };

package/type-dist/getGlobal.d.ts

@@ -0,0 +1,4 @@
+//#region remote/BeforeSC2/getGlobal.d.ts
+declare function getGlobal(): any;
+//#endregion
+export { getGlobal };

package/type-dist/global.d.ts

@@ -0,0 +1,17 @@
+import JQueryStatic from "jquery/JQueryStatic";
+
+//#region remote/BeforeSC2/global.d.ts
+// declare var $: JQueryStatic;
+// declare var jQuery: JQueryStatic;
+declare global {
+  interface Window {
+    jQuery: JQueryStatic;
+    $: JQueryStatic;
+    modSC2DataManager: SC2DataManager;
+    modUtils: ModUtils;
+    jsPreloader: JsPreloader;
+    modModLoadController: ModLoadController;
+    modAddonPluginManager: AddonPluginManager;
+    modSC2JsEvalContext: SC2JsEvalContext;
+  }
+}

package/type-dist/global.ts

@@ -0,0 +1,19 @@
+import type JQueryStatic from "jquery/JQueryStatic";
+import type { SC2DataManager } from "./SC2DataManager.d.ts";
+import type { ModUtils } from "./Utils.d.ts";
+import type { JsPreloader } from "./JsPreloader.d.ts";
+import type { ModLoadController } from "./ModLoadController.d.ts";
+import type { AddonPluginManager } from "./AddonPlugin.d.ts";
+import type { SC2JsEvalContext } from "./SC2JsEvalContext.d.ts";
+declare global {
+  interface window {
+    jQuery: JQueryStatic
+    "$": JQueryStatic
+    modSC2DataManager: SC2DataManager
+    modUtils: ModUtils
+    jsPreloader: JsPreloader
+    modModLoadController: ModLoadController
+    modAddonPluginManager: AddonPluginManager
+    modSC2JsEvalContext: SC2JsEvalContext
+  }
+}

package/type-dist/init-comp-mock.d.ts

@@ -0,0 +1 @@
+export { };

package/type-dist/init-comp.d.ts

@@ -0,0 +1 @@
+import "./init.js";

package/type-dist/init.d.ts

@@ -0,0 +1 @@
+import "core-js";

package/type-dist/polyfill.d.ts

@@ -0,0 +1 @@
+import "core-js/full";