@scml-dol-maplebirch/types 5.0.1 → 5.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/maplebirch.d.ts +12 -13
  2. package/package.json +1 -1
package/maplebirch.d.ts CHANGED
@@ -23,7 +23,6 @@ import { VisibilityAPI } from '@scml/sc2-verlnir/src/visibility';
23
23
  import { WikifierAPI } from '@scml/sc2-verlnir/src/wikifier';
24
24
  import { SugarCubeStoryVariables, SugarCubeTemporaryVariables } from 'twine-sugarcube/userdata';
25
25
  import { SC2DataManager } from '@scml/types/sugarcube-2-ModLoader/SC2DataManager';
26
- import { WikifyTracerCallback } from '@scml/types/sugarcube-2-ModLoader/WikifyTracer';
27
26
  import { Gui } from '@scml/types/Mod_LoaderGui/Gui';
28
27
  import * as marked from 'marked';
29
28
  import jsyaml from 'js-yaml';
@@ -2193,7 +2192,6 @@ export declare class AddonPlugin extends Hooks<[BootTask], void> {
2193
2192
  constructor(modloader: ModLoader, sugarcube: SugarCube, events: Emitter, idb: IndexedDB, modules: Modules, services: AddonServices);
2194
2193
  get SC2DataManager(): SC2DataManager;
2195
2194
  get modUtils(): ModUtils;
2196
- wikify(name: string, callbacks: WikifyTracerCallback): void;
2197
2195
  hook<T>(name: string, handler: BootHandler<T>): boolean;
2198
2196
  canLoadThisMod(bootJson: ModBootJson, _zip: JSZipLikeReadOnlyInterface): Promise<boolean>;
2199
2197
  afterInjectEarlyLoad(): Promise<void>;
@@ -2316,6 +2314,7 @@ declare const MaplebirchCore: {
2316
2314
  get LogLevel(): string;
2317
2315
  set LogLevel(level: string);
2318
2316
  get dependencyGraph(): DependencyGraph;
2317
+ get modList(): string[];
2319
2318
  on<Name extends keyof CoreEvents>(eventName: Name, callback: EventCallback<CoreEvents[Name]>, description?: string): boolean;
2320
2319
  on<Name extends string, Args extends unknown[]>(eventName: Name extends keyof CoreEvents ? never : Name, callback: EventCallback<Args>, description?: string): boolean;
2321
2320
  off<Args extends unknown[]>(eventName: string, identifier: string | EventCallback<Args>): boolean;
@@ -2326,7 +2325,6 @@ declare const MaplebirchCore: {
2326
2325
  trigger<Name extends keyof CoreEvents>(eventName: Name, ...args: CoreEvents[Name]): Promise<void>;
2327
2326
  trigger<Name extends string>(eventName: Name extends keyof CoreEvents ? never : Name, ...args: unknown[]): Promise<void>;
2328
2327
  define<T extends object>(name: string, module: T & Module, dependencies?: string[]): boolean;
2329
- wikify(name: string, callbacks: WikifyTracerCallback): void;
2330
2328
  idb(name: string, options?: IDBObjectStoreParameters, indexes?: StoreIndex[]): boolean;
2331
2329
  with<T, Mode extends IDBTransactionMode>(storeNames: string | string[], mode: Mode, callback: (tx: Transaction<Mode>) => T | Promise<T>): Promise<T>;
2332
2330
  t(key: string, space?: boolean): string;
@@ -2561,15 +2559,21 @@ type SimpleMacroFunction<Args extends unknown[]> = (this: MacroContext$1 | null,
2561
2559
  type StatFunction<Args extends unknown[] = unknown[]> = (...args: Args) => DocumentFragment;
2562
2560
  type MacroTags = string[] | null | undefined;
2563
2561
  type SkipArgs = string[] | boolean | null | undefined;
2562
+ type MacroPhase = 'sugarcube' | 'storyready';
2564
2563
  declare class defineMacros {
2565
2564
  readonly manager: ToolCollection;
2566
2565
  readonly log: ScopedLog;
2567
2566
  readonly macros: string[];
2568
2567
  readonly statFunctions: Record<string, StatFunction>;
2568
+ private readonly definitions;
2569
+ private sugarcube;
2570
+ private story;
2569
2571
  constructor(manager: ToolCollection);
2570
2572
  get Macro(): ReturnType<MaplebirchCore['host']['sugarcube']['require']>['Macro'];
2571
- define<Args extends unknown[]>(macroName: string, macroFunction: MacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, isAsync?: boolean): void;
2572
- defineS<Args extends unknown[]>(macroName: string, macroFunction: SimpleMacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, maintainContext?: boolean): void;
2573
+ define<Args extends unknown[]>(macroName: string, macroFunction: MacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, isAsync?: boolean, phase?: MacroPhase): void;
2574
+ private installAll;
2575
+ private install;
2576
+ defineS<Args extends unknown[]>(macroName: string, macroFunction: SimpleMacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, maintainContext?: boolean, phase?: MacroPhase): void;
2573
2577
  create<Args extends unknown[]>(name: string, fn: StatFunction<Args>): void;
2574
2578
  callStatFunction(name: string, ...args: unknown[]): DocumentFragment;
2575
2579
  }
@@ -2729,17 +2733,12 @@ declare const applyLinkZone: typeof LinkZoneManager;
2729
2733
  //#endregion
2730
2734
  //#region src/modules/Frameworks/Patch.d.ts
2731
2735
  type PatchPhase = 'init' | 'state';
2732
- interface WidgetPatch {
2733
- before?: (text: string) => string;
2734
- after?: (node: DocumentFragment) => void;
2735
- }
2736
2736
  interface PatchDefinition<T extends object = object, Flat extends object = T> {
2737
2737
  api: T;
2738
2738
  legacy?: Flat;
2739
2739
  available?: () => boolean;
2740
2740
  init?: () => void;
2741
2741
  state?: () => void;
2742
- widgets?: Readonly<Record<string, WidgetPatch>>;
2743
2742
  }
2744
2743
  declare class Patch<Extensions extends Record<string, object> = Record<never, never>> {
2745
2744
  private readonly report;
@@ -2752,9 +2751,6 @@ declare class Patch<Extensions extends Record<string, object> = Record<never, ne
2752
2751
  require<T extends object = object>(name: string): T;
2753
2752
  has(name: string): boolean;
2754
2753
  names(): string[];
2755
- beforeWidget(widget: string, text: string): string;
2756
- afterWidget(widget: string, node: DocumentFragment): void;
2757
- private widget;
2758
2754
  private available;
2759
2755
  private run;
2760
2756
  apply(phase: PatchPhase): void;
@@ -2778,6 +2774,8 @@ declare class ToolCollection {
2778
2774
  readonly patch: Patch;
2779
2775
  constructor(core: MaplebirchCore, constructors?: ToolConstructors);
2780
2776
  onInit(...widgets: InitFunction[]): void;
2777
+ define<Args extends unknown[]>(name: string, fn: MacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, isAsync?: boolean, phase?: MacroPhase): void;
2778
+ defineS<Args extends unknown[]>(name: string, fn: SimpleMacroFunction<Args>, tags?: MacroTags, skipArgs?: SkipArgs, maintainContext?: boolean, phase?: MacroPhase): void;
2781
2779
  addTo(zone: string, ...widgets: ZoneWidget[]): void;
2782
2780
  inject(...databases: Parameters<zonesManager['inject']>): void;
2783
2781
  }
@@ -4369,6 +4367,7 @@ declare class Combat {
4369
4367
  readonly log: ScopedLog;
4370
4368
  readonly CombatAction: CombatActions;
4371
4369
  constructor(core: MaplebirchCore);
4370
+ preInit(): void;
4372
4371
  private _generateCombatAction;
4373
4372
  private _combatListColor;
4374
4373
  private _combatButtonAdjustments;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scml-dol-maplebirch/types",
3
- "version": "5.0.1",
3
+ "version": "5.0.3",
4
4
  "description": "TypeScript definitions for maplebirchFramework.",
5
5
  "keywords": [
6
6
  "degrees-of-lewdity",