narraleaf-react 0.4.1 → 0.4.2

package/README.md

@@ -90,7 +90,7 @@ npm install narraleaf-react
 
 ### Documentation
 
-- [Introduction](https://react.narraleaf.com/documentation/introduction)****
+- [Introduction](https://react.narraleaf.com/documentation/introduction)
 - [Quick Start](https://react.narraleaf.com/documentation/quick-start)
 - [Installation](https://react.narraleaf.com/documentation/installation)
 - [Basic](https://react.narraleaf.com/documentation/basic)

package/dist/game/nlcore/action/gameHistory.d.ts

@@ -10,7 +10,7 @@ type GameElementHistory = {
     voice: string | null;
 } | {
     type: "menu";
-    text: string;
+    text: string | null;
     selected: string;
 };
 export type GameHistory = GameHistoryAction & {

package/dist/game/nlcore/action/logicAction.d.ts

@@ -32,6 +32,15 @@ import { LayerAction } from "../action/actions/layerAction";
 import { ExposedStateType } from "../../player/type";
 import { Video } from "../elements/video";
 import { VideoAction } from "../action/actions/videoAction";
+export interface LogicActionInterface {
+    DisplayableElements: Text | Image | Layer | AbstractDisplayable<any, any>;
+    DisplayableExposed: ExposedStateType.image | ExposedStateType.layer | ExposedStateType.text;
+    GameElement: Character | Scene | Story | Image | Condition | Script | Menu | Sound | Control | Text | AbstractDisplayable<any, any> | Persistent<any> | ServiceSkeleton | Video;
+    Actions: TypedAction | CharacterAction | ConditionAction | ImageAction | SceneAction | ScriptAction | StoryAction | MenuAction | SoundAction | ControlAction | TextAction | DisplayableAction | PersistentAction | ServiceAction | LayerAction | VideoAction;
+    ActionTypes: Values<typeof CharacterActionTypes> | Values<typeof ConditionActionTypes> | Values<typeof ImageActionTypes> | Values<typeof SceneActionTypes> | Values<typeof ScriptActionTypes> | Values<typeof StoryActionTypes> | Values<typeof MenuActionTypes> | Values<typeof SoundAction.ActionTypes> | Values<typeof ControlAction.ActionTypes> | Values<typeof TextAction.ActionTypes> | Values<typeof DisplayableActionTypes> | Values<typeof PersistentActionTypes> | StringKeyOf<ServiceActionContentType> | Values<typeof LayerActionTypes> | Values<typeof VideoActionTypes>;
+    ActionContents: CharacterActionContentType & ConditionActionContentType & ImageActionContentType & SceneActionContentType & ScriptActionContentType & StoryActionContentType & MenuActionContentType & SoundActionContentType & ControlActionContentType & TextActionContentType & DisplayableActionContentType & PersistentActionContentType & ServiceActionContentType & LayerActionContentType & VideoActionContentType;
+}
+export declare const LogicAction: {};
 export declare namespace LogicAction {
     type DisplayableElements = Text | Image | Layer | AbstractDisplayable<any, any>;
     type DisplayableExposed = ExposedStateType.image | ExposedStateType.layer | ExposedStateType.text;
@@ -40,3 +49,4 @@ export declare namespace LogicAction {
     type ActionTypes = Values<typeof CharacterActionTypes> | Values<typeof ConditionActionTypes> | Values<typeof ImageActionTypes> | Values<typeof SceneActionTypes> | Values<typeof ScriptActionTypes> | Values<typeof StoryActionTypes> | Values<typeof MenuActionTypes> | Values<typeof SoundAction.ActionTypes> | Values<typeof ControlAction.ActionTypes> | Values<typeof TextAction.ActionTypes> | Values<typeof DisplayableActionTypes> | Values<typeof PersistentActionTypes> | StringKeyOf<ServiceActionContentType> | Values<typeof LayerActionTypes> | Values<typeof VideoActionTypes>;
     type ActionContents = CharacterActionContentType & ConditionActionContentType & ImageActionContentType & SceneActionContentType & ScriptActionContentType & StoryActionContentType & MenuActionContentType & SoundActionContentType & ControlActionContentType & TextActionContentType & DisplayableActionContentType & PersistentActionContentType & ServiceActionContentType & LayerActionContentType & VideoActionContentType;
 }
+export type LogicAction = typeof LogicAction;

package/dist/game/nlcore/elements/character/sentence.d.ts

@@ -1,9 +1,9 @@
-import { Sound } from "../../elements/sound";
 import type { Character } from "../../elements/character";
+import { Pausing } from "../../elements/character/pause";
 import { Word } from "../../elements/character/word";
-import { Color, Font } from "../../types";
 import type { ScriptCtx } from "../../elements/script";
-import { Pausing } from "../../elements/character/pause";
+import { Sound } from "../../elements/sound";
+import { Color, Font } from "../../types";
 export type SentenceConfig = {
     pause?: boolean | number;
     voice: Sound | null;

package/dist/game/nlcore/elements/menu.d.ts

@@ -13,7 +13,7 @@ export type Choice = {
     prompt: Sentence;
 };
 export type MenuData = {
-    prompt: Sentence;
+    prompt: Sentence | null;
     choices: Choice[];
 };
 export declare class Menu extends Actionable<any, Menu> {
@@ -23,9 +23,11 @@ export declare class Menu extends Actionable<any, Menu> {
      * @returns A new menu
      */
     static prompt(prompt: SentencePrompt | Sentence, config?: MenuConfig): Menu;
+    static choose(arg0: Sentence | MenuChoice | SentencePrompt, arg1?: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
     constructor(prompt: SentencePrompt, config?: MenuConfig);
     constructor(prompt: Sentence, config?: MenuConfig);
     constructor(prompt: SentencePrompt | Sentence, config: MenuConfig);
+    constructor(prompt: null, config?: MenuConfig);
     /**
      * Add a choice to the menu
      * @example
@@ -37,4 +39,5 @@ export declare class Menu extends Actionable<any, Menu> {
     choose(choice: MenuChoice): Proxied<Menu, Chained<LogicAction.Actions>>;
     choose(prompt: Sentence, action: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
     choose(prompt: SentencePrompt, action: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
+    choose(arg0: Sentence | MenuChoice | SentencePrompt, arg1?: ChainedActions): Proxied<Menu, Chained<LogicAction.Actions>>;
 }

package/dist/game/nlcore/gameTypes.d.ts

@@ -317,6 +317,11 @@ export type GameConfig = {
      * @default null
      */
     stage: React.ReactNode | null;
+    /**
+     * The default color for the menu choices
+     * @default "#000"
+     */
+    defaultMenuChoiceColor: Color;
 };
 export type GameSettings = {
     volume: number;

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

@@ -1,5 +1,4 @@
 import "client-only";
-import "@player/lib/styles/style.css";
 import { PlayerProps } from "../elements/type";
 import React from "react";
 export default function Player({ story, width, height, className, onReady, onEnd, children, active, }: Readonly<PlayerProps>): React.JSX.Element;

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

@@ -5,11 +5,11 @@ import { Word } from "../../../nlcore/elements/character/word";
 import { Pausing } from "../../../nlcore/elements/character/pause";
 import { Chosen } from "../../type";
 export interface MenuElementProps {
-    prompt: Sentence;
+    prompt: Sentence | null;
     choices: Choice[];
     afterChoose: (choice: Chosen) => void;
     state: GameState;
-    words: Word<Pausing | string>[];
+    words: Word<Pausing | string>[] | null;
 }
 export interface IUserMenuProps {
     items: number[];

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

@@ -1,27 +1,11 @@
-import React from "react";
 import { DialogProps } from "../../elements/say/type";
-import { GameState } from "../../../nlcore/common/game";
-import { Sentence } from "../../../nlcore/elements/character/sentence";
-import { Word } from "../../../nlcore/elements/character/word";
-import { Pausing } from "../../../nlcore/elements/character/pause";
-/**
- * Props-based wrapper component
- * Provides a clean interface for direct prop usage
- */
-export interface RawDialogProps extends Omit<DialogProps, "onClick"> {
-    sentence: Sentence;
-    words: Word<Pausing | string>[];
-    gameState: GameState;
-    useTypeEffect?: boolean;
-    onClick?: (skiped?: boolean) => void;
-    onFinished?: () => void;
-}
-export declare function RawDialog(props: RawDialogProps): React.JSX.Element;
+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;
+export declare function Dialog({ children, ...props }: DialogProps): React.JSX.Element | null;
 export default Dialog;
 /**
  * Default dialog component with Texts as children

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

@@ -1,9 +1,20 @@
-import React from "react";
-import { Word } from "../../../nlcore/elements/character/word";
 import { Pausing } from "../../../nlcore/elements/character/pause";
-import { DialogElementProps } from "./type";
-import { GameState } from "../../../../game/nlcore/common/game";
 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
@@ -17,10 +28,10 @@ export interface TextsProps extends DialogElementProps {
     count?: number;
     words?: Word<Pausing | string>[];
 }
-export declare function RawTexts(props: TextsProps): React.JSX.Element;
+export declare function RawTexts(props: BaseTextsProps): React.JSX.Element;
 /**
  * Context-based wrapper component
  * Provides integration with the sentence context
  */
-export declare function Texts(props: DialogElementProps): React.JSX.Element;
+export declare function Texts(props: BaseTextsProps): React.JSX.Element;
 export default Texts;

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

@@ -1,3 +1,65 @@
+import { Pausing } from "../../../nlcore/elements/character/pause";
+import { Word } from "../../../nlcore/elements/character/word";
+import { GameState } from "../../../../game/nlcore/common/game";
+import { EventDispatcher } from "../../../../util/data";
 import React from "react";
-import { PlayerDialogProps } from "./type";
-export default function PlayerDialog({ action, onClick, useTypeEffect, gameState, }: Readonly<PlayerDialogProps>): React.JSX.Element;
+import { DialogAction, DialogStateType, SayElementProps } from "./type";
+type DialogEvents = {
+    "event:dialog.requestComplete": [];
+    "event:dialog.complete": [];
+    "event:dialog.forceSkip": [];
+};
+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";
+    };
+    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(): void;
+    emitComplete(): void;
+    isEnded(): boolean;
+    setPause(pause: boolean): void;
+    isForceSkipped(): boolean;
+    tryScheduleAutoForward(): void;
+    cancelAutoForward(): void;
+    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,19 +1,4 @@
-import { GameState } from "../../../../game/nlcore/common/game";
-import { SayElementProps } from "./type";
 import React from "react";
-import { Sentence } from "../../../nlcore/elements/character/sentence";
-import { Word } from "../../../nlcore/elements/character/word";
-import { Pausing } from "../../../nlcore/elements/character/pause";
-export declare const SayContext: React.Context<SayElementProps | null>;
-export declare function useSayContext(): SayElementProps;
-export interface SentenceContext {
-    sentence: Sentence;
-    gameState: GameState;
-    finished: boolean;
-    useTypeEffect: boolean;
-    onCompleted?: () => void;
-    count: number;
-    words: Word<Pausing | string>[];
-}
-export declare const SentenceContext: React.Context<SentenceContext | null>;
-export declare function useSentenceContext(): SentenceContext;
+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

@@ -6,23 +6,21 @@ import { Pausing } from "../../../nlcore/elements/character/pause";
 import React from "react";
 export interface SayElementProps {
     action: {
-        sentence: Sentence;
+        sentence: Sentence | null;
         character: Character | null;
-        words: Word<Pausing | string>[];
+        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?: () => void;
+    onFinished?: (skiped?: boolean) => void;
     useTypeEffect?: boolean;
     gameState: GameState;
 }
-export interface PlayerDialogProps extends SayElementProps {
-    onFinished?: () => void;
-}
 export interface IDialogProps {
-    isFinished: boolean;
 }
 export type DialogProps = {
     children: React.ReactNode;
@@ -33,3 +31,23 @@ export type DialogElementProps = {
 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/gameState.d.ts

@@ -125,7 +125,7 @@ export declare class GameState {
         text: string;
     };
     createMenu(menu: MenuData, afterChoose?: (choice: Chosen) => void, scene?: Scene): LiveGameEventToken & {
-        prompt: string;
+        prompt: null | string;
     };
     createDisplayable(displayable: LogicAction.DisplayableElements, scene?: Scene | null, layer?: Layer | null): this;
     disposeDisplayable(displayable: LogicAction.DisplayableElements, scene?: Scene | null, layer?: Layer | null): this;

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./game/nlcore/common/core";
 export * from "./game/nlcore/common/player";
+import "./styles/index.css";