narraleaf-react 0.2.2 → 0.2.4-beta.1

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

@@ -4,38 +4,6 @@ import { GameState } from "../../player/gameState";
 import { Storable } from "../elements/persistent/storable";
 import { Game } from "../game";
 import { LiveGameEventHandler, LiveGameEventToken } from "../types";
-import { Character } from "../elements/character";
-import { Sentence } from "../elements/character/sentence";
-type LiveGameEvent = {
-    "event:character.prompt": [
-        {
-            /**
-             * The character who says the sentence
-             */
-            character: Character | null;
-            /**
-             * The sentence said by the character
-             */
-            sentence: Sentence;
-            /**
-             * The text of the sentence
-             */
-            text: string;
-        }
-    ];
-    "event:menu.choose": [
-        {
-            /**
-             * The sentence selected by the player
-             */
-            sentence: Sentence;
-            /**
-             * The text of the sentence
-             */
-            text: string;
-        }
-    ];
-};
 export declare class LiveGame {
     static DefaultNamespaces: {
         game: {};
@@ -81,4 +49,3 @@ export declare class LiveGame {
     newGame(): this;
     getGameState(): GameState | undefined;
 }
-export {};

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

@@ -1,8 +1,4 @@
-import { EventDispatcher } from "../../../util/data";
-type PreferenceEventToken = {
-    cancel: () => void;
-};
-type StringKeyof<T> = Extract<keyof T, string>;
+import { BooleanValueKeyOf, EventDispatcher } from "../../../util/data";
 export declare class Preference<T extends Record<string, string | boolean | number | null | undefined>> {
     private readonly settings;
     static EventTypes: {
@@ -20,12 +16,12 @@ export declare class Preference<T extends Record<string, string | boolean | numb
     /**
      * Import preferences
      *
-     * Note: This will override the existing preferences, and trigger the change event
+     * Note: this will override the existing preferences and trigger the change event
      */
     importPreferences(preferences: Partial<T>): void;
     /**
      * Export preferences
      */
     exportPreferences(): Partial<T>;
+    togglePreference<K extends BooleanValueKeyOf<T>>(key: K): void;
 }
-export {};

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

@@ -105,6 +105,10 @@ export type GameConfig = {
          * Cursor height in pixels
          */
         cursorHeight: number;
+        /**
+         * Show overflowed content
+         */
+        showOverflow: boolean;
     };
     elements: {
         say: {

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

@@ -1,23 +1 @@
-import React from "react";
-import { EventfulDisplayable } from "../../../nlcore/types";
-import { DisplayableChildHandler, StatefulDisplayable } from "../../elements/displayable/type";
-import { TransformersMap, TransformHandler } from "../../../nlcore/elements/transform/transform";
-import { GameState } from "../../gameState";
-export type DisplayableProps = {
-    displayable: {
-        skipTransition?: boolean;
-        skipTransform?: boolean;
-        transformOverwrites?: {
-            [K in keyof TransformersMap]?: TransformHandler<TransformersMap[K]>;
-        };
-    } & ({
-        element: EventfulDisplayable & StatefulDisplayable;
-        state?: StatefulDisplayable;
-    } | {
-        element: EventfulDisplayable;
-        state: StatefulDisplayable;
-    });
-    child: DisplayableChildHandler;
-    state: GameState;
-};
-export default function Displayable({ state: gameState, displayable, child, }: Readonly<DisplayableProps>): React.JSX.Element;
+export {};

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

@@ -1,7 +1 @@
-import React from "react";
-import { GameState } from "../../gameState";
-import { LogicAction } from "../../../nlcore/action/logicAction";
-export default function Displayables({ state, displayable }: Readonly<{
-    state: GameState;
-    displayable: LogicAction.DisplayableElements[];
-}>): React.JSX.Element;
+export {};

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

@@ -1,7 +1 @@
-import { GameState } from "../../gameState";
-import { Text as GameText } from "../../../nlcore/elements/displayable/text";
-import React from "react";
-export default function Text({ state, text }: Readonly<{
-    state: GameState;
-    text: GameText;
-}>): React.JSX.Element;
+export {};

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

@@ -1,15 +1 @@
-import { ElementProp, ITransition } from "../../../nlcore/elements/transition/type";
-import React from "react";
-import { Transform } from "../../../nlcore/elements/transform/transform";
-import { GameState } from "../../gameState";
-export type DisplayableChildProps = {
-    transition: ITransition | null;
-    transform: Transform | null;
-    transformProps: ElementProp<Element, React.HTMLAttributes<Element>>;
-    transformRef: React.MutableRefObject<HTMLDivElement | null>;
-    state: GameState;
-};
-export type DisplayableChildHandler = (props: Readonly<DisplayableChildProps>) => React.ReactElement;
-export type StatefulDisplayable = {
-    state: Record<any, any>;
-};
+export {};

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

@@ -1,8 +1 @@
-import React from "react";
-import { ImgElementProp } from "../../../nlcore/elements/transition/type";
-export default function AspectScaleImage({ props, onLoad, id, Ref, }: Readonly<{
-    props: Omit<ImgElementProp, "onLoad">;
-    onLoad: (event: React.SyntheticEvent<HTMLImageElement, Event>) => void;
-    id?: string;
-    Ref?: React.RefObject<HTMLImageElement>;
-}>): React.JSX.Element;
+export {};

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

@@ -1,7 +1 @@
-import { Image as GameImage } from "../../../nlcore/elements/displayable/image";
-import React from "react";
-import { GameState } from "../../gameState";
-export default function Image({ image, state, }: Readonly<{
-    image: GameImage;
-    state: GameState;
-}>): React.JSX.Element;
+export {};

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

@@ -1,3 +1 @@
-import React from "react";
-import { MenuElementProps } from "../../elements/menu/type";
-export default function Menu({ prompt, choices, afterChoose, state, words, }: Readonly<MenuElementProps>): React.JSX.Element;
+export {};

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

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

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

@@ -1,4 +1 @@
-import React from "react";
-export default function SizeUpdateAnnouncer({ containerRef }: Readonly<{
-    containerRef: React.RefObject<HTMLDivElement>;
-}>): null;
+export {};

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

@@ -1,4 +1 @@
-import { GameState } from "../../gameState";
-export declare function Preload({ state, }: Readonly<{
-    state: GameState;
-}>): null;
+export {};

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

@@ -1,3 +1 @@
-import React from "react";
-import { SayElementProps } from "../../elements/say/type";
-export default function Say({ action, onClick, useTypeEffect, className, state, }: Readonly<SayElementProps>): React.JSX.Element;
+export {};

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

@@ -1,15 +1 @@
-import React from "react";
-import { GameState } from "../../gameState";
-import { Sentence as GameSentence } from "../../../nlcore/elements/character/sentence";
-import { Word } from "../../../nlcore/elements/character/word";
-import { Pausing } from "../../../nlcore/elements/character/pause";
-export default function Sentence({ sentence, gameState, useTypeEffect, onCompleted, finished, count, className, words: w, }: Readonly<{
-    sentence: GameSentence;
-    gameState: GameState;
-    useTypeEffect?: boolean;
-    onCompleted?: () => void;
-    finished?: boolean;
-    count?: number;
-    className?: string;
-    words?: Word<string | Pausing>[];
-}>): React.JSX.Element;
+export {};

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

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

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

@@ -1,8 +1 @@
-import React from "react";
-import { Scene as GameScene } from "../../../nlcore/elements/scene";
-import { GameState } from "../../gameState";
-export default function BackgroundTransition({ scene, props, state }: {
-    scene: GameScene;
-    props: Record<string, any>;
-    state: GameState;
-}): React.JSX.Element;
+export {};

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

@@ -1,9 +1 @@
-import { Scene as GameScene } from "../../../nlcore/elements/scene";
-import React from "react";
-import { GameState } from "../../gameState";
-export default function Scene({ scene, state, children, className }: Readonly<{
-    scene: GameScene;
-    state: GameState;
-    children?: React.ReactNode;
-    className?: string;
-}>): React.JSX.Element;
+export {};

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

@@ -22,7 +22,7 @@ export type PlayerEventContext = {
     storable: Storable;
 };
 export interface PlayerProps {
-    story: Story;
+    story?: Story;
     width?: string | number;
     height?: string | number;
     className?: clsx.ClassValue;

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

@@ -37,7 +37,6 @@ export type PlayerStateData = {
         };
     }[];
 };
-export type PlayerAction = CalledActionResult;
 interface StageUtils {
     update: () => void;
     forceUpdate: () => void;

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

@@ -1,20 +1 @@
-import { Character } from "../nlcore/elements/character";
-import { Choice } from "../nlcore/elements/menu";
-import { Sentence } from "../nlcore/elements/character/sentence";
-import { Word } from "../nlcore/elements/character/word";
-import { Pausing } from "../nlcore/elements/character/pause";
-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;
-    words: Word<Pausing | string>[];
-};
-export type MenuElement = {
-    prompt: Sentence;
-    choices: Choice[];
-    words: Word<Pausing | string>[];
-};
+export {};

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

@@ -6,7 +6,11 @@ type ForwardSize = {
 type ForwardChildren = {
     children?: React.ReactNode;
 };
+type ForwardClassName = {
+    className?: string;
+};
 type FrameComponentProps = ForwardSize & ForwardChildren;
+declare function Full({ children, className }: ForwardChildren & ForwardClassName): React.JSX.Element;
 declare const Top: {
     Left: (props: FrameComponentProps) => React.JSX.Element;
     Center: (props: FrameComponentProps) => React.JSX.Element;
@@ -22,4 +26,4 @@ declare const Bottom: {
     Center: (props: FrameComponentProps) => React.JSX.Element;
     Right: (props: FrameComponentProps) => React.JSX.Element;
 };
-export { Top, Center, Bottom, };
+export { Top, Center, Bottom, Full, };

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

@@ -0,0 +1,3 @@
+import { StringKeyOf } from "../../../util/data";
+import { GamePreference } from "../../nlcore/game";
+export declare function usePreference<K extends StringKeyOf<GamePreference>>(key: K): [GamePreference[K], (value: GamePreference[K]) => void];

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

@@ -1,5 +1,6 @@
 import Isolated from "./lib/isolated";
 import Say from "./elements/say/Say";
-import { Top, Center, Bottom } from "./lib/PlayerFrames";
+import { Top, Center, Bottom, Full } from "./lib/PlayerFrames";
 import { VBox, HBox } from "./lib/UtilComponents";
-export { Isolated, Say, Top, Center, Bottom, VBox, HBox, };
+import { usePreference } from "./lib/preferences";
+export { Isolated, Say, Top, Center, Bottom, VBox, HBox, Full, usePreference, };

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

@@ -1,13 +1,8 @@
-import React, { ReactNode } from "react";
 import { Game } from "../../nlcore/game";
 type GameContextType = {
     game: Game;
     setGame: (update: (prevGame: Game) => Game) => void;
 };
-export declare function GameProvider({ children, game }: {
-    children?: ReactNode;
-    game?: Game;
-}): React.JSX.Element;
 /**
  * use {@link Game} context
  * @returns {GameContextType}

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

@@ -1,12 +1 @@
-import React from "react";
-import { Preloaded } from "../lib/Preloaded";
-import { ImageCacheManager } from "../lib/ImageCacheManager";
-type PreloadedContextType = {
-    preloaded: Preloaded;
-    cacheManager: ImageCacheManager;
-};
-export declare function PreloadedProvider({ children }: {
-    children: React.ReactNode;
-}): React.JSX.Element;
-export declare function usePreloaded(): PreloadedContextType;
 export {};

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

@@ -1,51 +1 @@
-import React from "react";
-import { EventDispatcher } from "../../../util/data";
-export type AspectRatioState = {
-    width: number;
-    height: number;
-    minWidth: number;
-    minHeight: number;
-    paused: boolean;
-    scale: number;
-};
-type AspectRatioEvents = {
-    "event:aspectRatio.update": [width: number, height: number];
-    "event:aspectRatio.pause": [];
-    "event:aspectRatio.resume": [];
-    "event:aspectRatio.requestUpdate": [];
-};
-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, scale: 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;
-    requestUpdate(): void;
-    onRequestedUpdate(callback: () => void): () => void;
-    private triggerUpdate;
-}
-export declare function RatioProvider({ children }: {
-    children: React.ReactNode;
-}): React.JSX.Element;
-export declare function useRatio(): {
-    ratio: AspectRatio;
-};
 export {};