narraleaf-react 0.4.4 → 0.6.0

package/dist/game/player/elements/notification/type.d.ts

@@ -1,19 +1,18 @@
-import { GameState } from "../../../../game/nlcore/common/game";
-import React from "react";
-export type Notification = {
-    message: string;
-    duration: number;
-    id: string;
-};
-export type PlayerNotificationProps = {
-    gameState: GameState;
-};
-export type NotificationsProps = {
-    children: React.ReactNode;
-} & React.HTMLAttributes<HTMLDivElement>;
-export type NotificationProps = React.PropsWithChildren<{
-    notification: Notification;
-}> & React.HTMLAttributes<HTMLDivElement>;
-export interface INotificationsProps {
-    notifications: Notification[];
-}
+import { GameState } from "../../../../game/nlcore/common/game";
+import React from "react";
+export type Notification = {
+    message: string;
+    id: string;
+};
+export type PlayerNotificationProps = {
+    gameState: GameState;
+};
+export type NotificationsProps = {
+    children: React.ReactNode;
+} & React.HTMLAttributes<HTMLDivElement>;
+export type NotificationProps = React.PropsWithChildren<{
+    notification: Notification;
+}> & React.HTMLAttributes<HTMLDivElement>;
+export interface INotificationsProps {
+    notifications: Notification[];
+}

package/dist/game/player/elements/player/KeyEventAnnouncer.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/game/player/elements/player/Layer.d.ts

@@ -1,8 +1,8 @@
-import React from "react";
-import { Layer as GameLayer } from "../../../nlcore/elements/layer";
-import { GameState } from "../../gameState";
-export declare function Layer({ state, layer, children }: Readonly<{
-    state: GameState;
-    layer: GameLayer;
-    children: React.ReactNode;
-}>): React.JSX.Element;
+import React from "react";
+import { Layer as GameLayer } from "../../../nlcore/elements/layer";
+import { GameState } from "../../gameState";
+export declare function Layer({ state, layer, children }: Readonly<{
+    state: GameState;
+    layer: GameLayer;
+    children: React.ReactNode;
+}>): React.JSX.Element;

package/dist/game/player/elements/player/PreferenceUpdateAnnouncer.d.ts

@@ -0,0 +1,4 @@
+import { GameState } from "../../../../game/nlcore/common/game";
+export default function PreferenceUpdateAnnouncer({ gameState }: Readonly<{
+    gameState: GameState;
+}>): null;

package/dist/game/player/elements/player/RenderEventAnnoucer.d.ts

@@ -0,0 +1,4 @@
+import { GameState } from "../../gameState";
+export declare function RenderEventAnnoucer({ gameState }: {
+    gameState: GameState;
+}): null;

package/dist/game/player/elements/player/SizeUpdateAnnouncer.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/game/player/elements/preload/Preload.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/game/player/elements/say/Dialog.d.ts

@@ -1,13 +1,13 @@
-import { DialogProps } from "../../elements/say/type";
-import React from "react";
-export declare function RawDialog(props: DialogProps): React.JSX.Element;
-/**
- * Context-based wrapper component
- * Provides integration with the say context
- */
-export declare function Dialog({ children, ...props }: DialogProps): React.JSX.Element | null;
-export default Dialog;
-/**
- * Default dialog component with Texts as children
- */
-export declare function DefaultDialog(): React.JSX.Element;
+import { DialogProps } from "../../elements/say/type";
+import React from "react";
+export declare function RawDialog(props: DialogProps): React.JSX.Element;
+/**
+ * Context-based wrapper component
+ * Provides integration with the say context
+ */
+export declare function Dialog({ children, ...props }: DialogProps): React.JSX.Element | null;
+export default Dialog;
+/**
+ * Default dialog component with Texts as children
+ */
+export declare function DefaultDialog(): React.JSX.Element;

package/dist/game/player/elements/say/Nametag.d.ts

@@ -1,2 +1,2 @@
-import React from "react";
-export default function Nametag({ ...props }: Readonly<React.HTMLAttributes<HTMLDivElement>>): React.JSX.Element;
+import React from "react";
+export default function Nametag({ ...props }: Readonly<React.HTMLAttributes<HTMLDivElement>>): React.JSX.Element;

package/dist/game/player/elements/say/Sentence.d.ts

@@ -1,37 +1,37 @@
-import { Pausing } from "../../../nlcore/elements/character/pause";
-import { Sentence } from "../../../nlcore/elements/character/sentence";
-import { Word } from "../../../nlcore/elements/character/word";
-import { GameState } from "../../../../game/nlcore/common/game";
-import { Color } from "../../../../game/nlcore/types";
-import React from "react";
-import { DialogElementProps } from "./type";
-import { DialogState } from "./UIDialog";
-type BaseTextsProps = {
-    /**
-     * The default color of the text
-     */
-    defaultColor?: Color;
-    className?: string;
-    style?: React.CSSProperties;
-    dialog?: DialogState;
-} & React.HTMLAttributes<HTMLDivElement>;
-/**
- * Props-based wrapper component
- * Provides a clean interface for direct prop usage
- */
-export interface TextsProps extends DialogElementProps {
-    sentence: Sentence;
-    gameState: GameState;
-    useTypeEffect?: boolean;
-    onCompleted?: () => void;
-    finished?: boolean;
-    count?: number;
-    words?: Word<Pausing | string>[];
-}
-export declare function RawTexts(props: BaseTextsProps): React.JSX.Element;
-/**
- * Context-based wrapper component
- * Provides integration with the sentence context
- */
-export declare function Texts(props: BaseTextsProps): React.JSX.Element;
-export default Texts;
+import { Pausing } from "../../../nlcore/elements/character/pause";
+import { Sentence } from "../../../nlcore/elements/character/sentence";
+import { Word } from "../../../nlcore/elements/character/word";
+import { GameState } from "../../../../game/nlcore/common/game";
+import { Color } from "../../../../game/nlcore/types";
+import React from "react";
+import { DialogElementProps } from "./type";
+import { DialogState } from "./UIDialog";
+type BaseTextsProps = {
+    /**
+     * The default color of the text
+     */
+    defaultColor?: Color;
+    className?: string;
+    style?: React.CSSProperties;
+    dialog?: DialogState;
+} & React.HTMLAttributes<HTMLDivElement>;
+/**
+ * Props-based wrapper component
+ * Provides a clean interface for direct prop usage
+ */
+export interface TextsProps extends DialogElementProps {
+    sentence: Sentence;
+    gameState: GameState;
+    useTypeEffect?: boolean;
+    onCompleted?: () => void;
+    finished?: boolean;
+    count?: number;
+    words?: Word<Pausing | string>[];
+}
+export declare function RawTexts(props: BaseTextsProps): React.JSX.Element;
+/**
+ * Context-based wrapper component
+ * Provides integration with the sentence context
+ */
+export declare function Texts(props: BaseTextsProps): React.JSX.Element;
+export default Texts;

package/dist/game/player/elements/say/UIDialog.d.ts

@@ -1,69 +1,72 @@
-import { Pausing } from "../../../nlcore/elements/character/pause";
-import { Word } from "../../../nlcore/elements/character/word";
-import { GameState } from "../../../../game/nlcore/common/game";
-import { EventDispatcher, EventToken } from "../../../../util/data";
-import React from "react";
-import { DialogAction, DialogStateType, SayElementProps } from "./type";
-type DialogEvents = {
-    "event:dialog.requestComplete": [];
-    "event:dialog.complete": [];
-    "event:dialog.forceSkip": [];
-    "event:dialog.onFlush": [];
-};
-type DialogStateConfig = {
-    useTypeEffect: boolean;
-    action: DialogAction;
-    evaluatedWords: Word<Pausing | string>[];
-    gameState: GameState;
-};
-export declare class DialogState {
-    static Events: {
-        requestComplete: "event:dialog.requestComplete";
-        complete: "event:dialog.complete";
-        forceSkip: "event:dialog.forceSkip";
-        onFlush: "event:dialog.onFlush";
-    };
-    readonly config: Readonly<DialogStateConfig>;
-    readonly events: EventDispatcher<DialogEvents>;
-    private _state;
-    private _count;
-    private _forceSkipped;
-    private _idle;
-    private autoForwardScheduler;
-    constructor(config: DialogStateConfig);
-    get state(): DialogStateType;
-    get deps(): React.DependencyList;
-    isIdle(): boolean;
-    setIdle(idle: boolean): void;
-    /**
-     * Only for dialog component to call
-     *
-     * Calling this method will request the sentence to be completed
-     * If the sentence is already completed, it will exit the dialog
-     */
-    requestComplete(): void;
-    /**
-     * Only for dialog state to call
-     *
-     * Force the sentence to cancel/skip all the tasks
-     */
-    forceSkip(): void;
-    /**
-     * Only for sentence component to call
-     *
-     * Only call this method when the sentence is completed
-     * Calling this method will schedule the exit of the dialog
-     */
-    dispatchComplete(): this | undefined;
-    emitComplete(): this;
-    isEnded(): boolean;
-    setPause(pause: boolean): void;
-    isForceSkipped(): boolean;
-    tryScheduleAutoForward(): void;
-    cancelAutoForward(): void;
-    emitFlush(): this;
-    onFlush(listener: () => void): EventToken;
-    private scheduleAutoForward;
-}
-export default function PlayerDialog({ action, onFinished, useTypeEffect, gameState, }: Readonly<SayElementProps>): React.JSX.Element;
-export {};
+import { Pausing } from "../../../nlcore/elements/character/pause";
+import { Word } from "../../../nlcore/elements/character/word";
+import { GameState } from "../../../../game/nlcore/common/game";
+import { EventDispatcher, EventToken } from "../../../../util/data";
+import React from "react";
+import { DialogAction, DialogStateType, SayElementProps } from "./type";
+type DialogEvents = {
+    "event:dialog.requestComplete": [];
+    "event:dialog.complete": [force: boolean];
+    "event:dialog.forceSkip": [];
+    "event:dialog.onFlush": [];
+    "event:dialog.simulateClick": [];
+};
+type DialogStateConfig = {
+    useTypeEffect: boolean;
+    action: DialogAction;
+    evaluatedWords: Word<Pausing | string>[];
+    gameState: GameState;
+};
+export declare class DialogState {
+    static Events: {
+        requestComplete: "event:dialog.requestComplete";
+        complete: "event:dialog.complete";
+        forceSkip: "event:dialog.forceSkip";
+        onFlush: "event:dialog.onFlush";
+        simulateClick: "event:dialog.simulateClick";
+    };
+    readonly config: Readonly<DialogStateConfig>;
+    readonly events: EventDispatcher<DialogEvents>;
+    private _state;
+    private _count;
+    private _forceSkipped;
+    private _idle;
+    private autoForwardScheduler;
+    constructor(config: DialogStateConfig);
+    get state(): DialogStateType;
+    get deps(): React.DependencyList;
+    isIdle(): boolean;
+    setIdle(idle: boolean): void;
+    /**
+     * Only for dialog component to call
+     *
+     * Calling this method will request the sentence to be completed
+     * If the sentence is already completed, it will exit the dialog
+     */
+    requestComplete(): void;
+    /**
+     * Only for dialog state to call
+     *
+     * Force the sentence to cancel/skip all the tasks
+     */
+    forceSkip(): void;
+    /**
+     * Only for sentence component to call
+     *
+     * Only call this method when the sentence is completed
+     * Calling this method will schedule the exit of the dialog
+     */
+    dispatchComplete(): this | undefined;
+    emitComplete(): this;
+    isEnded(): boolean;
+    setPause(pause: boolean): void;
+    isForceSkipped(): boolean;
+    tryScheduleAutoForward(): void;
+    cancelAutoForward(): void;
+    emitFlush(): this;
+    onFlush(listener: () => void): EventToken;
+    safeEmit(event: keyof DialogEvents, ...args: DialogEvents[keyof DialogEvents]): this;
+    private scheduleAutoForward;
+}
+export default function PlayerDialog({ action, onFinished, useTypeEffect, gameState, }: Readonly<SayElementProps>): React.JSX.Element;
+export {};

package/dist/game/player/elements/say/context.d.ts

@@ -1,4 +1,4 @@
-import React from "react";
-import { DialogState } from "./UIDialog";
-export declare const DialogContext: React.Context<DialogState | null>;
-export declare function useDialogContext(): DialogState;
+import React from "react";
+import { DialogState } from "./UIDialog";
+export declare const DialogContext: React.Context<DialogState | null>;
+export declare function useDialogContext(): DialogState;

package/dist/game/player/elements/say/type.d.ts

@@ -1,53 +1,53 @@
-import type { Character } from "../../../nlcore/elements/character";
-import type { GameState } from "../../gameState";
-import { Sentence } from "../../../nlcore/elements/character/sentence";
-import { Word } from "../../../nlcore/elements/character/word";
-import { Pausing } from "../../../nlcore/elements/character/pause";
-import React from "react";
-export interface SayElementProps {
-    action: {
-        sentence: Sentence | null;
-        character: Character | null;
-        words: Word<Pausing | string>[] | null;
-        id?: string;
-    };
-    /**
-     * @deprecated
-     * Callback function to be called when the player triggers the next action
-     */
-    onClick?: (skiped?: boolean) => void;
-    onFinished?: (skiped?: boolean) => void;
-    useTypeEffect?: boolean;
-    gameState: GameState;
-}
-export interface IDialogProps {
-}
-export type DialogProps = {
-    children: React.ReactNode;
-} & React.HTMLAttributes<HTMLDivElement>;
-export type DialogElementProps = {
-    children?: never;
-} & React.HTMLAttributes<HTMLDivElement>;
-export interface IDialogElementProps extends React.HTMLAttributes<HTMLDivElement> {
-    children?: never;
-}
-export declare enum DialogStateType {
-    Pending = "pending",
-    Paused = "paused",
-    Ended = "ended"
-}
-export interface DialogContext {
-    gameState: GameState;
-    action: {
-        sentence: Sentence | null;
-        character: Character | null;
-        words: Word<Pausing | string>[] | null;
-    };
-    state: DialogStateType;
-}
-export type DialogAction = {
-    sentence: Sentence | null;
-    character: Character | null;
-    words: Word<Pausing | string>[] | null;
-    id?: string;
-};
+import type { Character } from "../../../nlcore/elements/character";
+import type { GameState } from "../../gameState";
+import { Sentence } from "../../../nlcore/elements/character/sentence";
+import { Word } from "../../../nlcore/elements/character/word";
+import { Pausing } from "../../../nlcore/elements/character/pause";
+import React from "react";
+export interface SayElementProps {
+    action: {
+        sentence: Sentence | null;
+        character: Character | null;
+        words: Word<Pausing | string>[] | null;
+        id?: string;
+    };
+    /**
+     * @deprecated
+     * Callback function to be called when the player triggers the next action
+     */
+    onClick?: (skiped?: boolean) => void;
+    onFinished?: (skiped?: boolean) => void;
+    useTypeEffect?: boolean;
+    gameState: GameState;
+}
+export interface IDialogProps {
+}
+export type DialogProps = {
+    children: React.ReactNode;
+} & React.HTMLAttributes<HTMLDivElement>;
+export type DialogElementProps = {
+    children?: never;
+} & React.HTMLAttributes<HTMLDivElement>;
+export interface IDialogElementProps extends React.HTMLAttributes<HTMLDivElement> {
+    children?: never;
+}
+export declare enum DialogStateType {
+    Pending = "pending",
+    Paused = "paused",
+    Ended = "ended"
+}
+export interface DialogContext {
+    gameState: GameState;
+    action: {
+        sentence: Sentence | null;
+        character: Character | null;
+        words: Word<Pausing | string>[] | null;
+    };
+    state: DialogStateType;
+}
+export type DialogAction = {
+    sentence: Sentence | null;
+    character: Character | null;
+    words: Word<Pausing | string>[] | null;
+    id?: string;
+};

package/dist/game/player/elements/say/useDialog.d.ts

@@ -1,16 +1,18 @@
-/**
- * Represents the context of a dialog, containing information about its completion status
- * and the text content.
- */
-export type DialogContext = {
-    /** Whether the dialog has finished displaying */
-    done: boolean;
-    /** The text content of the dialog */
-    text: string;
-};
-/**
- * A custom hook that provides access to the current dialog's state and content.
- * It retrieves the dialog information from the sentence context and processes
- * the words to generate the final text.
- */
-export declare function useDialog(): DialogContext;
+/**
+ * Represents the context of a dialog, containing information about its completion status
+ * and the text content.
+ */
+export type DialogContext = {
+    /** Whether the dialog has finished displaying */
+    done: boolean;
+    /** The text content of the dialog */
+    text: string;
+    /** Whether the dialog is the narrator */
+    isNarrator: boolean;
+};
+/**
+ * A custom hook that provides access to the current dialog's state and content.
+ * It retrieves the dialog information from the sentence context and processes
+ * the words to generate the final text.
+ */
+export declare function useDialog(): DialogContext;

package/dist/game/player/elements/scene/Scene.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/game/player/elements/type.d.ts

@@ -1,53 +1,53 @@
-import React from "react";
-import { IDialogProps, SayElementProps } from "../elements/say/type";
-import { IUserMenuProps, MenuElementProps } from "../elements/menu/type";
-import { Story } from "../../nlcore/elements/story";
-import clsx from "clsx";
-import { Game } from "../../nlcore/game";
-import { GameState } from "../gameState";
-import { Storable } from "../../nlcore/elements/persistent/storable";
-import { LiveGame } from "../../nlcore/game/liveGame";
-import { INotificationsProps, NotificationsProps } from "./notification/type";
-export type Components<T extends Record<string, any>> = (props: Readonly<T>) => React.JSX.Element;
-export type SayComponent = Components<IDialogProps>;
-export type MenuComponent = Components<IUserMenuProps>;
-export type NotificationComponent = Components<INotificationsProps>;
-export type ComponentsTypes = {
-    say: SayComponent;
-    menu: MenuComponent;
-    notification: NotificationComponent;
-};
-export type { SayElementProps, MenuElementProps, NotificationsProps as INotificationProps, };
-export type PlayerEventContext = {
-    game: Game;
-    gameState: GameState;
-    liveGame: LiveGame;
-    storable: Storable;
-};
-export interface PlayerProps {
-    story?: Story;
-    width?: string | number;
-    height?: string | number;
-    className?: clsx.ClassValue;
-    /**
-     * Once the game is ready to be played
-     *
-     * only called each lifecycle once
-     */
-    onReady?: (ctx: PlayerEventContext) => void;
-    /**
-     * Once the game is ended
-     *
-     * only called each lifecycle once
-     */
-    onEnd?: (ctx: PlayerEventContext) => void;
-    children?: React.ReactNode;
-    /**
-     * Whether to show the player
-     *
-     * Even the active is false, the pages will be rendered
-     *
-     * @default true
-     */
-    active?: boolean;
-}
+import React from "react";
+import { IDialogProps, SayElementProps } from "../elements/say/type";
+import { IUserMenuProps, MenuElementProps } from "../elements/menu/type";
+import { Story } from "../../nlcore/elements/story";
+import clsx from "clsx";
+import { Game } from "../../nlcore/game";
+import { GameState } from "../gameState";
+import { Storable } from "../../nlcore/elements/persistent/storable";
+import { LiveGame } from "../../nlcore/game/liveGame";
+import { INotificationsProps, NotificationsProps } from "./notification/type";
+export type Components<T extends Record<string, any>> = (props: Readonly<T>) => React.JSX.Element;
+export type SayComponent = Components<IDialogProps>;
+export type MenuComponent = Components<IUserMenuProps>;
+export type NotificationComponent = Components<INotificationsProps>;
+export type ComponentsTypes = {
+    say: SayComponent;
+    menu: MenuComponent;
+    notification: NotificationComponent;
+};
+export type { SayElementProps, MenuElementProps, NotificationsProps as INotificationProps, };
+export type PlayerEventContext = {
+    game: Game;
+    gameState: GameState;
+    liveGame: LiveGame;
+    storable: Storable;
+};
+export interface PlayerProps {
+    story?: Story;
+    width?: string | number;
+    height?: string | number;
+    className?: clsx.ClassValue;
+    /**
+     * Once the game is ready to be played
+     *
+     * only called each lifecycle once
+     */
+    onReady?: (ctx: PlayerEventContext) => void;
+    /**
+     * Once the game is ended
+     *
+     * only called each lifecycle once
+     */
+    onEnd?: (ctx: PlayerEventContext) => void;
+    children?: React.ReactNode;
+    /**
+     * Whether to show the player
+     *
+     * Even the active is false, the pages will be rendered
+     *
+     * @default true
+     */
+    active?: boolean;
+}

package/dist/game/player/elements/video/video.d.ts

@@ -1 +1 @@
-export {};
+export {};