@scml/sc2-verlnir 1.0.5 → 1.0.7

package/README.md

@@ -1,42 +1,3 @@
 # @scml/sc2-verlnir
 
-TypeScript type definitions for SugarCube 2 API (based on verlnir).
-
-This package uses type declarations from `src/` directly in the repository. No `download` or `build` required.
-
-## Installation
-
-```bash
-pnpm add -D @scml/sc2-verlnir
-```
-
-## Usage
-
-### Main entry (global SugarCube types)
-
-```ts
-/// <reference types="@scml/sc2-verlnir" />
-```
-
-The main entry `./src/global.d.ts` declares SugarCube 2's global API.
-
-## Types
-
-### Global APIs (via `declare global`)
-- **`Story`** – `StoryAPI` – Story and passage access.
-- **`Config`** – `ConfigAPI` – Engine configuration.
-- **`State`** – `StateAPI` – Game state, history, temporary variables.
-- **`Passage`** – `PassageConstructor` – Current passage.
-- **`Save`** – `SaveAPI` – Save/load.
-- **`Dialog`** – `DialogAPI` – Dialog system.
-- **`Engine`** – `EngineAPI` – Engine control.
-- **`Macro`** – `MacroAPI` – Macro definitions.
-- **`Scripting`** – `ScriptingAPI` – Script evaluation.
-- **`Template`** – `TemplateAPI` – Template engine.
-- **`UI`** / **`UIBar`** – `UIAPI` / `UIBarAPI` – UI components.
-- **`Alert`**, **`Browser`**, **`Config`**, **`DebugBar`**, **`Fullscreen`**, **`Has`**, **`L10n`**, **`Links`**, **`LoadScreen`**, **`Setting`**, **`SimpleAudio`**, **`SimpleStore`**, **`Util`**, **`Visibility`**, **`Wikifier`** – Other SugarCube APIs.
-- **`version`** – `VersionInfo`.
-- **`session`**, **`storage`** – `SimpleStoreInstanceAPI | null`.
-- **`settings`**, **`setup`** – `Record<string, unknown>`.
-- **`idb`** – `IdbAPI`.
-- **`window.SugarCube`** – Object containing all above APIs for detection and debugging.
+See [documentation](https://scml-type.pages.dev/packages/sc2-verlnir).

package/package.json

@@ -1,10 +1,21 @@
 {
   "name": "@scml/sc2-verlnir",
-  "version": "1.0.5",
+  "version": "1.0.7",
+  "private": false,
   "description": "TypeScript type definitions for SugarCube 2",
+  "keywords": [
+    "dol",
+    "mod-loader",
+    "scml",
+    "sugarcube",
+    "typescript",
+    "verlnir"
+  ],
+  "homepage": "https://github.com/Muromi-Rikka/scml-types/tree/main/packages/sugarcube-2-verlnir#readme",
+  "bugs": {
+    "url": "https://github.com/Muromi-Rikka/scml-types/issues"
+  },
   "license": "MIT",
-  "private": false,
-  "type": "module",
   "author": {
     "name": "Rikka",
     "email": "admin@rikka.cc",
@@ -12,17 +23,22 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/Muromi-Rikka/scml-types.git",
+    "url": "git+https://github.com/Muromi-Rikka/scml-types.git",
     "directory": "packages/sugarcube-2-verlnir"
   },
   "files": [
     "src",
     "README.md"
   ],
+  "type": "module",
+  "sideEffects": false,
   "types": "./src/global.d.ts",
   "exports": {
     ".": "./src/global.d.ts"
   },
+  "publishConfig": {
+    "access": "public"
+  },
   "devDependencies": {
     "@types/jquery": "*"
   },

package/src/alert.d.ts

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

package/src/browser.d.ts

@@ -1,10 +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;
+  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

@@ -10,65 +10,70 @@
 	UI settings.
 */
 export interface ConfigHistoryAPI {
-	controls: boolean;
-	maxStates: number;
-	maxSessionStates: number;
-	maxExpired: number;
+  controls: boolean;
+  maxStates: number;
+  maxSessionStates: number;
+  maxExpired: number;
 }
 
 export interface ConfigAudioAPI {
-	pauseOnFadeToZero: boolean;
-	preloadMetadata: boolean;
+  pauseOnFadeToZero: boolean;
+  preloadMetadata: boolean;
 }
 
 export interface ConfigMacrosAPI {
-	ifAssignmentError: boolean;
-	maxLoopIterations: number;
-	typeSkipKey: string;
-	typeVisitedPassages: boolean;
+  ifAssignmentError: boolean;
+  maxLoopIterations: number;
+  typeSkipKey: string;
+  typeVisitedPassages: boolean;
 }
 
 export interface ConfigNavigationAPI {
-	override: ((...args: unknown[]) => unknown) | null | undefined;
-	gotohell: unknown;
-	rememberYPos: unknown;
+  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;
+  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;
+  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;
+  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;
+  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

@@ -4,22 +4,22 @@
 	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;
+  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;
+  init(): void;
+  isStowed(): boolean;
+  start(): void;
+  stow(): void;
+  toggle(): void;
+  unstow(): void;
+  watch: DebugBarWatchAPI;
 }

package/src/dialog.d.ts

@@ -1,15 +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;
+  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

@@ -6,31 +6,31 @@
 */
 /* Engine state types object (pseudo-enumeration). */
 export interface EngineStatesAPI {
-	Idle: string;
-	Playing: string;
-	Rendering: string;
+  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>;
+  /* 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

@@ -1,13 +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;
+  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

@@ -3,114 +3,114 @@
 	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';
+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;
+  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;
+  /* 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'];
+  /* 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;
-		};
-	}
+  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

@@ -1,10 +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;
+  readonly audio: boolean;
+  readonly fileAPI: boolean;
+  readonly geolocation: boolean;
+  readonly mutationObserver: boolean;
+  readonly performance: boolean;
+  readonly touch: boolean;
+  readonly transitionEndEvent: string;
 }