@scml-dol-maplebirch/types 5.0.0 → 5.0.2

package/maplebirch.d.ts

@@ -23,7 +23,6 @@ import { VisibilityAPI } from '@scml/sc2-verlnir/src/visibility';
 import { WikifierAPI } from '@scml/sc2-verlnir/src/wikifier';
 import { SugarCubeStoryVariables, SugarCubeTemporaryVariables } from 'twine-sugarcube/userdata';
 import { SC2DataManager } from '@scml/types/sugarcube-2-ModLoader/SC2DataManager';
-import { WikifyTracerCallback } from '@scml/types/sugarcube-2-ModLoader/WikifyTracer';
 import { Gui } from '@scml/types/Mod_LoaderGui/Gui';
 import * as marked from 'marked';
 import jsyaml from 'js-yaml';
@@ -897,13 +896,6 @@ interface PatchResult {
   expected?: number;
   error?: string;
 }
-interface ModRequirement {
-  name: string;
-  range?: string;
-  version?: string;
-  status: 'available' | 'missing' | 'incompatible' | 'invalid';
-  error?: string;
-}
 interface ModConflict {
   source: string;
   dataSource: string;
@@ -927,11 +919,9 @@ export declare class Diagnostics extends Logger {
   get patches(): PatchResult[];
   recordPatch(result: PatchResult): void;
   clearPatches(): void;
-  mod(name: string, range?: string): ModRequirement;
-  checkDependencies(): boolean;
   get conflicts(): ModConflict[] | undefined;
   export(): string;
-  clear(): void;
+  reset(): void;
 }
 //#endregion
 //#region src/host/Resources.d.ts
@@ -1703,6 +1693,8 @@ export declare class Catalog<Key, Value> extends Diagnostics {
   get(key: Key): Value | undefined;
   has(key: Key): boolean;
   list(): Value[];
+  clear(): void;
+  get entries(): ReadonlyMap<Key, Value>;
 }
 //#endregion
 //#region src/services/IndexedDB.d.ts
@@ -2010,8 +2002,10 @@ export declare class Lifecycle<Key = string, Target extends LifecycleTarget = Li
   Init(): void;
   loadInit(): void;
   postInit(): void;
-  execute(target: Target, phase: LifecyclePhase, scope?: string): Promise<LifecycleResult>;
-  executeSync(target: Target, phase: Exclude<LifecyclePhase, 'preInit'>, scope?: string): LifecycleResult;
+  execute(target: Target, phase: 'preInit', scope?: string): Promise<LifecycleResult>;
+  execute(target: Target, phase: Exclude<LifecyclePhase, 'preInit'>, scope?: string): LifecycleResult;
+  execute(target: Target, phase: LifecyclePhase, scope?: string): LifecycleResult | Promise<LifecycleResult>;
+  private failure;
 }
 //#endregion
 //#region src/services/Modules.d.ts
@@ -2137,12 +2131,15 @@ export declare class GUIControl {
 //#endregion
 //#region src/infra/Hooks.d.ts
 type HookCallback<Args extends unknown[] = unknown[], Result = unknown> = (...args: Args) => Result | Promise<Result>;
+type HookErrorPolicy = 'throw' | 'continue';
 export declare class Hooks<Args extends unknown[] = unknown[], Result = unknown> extends Catalog<string, HookCallback<Args, Result>> {
+  private readonly onError;
   private readonly order;
-  constructor(modloader?: ModLoader);
+  constructor(modloader?: ModLoader, onError?: HookErrorPolicy);
   add(name: string, callback: HookCallback<Args, Result>, order?: number): boolean;
   remove(name: string): boolean;
-  execute(...args: Args): Promise<Awaited<Result>[]>;
+  clear(): void;
+  execute(...args: Args): Result[];
   call(name: string, ...args: Args): Promise<Awaited<Result> | undefined>;
 }
 //#endregion
@@ -2195,7 +2192,6 @@ export declare class AddonPlugin extends Hooks<[BootTask], void> {
   constructor(modloader: ModLoader, sugarcube: SugarCube, events: Emitter, idb: IndexedDB, modules: Modules, services: AddonServices);
   get SC2DataManager(): SC2DataManager;
   get modUtils(): ModUtils;
-  wikify(name: string, callbacks: WikifyTracerCallback): void;
   hook<T>(name: string, handler: BootHandler<T>): boolean;
   canLoadThisMod(bootJson: ModBootJson, _zip: JSZipLikeReadOnlyInterface): Promise<boolean>;
   afterInjectEarlyLoad(): Promise<void>;
@@ -2318,6 +2314,7 @@ declare const MaplebirchCore: {
     get LogLevel(): string;
     set LogLevel(level: string);
     get dependencyGraph(): DependencyGraph;
+    get modList(): string[];
     on<Name extends keyof CoreEvents>(eventName: Name, callback: EventCallback<CoreEvents[Name]>, description?: string): boolean;
     on<Name extends string, Args extends unknown[]>(eventName: Name extends keyof CoreEvents ? never : Name, callback: EventCallback<Args>, description?: string): boolean;
     off<Args extends unknown[]>(eventName: string, identifier: string | EventCallback<Args>): boolean;
@@ -2328,7 +2325,6 @@ declare const MaplebirchCore: {
     trigger<Name extends keyof CoreEvents>(eventName: Name, ...args: CoreEvents[Name]): Promise<void>;
     trigger<Name extends string>(eventName: Name extends keyof CoreEvents ? never : Name, ...args: unknown[]): Promise<void>;
     define<T extends object>(name: string, module: T & Module, dependencies?: string[]): boolean;
-    wikify(name: string, callbacks: WikifyTracerCallback): void;
     idb(name: string, options?: IDBObjectStoreParameters, indexes?: StoreIndex[]): boolean;
     with<T, Mode extends IDBTransactionMode>(storeNames: string | string[], mode: Mode, callback: (tx: Transaction<Mode>) => T | Promise<T>): Promise<T>;
     t(key: string, space?: boolean): string;
@@ -2568,9 +2564,12 @@ declare class defineMacros {
   readonly log: ScopedLog;
   readonly macros: string[];
   readonly statFunctions: Record<string, StatFunction>;
+  private readonly definitions;
   constructor(manager: ToolCollection);
   get Macro(): ReturnType<MaplebirchCore['host']['sugarcube']['require']>['Macro'];
   define<Args extends unknown[]>(macroName: string, macroFunction: MacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, isAsync?: boolean): void;
+  private installAll;
+  private install;
   defineS<Args extends unknown[]>(macroName: string, macroFunction: SimpleMacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, maintainContext?: boolean): void;
   create<Args extends unknown[]>(name: string, fn: StatFunction<Args>): void;
   callStatFunction(name: string, ...args: unknown[]): DocumentFragment;
@@ -2731,22 +2730,16 @@ declare const applyLinkZone: typeof LinkZoneManager;
 //#endregion
 //#region src/modules/Frameworks/Patch.d.ts
 type PatchPhase = 'init' | 'state';
-interface WidgetPatch {
-  before?: (text: string) => string;
-  after?: (node: DocumentFragment) => void;
-}
 interface PatchDefinition<T extends object = object, Flat extends object = T> {
   api: T;
   legacy?: Flat;
   available?: () => boolean;
   init?: () => void;
   state?: () => void;
-  widgets?: Readonly<Record<string, WidgetPatch>>;
 }
 declare class Patch<Extensions extends Record<string, object> = Record<never, never>> {
   private readonly report;
-  private readonly entries;
-  private readonly extensionValues;
+  private readonly definitions;
   constructor(report: (name: string, error: unknown) => void);
   add<T extends object, Flat extends object = T>(name: string, definition: PatchDefinition<T, Flat>): this & Flat;
   get<Name extends keyof Extensions>(name: Name): Extensions[Name] | undefined;
@@ -2755,9 +2748,6 @@ declare class Patch<Extensions extends Record<string, object> = Record<never, ne
   require<T extends object = object>(name: string): T;
   has(name: string): boolean;
   names(): string[];
-  beforeWidget(widget: string, text: string): string;
-  afterWidget(widget: string, node: DocumentFragment): void;
-  private widget;
   private available;
   private run;
   apply(phase: PatchPhase): void;
@@ -2781,6 +2771,8 @@ declare class ToolCollection {
   readonly patch: Patch;
   constructor(core: MaplebirchCore, constructors?: ToolConstructors);
   onInit(...widgets: InitFunction[]): void;
+  define<Args extends unknown[]>(name: string, fn: MacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, isAsync?: boolean): void;
+  defineS<Args extends unknown[]>(name: string, fn: SimpleMacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, maintainContext?: boolean): void;
   addTo(zone: string, ...widgets: ZoneWidget[]): void;
   inject(...databases: Parameters<zonesManager['inject']>): void;
 }
@@ -2911,9 +2903,8 @@ declare class TimeEvent extends Event {
 }
 declare class TimeManager {
   private readonly manager;
-  private readonly eventTypes;
   private readonly timeEvents;
-  private readonly sortedEventsCache;
+  private readonly travelHooks;
   readonly log: DoLDynamic['log'];
   readonly TimeConstants: Readonly<{
     secondsPerDay: 86400;
@@ -2949,6 +2940,7 @@ declare class TimeManager {
   patchTime(TimeObject: typeof Time): void;
   register(type: TimeEventType, eventId: string, options: TimeEventOptions): boolean;
   unregister(type: string, eventId: string): boolean;
+  onTravel(name: string, callback: (data: TimeData) => void): boolean;
   timeTravel(options?: TimeTravelOptions): boolean;
   updateTimeLanguage(choice?: 'JournalTime'): string | boolean;
   private handleTimePass;
@@ -2995,7 +2987,6 @@ declare class WeatherManager {
   private readonly manager;
   private readonly weatherEvents;
   private readonly activeEvents;
-  private sortedEventsCache;
   private readonly Exceptions;
   private readonly WeatherTypes;
   private readonly layerModifications;
@@ -3003,6 +2994,7 @@ declare class WeatherManager {
   private weatherTriggered;
   private readonly log;
   constructor(manager: DoLDynamic);
+  private refresh;
   private checkEvents;
   register(eventId: string, options: WeatherEventOptions): boolean;
   unregister(eventId: string): boolean;
@@ -3518,7 +3510,8 @@ declare class Character {
   readonly log: ScopedLog;
   readonly mask: typeof mask;
   readonly faceStyleMap: Map<string, string[]>;
-  private readonly handlers;
+  private readonly processors;
+  private nextProcessor;
   private readonly layers;
   readonly pet: Pet;
   readonly transformation: Transformation;
@@ -4371,6 +4364,7 @@ declare class Combat {
   readonly log: ScopedLog;
   readonly CombatAction: CombatActions;
   constructor(core: MaplebirchCore);
+  preInit(): void;
   private _generateCombatAction;
   private _combatListColor;
   private _combatButtonAdjustments;
@@ -4429,7 +4423,6 @@ export {
   type LogLevel,
   type MaplebirchCore,
   type ModConflict,
-  type ModRequirement,
   type Module,
   type ModulesMeta,
   type PatchResult,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scml-dol-maplebirch/types",
-  "version": "5.0.0",
+  "version": "5.0.2",
   "description": "TypeScript definitions for maplebirchFramework.",
   "keywords": [
     "degrees-of-lewdity",