narraleaf-react 0.0.1-beta.4 → 0.0.1-beta.5

package/README.md

@@ -102,6 +102,9 @@ export default nextConfig;
 
 ## Documentation
 
+- [Quick Start](./docs/quick-start.md)  
+- [Customization](./docs/customization.md)
+
 in progress...
 
 ## License

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

@@ -79,15 +79,17 @@ export declare const SoundActionTypes: {
     readonly fade: "sound:fade";
     readonly setVolume: "sound:setVolume";
     readonly setRate: "sound:setRate";
+    readonly pause: "sound:pause";
+    readonly resume: "sound:resume";
 };
 export type SoundActionContentType = {
     [K in typeof SoundActionTypes[keyof typeof SoundActionTypes]]: K extends "sound:play" ? [void] : K extends "sound:stop" ? [void] : K extends "sound:fade" ? [
         {
-            start: number;
+            start?: number;
             end: number;
             duration: number;
         }
-    ] : K extends "sound:setVolume" ? [number] : K extends "sound:setRate" ? [number] : any;
+    ] : K extends "sound:setVolume" ? [number] : K extends "sound:setRate" ? [number] : K extends "sound:pause" ? [void] : K extends "sound:resume" ? [void] : any;
 };
 export declare const ControlActionTypes: {
     readonly action: "control:action";

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

@@ -97,6 +97,8 @@ export declare class SoundAction<T extends typeof SoundActionTypes[keyof typeof
         readonly fade: "sound:fade";
         readonly setVolume: "sound:setVolume";
         readonly setRate: "sound:setRate";
+        readonly pause: "sound:pause";
+        readonly resume: "sound:resume";
     };
     static initSound(state: GameState, sound: Sound): void;
     executeAction(state: GameState): CalledActionResult | Awaitable<CalledActionResult, any>;

package/dist/game/nlcore/common/player.d.ts

@@ -1,4 +1,7 @@
 import Player from "../../player/elements/Player";
 import GameProviders from "../../player/provider/providers";
 import { GameState } from "../../player/gameState";
-export { GameProviders, Player, GameState, };
+import { useGame } from "../../../game/player/provider/game-state";
+export * from "../../player/type";
+export * from "../../player/libElements";
+export { GameProviders, Player, useGame, GameState, };

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

@@ -1,12 +1,12 @@
-import { CommonImage, NextJSStaticImageData, StaticImageData } from "../types";
-import { DeepPartial, EventDispatcher } from "../../../util/data";
-import { Transform } from "./transform/transform";
-import { ImageAction } from "../action/actions";
-import { Actionable } from "../action/actionable";
-import type { TransformDefinitions } from "../elements/transform/type";
 import React from "react";
+import type { TransformDefinitions } from "../elements/transform/type";
 import { AnimationScope } from "framer-motion";
+import { ImageAction } from "../action/actions";
+import { Actionable } from "../action/actionable";
+import { Transform } from "./transform/transform";
+import { CommonImage, NextJSStaticImageData, StaticImageData } from "../types";
 import { ITransition } from "../elements/transition/type";
+import { DeepPartial, EventDispatcher } from "../../../util/data";
 export type ImageConfig = {
     src: string | NextJSStaticImageData;
     display: boolean;

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

@@ -42,9 +42,11 @@ export declare class Sound extends Actionable<SoundDataRaw> {
     constructor(config?: DeepPartial<SoundConfig>);
     play(): this;
     stop(): this;
-    fade(start: number, end: number, duration: number): this;
+    fade(start: number | undefined, end: number, duration: number): this;
     setVolume(volume: number): this;
     setRate(rate: number): this;
+    pause(fade?: number): this;
+    resume(fade?: number): this;
     getHowlOptions(): HowlOptions;
     getSrc(): string;
     $setToken(token: any): void;

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

@@ -4,6 +4,7 @@ import { Storable } from "./store/storable";
 import { Story } from "./elements/story";
 import { LogicAction } from "./action/logicAction";
 import { GameState } from "../player/gameState";
+import { ComponentsTypes } from "../player/elements/type";
 declare const IdManager_base: {
     new (): {};
     _instance: {} | null;
@@ -26,6 +27,9 @@ declare enum GameSettingsNamespace {
 }
 export declare class Game {
     static defaultSettings: GameSettings;
+    static ComponentTypes: {
+        [K in keyof ComponentsTypes]: K;
+    };
     static DefaultConfig: GameConfig;
     static GameSettingsNamespace: typeof GameSettingsNamespace;
     readonly config: Readonly<GameConfig>;
@@ -36,6 +40,7 @@ export declare class Game {
      */
     constructor(config: DeepPartial<GameConfig>);
     static getIdManager(): IdManager;
+    useComponent<T extends keyof ComponentsTypes>(key: T, components: ComponentsTypes[T]): this;
     getLiveGame(): LiveGame;
     private createLiveGame;
 }

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

@@ -40,7 +40,8 @@ export type CommonImage = {
     scale?: number;
     rotation?: number;
     position?: IPosition;
-    opacity: number;
+    opacity?: number;
+    alt?: string;
 };
 export declare const ImagePosition: {
     [K in CommonImagePosition]: K;

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/say/type.d.ts

@@ -3,6 +3,9 @@ export interface SayElementProps {
     action: {
         sentence: Sentence;
     };
+    /**
+     * Callback function to be called when player triggers the next action
+     */
     onClick?: () => void;
     useTypeEffect?: boolean;
     className?: string;

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

@@ -1,6 +1,32 @@
 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";
 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 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?: (game: Game) => void;
+    /**
+     * Once the game is ended
+     *
+     * only called once each lifecycle
+     */
+    onEnd?: (game: Game) => void;
+}

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

@@ -40,6 +40,7 @@ interface StageUtils {
 }
 type GameStateEvents = {
     "event:state.ready": [];
+    "event:state.end": [];
 };
 export declare class GameState {
     static EventTypes: {

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/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/type.d.ts

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