@scml/sc2-verlnir 1.0.4

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@scml/sc2-verlnir",
+  "version": "1.0.4",
+  "description": "TypeScript type definitions for SugarCube 2",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "author": {
+    "name": "Rikka",
+    "email": "admin@rikka.cc",
+    "url": "https://github.com/Muromi-Rikka"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Muromi-Rikka/scml-types.git",
+    "directory": "packages/sugarcube-2-verlnir"
+  },
+  "files": ["src", "README.md"],
+  "types": "./src/global.d.ts",
+  "exports": {
+    ".": "./src/global.d.ts"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "publint": "publint"
+  },
+  "devDependencies": {
+    "@types/jquery": "*"
+  }
+}

package/src/alert.d.ts

@@ -0,0 +1,4 @@
+export interface AlertAPI {
+	error(title: string | null, message: string, ex?: unknown): void;
+	fatal(title: string | null, message: string, ex?: unknown): never;
+}

package/src/browser.d.ts

@@ -0,0 +1,10 @@
+export interface BrowserAPI {
+	readonly userAgent: string;
+	readonly isMobile: boolean;
+	readonly isGecko: boolean;
+	readonly isIE: boolean;
+	readonly ieVersion: number | null;
+	readonly isOpera: boolean;
+	readonly operaVersion: number | null;
+	readonly isVivaldi: boolean;
+}

package/src/config.d.ts

@@ -0,0 +1,74 @@
+/*
+	Object Exports.
+	General settings.
+	Audio settings.
+	State history settings.
+	Macros settings.
+	Navigation settings.
+	Passages settings.
+	Saves settings.
+	UI settings.
+*/
+export interface ConfigHistoryAPI {
+	controls: boolean;
+	maxStates: number;
+	maxSessionStates: number;
+	maxExpired: number;
+}
+
+export interface ConfigAudioAPI {
+	pauseOnFadeToZero: boolean;
+	preloadMetadata: boolean;
+}
+
+export interface ConfigMacrosAPI {
+	ifAssignmentError: boolean;
+	maxLoopIterations: number;
+	typeSkipKey: string;
+	typeVisitedPassages: boolean;
+}
+
+export interface ConfigNavigationAPI {
+	override: ((...args: unknown[]) => unknown) | null | undefined;
+	gotohell: unknown;
+	rememberYPos: unknown;
+}
+
+export interface ConfigPassagesAPI {
+	descriptions: boolean | Record<string, string> | ((this: null) => string | undefined) | null | undefined;
+	displayTitles: boolean;
+	nobr: boolean;
+	onProcess: ((opts: { title: string; tags: string[]; text: string }) => string) | null | undefined;
+	start: string | null | undefined;
+	transitionOut: string | number | null | undefined;
+}
+
+export interface ConfigSavesAPI {
+	autoload: boolean | string | ((...args: unknown[]) => unknown) | null | undefined;
+	autosave: boolean | string[] | ((...args: unknown[]) => unknown) | null | undefined;
+	id: string;
+	isAllowed: ((...args: unknown[]) => unknown) | null | undefined;
+	slots: number;
+	tryDiskOnMobile: boolean;
+	version: unknown;
+	useLZString: number;
+}
+
+export interface ConfigUIAPI {
+	stowBarInitially: boolean | number;
+	updateStoryElements: boolean;
+}
+
+export interface ConfigAPI {
+	debug: boolean;
+	addVisitedLinkClass: boolean;
+	cleanupWikifierOutput: boolean;
+	loadDelay: number;
+	audio: ConfigAudioAPI;
+	history: ConfigHistoryAPI;
+	macros: ConfigMacrosAPI;
+	navigation: ConfigNavigationAPI;
+	passages: ConfigPassagesAPI;
+	saves: ConfigSavesAPI;
+	ui: ConfigUIAPI;
+}

package/src/debugbar.d.ts

@@ -0,0 +1,25 @@
+/*
+	Module Exports.
+	Debug Bar Functions.
+	Watch Functions.
+*/
+export interface DebugBarWatchAPI {
+	add(name: string, getValue: () => unknown): void;
+	all(): void;
+	clear(): void;
+	delete(name: string): void;
+	disable(name: string): void;
+	enable(name: string): void;
+	isEnabled(name: string): boolean;
+	toggle(name: string): void;
+}
+
+export interface DebugBarAPI {
+	init(): void;
+	isStowed(): boolean;
+	start(): void;
+	stow(): void;
+	toggle(): void;
+	unstow(): void;
+	watch: DebugBarWatchAPI;
+}

package/src/dialog.d.ts

@@ -0,0 +1,15 @@
+export interface DialogAPI {
+	append(...args: unknown[]): DialogAPI;
+	body(): HTMLElement | undefined;
+	close(ev?: unknown): DialogAPI;
+	create(title?: string, classNames?: string): DialogAPI;
+	empty(): DialogAPI;
+	init(): void;
+	isOpen(classNames?: string): boolean;
+	open(options?: { top?: number }, onClose?: () => void): DialogAPI;
+	resize(options?: { top?: number }): void;
+	wiki(...args: unknown[]): DialogAPI;
+	wikiPassage(name: string): DialogAPI;
+	/** Deprecated Functions. */
+	setup(title?: string, classNames?: string): HTMLElement | undefined;
+}

package/src/engine.d.ts

@@ -0,0 +1,36 @@
+/*
+	Module Exports.
+	Constants.
+	Core Functions.
+	Legacy Functions.
+*/
+/* Engine state types object (pseudo-enumeration). */
+export interface EngineStatesAPI {
+	Idle: string;
+	Playing: string;
+	Rendering: string;
+}
+
+export interface EngineAPI {
+	/* Constants. */
+	readonly States: EngineStatesAPI;
+	/* Minimum delay for DOM actions (in milliseconds). */
+	readonly minDomActionDelay: number;
+	init(): void;
+	start(): void;
+	restart(): void;
+	readonly state: string;
+	isIdle(): boolean;
+	isPlaying(): boolean;
+	isRendering(): boolean;
+	readonly lastPlay: number | null;
+	goTo(index: number): void;
+	go(delta: number): void;
+	backward(): void;
+	forward(): void;
+	show(passage: string, ...args: unknown[]): void;
+	play(passage?: string, ...args: unknown[]): void;
+	/* Legacy Functions. */
+	display(passage?: string, ...args: unknown[]): void;
+	flags: Record<string, unknown>;
+}

package/src/fullscreen.d.ts

@@ -0,0 +1,13 @@
+export interface FullscreenAPI {
+	readonly vendor: unknown;
+	readonly element: Element | null;
+	isEnabled(): boolean;
+	isFullscreen(): boolean;
+	request(): Promise<void>;
+	exit(): Promise<void>;
+	toggle(): Promise<void>;
+	onChange(handler: () => void): void;
+	offChange(handler: () => void): void;
+	onError(handler: (err: unknown) => void): void;
+	offError(handler: (err: unknown) => void): void;
+}

package/src/global.d.ts

@@ -0,0 +1,116 @@
+/*
+	Global `SugarCube` object.  Allows scripts to detect if they're running in SugarCube by
+	testing for the object (e.g. `"SugarCube" in window`) and contains exported identifiers
+	for debugging purposes.
+*/
+import type { AlertAPI } from './alert.d.ts';
+import type { BrowserAPI } from './browser.d.ts';
+import type { ConfigAPI } from './config.d.ts';
+import type { DebugBarAPI } from './debugbar.d.ts';
+import type { DialogAPI } from './dialog.d.ts';
+import type { EngineAPI } from './engine.d.ts';
+import type { FullscreenAPI } from './fullscreen.d.ts';
+import type { HasAPI } from './has.d.ts';
+import type { IdbAPI } from './idb.d.ts';
+import type { L10nAPI } from './l10n.d.ts';
+import type { LinksAPI } from './links.d.ts';
+import type { LoadScreenAPI } from './loadscreen.d.ts';
+import type { MacroAPI } from './macro.d.ts';
+import type { PassageAPI, PassageConstructor } from './passage.d.ts';
+import type { SaveAPI } from './save.d.ts';
+import type { ScriptingAPI } from './scripting.d.ts';
+import type { SettingAPI } from './setting.d.ts';
+import type { SimpleAudioAPI } from './simpleaudio.d.ts';
+import type { SimpleStoreAPI, SimpleStoreInstanceAPI } from './simplestore.d.ts';
+import type { StateAPI } from './state.d.ts';
+import type { StoryAPI } from './story.d.ts';
+import type { TemplateAPI } from './template.d.ts';
+import type { UIBarAPI } from './uibar.d.ts';
+import type { UIAPI } from './ui.d.ts';
+import type { UtilAPI } from './util.d.ts';
+import type { VersionInfo } from './version.d.ts';
+import type { VisibilityAPI } from './visibility.d.ts';
+import type { WikifierAPI } from './wikifier.d.ts';
+
+declare global {
+	const Alert: AlertAPI;
+	const Browser: BrowserAPI;
+	const Config: ConfigAPI;
+	const DebugBar: DebugBarAPI;
+	const Dialog: DialogAPI;
+	const Engine: EngineAPI;
+	const Fullscreen: FullscreenAPI;
+	const Has: HasAPI;
+	const L10n: L10nAPI;
+	const Links: LinksAPI;
+	const LoadScreen: LoadScreenAPI;
+	const Macro: MacroAPI;
+	const Passage: PassageConstructor;
+	const Save: SaveAPI;
+	const Scripting: ScriptingAPI;
+	const Setting: SettingAPI;
+	const SimpleAudio: SimpleAudioAPI;
+	const SimpleStore: SimpleStoreAPI;
+	const State: StateAPI;
+	const Story: StoryAPI;
+	const Template: TemplateAPI;
+	const UIBar: UIBarAPI;
+	const UI: UIAPI;
+	const Util: UtilAPI;
+	const Visibility: VisibilityAPI;
+	const Wikifier: WikifierAPI;
+
+	/* Version object. */
+	const version: VersionInfo;
+	/* Session storage manager object. */
+	const session: SimpleStoreInstanceAPI | null;
+	/* Settings object. */
+	const settings: Record<string, unknown>;
+	/* Setup object. */
+	const setup: Record<string, unknown>;
+	/* Persistant storage manager object. */
+	const storage: SimpleStoreInstanceAPI | null;
+	const idb: IdbAPI;
+
+	/* Legacy aliases. */
+	const browser: BrowserAPI;
+	const config: ConfigAPI;
+	const has: HasAPI;
+	const History: StateAPI;
+	const state: StateAPI;
+	const tale: StoryAPI;
+	const TempVariables: StateAPI['temporary'];
+
+	interface Window {
+		SugarCube: {
+			Browser: BrowserAPI;
+			Config: ConfigAPI;
+			Dialog: DialogAPI;
+			Engine: EngineAPI;
+			Fullscreen: FullscreenAPI;
+			Has: HasAPI;
+			L10n: L10nAPI;
+			Macro: MacroAPI;
+			Passage: typeof Passage;
+			Save: SaveAPI;
+			Scripting: ScriptingAPI;
+			Setting: SettingAPI;
+			SimpleAudio: SimpleAudioAPI;
+			State: StateAPI;
+			Story: StoryAPI;
+			UI: UIAPI;
+			UIBar: UIBarAPI;
+			DebugBar: DebugBarAPI;
+			Util: UtilAPI;
+			Visibility: VisibilityAPI;
+			Wikifier: WikifierAPI;
+			session: SimpleStoreInstanceAPI | null;
+			settings: Record<string, unknown>;
+			setup: Record<string, unknown>;
+			storage: SimpleStoreInstanceAPI | null;
+			version: VersionInfo;
+		};
+	}
+}
+
+export {};

package/src/has.d.ts

@@ -0,0 +1,10 @@
+/* Module Exports. */
+export interface HasAPI {
+	readonly audio: boolean;
+	readonly fileAPI: boolean;
+	readonly geolocation: boolean;
+	readonly mutationObserver: boolean;
+	readonly performance: boolean;
+	readonly touch: boolean;
+	readonly transitionEndEvent: string;
+}

package/src/idb.d.ts

@@ -0,0 +1,34 @@
+/*
+ * "simple" indexedDB backend for storing save data, working similarly to existing webStorage system
+ * indexedDB works faster, has virtually unlimited storage, but does not work properly in private mode. then again, localStorage doesn't persist in private mode either
+ * indexedDB operates asynchronously, by making requests that may be fulfilled or rejected later, without blocking the rest of the code, but also without a guarantee that requested values will be available when that rest of the code runs. this requires some working around.
+ * unlike old synchronous operations, most functions do not return the value immediately, but a promise to return it when it's completed. these promises can then be used to retrieve that data by calling Promise.then() callback function
+ * for example, `idb.getItem(0).then((value) => console.log(value))` will first attempt to retrieve save data from slot 0, and then when that is done - the then() function triggers, in this case printing retrieved value to the console
+ *
+ * this implementation doesn't rely on caches, doesn't compress save data in any way, and separates save details store from save data store to speed up building the save list and allow extra features like timestamp highlighting at minimal processing cost
+ * as a consequence, it requires more disk space, and a completely separate namespace that might need extra setup for games that override the default save list appearance
+ * generally though, just adding a "saveList" id or class to the div element where the saves should appear and replacing the function/macro that populates that div with "if (idb.active) idb.saveList(); else old-custom-way-of-building-save-menu" should be enough to make it work.
+ */
+export interface IdbAPI {
+	dbName: string;
+	lock: boolean;
+	active: boolean;
+	listLength: number;
+	listPage: number;
+	footerHTML: string | false;
+	readonly baddies: unknown;
+	init(dbName?: string): Promise<unknown>;
+	getSaveDetails(): Promise<unknown>;
+	getAllSaves(): Promise<unknown>;
+	saveList(): void;
+	saveState(): Promise<unknown>;
+	loadState(): Promise<unknown>;
+	setItem(slot: number, value: unknown): Promise<void>;
+	getItem(slot: number): Promise<unknown>;
+	deleteItem(slot: number): Promise<void>;
+	clearAll(): Promise<void>;
+	updateSettings(): void;
+	funNuke(): void;
+	ekuNnuf(): void;
+	importFromLocalStorage(): Promise<void>;
+}

package/src/index.d.ts

@@ -0,0 +1,30 @@
+import "./jquery-shim";
+import "./version";
+import "./config";
+import "./util";
+import "./has";
+import "./browser";
+import "./alert";
+import "./visibility";
+import "./fullscreen";
+import "./l10n";
+import "./scripting";
+import "./template";
+import "./simplestore";
+import "./passage";
+import "./state";
+import "./engine";
+import "./story";
+import "./save";
+import "./setting";
+import "./macro";
+import "./wikifier";
+import "./loadscreen";
+import "./dialog";
+import "./uibar";
+import "./ui";
+import "./simpleaudio";
+import "./debugbar";
+import "./links";
+import "./idb";
+import "./global";

package/src/jquery-shim.d.ts

@@ -0,0 +1,37 @@
+declare interface JQuery {
+	append(...args: unknown[]): JQuery;
+	empty(): JQuery;
+	get(index: number): Element | undefined;
+	hasClass(className: string): boolean;
+	removeClass(): JQuery;
+	addClass(classNames: string): JQuery;
+	trigger(eventType: string): JQuery;
+	off(events?: string): JQuery;
+	on(events: string, handler: (ev: JQuery.TriggeredEvent) => void): JQuery;
+	one(events: string, selector: string, handler: (ev: JQuery.TriggeredEvent) => void): JQuery;
+	css(propertyName: string): string;
+	css(properties: Record<string, string | number>): JQuery;
+	attr(attributeName: string): string | undefined;
+	attr(attributeName: string, value: string | number | null): JQuery;
+	removeAttr(name: string): JQuery;
+	find(selector: string): JQuery;
+	hide(): JQuery;
+	show(): JQuery;
+	wiki(...args: unknown[]): JQuery;
+	[key: string]: unknown;
+}
+
+declare namespace JQuery {
+	interface TriggeredEvent {
+		target: EventTarget;
+		[key: string]: unknown;
+	}
+}
+
+declare interface JQueryStatic {
+	(selector: string | Element | DocumentFragment): JQuery;
+	(event: { type: string }): JQuery;
+}
+
+declare var jQuery: JQueryStatic;
+declare var $: JQueryStatic;

package/src/l10n.d.ts

@@ -0,0 +1,4 @@
+export interface L10nAPI {
+	init(): void;
+	get(id: string, context?: Record<string, unknown>): string;
+}

package/src/links.d.ts

@@ -0,0 +1,15 @@
+export interface LinksAPI {
+	init(): void;
+	generate(): void;
+	generateLinkNumbers(): void;
+	pushTheButton(): void;
+	numberPrepend: string;
+	numberAppend: string;
+	skipElements: unknown;
+	includeElements: unknown;
+	enabled: boolean;
+	disableRNGReload: boolean;
+	disableNumbers: boolean;
+	throttle: number;
+	readonly currentLinks: unknown;
+}

package/src/loadscreen.d.ts

@@ -0,0 +1,8 @@
+export interface LoadScreenAPI {
+	init(): void;
+	clear(): void;
+	hide(): void;
+	show(): void;
+	lock(): number;
+	unlock(lockId: number): void;
+}

package/src/macro.d.ts

@@ -0,0 +1,31 @@
+/*
+	Module Exports.
+	Macro Functions.
+	Hook API
+	Tags Functions.
+	Legacy Aliases.
+*/
+export interface MacroTagsAPI {
+	register(name: string, handler: (...args: unknown[]) => unknown): void;
+	unregister(name: string): void;
+	has(name: string): boolean;
+	get(name: string): (...args: unknown[]) => unknown;
+}
+
+export interface MacroHooksAPI {
+	on(event: string, handler: (...args: unknown[]) => void): void;
+	off(event: string, handler?: (...args: unknown[]) => void): void;
+	emit(event: string, ...args: unknown[]): void;
+}
+
+export interface MacroAPI {
+	add(name: string, definition: unknown): void;
+	delete(name: string): void;
+	isEmpty(): boolean;
+	has(name: string): boolean;
+	get(name: string): unknown;
+	init(): void;
+	hooks: MacroHooksAPI;
+	tags: MacroTagsAPI;
+	evalStatements(...args: unknown[]): unknown;
+}

package/src/passage.d.ts

@@ -0,0 +1,25 @@
+/*
+	Passage Class.
+	Passage title/ID.
+	Passage data element (within the story data element; i.e. T1: '[tiddler]', T2: 'tw-passagedata').
+	Passage tags array (unique).
+*/
+export interface PassageAPI {
+	readonly title: string;
+	readonly element: Element | null;
+	readonly tags: readonly string[];
+	readonly domId: string;
+	readonly classes: readonly string[];
+	readonly className: string;
+	readonly text: string;
+	description(): string;
+	processText(): string;
+	render(options?: unknown): DocumentFragment;
+}
+
+/** Constructor type for Passage (static methods live here). */
+export interface PassageConstructor {
+	new (title: string, el?: Element | null): PassageAPI;
+	getExcerptFromNode(node: Node, count?: number): string;
+	getExcerptFromText(text: string, count?: number): string;
+}

package/src/save.d.ts

@@ -0,0 +1,61 @@
+/*
+	Module Exports.
+	Save Functions.
+	Autosave Functions.
+	Slots Functions.
+	Disk Import/Export Functions.
+	Serialization Functions.
+	Event Functions.
+*/
+export interface SaveOnLoadAPI {
+	add(handler: (...args: unknown[]) => unknown): void;
+	clear(): void;
+	delete(handler: (...args: unknown[]) => unknown): void;
+	readonly size: number;
+	readonly handlers: readonly ((...args: unknown[]) => unknown)[];
+}
+
+export interface SaveOnSaveAPI {
+	add(handler: (...args: unknown[]) => unknown): void;
+	clear(): void;
+	delete(handler: (...args: unknown[]) => unknown): void;
+	readonly size: number;
+	readonly handlers: readonly ((...args: unknown[]) => unknown)[];
+}
+
+export interface SaveAutosaveAPI {
+	ok(): boolean;
+	has(): boolean;
+	get(): unknown;
+	load(): void;
+	save(): void;
+	delete(): void;
+}
+
+export interface SaveSlotsAPI {
+	ok(): boolean;
+	readonly length: number;
+	isEmpty(): boolean;
+	count(): number;
+	has(slot: number): boolean;
+	get(slot: number): unknown;
+	load(slot: number): void;
+	save(slot: number, title?: string): void;
+	delete(slot: number): void;
+}
+
+export interface SaveAPI {
+	init(): void;
+	get(): { autosave: unknown; slots: unknown[] };
+	clear(): void;
+	ok(): boolean;
+	autosave: SaveAutosaveAPI;
+	slots: SaveSlotsAPI;
+	export(): void;
+	import(): void;
+	serialize(): string;
+	deserialize(data: string): unknown;
+	onLoad: SaveOnLoadAPI;
+	onSave: SaveOnSaveAPI;
+	readonly meta: unknown;
+}

package/src/scripting.d.ts

@@ -0,0 +1,5 @@
+export interface ScriptingAPI {
+	parse(script: string): unknown;
+	evalJavaScript(script: string): unknown;
+	evalTwineScript(script: string): unknown;
+}

package/src/setting.d.ts

@@ -0,0 +1,29 @@
+/*
+	Module Exports.
+	Enumerations.
+	Settings Functions.
+	Definitions Functions.
+*/
+export interface SettingTypesAPI {
+	[key: string]: unknown;
+}
+
+export interface SettingAPI {
+	readonly Types: SettingTypesAPI;
+	init(): void;
+	create(): void;
+	save(): void;
+	load(): void;
+	clear(): void;
+	reset(): void;
+	forEach(callback: (...args: unknown[]) => void): void;
+	add(name: string, definition: unknown): void;
+	addHeader(name: string, definition: unknown): void;
+	addToggle(name: string, definition: unknown): void;
+	addList(name: string, definition: unknown): void;
+	addRange(name: string, definition: unknown): void;
+	isEmpty(): boolean;
+	has(name: string): boolean;
+	get(name: string): unknown;
+	delete(name: string): void;
+}

package/src/simpleaudio.d.ts

@@ -0,0 +1,38 @@
+export interface SimpleAudioTracksAPI {
+	add(name: string, definition: unknown): void;
+	delete(name: string): void;
+	clear(): void;
+	has(name: string): boolean;
+	get(name: string): unknown;
+}
+
+export interface SimpleAudioGroupsAPI {
+	add(name: string, definition: unknown): void;
+	delete(name: string): void;
+	clear(): void;
+	has(name: string): boolean;
+	get(name: string): unknown;
+}
+
+export interface SimpleAudioListsAPI {
+	add(name: string, definition: unknown): void;
+	delete(name: string): void;
+	clear(): void;
+	has(name: string): boolean;
+	get(name: string): unknown;
+}
+
+export interface SimpleAudioAPI {
+	tracks: SimpleAudioTracksAPI;
+	groups: SimpleAudioGroupsAPI;
+	lists: SimpleAudioListsAPI;
+	select: unknown;
+	load(...args: unknown[]): void;
+	loadWithScreen(...args: unknown[]): void;
+	mute(flag?: boolean): void;
+	muteOnHidden(flag?: boolean): void;
+	rate(value?: number): number;
+	stop(): void;
+	unload(): void;
+	volume(value?: number): number;
+}

package/src/simplestore.d.ts

@@ -0,0 +1,20 @@
+/*
+	Adapters List.
+	Core Functions.
+*/
+export interface SimpleStoreInstanceAPI {
+	readonly name: string;
+	readonly id: string;
+	readonly persistent: boolean;
+	size(): number;
+	keys(): string[];
+	has(key: string): boolean;
+	get(key: string): unknown;
+	set(key: string, value: unknown): void;
+	delete(key: string): void;
+}
+
+export interface SimpleStoreAPI {
+	readonly adapters: unknown[];
+	create(storageId: string, persistent: boolean): SimpleStoreInstanceAPI;
+}

package/src/state.d.ts

@@ -0,0 +1,111 @@
+/*
+	State Functions.
+	Moment Functions.
+	History Functions.
+	PRNG Functions.
+	Temporary Variables Functions.
+	Local variables.
+	Variable Chain Parsing Functions.
+	Story Metadata Functions.
+	qc stuff
+	Legacy Aliases.
+*/
+export interface StateMoment {
+	readonly title: string;
+	readonly variables: Record<string, unknown>;
+}
+
+export interface StateMetadataAPI {
+	clear(): void;
+	delete(key: string): boolean;
+	entries(): Iterable<[string, unknown]>;
+	get(key: string): unknown;
+	has(key: string): boolean;
+	keys(): Iterable<string>;
+	set(key: string, value: unknown): void;
+	readonly size: number;
+}
+
+export interface StatePRNGAPI {
+	init(seed: string | number): void;
+	isEnabled(): boolean;
+	pull: number;
+	readonly seed: string | number;
+	str2int(str: string): number;
+	test(seed: string | number): boolean;
+	peek(): number;
+}
+
+export interface StateAPI {
+	/* State Functions. */
+	reset(): void;
+	restore(soft?: boolean): boolean;
+	marshalForSave(): unknown;
+	unmarshalForSave(stateObj: unknown): void;
+	readonly expired: string[];
+	readonly turns: number;
+	readonly passages: string[];
+	hasPlayed(passage: string): boolean;
+	getSessionState(): unknown;
+	setSessionState(state: unknown): void;
+
+	/* Moment Functions. */
+	readonly active: StateMoment;
+	readonly activeIndex: number;
+	/** shortcut for `State.active.title` */
+	readonly passage: string;
+	/** shortcut for `State.active.variables` */
+	readonly variables: Record<string, unknown>;
+
+	/* History Functions. */
+	readonly history: StateMoment[];
+	readonly length: number;
+	readonly size: number;
+	isEmpty(): boolean;
+	readonly current: StateMoment | undefined;
+	readonly top: StateMoment | undefined;
+	readonly bottom: StateMoment | undefined;
+	index(offset?: number): number;
+	peek(offset?: number): StateMoment | undefined;
+	has(offset: number): boolean;
+	create(): StateMoment;
+	goTo(index: number): void;
+	go(delta: number): void;
+	deltaEncode(moments: StateMoment[]): unknown;
+	deltaDecode(data: unknown): StateMoment[];
+
+	/* PRNG Functions. */
+	readonly prng: StatePRNGAPI;
+	random(): number;
+
+	/* Temporary Variables Functions. */
+	clearTemporary(): void;
+	readonly temporary: Record<string, unknown>;
+
+	/* Local variables. */
+	pushLocal(): void;
+	popLocal(): Record<string, unknown> | undefined;
+	peekLocal(): Record<string, unknown> | undefined;
+	readonly local: Record<string, unknown>;
+	clearLocal(): void;
+
+	/* Variable Chain Parsing Functions. */
+	getVar(path: string): unknown;
+	setVar(path: string, value: unknown): void;
+
+	/* Story Metadata Functions. */
+	readonly metadata: StateMetadataAPI;
+
+	/* qc stuff */
+	readonly qc: unknown;
+	qcadd(fn: (...args: unknown[]) => void): void;
+
+	/* Legacy Aliases. */
+	initPRNG(seed: string | number): void;
+	restart(): void;
+	backward(): void;
+	forward(): void;
+	display(...args: unknown[]): void;
+	show(...args: unknown[]): void;
+	play(...args: unknown[]): void;
+}

package/src/story.d.ts

@@ -0,0 +1,24 @@
+/*
+	Module Exports.
+	Story Functions.
+	Passage Functions.
+*/
+import type { PassageAPI } from './passage.d.ts';
+
+export interface StoryAPI {
+	load(): void;
+	init(): void;
+	readonly title: string;
+	readonly domId: string;
+	readonly ifId: string;
+	add(passage: PassageAPI): void;
+	has(title: string): boolean;
+	get(title: string): PassageAPI;
+	getAllInit(): readonly PassageAPI[];
+	getAllRegular(): readonly PassageAPI[];
+	getAllScript(): readonly string[];
+	getAllStylesheet(): readonly string[];
+	getAllWidget(): readonly string[];
+	lookup(tags: string | string[]): PassageAPI[];
+	lookupWith(predicate: (p: PassageAPI) => boolean): PassageAPI[];
+}

package/src/template.d.ts

@@ -0,0 +1,7 @@
+export interface TemplateAPI {
+	add(name: string, template: string | ((...args: unknown[]) => string)): void;
+	delete(name: string): void;
+	get(name: string): ((...args: unknown[]) => string) | undefined;
+	has(name: string): boolean;
+	readonly size: number;
+}

package/src/ui.d.ts

@@ -0,0 +1,39 @@
+/*
+	UI Functions, Core.
+	UI Functions, Built-ins.
+	Legacy Aliases.
+*/
+import type { DialogAPI } from './dialog.d.ts';
+
+export interface UIAPI {
+	assembleLinkList(passage?: string): unknown;
+	alert(title: string, message: string): void;
+	jumpto(): void;
+	restart(): void;
+	saves(): void;
+	settings(): void;
+	share(): void;
+	buildAutoload(): unknown;
+	buildJumpto(): unknown;
+	buildRestart(): unknown;
+	buildSaves(): unknown;
+	buildSettings(): unknown;
+	buildShare(): unknown;
+	stow(): void;
+	unstow(): void;
+	setStoryElements(): void;
+	isOpen(...args: Parameters<DialogAPI['isOpen']>): boolean;
+	body(): ReturnType<DialogAPI['body']>;
+	setup(...args: Parameters<DialogAPI['setup']>): ReturnType<DialogAPI['setup']>;
+	addClickHandler(...args: unknown[]): unknown;
+	open(...args: Parameters<DialogAPI['open']>): DialogAPI;
+	close(...args: Parameters<DialogAPI['close']>): DialogAPI;
+	resize(): void;
+	buildDialogAutoload(): unknown;
+	buildDialogJumpto(): unknown;
+	buildDialogRestart(): unknown;
+	buildDialogSaves(): unknown;
+	buildDialogSettings(): unknown;
+	buildDialogShare(): unknown;
+	buildLinkListFromPassage(passage?: string): unknown;
+}

package/src/uibar.d.ts

@@ -0,0 +1,18 @@
+/*
+	UI Bar Functions.
+	Object Exports.
+	Legacy Functions.
+*/
+export interface UIBarAPI {
+	destroy(): void;
+	hide(): UIBarAPI;
+	init(): void;
+	isHidden(): boolean;
+	isStowed(): boolean;
+	show(): UIBarAPI;
+	start(): void;
+	stow(): void;
+	unstow(): void;
+	update(): void;
+	setStoryElements(): void;
+}

package/src/util.d.ts

@@ -0,0 +1,28 @@
+export interface UtilAPI {
+	getType(value: unknown): string;
+	isBoolean(value: unknown): boolean;
+	isIterable(value: unknown): boolean;
+	isNumeric(value: unknown): boolean;
+	sameValueZero(x: unknown, y: unknown): boolean;
+	toEnum<T extends Record<string, string>>(obj: T): T;
+	toStringTag(value: unknown): string;
+	slugify(str: string): string;
+	sanitizeFilename(str: string): string;
+	escapeMarkup(str: string): string;
+	escape(str: string): string;
+	unescape(str: string): string;
+	charAndPosAt(str: string, index: number): { char: string; start: number; end: number };
+	now(): number;
+	fromCssTime(value: string): number;
+	toCssTime(value: number): string;
+	fromCssProperty(value: string): unknown;
+	parseUrl(url: string): { href: string; [key: string]: unknown };
+	newExceptionFrom(ex: unknown): Error;
+	scrubEventKey(key: string): string;
+	hasMediaQuery(query: string): boolean;
+	random(): number;
+	entityEncode(str: string): string;
+	entityDecode(str: string): string;
+	evalExpression(script: string): unknown;
+	evalStatements(script: string): unknown;
+}

package/src/version.d.ts

@@ -0,0 +1,16 @@
+/*
+	Version object.
+*/
+export interface VersionInfo {
+	readonly title: string;
+	readonly major: string;
+	readonly minor: string;
+	readonly patch: string;
+	readonly prerelease: string;
+	readonly build: string;
+	readonly date: Date;
+	readonly extensions: Record<string, unknown>;
+	toString(): string;
+	short(): string;
+	long(): string;
+}

package/src/visibility.d.ts

@@ -0,0 +1,9 @@
+export interface VisibilityAPI {
+	readonly vendor: unknown;
+	readonly state: string;
+	isEnabled(): boolean;
+	isHidden(): boolean;
+	readonly hiddenProperty: string | undefined;
+	readonly stateProperty: string | undefined;
+	readonly changeEvent: string | undefined;
+}

package/src/wikifier.d.ts

@@ -0,0 +1,40 @@
+export interface WikifierParserProfileAPI {
+	readonly profiles: unknown;
+	compile(name: string, compiler: (...args: unknown[]) => string): void;
+	isEmpty(): boolean;
+	has(name: string): boolean;
+	get(name: string): unknown;
+}
+
+export interface WikifierParserAPI {
+	readonly parsers: unknown[];
+	add(parser: { name: string; [key: string]: unknown }): void;
+	delete(name: string): void;
+	isEmpty(): boolean;
+	has(name: string): boolean;
+	get(name: string): unknown;
+	readonly Profile: WikifierParserProfileAPI;
+}
+
+export interface WikifierHelpersAPI {
+	inlineCss?: (w: { nextMatch: number; [key: string]: unknown }) => void;
+	[key: string]: unknown;
+}
+
+export interface WikifierStaticAPI {
+	Parser: WikifierParserAPI;
+	helpers: WikifierHelpersAPI;
+	stopWikify: boolean;
+	getValue: (path: string) => unknown;
+	setValue: (path: string, value: unknown) => void;
+	parse: (script: string) => unknown;
+	evalExpression: (script: string) => unknown;
+	evalStatements: (script: string) => unknown;
+	textPrimitives: unknown;
+}
+
+export interface WikifierConstructor {
+	new (context: DocumentFragment | Element, text: string, options?: unknown): unknown;
+}
+
+export type WikifierAPI = WikifierConstructor & WikifierStaticAPI;