narraleaf-react 0.0.1-beta.1 → 0.0.1-beta.10

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

@@ -1,13 +1,5 @@
 import "client-only";
 import "@player/lib/styles/style.css";
-import clsx from "clsx";
 import React from "react";
-import { Story } from "../../nlcore/elements/story";
-import { Game } from "../../nlcore/game";
-export default function Player({ story, onReady, width, height, className, }: Readonly<{
-    story: Story;
-    onReady?: (game: Game) => void;
-    width?: string | number;
-    height?: string | number;
-    className?: clsx.ClassValue;
-}>): React.JSX.Element;
+import { PlayerProps } from "../elements/type";
+export default function Player({ story, width, height, className, onReady, onEnd, }: Readonly<PlayerProps>): React.JSX.Element;

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

@@ -0,0 +1,6 @@
+import { default as StageSay } from "../elements/say/Say";
+import { default as StageMenu } from "../elements/menu/Menu";
+export declare const DefaultElements: {
+    readonly say: typeof StageSay;
+    readonly menu: typeof StageMenu;
+};

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

@@ -1,8 +1,3 @@
 import React from "react";
-import { Choice } from "../../../nlcore/elements/menu";
-import { Sentence } from "../../../nlcore/elements/text";
-export default function Menu({ prompt, choices, afterChoose, }: Readonly<{
-    prompt: Sentence;
-    choices: Choice[];
-    afterChoose: (choice: Choice) => void;
-}>): React.JSX.Element;
+import { MenuElementProps } from "../../elements/menu/type";
+export default function Menu({ prompt, choices, afterChoose, state, }: Readonly<MenuElementProps>): React.JSX.Element;

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

@@ -1,5 +1,6 @@
 import React from "react";
 import { Sentence } from "../../../nlcore/elements/text";
-export default function ColoredSentence({ sentence, }: Readonly<{
+export default function ColoredSentence({ sentence, className, }: Readonly<{
     sentence: Sentence;
+    className?: string;
 }>): React.JSX.Element;

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

@@ -0,0 +1,9 @@
+import type { Sentence } from "../../../nlcore/elements/text";
+import type { Choice } from "../../../nlcore/elements/menu";
+import type { GameState } from "../../gameState";
+export interface MenuElementProps {
+    prompt: Sentence;
+    choices: Choice[];
+    afterChoose: (choice: Choice) => void;
+    state: GameState;
+}

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

@@ -0,0 +1,5 @@
+import React from "react";
+import { GameState } from "../../gameState";
+export declare function KeyEventAnnouncer({ state }: Readonly<{
+    state: GameState;
+}>): React.JSX.Element;

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

@@ -1,10 +1,3 @@
-import { Sentence } from "../../../nlcore/elements/text";
 import React from "react";
-export default function Say({ action, onClick, useTypeEffect, className, }: Readonly<{
-    action: {
-        sentence: Sentence;
-    };
-    onClick?: () => void;
-    useTypeEffect?: boolean;
-    className?: string;
-}>): React.JSX.Element;
+import { SayElementProps } from "../../elements/say/type";
+export default function Say({ action, onClick, useTypeEffect, className, state, }: Readonly<SayElementProps>): React.JSX.Element;

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

@@ -3,6 +3,7 @@ interface TypingEffectProps {
     text: string;
     speed: number;
     onComplete?: () => void;
+    className?: string;
 }
 declare const TypingEffect: React.FC<TypingEffectProps>;
 export default TypingEffect;

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

@@ -0,0 +1,15 @@
+import type { Character, Sentence } from "../../../nlcore/elements/text";
+import type { GameState } from "../../gameState";
+export interface SayElementProps {
+    action: {
+        sentence: Sentence;
+        character: Character | null;
+    };
+    /**
+     * Callback function to be called when player triggers the next action
+     */
+    onClick?: () => void;
+    useTypeEffect?: boolean;
+    className?: string;
+    state: GameState;
+}

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

@@ -1,5 +1,5 @@
-import React from "react";
 import type { ReactNode } from "react";
+import React from "react";
 export default function Background({ children }: Readonly<{
     children: ReactNode;
 }>): React.JSX.Element;

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

@@ -0,0 +1,37 @@
+import React from "react";
+import { SayElementProps } from "../elements/say/type";
+import { MenuElementProps } from "../elements/menu/type";
+import { Story } from "../../nlcore/elements/story";
+import clsx from "clsx";
+import { Game } from "../../nlcore/game";
+import { GameState } from "../gameState";
+export type Components<T extends Record<string, any>> = (props: Readonly<T>) => React.JSX.Element;
+export type SayComponent = Components<SayElementProps>;
+export type MenuComponent = Components<MenuElementProps>;
+export type ComponentsTypes = {
+    say: SayComponent;
+    menu: MenuComponent;
+};
+export type { SayElementProps, MenuElementProps, };
+export type PlayerEventContext = {
+    game: Game;
+    state: GameState;
+};
+export interface PlayerProps {
+    story: Story;
+    width?: string | number;
+    height?: string | number;
+    className?: clsx.ClassValue;
+    /**
+     * Once the game is ready to be played
+     *
+     * only called once each lifecycle
+     */
+    onReady?: (ctx: PlayerEventContext) => void;
+    /**
+     * Once the game is ended
+     *
+     * only called once each lifecycle
+     */
+    onEnd?: (ctx: PlayerEventContext) => void;
+}

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

@@ -1,6 +1,6 @@
-import { CalledActionResult } from "@core/gameTypes";
-import { EventDispatcher } from "../../util/data";
-import { Character, Sentence } from "../nlcore/elements/text";
+import { CalledActionResult } from "../nlcore/gameTypes";
+import { EventDispatcher, Logger } from "../../util/data";
+import { Sentence } from "../nlcore/elements/text";
 import { Choice, MenuData } from "../nlcore/elements/menu";
 import { Image, ImageEventTypes } from "../nlcore/elements/image";
 import { Scene } from "../nlcore/elements/scene";
@@ -10,19 +10,7 @@ import { SrcManager } from "../nlcore/elements/srcManager";
 import { LogicAction } from "../nlcore/action/logicAction";
 import { Storable } from "../nlcore/store/storable";
 import { Game } from "../nlcore/game";
-type Clickable<T, U = undefined> = {
-    action: T;
-    onClick: U extends undefined ? () => void : (arg0: U) => void;
-};
-type TextElement = {
-    character: Character | null;
-    sentence: Sentence;
-    id: string;
-};
-type MenuElement = {
-    prompt: Sentence;
-    choices: Choice[];
-};
+import { Clickable, MenuElement, TextElement } from "./gameState.type";
 type PlayerStateElement = {
     texts: Clickable<TextElement>[];
     menus: Clickable<MenuElement, Choice>[];
@@ -52,6 +40,8 @@ interface StageUtils {
 }
 type GameStateEvents = {
     "event:state.ready": [];
+    "event:state.end": [];
+    "event:state.player.skip": [];
 };
 export declare class GameState {
     static EventTypes: {
@@ -62,6 +52,7 @@ export declare class GameState {
     stage: StageUtils;
     game: Game;
     readonly events: EventDispatcher<GameStateEvents>;
+    readonly logger: Logger;
     constructor(game: Game, stage: StageUtils);
     findElementByScene(scene: Scene): {
         scene: Scene;

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

@@ -0,0 +1,15 @@
+import { Character, Sentence } from "../nlcore/elements/text";
+import { Choice } from "../nlcore/elements/menu";
+export type Clickable<T, U = undefined> = {
+    action: T;
+    onClick: U extends undefined ? () => void : (arg0: U) => void;
+};
+export type TextElement = {
+    character: Character | null;
+    sentence: Sentence;
+    id: string;
+};
+export type MenuElement = {
+    prompt: Sentence;
+    choices: Choice[];
+};

package/dist/game/player/lib/{main.d.ts → AspectRatio.d.ts}

@@ -1,5 +1,5 @@
 import React from "react";
-export default function Main({ children, className }: {
+export default function AspectRatio({ children, className }: {
     children: React.ReactNode;
     className?: string;
 }): React.JSX.Element;

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

@@ -0,0 +1,4 @@
+import React from "react";
+export default function Motion({ children }: Readonly<{
+    children: React.ReactNode;
+}>): React.JSX.Element;

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

@@ -1,5 +1,4 @@
-import type { ReactNode } from "react";
-import React from "react";
+import React, { ReactNode } from "react";
 export default function Isolated({ children, className }: Readonly<{
     children: ReactNode;
     className?: string;

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

@@ -0,0 +1,4 @@
+import Isolated from "./lib/isolated";
+import Say from "./elements/say/Say";
+import ColoredSentence from "./elements/menu/Sentence";
+export { Isolated, Say, ColoredSentence, };

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

@@ -8,5 +8,9 @@ export declare function GameProvider({ children, game }: {
     children?: ReactNode;
     game?: Game;
 }): React.JSX.Element;
+/**
+ * use {@link Game} context
+ * @returns {GameContextType}
+ */
 export declare function useGame(): GameContextType;
 export {};

package/dist/game/player/provider/providers.d.ts

@@ -1,5 +1,7 @@
 import "client-only";
 import React from "react";
-export default function GameProviders({ children }: Readonly<{
+import { Game } from "../../nlcore/game";
+export default function GameProviders({ children, game }: Readonly<{
     children?: React.ReactNode;
+    game?: Game;
 }>): React.JSX.Element;

package/dist/game/player/provider/ratio.d.ts

@@ -1,23 +1,47 @@
 import React from "react";
-type Ratio = {
-    w: number;
-    h: number;
-    updateStyle: () => void;
-    style: React.CSSProperties;
-    s: {
-        style: React.CSSProperties;
-    };
-    min: {
-        w: number;
-        h: number;
-    };
+import { EventDispatcher } from "../../../util/data";
+export type AspectRatioState = {
+    width: number;
+    height: number;
+    minWidth: number;
+    minHeight: number;
+    paused: boolean;
 };
-type ThemeContextType = {
-    ratio: Ratio;
-    setRatio: (ratio: Ratio) => void;
+type AspectRatioEvents = {
+    "event:aspectRatio.update": [width: number, height: number];
+    "event:aspectRatio.pause": [];
+    "event:aspectRatio.resume": [];
 };
-export declare function AspectRatioProvider({ children }: {
+declare class AspectRatio {
+    static EventTypes: {
+        [K in keyof AspectRatioEvents]: K;
+    };
+    state: AspectRatioState;
+    readonly events: EventDispatcher<AspectRatioEvents, AspectRatioEvents & {
+        "event:EventDispatcher.register": [string | number, import("../../../util/data").EventListener<any>];
+    }>;
+    private lockers;
+    private updater;
+    constructor();
+    update(width: number, height: number): void;
+    updateMin(width: number, height: number): void;
+    lock(): symbol;
+    unlock(locker: symbol | null | undefined): null;
+    isLocked(): boolean;
+    getStyle(): {
+        width: string;
+        height: string;
+    };
+    setUpdate(updater: () => void): void;
+    pause(): void;
+    resume(): void;
+    onUpdate(callback: (width: number, height: number) => void): () => void;
+    private triggerUpdate;
+}
+export declare function RatioProvider({ children }: {
     children: React.ReactNode;
 }): React.JSX.Element;
-export declare function useAspectRatio(): ThemeContextType;
+export declare function useRatio(): {
+    ratio: AspectRatio;
+};
 export {};

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

@@ -0,0 +1 @@
+export * from "./elements/type";