narraleaf-react 0.4.4 → 0.6.0

package/dist/game/player/lib/ImageCacheManager.d.ts

@@ -1,26 +1,26 @@
-import { Game } from "../../../game/nlcore/game";
-import { GameState } from "../gameState";
-export type PreloadedToken = {
-    abort: () => void;
-    onFinished: (callback: () => void) => PreloadedToken;
-    onErrored: (callback: (reason: any) => void) => PreloadedToken;
-};
-export declare class ImageCacheManager {
-    private readonly game;
-    static getImage(src: string, abortSignal?: AbortSignal, options?: RequestInit): Promise<string>;
-    private src;
-    private preloadTasks;
-    constructor(game: Game);
-    has(name: string): boolean;
-    add(name: string, src: string): this;
-    remove(name: string): this;
-    get(name: string): string | undefined;
-    clear(): this;
-    size(): number;
-    isPreloading(src: string): boolean;
-    preload(gameState: GameState, url: string): PreloadedToken;
-    abortAll(): void;
-    abort(src: string): void;
-    preloadedSrc(): string[];
-    filter(names: string[]): this;
-}
+import { Game } from "../../../game/nlcore/game";
+import { GameState } from "../gameState";
+export type PreloadedToken = {
+    abort: () => void;
+    onFinished: (callback: () => void) => PreloadedToken;
+    onErrored: (callback: (reason: any) => void) => PreloadedToken;
+};
+export declare class ImageCacheManager {
+    private readonly game;
+    static getImage(src: string, abortSignal?: AbortSignal, options?: RequestInit): Promise<string>;
+    private src;
+    private preloadTasks;
+    constructor(game: Game);
+    has(name: string): boolean;
+    add(name: string, src: string): this;
+    remove(name: string): this;
+    get(name: string): string | undefined;
+    clear(): this;
+    size(): number;
+    isPreloading(src: string): boolean;
+    preload(gameState: GameState, url: string): PreloadedToken;
+    abortAll(): void;
+    abort(src: string): void;
+    preloadedSrc(): string[];
+    filter(names: string[]): this;
+}

package/dist/game/player/lib/Inspect.d.ts

@@ -1,36 +1,36 @@
-import React from "react";
-import { DivElementProp } from "../../nlcore/elements/transition/type";
-type InspectStyle = {
-    border?: "solid" | "dashed" | "dotted";
-    borderWidth?: number;
-    color?: React.CSSProperties["color"];
-};
-declare function InspectDiv(props: Readonly<DivElementProp & {
-    children?: React.ReactNode;
-    tag?: string;
-} & InspectStyle>): React.JSX.Element;
-declare function InspectSpan(props: Readonly<DivElementProp & {
-    children?: React.ReactNode;
-    tag?: string;
-} & InspectStyle>): React.JSX.Element;
-declare function InspectImg(props: Readonly<DivElementProp & {
-    tag?: string;
-} & InspectStyle>): React.JSX.Element;
-declare function InspectButton(props: Readonly<DivElementProp & {
-    children?: React.ReactNode;
-    tag?: string;
-} & InspectStyle>): React.JSX.Element;
-declare function InspectFramerMotionDiv(props: Readonly<DivElementProp & {
-    children?: React.ReactNode;
-    tag?: string;
-    ref?: React.RefObject<HTMLDivElement | null>;
-    layout?: boolean;
-} & InspectStyle>): React.JSX.Element;
-declare const Inspect: {
-    Div: typeof InspectDiv;
-    Span: typeof InspectSpan;
-    Button: typeof InspectButton;
-    Img: typeof InspectImg;
-    mDiv: typeof InspectFramerMotionDiv;
-};
-export default Inspect;
+import React from "react";
+import { DivElementProp } from "../../nlcore/elements/transition/type";
+type InspectStyle = {
+    border?: "solid" | "dashed" | "dotted";
+    borderWidth?: number;
+    color?: React.CSSProperties["color"];
+};
+declare function InspectDiv(props: Readonly<DivElementProp & {
+    children?: React.ReactNode;
+    tag?: string;
+} & InspectStyle>): React.JSX.Element;
+declare function InspectSpan(props: Readonly<DivElementProp & {
+    children?: React.ReactNode;
+    tag?: string;
+} & InspectStyle>): React.JSX.Element;
+declare function InspectImg(props: Readonly<DivElementProp & {
+    tag?: string;
+} & InspectStyle>): React.JSX.Element;
+declare function InspectButton(props: Readonly<DivElementProp & {
+    children?: React.ReactNode;
+    tag?: string;
+} & InspectStyle>): React.JSX.Element;
+declare function InspectFramerMotionDiv(props: Readonly<DivElementProp & {
+    children?: React.ReactNode;
+    tag?: string;
+    ref?: React.RefObject<HTMLDivElement | null>;
+    layout?: boolean;
+} & InspectStyle>): React.JSX.Element;
+declare const Inspect: {
+    Div: typeof InspectDiv;
+    Span: typeof InspectSpan;
+    Button: typeof InspectButton;
+    Img: typeof InspectImg;
+    mDiv: typeof InspectFramerMotionDiv;
+};
+export default Inspect;

package/dist/game/player/lib/PageRouter/AnimatePresence.d.ts

@@ -0,0 +1,4 @@
+import { FirstParam } from "../../../../util/data";
+import { AnimatePresence } from "motion/react";
+import { JSX } from "react";
+export type AnimatePresenceComponent = (arg0: FirstParam<typeof AnimatePresence>) => JSX.Element;

package/dist/game/player/lib/PageRouter/Page.d.ts

@@ -1,9 +1,9 @@
-import React from "react";
-import { HTMLMotionProps } from "motion/react";
-export type PageProps = Readonly<{
-    id: string;
-    children?: React.ReactNode;
-    className?: string;
-    style?: React.CSSProperties;
-} & HTMLMotionProps<"div">>;
-export declare function Page({ id, children, className, style, ...motionProps }: PageProps): React.JSX.Element;
+import React from "react";
+import { HTMLMotionProps } from "motion/react";
+export type PageProps = Readonly<{
+    id: string;
+    children?: React.ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+} & HTMLMotionProps<"div">>;
+export declare function Page({ id, children, className, style, ...motionProps }: PageProps): React.JSX.Element;

package/dist/game/player/lib/PageRouter/PageRouter.d.ts

@@ -1,27 +1,27 @@
-import React from "react";
-type PageRouterProps = Readonly<{
-    children?: React.ReactNode;
-}>;
-/**
- * Page Router for NarraLeaf-React
- *
- * **Note**: only `Page` and `Stage` components are allowed as children, other components will be ignored.
- *
- * @example
- * ```tsx
- * const router = useRouter("home");
- * ```
- * ```tsx
- * <PageRouter router={router}>
- *     <Page id="home">
- *         <Home />
- *     </Page>
- *     <Page id="about">
- *         <About />
- *         <Contact />
- *     </Page>
- * </PageRouter>
- * ```
- */
-export declare function PageRouter({ children, }: PageRouterProps): React.JSX.Element | null;
-export {};
+import React from "react";
+type PageRouterProps = Readonly<{
+    children?: React.ReactNode;
+}>;
+/**
+ * Page Router for NarraLeaf-React
+ *
+ * **Note**: only `Page` and `Stage` components are allowed as children, other components will be ignored.
+ *
+ * @example
+ * ```tsx
+ * const router = useRouter("home");
+ * ```
+ * ```tsx
+ * <PageRouter router={router}>
+ *     <Page id="home">
+ *         <Home />
+ *     </Page>
+ *     <Page id="about">
+ *         <About />
+ *         <Contact />
+ *     </Page>
+ * </PageRouter>
+ * ```
+ */
+export declare function PageRouter({ children, }: PageRouterProps): React.JSX.Element | null;
+export {};

package/dist/game/player/lib/PageRouter/Stage.d.ts

@@ -1,6 +1,6 @@
-import React from "react";
-export declare function Stage({ children, className, style, }: Readonly<{
-    children?: React.ReactNode;
-    className?: string;
-    style?: React.CSSProperties;
-}>): React.JSX.Element;
+import React from "react";
+export declare function Stage({ children, className, style, }: Readonly<{
+    children?: React.ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+}>): React.JSX.Element;

package/dist/game/player/lib/PageRouter/router.d.ts

@@ -1,23 +1,28 @@
-export declare class Router {
-    getCurrentId(): string | null;
-    /**
-     * Push a new page id to the router history
-     */
-    push(id: string): this;
-    /**
-     * Go back to the previous page id in the router history
-     */
-    back(): this;
-    /**
-     * Go forward to the next page id in the router history
-     */
-    forward(): this;
-    /**
-     * Clear the current page id and history
-     *
-     * All pages will be removed from the stage
-     */
-    clear(): this;
-    cleanHistory(): this;
-}
-export declare function useRouter(): Router;
+import { LiveGameEventToken } from "../../../../game/nlcore/types";
+export declare class Router {
+    getCurrentId(): string | null;
+    /**
+     * Push a new page id to the router history
+     */
+    push(id: string): this;
+    /**
+     * Go back to the previous page id in the router history
+     */
+    back(): this;
+    /**
+     * Go forward to the next page id in the router history
+     */
+    forward(): this;
+    /**
+     * Clear the current page id and history
+     *
+     * All pages will be removed from the stage
+     */
+    clear(): this;
+    cleanHistory(): this;
+    onExitComplete(handler: () => void): LiveGameEventToken;
+    onceExitComplete(handler: () => void): LiveGameEventToken;
+    onPageMount(handler: () => void): LiveGameEventToken;
+    oncePageMount(handler: () => void): LiveGameEventToken;
+}
+export declare function useRouter(): Router;

package/dist/game/player/lib/PlayerFrames.d.ts

@@ -1,10 +1,10 @@
-import React from "react";
-type ForwardChildren = {
-    children?: React.ReactNode;
-};
-type ForwardStyle = {
-    className?: string;
-    style?: React.CSSProperties;
-} & React.HTMLAttributes<HTMLDivElement>;
-declare function Full({ children, className, style, ...props }: ForwardChildren & ForwardStyle & React.HTMLAttributes<HTMLDivElement>): React.JSX.Element;
-export { Full, };
+import React from "react";
+type ForwardChildren = {
+    children?: React.ReactNode;
+};
+type ForwardStyle = {
+    className?: string;
+    style?: React.CSSProperties;
+} & React.HTMLAttributes<HTMLDivElement>;
+declare function Full({ children, className, style, ...props }: ForwardChildren & ForwardStyle & React.HTMLAttributes<HTMLDivElement>): React.JSX.Element;
+export { Full, };

package/dist/game/player/lib/Preloaded.d.ts

@@ -1,48 +1,48 @@
-import { Sound } from "../../nlcore/elements/sound";
-import { Src } from "../../nlcore/action/srcManager";
-import { EventDispatcher } from "../../../util/data";
-import { Image } from "../../nlcore/elements/displayable/image";
-export type PreloadedSrcTypes = "image" | "audio" | "video";
-export type PreloadedSrc<T extends PreloadedSrcTypes = any> = ({
-    type: "image";
-    src: Image;
-} | {
-    type: "audio";
-    src: Sound;
-} | {
-    type: "video";
-    src: string;
-}) & (T extends undefined ? {} : ({
-    type: T;
-} & T extends "image" ? {
-    src: Image;
-} : T extends "audio" ? {
-    src: Sound;
-} : T extends "video" ? {
-    src: string;
-} : {}));
-export type PreloadedEventTypes = {
-    "event:preloaded.add": [PreloadedSrc | string];
-    "event:preloaded.remove": [PreloadedSrc | string];
-    "event:preloaded.change": [];
-    "event:preloaded.mount": [];
-    "event:preloaded.ready": [];
-    "event:preloaded.unmount": [];
-};
-export declare class Preloaded {
-    static EventTypes: {
-        [K in keyof PreloadedEventTypes]: K;
-    };
-    preloaded: PreloadedSrc[];
-    events: EventDispatcher<PreloadedEventTypes>;
-    add<T extends PreloadedSrcTypes = PreloadedSrcTypes>(src: PreloadedSrc<T>): this;
-    get<T extends PreloadedSrcTypes = any>(src: string): PreloadedSrc<T> | undefined;
-    has(src: string): boolean;
-    has(src: string[]): boolean;
-    remove(src: string): this;
-    remove(src: PreloadedSrc): this;
-    remove(src: string[]): this;
-    remove(src: PreloadedSrc[]): this;
-    clear(): this;
-    getSrc(src: Src | string): string | null;
-}
+import { Sound } from "../../nlcore/elements/sound";
+import { Src } from "../../nlcore/action/srcManager";
+import { EventDispatcher } from "../../../util/data";
+import { Image } from "../../nlcore/elements/displayable/image";
+export type PreloadedSrcTypes = "image" | "audio" | "video";
+export type PreloadedSrc<T extends PreloadedSrcTypes = any> = ({
+    type: "image";
+    src: Image;
+} | {
+    type: "audio";
+    src: Sound;
+} | {
+    type: "video";
+    src: string;
+}) & (T extends undefined ? {} : ({
+    type: T;
+} & T extends "image" ? {
+    src: Image;
+} : T extends "audio" ? {
+    src: Sound;
+} : T extends "video" ? {
+    src: string;
+} : {}));
+export type PreloadedEventTypes = {
+    "event:preloaded.add": [PreloadedSrc | string];
+    "event:preloaded.remove": [PreloadedSrc | string];
+    "event:preloaded.change": [];
+    "event:preloaded.mount": [];
+    "event:preloaded.ready": [];
+    "event:preloaded.unmount": [];
+};
+export declare class Preloaded {
+    static EventTypes: {
+        [K in keyof PreloadedEventTypes]: K;
+    };
+    preloaded: PreloadedSrc[];
+    events: EventDispatcher<PreloadedEventTypes>;
+    add<T extends PreloadedSrcTypes = PreloadedSrcTypes>(src: PreloadedSrc<T>): this;
+    get<T extends PreloadedSrcTypes = any>(src: string): PreloadedSrc<T> | undefined;
+    has(src: string): boolean;
+    has(src: string[]): boolean;
+    remove(src: string): this;
+    remove(src: PreloadedSrc): this;
+    remove(src: string[]): this;
+    remove(src: PreloadedSrc[]): this;
+    clear(): this;
+    getSrc(src: Src | string): string | null;
+}

package/dist/game/player/lib/flush.d.ts

@@ -1,5 +1,5 @@
-import React from "react";
-export declare function useFlush(deps?: React.DependencyList): [
-    () => void,
-    number
-];
+import React from "react";
+export declare function useFlush(deps?: React.DependencyList): [
+    () => void,
+    number
+];

package/dist/game/player/lib/isolated.d.ts

@@ -1,7 +1,7 @@
-import React, { ReactNode } from "react";
-export default function Isolated({ children, className, style, ref, ...props }: Readonly<{
-    children: ReactNode;
-    className?: string;
-    style?: React.CSSProperties;
-    ref?: React.RefObject<HTMLDivElement | null>;
-} & React.HTMLAttributes<HTMLDivElement>>): React.JSX.Element;
+import React, { ReactNode } from "react";
+export default function Isolated({ children, className, style, ref, ...props }: Readonly<{
+    children: ReactNode;
+    className?: string;
+    style?: React.CSSProperties;
+    ref?: React.RefObject<HTMLDivElement | null>;
+} & React.HTMLAttributes<HTMLDivElement>>): React.JSX.Element;

package/dist/game/player/lib/notification.d.ts

@@ -1,47 +1,47 @@
-import { Awaitable } from "../../../util/data";
-import { GameState } from "../gameState";
-import { LiveGameEventToken } from "../../../game/nlcore/types";
-export type Notification = {
-    message: string;
-    id: string;
-    duration: number;
-};
-export declare class NotificationArray {
-    private readonly notifications;
-    static create(notifications: Notification[]): NotificationArray;
-    private readonly stringified;
-    private constructor();
-    private wrap;
-    /**
-     * Map the notifications to a new array
-     *
-     * **Note:** The callback function is called with the notification message, the **id** of the notification, and the array of notifications.
-     *
-     * @param callbackfn - The callback function
-     * @returns The new array
-     */
-    map<U>(callbackfn: (notification: string, id: string, array: string[]) => U): U[];
-    filter(callbackfn: (notification: string, id: string, array: string[]) => boolean): string[];
-    forEach(callbackfn: (notification: string, id: string, array: string[]) => void): void;
-    find(callbackfn: (notification: string, id: string, array: string[]) => boolean): string | undefined;
-    findIndex(callbackfn: (notification: string, id: string, array: string[]) => boolean): number;
-}
-export declare class NotificationManager {
-    gameState: GameState;
-    notifications: Notification[];
-    private readonly events;
-    constructor(gameState: GameState, notifications: Notification[]);
-    addNotification(notification: Notification): void;
-    removeNotification(notification: Notification): void;
-    clearNotifications(): void;
-    /**
-     * Consume a notification
-     *
-     * @param notification - The notification to consume
-     * @returns A promise that resolves when the notification is consumed
-     */
-    consume(notification: Notification): Awaitable<void>;
-    onFlush(callback: () => void): LiveGameEventToken;
-    toArray(): Notification[];
-    private flush;
-}
+import { Awaitable } from "../../../util/data";
+import { GameState } from "../gameState";
+import { LiveGameEventToken } from "../../../game/nlcore/types";
+export type Notification = {
+    message: string;
+    id: string;
+    duration: number | null;
+};
+export declare class NotificationArray {
+    private readonly notifications;
+    static create(notifications: Notification[]): NotificationArray;
+    private readonly stringified;
+    private constructor();
+    private wrap;
+    /**
+     * Map the notifications to a new array
+     *
+     * **Note:** The callback function is called with the notification message, the **id** of the notification, and the array of notifications.
+     *
+     * @param callbackfn - The callback function
+     * @returns The new array
+     */
+    map<U>(callbackfn: (notification: string, id: string, array: string[]) => U): U[];
+    filter(callbackfn: (notification: string, id: string, array: string[]) => boolean): string[];
+    forEach(callbackfn: (notification: string, id: string, array: string[]) => void): void;
+    find(callbackfn: (notification: string, id: string, array: string[]) => boolean): string | undefined;
+    findIndex(callbackfn: (notification: string, id: string, array: string[]) => boolean): number;
+}
+export declare class NotificationManager {
+    gameState: GameState;
+    notifications: Notification[];
+    private readonly events;
+    constructor(gameState: GameState, notifications: Notification[]);
+    addNotification(notification: Notification): void;
+    removeNotification(notification: Notification): void;
+    clearNotifications(): void;
+    /**
+     * Consume a notification
+     *
+     * @param notification - The notification to consume
+     * @returns A promise that resolves when the notification is consumed
+     */
+    consume(notification: Notification): Awaitable<void>;
+    onFlush(callback: () => void): LiveGameEventToken;
+    toArray(): Notification[];
+    private flush;
+}

package/dist/game/player/lib/preferences.d.ts

@@ -1,8 +1,8 @@
-import { StringKeyOf } from "../../../util/data";
-import { GamePreference } from "../../nlcore/game";
-/**
- * Custom hook for managing game preferences
- * @param key - Preference key to access/modify
- * @returns Tuple containing current preference value and setter function
- */
-export declare function usePreference<K extends StringKeyOf<GamePreference>>(key: K): [GamePreference[K], (value: GamePreference[K]) => void];
+import { StringKeyOf } from "../../../util/data";
+import { GamePreference } from "../../../game/nlcore/gameTypes";
+/**
+ * Custom hook for managing game preferences
+ * @param key - Preference key to access/modify
+ * @returns Tuple containing current preference value and setter function
+ */
+export declare function usePreference<K extends StringKeyOf<GamePreference>>(key: K): [GamePreference[K], (value: GamePreference[K]) => void];

package/dist/game/player/lib/useElementVisibility.d.ts

@@ -1,5 +1,5 @@
-import { RefObject } from "react";
-export declare function useElementVisibility<T extends HTMLElement>(ref: RefObject<T | null>): {
-    show: () => void;
-    hide: () => void;
-};
+import { RefObject } from "react";
+export declare function useElementVisibility<T extends HTMLElement>(ref: RefObject<T | null>): {
+    show: () => void;
+    hide: () => void;
+};

package/dist/game/player/lib/useExposeState.d.ts

@@ -1,10 +1,10 @@
-import { ExposedKeys, ExposedState, ExposedStateType } from "../type";
-import React from "react";
-/**
- * Custom hook for exposing state to the game state manager
- * @param key - Unique identifier for the state
- * @param value - State value or function returning state value
- * @param deps - Dependency array for state updates
- * @returns Empty array (for consistency with React hooks)
- */
-export declare function useExposeState<T extends ExposedStateType>(key: ExposedKeys[T], value: ExposedState[T] | (() => ExposedState[T]), deps?: React.DependencyList): [];
+import { ExposedKeys, ExposedState, ExposedStateType } from "../type";
+import React from "react";
+/**
+ * Custom hook for exposing state to the game state manager
+ * @param key - Unique identifier for the state
+ * @param value - State value or function returning state value
+ * @param deps - Dependency array for state updates
+ * @returns Empty array (for consistency with React hooks)
+ */
+export declare function useExposeState<T extends ExposedStateType>(key: ExposedKeys[T], value: ExposedState[T] | (() => ExposedState[T]), deps?: React.DependencyList): [];

package/dist/game/player/lib/useLiveGame.d.ts

@@ -1 +1 @@
-export declare function useLiveGame(): import("../../..").LiveGame;
+export declare function useLiveGame(): import("../../..").LiveGame;

package/dist/game/player/libElements.d.ts

@@ -1,12 +1,12 @@
-import Isolated from "./lib/isolated";
-import { usePreference } from "./lib/preferences";
-import { Stage } from "./lib/PageRouter/Stage";
-import { Page } from "./lib/PageRouter/Page";
-import GameMenu from "./elements/menu/UIMenu/Menu";
-import Item from "./elements/menu/UIMenu/Item";
-import Notifications from "./elements/notification/Notifications";
-import Texts from "./elements/say/Sentence";
-import Nametag from "./elements/say/Nametag";
-import Dialog from "./elements/say/Dialog";
-import { useDialog } from "./elements/say/useDialog";
-export { Isolated, usePreference, Stage, Page, GameMenu, Item, Notifications, Texts, Nametag, Dialog, useDialog, };
+import Isolated from "./lib/isolated";
+import { usePreference } from "./lib/preferences";
+import { Stage } from "./lib/PageRouter/Stage";
+import { Page } from "./lib/PageRouter/Page";
+import GameMenu from "./elements/menu/UIMenu/Menu";
+import Item from "./elements/menu/UIMenu/Item";
+import Notifications from "./elements/notification/Notifications";
+import Texts from "./elements/say/Sentence";
+import Nametag from "./elements/say/Nametag";
+import Dialog from "./elements/say/Dialog";
+import { useDialog } from "./elements/say/useDialog";
+export { Isolated, usePreference, Stage, Page, GameMenu, Item, Notifications, Texts, Nametag, Dialog, useDialog, };

package/dist/game/player/provider/game-state.d.ts

@@ -1,24 +1,24 @@
-import "client-only";
-import React, { ReactNode } from "react";
-import { Game } from "../../nlcore/game";
-/**
- * Context type definition for game state management
- */
-type GameContextType = Game;
-/**
- * Game state provider component
- * Provides game state context to all child components
- * @param children - React children components
- * @param game - Optional initial game instance
- */
-export declare function GameProvider({ children, game }: {
-    children?: ReactNode;
-    game?: Game;
-}): React.JSX.Element;
-/**
- * Custom hook to access game state context
- * @returns GameContextType object containing game instance and setter
- * @throws Error if used outside of GameProvider
- */
-export declare function useGame(): GameContextType;
-export {};
+import "client-only";
+import React, { ReactNode } from "react";
+import { Game } from "../../nlcore/game";
+/**
+ * Context type definition for game state management
+ */
+type GameContextType = Game;
+/**
+ * Game state provider component
+ * Provides game state context to all child components
+ * @param children - React children components
+ * @param game - Optional initial game instance
+ */
+export declare function GameProvider({ children, game }: {
+    children?: ReactNode;
+    game?: Game;
+}): React.JSX.Element;
+/**
+ * Custom hook to access game state context
+ * @returns GameContextType object containing game instance and setter
+ * @throws Error if used outside of GameProvider
+ */
+export declare function useGame(): GameContextType;
+export {};