@scml-dol-maplebirch/types 5.0.3 → 5.1.0

package/macros/helpers.d.ts

@@ -0,0 +1,54 @@
+import { type MaplebirchCore } from '../core.js';
+import type { MacroContext as SugarCubeMacroContext } from 'twine-sugarcube';
+export declare const CONVERT_MODES: readonly ['lower', 'upper', 'capitalize', 'title', 'camel', 'pascal', 'snake', 'kebab', 'constant'];
+export type ConvertMode = (typeof CONVERT_MODES)[number];
+export type MacroArgs = unknown[] & {
+    full?: string;
+    raw?: string;
+};
+export interface MacroPayload {
+    name: string;
+    args: MacroArgs;
+    contents?: string;
+}
+export interface MacroContext extends Omit<SugarCubeMacroContext, 'args' | 'createShadowWrapper' | 'error' | 'payload'> {
+    args: MacroArgs;
+    payload?: MacroPayload[] | null;
+    error(msg: string): void;
+    createShadowWrapper(callback: (...args: never[]) => unknown, doneCallback?: (...args: never[]) => unknown, startCallback?: (...args: never[]) => unknown): (...args: unknown[]) => void;
+    passageObj?: {
+        title: string;
+    };
+    lanListboxCache?: Record<string, {
+        options: ListboxOption[];
+        selectedIdx: number;
+    }>;
+}
+export interface LinkArg {
+    text: string | readonly string[];
+    link?: string;
+}
+export interface StyleArgs {
+    className: string;
+    style: string;
+    icon: string;
+    iconOnly: boolean;
+    convertMode: ConvertMode | null;
+}
+export interface ListboxOption {
+    label: string | readonly string[];
+    value: unknown;
+    type: 'static' | 'dynamic';
+    exprIndex?: number;
+    convertMode: ConvertMode | null;
+}
+export declare function text(value: unknown): string;
+export declare function sourceText(value: unknown): string;
+export declare function macroTranslation(key: unknown, core?: MaplebirchCore): string;
+export declare function readStyle(args: unknown[], start?: number): StyleArgs;
+export declare function isStyleArg(arg: string): boolean;
+export declare function translatedText(source: unknown, convertMode: ConvertMode | null): string;
+export declare function appendMacroIcon($target: JQuery, icon: string): void;
+export declare function addClasses($target: JQuery, className: string): void;
+export declare function bindLanguageUpdate($target: JQuery, key: string, update: () => void): void;
+export declare function wiki($container: JQuery, content: string): void;

package/macros/index.d.ts

@@ -0,0 +1,8 @@
+export type { MacroContext } from './helpers.js';
+export { _language } from './language.js';
+export { _languageSwitch } from './lanSwitch.js';
+export { _languageButton } from './lanButton.js';
+export { _languageLink } from './lanLink.js';
+export { _languageListbox } from './lanListbox.js';
+export { _radiobuttonsfrom } from './radiobuttonsfrom.js';
+export { _overlayReplace } from './maplebirchReplace.js';

package/macros/lanButton.d.ts

@@ -0,0 +1,2 @@
+import { type MacroContext } from './helpers.js';
+export declare function _languageButton(this: MacroContext): void;

package/macros/lanLink.d.ts

@@ -0,0 +1,2 @@
+import { type MacroContext } from './helpers.js';
+export declare function _languageLink(this: MacroContext): void;

package/macros/lanListbox.d.ts

@@ -0,0 +1,2 @@
+import { type MacroContext } from './helpers.js';
+export declare function _languageListbox(this: MacroContext): void;

package/macros/lanSwitch.d.ts

@@ -0,0 +1,3 @@
+import { type MacroContext } from './helpers.js';
+export declare function _languageSwitch(this: void, ...lanObj: unknown[]): string;
+export declare function _languageSwitch(this: MacroContext, ...lanObj: unknown[]): HTMLElement;

package/macros/language.d.ts

@@ -0,0 +1,2 @@
+import { type MacroContext } from './helpers.js';
+export declare function _language(this: MacroContext): void;

package/macros/macros.d.ts

@@ -0,0 +1,14 @@
+import type { MaplebirchCore } from '../core.js';
+declare class Macros {
+    private readonly core;
+    private installed;
+    constructor(core: MaplebirchCore);
+    install(): void;
+    private modDisplayName;
+    private collectFrameworkMods;
+    private showFrameworkInfo;
+    private showFrameworkNotice;
+    notice(): void;
+    register(): void;
+}
+export default Macros;

package/macros/maplebirchReplace.d.ts

@@ -0,0 +1 @@
+export declare function _overlayReplace(name: string, type: string): void;

package/macros/radiobuttonsfrom.d.ts

@@ -0,0 +1,2 @@
+import { type MacroContext } from './helpers.js';
+export declare function _radiobuttonsfrom(this: MacroContext): HTMLElement | void;

package/main.d.ts

@@ -0,0 +1,22 @@
+export { default, type MaplebirchCore, type FrameworkHost, type FrameworkInfra, type FrameworkServices, type CoreEvents, type Extensions } from './core.js';
+export { Save, type SaveObject } from './host/SugarCube.js';
+export { default as AddonPlugin, type AddonServices, type BootTask, type BootHandler } from './services/AddonPlugin.js';
+export { default as Resources } from './host/Resources.js';
+export { default as Logger, type LogLevel } from './infra/Logger.js';
+export { default as Diagnostics, type DiagnosticRecord, type PatchResult, type ModConflict } from './infra/Diagnostics.js';
+export { default as Catalog } from './infra/Catalog.js';
+export { default as Hooks, type HookCallback } from './infra/Hooks.js';
+export { default as Lifecycle, type LifecyclePhase, type LifecycleTarget, type LifecycleResult } from './infra/Lifecycle.js';
+export { default as Emitter, type EventCallback } from './infra/Emitter.js';
+export { default as Modules, type Module, type ModulesMeta, type DependencyInfo, type DependencyGraph } from './services/Modules.js';
+export { default as IndexedDB } from './services/IndexedDB.js';
+export { default as Translator, type Translation } from './services/Translator.js';
+export { default as GUIControl } from './services/GUIControl.js';
+export { default as CredentialVault } from './services/CredentialVault.js';
+export { default as CloudSave, type CloudSaveConfig, type CloudSaveRecord, type CloudSaveRemoteItem, type CloudSaveRemoteCode } from './services/CloudSave.js';
+export { default as SugarCube } from './host/SugarCube.js';
+export { default as ModLoader } from './host/ModLoader.js';
+export { default as Dynamic } from './modules/Dynamic.js';
+export { StateManager, type StateEventOptions } from './modules/State.js';
+export { default as ToolCollection } from './modules/ToolCollection.js';
+export * as utils from './utils/index.js';