narraleaf-react 0.6.0 → 0.7.0

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

@@ -5,4 +5,4 @@ export * from "./player";
 export * from "./types";
 export * from "./position";
 export * from "./transition";
-export { i, c, b, };
+export { i, c, b };

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

@@ -4,5 +4,6 @@ import { Storable, Namespace } from "../elements/persistent/storable";
 import { LiveGame } from "../game/liveGame";
 import { Preference } from "../game/preference";
 import type { SavedGame } from "../gameTypes";
-export { LiveGame, GameState, Game, Storable, Namespace, Preference, };
+import { KeyMap } from "../game/keyMap";
+export { LiveGame, GameState, Game, Storable, Namespace, Preference, KeyMap, };
 export type { SavedGame, };

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

@@ -2,6 +2,8 @@ import Player from "../../player/elements/Player";
 import GameProviders from "../../player/provider/providers";
 import { useGame } from "../../../game/player/provider/game-state";
 import { useRouter } from "../../player/lib/PageRouter/router";
+import { usePathname, useParams, useQueryParams } from "../../player/lib/PageRouter/routerHooks";
 export * from "../../player/type";
 export * from "../../player/libElements";
-export { GameProviders, Player, useGame, useRouter, };
+export { GameProviders, Player, useGame, useRouter, usePathname, useParams, useQueryParams, };
+export { PresenceContext } from "motion/react";

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

@@ -5,5 +5,9 @@ import { IGamePluginRegistry } from "../game/plugin/plugin";
 import { LiveGameEventToken } from "../types";
 import { GameHistory } from "../action/gameHistory";
 import { GameConfig, SavedGame, NotificationToken, SavedGameMetaData } from "../gameTypes";
+import type { LayoutRouter } from "../../../game/player/lib/PageRouter/router";
+import { KeyBindingType, WebKeyboardKey } from "../game/types";
+import { KeyBindingValue } from "../game/keyMap";
 export * from "../elements/type";
-export type { GameHistory, IGamePluginRegistry, LiveGameEventToken, Origins, ServiceHandlerCtx, TransformDefinitions, GameConfig, SavedGame, NotificationToken, SavedGameMetaData, };
+export type { GameHistory, IGamePluginRegistry, LiveGameEventToken, Origins, ServiceHandlerCtx, TransformDefinitions, GameConfig, SavedGame, NotificationToken, SavedGameMetaData, LayoutRouter, KeyBindingValue, WebKeyboardKey, };
+export { KeyBindingType, };

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

@@ -0,0 +1,82 @@
+import { EventDispatcher } from "../../../util/data";
+import { KeyBindingType, WebKeyboardKey } from "./types";
+export type KeyBindingValue = WebKeyboardKey[] | WebKeyboardKey | null;
+export declare class KeyMap {
+    private keyMap;
+    readonly events: EventDispatcher<{
+        "event:keyMap.change": [KeyBindingType | string, KeyBindingValue];
+    }>;
+    constructor(keyMap?: Record<KeyBindingType | string, KeyBindingValue>);
+    /**
+     * Set a key binding (case-insensitive)
+     * @param type - The type of key binding
+     * @param value - The value of the key binding
+     *
+     * @example
+     * ```ts
+     * // Set the skip action to the space key
+     * game.keyMap.setKeyBinding(KeyBindingType.skipAction, " ");
+     *
+     * // Press either Control or F3 to skip the action
+     * game.keyMap.setKeyBinding(KeyBindingType.skipAction, ["Control", "F3"]);
+     *
+     * // Remove the key binding
+     * game.keyMap.setKeyBinding(KeyBindingType.skipAction, null);
+     * ```
+     */
+    setKeyBinding(type: KeyBindingType | string, value: KeyBindingValue): void;
+    /**
+     * Get a key binding
+     * @param type - The type of key binding
+     * @returns The value of the key binding
+     *
+     * @example
+     * ```ts
+     * const skipKeyBinding = game.keyMap.getKeyBinding(KeyBindingType.skipAction);
+     * // ["Control"]
+     * ```
+     */
+    getKeyBinding(type: KeyBindingType | string): KeyBindingValue;
+    /**
+     * Add a key binding (case-insensitive)
+     * @param type - The type of key binding
+     * @param value - The value of the key binding
+     *
+     * @example
+     * ```ts
+     * game.keyMap.addKeyBinding(KeyBindingType.skipAction, "F3");
+     * // Now you can press F3 to skip the action
+     *
+     * // equivalent to
+     * const currentKeyBinding = game.keyMap.getKeyBinding(KeyBindingType.skipAction);
+     * game.keyMap.setKeyBinding(
+     *  KeyBindingType.skipAction,
+     *  [
+     *      ...(Array.isArray(currentKeyBinding) ? currentKeyBinding :
+     *          currentKeyBinding !== null ? [currentKeyBinding] : []),
+     *      "F3"
+     *  ]
+     * );
+     * ```
+     */
+    addKeyBinding(type: KeyBindingType | string, value: KeyBindingValue): void;
+    getKeyBindings(): Record<KeyBindingType | string, KeyBindingValue>;
+    onKeyBindingChange(type: KeyBindingType | string, listener: (value: KeyBindingValue) => void): import("../../../util/data").EventToken<import("../../../util/data").EventTypes>;
+    importKeyBindings(keyBindings: Record<KeyBindingType | string, KeyBindingValue>): void;
+    exportKeyBindings(): Record<KeyBindingType | string, KeyBindingValue>;
+    /**
+     * Check if a key matches a key binding (case-insensitive)
+     * @param type - The type of key binding
+     * @param key - The key to check
+     * @returns True if the key matches the key binding, false otherwise
+     *
+     * @example
+     * ```ts
+     * // if the skip action is set to [" ", "F3"]
+     * game.keyMap.match(KeyBindingType.skipAction, " "); // true
+     * game.keyMap.match(KeyBindingType.skipAction, "F3"); // true
+     * game.keyMap.match(KeyBindingType.skipAction, "A"); // false
+     * ```
+     */
+    match(type: KeyBindingType | string, key: WebKeyboardKey): boolean;
+}

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

@@ -0,0 +1,22 @@
+/**
+ * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
+ *
+ * Case-insensitive
+ */
+export type WebKeyboardKey = string;
+export declare enum KeyBindingType {
+    /**
+     * When the player presses one of these keys, the game will show the next sentence
+     *
+     * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
+     * @default [" "]
+     */
+    skipAction = "skipAction",
+    /**
+     * When the player presses one of these keys, the game will skip the current action
+     *
+     * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
+     * @default ["Control"]
+     */
+    nextAction = "nextAction"
+}

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

@@ -4,6 +4,8 @@ import { LogicAction } from "./action/logicAction";
 import { LiveGame } from "./game/liveGame";
 import { Preference } from "./game/preference";
 import { Plugins, IGamePluginRegistry } from "./game/plugin/plugin";
+import { LayoutRouter } from "../player/lib/PageRouter/router";
+import { KeyMap } from "./game/keyMap";
 declare enum GameSettingsNamespace {
     game = "game"
 }
@@ -31,10 +33,15 @@ export declare class Game {
      * Game settings
      */
     preference: Preference<GamePreference>;
+    /**
+     * Game key bindings
+     */
+    keyMap: KeyMap;
     /**
      * Plugin registry
      */
     plugins: Plugins;
+    router: LayoutRouter;
     /**
      * Create a new game
      * @param config - Game configuration

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

@@ -87,13 +87,6 @@ export type GameConfig = {
      * @default 1080
      */
     height: number;
-    /**
-     * When the player presses one of these keys, the game will skip the current action
-     *
-     * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
-     * @default ["Control"]
-     */
-    skipKey: React.KeyboardEvent["key"][];
     /**
      * If true, the game will listen to the window events instead of the player element
      *
@@ -173,13 +166,6 @@ export type GameConfig = {
      * @default 1
      */
     screenshotQuality: number;
-    /**
-     * When the player presses one of these keys, the game will show the next sentence
-     *
-     * See [Key_Values](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values)
-     * @default [" "]
-     */
-    nextKey: React.KeyboardEvent["key"][];
     /**
      * If true, the game will scale the dialog to fit the screen
      *
@@ -231,6 +217,13 @@ export type GameConfig = {
      * @default true
      */
     allowSkipTextTransition: boolean;
+    /**
+     * If true, the animation will propagate to the children
+     *
+     * This behavior is controlled by [motion](https://motion.dev): `When true, exit animations will be propagated to nested AnimatePresence components.`
+     * @default true
+     */
+    animationPropagate: boolean;
     /**
      * Base width of the dialog in pixels
      *

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

@@ -1,4 +1,4 @@
 import "client-only";
 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;
+export default function Player({ story, width, height, className, onReady, onEnd, onError, children, active, }: Readonly<PlayerProps>): React.JSX.Element;

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

@@ -1,4 +1,4 @@
-import React from "react";
+import React, { ErrorInfo } from "react";
 import { IDialogProps, SayElementProps } from "../elements/say/type";
 import { IUserMenuProps, MenuElementProps } from "../elements/menu/type";
 import { Story } from "../../nlcore/elements/story";
@@ -41,6 +41,12 @@ export interface PlayerProps {
      * only called each lifecycle once
      */
     onEnd?: (ctx: PlayerEventContext) => void;
+    /**
+     * Once the game encounters an error
+     *
+     * only called each lifecycle once
+     */
+    onError?: (error: Error, errorInfo: ErrorInfo) => void;
     children?: React.ReactNode;
     /**
      * Whether to show the player

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

@@ -24,7 +24,6 @@ import { Timelines } from "./Tasks";
 import { Notification, NotificationManager } from "./lib/notification";
 import { ActionHistoryManager } from "../../game/nlcore/action/actionHistory";
 import { GameHistoryManager } from "../../game/nlcore/action/gameHistory";
-import { Router } from "./lib/PageRouter/router";
 type Legacy_PlayerStateElement = {
     texts: Clickable<TextElement>[];
     menus: Clickable<MenuElement, Chosen>[];
@@ -105,7 +104,7 @@ export declare class GameState {
     readonly idManager: IdManager;
     readonly actionHistory: ActionHistoryManager;
     readonly gameHistory: GameHistoryManager;
-    pageRouter: Router | null;
+    pageRouter: null;
     constructor(game: Game, stage: StageUtils);
     get deps(): number;
     addVideo(video: Video): this;

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

@@ -1,6 +1,7 @@
 import React, { ErrorInfo, ReactNode } from "react";
 interface ErrorBoundaryProps {
     children: ReactNode;
+    onError?: (error: Error, errorInfo: ErrorInfo) => void;
 }
 interface ErrorBoundaryState {
     hasError: boolean;

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

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

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

@@ -0,0 +1,48 @@
+import React from "react";
+import { LayoutRouter } from "./router";
+type LayoutContextType = {
+    router: LayoutRouter;
+    path: string | null;
+    consumedBy?: string;
+};
+type LayoutContextProviderProps = {
+    children: React.ReactNode;
+    path: string | null;
+    consumedBy?: string;
+};
+export declare function LayoutRouterProvider({ children, path, consumedBy }: LayoutContextProviderProps): React.JSX.Element;
+export declare function useLayout(): Omit<LayoutContextType, "path"> & {
+    path: string;
+};
+export type LayoutProps = {
+    children: React.ReactNode;
+    /**
+     * The relative path of the layout. It can be a path or a path pattern.
+     *
+     * @example
+     * ```typescript
+     * // Can be navigated to by "/home"
+     * <Layout name="home">
+     *     <div>Home</div>
+     * </Layout>
+     *
+     * <Layout name="user">
+     *     // equivalent to "/user/:id"
+     *     // Can be navigated to by "/user/123"
+     *     <Layout name=":id">
+     *         <div>User</div>
+     *     </Layout>
+     * </Layout>
+     * ```
+     */
+    name: string;
+    /**
+     * When true, exit animations will be propagated to nested AnimatePresence components.
+     */
+    propagate?: boolean;
+};
+export declare function Layout({ children, name, propagate }: LayoutProps): React.JSX.Element;
+export declare function RootLayout({ children }: {
+    children: React.ReactNode;
+}): React.JSX.Element;
+export {};

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

@@ -1,9 +1,46 @@
 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;
+    /**
+     * The name of the page. It can be a dynamic string, null, or undefined.
+     *
+     * If name is null or undefined, this page becomes the default handler for its parent layout.
+     * It will be rendered whenever the parent layout matches and no specific page name matches.
+     *
+     * @example
+     * <Page name="home">
+     *     // Can be navigated to by "/home"
+     *     <div>Home</div>
+     * </Page>
+     *
+     * <Layout path="user">
+     *     <Page name="profile">
+     *         // Can be navigated to by "/user/profile"
+     *         <div>User Profile</div>
+     *     </Page>
+     *
+     *     <Page name={null}>
+     *         // Default handler for "/user" - renders when no specific page matches
+     *         <div>User Default Page</div>
+     *     </Page>
+     * </Layout>
+     *
+     * <Layout path="user">
+     *     <Layout path=":id">
+     *         <Page name="profile">
+     *             // Can be navigated to by "/user/123/profile"
+     *             <div>User Profile</div>
+     *         </Page>
+     *     </Layout>
+     * </Layout>
+     * ```
+     */
+    name?: string | null;
+}>;
+type PageInjectContextType = {
+    name: string | null | undefined;
+};
+export declare const PageInjectContext: React.Context<PageInjectContextType | null>;
+export declare function usePageInject(): PageInjectContextType | null;
+export declare function Page({ children, name: nameProp }: PageProps): string | number | bigint | boolean | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined> | React.JSX.Element | null | undefined;
+export {};