narraleaf-react 0.3.0 → 0.3.1-alpha.1

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

@@ -7,6 +7,12 @@ import { Sentence, SentencePrompt, SentenceUserConfig, SingleWord } from "../ele
 export type CharacterConfig = {
     color: Color;
 };
+export interface Character {
+    (content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    (content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
+    (content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    (texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
+}
 export declare class Character extends Actionable<CharacterStateData, Character> {
     constructor(name: string | null, config?: DeepPartial<CharacterConfig>);
     /**
@@ -38,4 +44,8 @@ export declare class Character extends Actionable<CharacterStateData, Character>
     say(content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
     say(texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
     setName(name: string): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(content: string, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(content: Sentence): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(content: SentencePrompt, config?: SentenceUserConfig): Proxied<Character, Chained<LogicAction.Actions>>;
+    apply(texts: TemplateStringsArray, ...words: SingleWord[]): Proxied<Character, Chained<LogicAction.Actions>>;
 }

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

@@ -12,6 +12,7 @@ export interface SavedGame {
     meta: {
         created: number;
         updated: number;
+        id: string;
     };
     game: {
         store: {

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

@@ -2,4 +2,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, router, }: Readonly<PlayerProps>): React.JSX.Element;
+export default function Player({ story, width, height, className, onReady, onEnd, children, }: Readonly<PlayerProps>): React.JSX.Element;

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

@@ -7,7 +7,6 @@ import { Game } from "../../nlcore/game";
 import { GameState } from "../gameState";
 import { Storable } from "../../nlcore/elements/persistent/storable";
 import { LiveGame } from "../../nlcore/game/liveGame";
-import { Router } from "../lib/PageRouter/router";
 export type Components<T extends Record<string, any>> = (props: Readonly<T>) => React.JSX.Element;
 export type SayComponent = Components<SayElementProps>;
 export type MenuComponent = Components<MenuElementProps>;
@@ -40,5 +39,4 @@ export interface PlayerProps {
      */
     onEnd?: (ctx: PlayerEventContext) => void;
     children?: React.ReactNode;
-    router?: Router;
 }

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

@@ -1,8 +1,6 @@
 import React from "react";
-import { Router } from "../../lib/PageRouter/router";
 type PageRouterProps = Readonly<{
     children?: React.ReactNode;
-    router?: Router;
 }>;
 /**
  * Page Router for NarraLeaf-React
@@ -25,5 +23,5 @@ type PageRouterProps = Readonly<{
  * </PageRouter>
  * ```
  */
-export declare function PageRouter({ children, router, }: PageRouterProps): React.JSX.Element | null;
+export declare function PageRouter({ children, }: PageRouterProps): React.JSX.Element | null;
 export {};

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

@@ -1,10 +1,23 @@
-type RouterHookResult = Router;
 export declare class Router {
     getCurrentId(): string | null;
+    /**
+     * Push a new page id to the router history
+     */
     push(id: string): this;
+    /**
+     * Go back to the previous page id in the router history
+     */
     back(): this;
+    /**
+     * Go forward to the next page id in the router history
+     */
     forward(): this;
+    /**
+     * Clear the current page id and history
+     *
+     * All pages will be removed from the stage
+     */
+    clear(): this;
     cleanHistory(): this;
 }
-export declare function useRouter(defaultId?: string): RouterHookResult;
-export {};
+export declare function useRouter(): Router;