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

package/README.md

@@ -1,4 +1,4 @@
-![](./docs/nlr-logo-md.png)
+![](./docs/nlr-logo-banner.png)
 
 # NarraLeaf-React
 

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

@@ -1,6 +1,5 @@
 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";
@@ -22,7 +21,7 @@ export type ImageEventTypes = {
     "event:image.applyTransform": [Transform];
     "event:image.mount": [];
     "event:image.unmount": [];
-    "event:image.ready": [AnimationScope];
+    "event:image.ready": [React.MutableRefObject<HTMLImageElement | null>];
     "event:image.elementLoaded": [];
     "event:image.setTransition": [ITransition | null];
 };
@@ -117,7 +116,6 @@ export declare class Image extends Actionable<ImageDataRaw> {
     hide(transform: Transform): this;
     hide(transform: Partial<TransformDefinitions.CommonTransformProps>): this;
     toTransform(): Transform;
-    toHTMLElementProps(): React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>;
     setScope(scope: React.RefObject<HTMLImageElement>): this;
     getScope(): React.RefObject<HTMLImageElement> | undefined;
     copy(): Image;

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

@@ -1,4 +1,5 @@
 import { Color } from "../types";
+import { DeepPartial } from "../../../util/data";
 import { Actionable } from "../action/actionable";
 export type SentenceConfig = {
     pause?: boolean | number;
@@ -34,12 +35,20 @@ export declare class Word {
     constructor(text: string, config?: Partial<WordConfig>);
     static isWord(obj: any): obj is Word;
 }
-export type CharacterConfig = {};
+export declare enum CharacterMode {
+    "adv" = "adv",
+    "nvl" = "nvl"
+}
+export type CharacterConfig = {
+    mode: CharacterMode;
+};
 export type CharacterStateData = {};
 export declare class Character extends Actionable<CharacterStateData> {
+    static Modes: typeof CharacterMode;
+    static defaultConfig: CharacterConfig;
     name: string | null;
     config: CharacterConfig;
-    constructor(name: string | null, config?: CharacterConfig);
+    constructor(name: string | null, config?: DeepPartial<CharacterConfig>);
     /**
      * Say something
      * @example

package/dist/game/nlcore/elements/transform/position.d.ts

@@ -1,13 +1,13 @@
 import { CSSProps } from "../../elements/transition/type";
 export declare enum CommonPositionType {
-    Left = 0,
-    Center = 1,
-    Right = 2
+    Left = "left",
+    Center = "center",
+    Right = "right"
 }
 export declare const CommonPositions: {
-    0: `${number}%`;
-    1: `${number}%`;
-    2: `${number}%`;
+    left: `${number}%`;
+    center: `${number}%`;
+    right: `${number}%`;
 };
 export interface IPosition {
     toCSS(): D2Position;
@@ -30,6 +30,13 @@ export type D2Position<X = any, Y = any> = {
     xoffset: UnknownAble<number>;
     yoffset: UnknownAble<number>;
 };
+export type RawPosition = CommonPositionType | (Coord2DPosition & {
+    xalign?: never;
+    yalign?: never;
+}) | (AlignPosition & {
+    x: never;
+    y: never;
+});
 export type Unknown = typeof PositionUtils.Unknown;
 export type UnknownAble<T> = T | Unknown;
 export declare class PositionUtils {
@@ -41,6 +48,13 @@ export declare class PositionUtils {
     static toCoord2D(pos: IPosition | D2Position): Coord2D;
     static mergePosition(a: IPosition, b: IPosition): Coord2D;
     static serializePosition(pos: IPosition): D2Position;
+    static isRawCommonPositionType(arg: any): arg is CommonPositionType;
+    static isRawCoord2DPosition(arg: any): arg is Coord2DPosition;
+    static isRawAlignPosition(arg: any): arg is AlignPosition;
+    static isRawPosition(arg: any): arg is IPosition;
+    static isPosition(arg: any): arg is IPosition;
+    static rawPositionToCoord2D(arg: any): Coord2D;
+    static tryParsePosition(arg: any): IPosition;
 }
 export declare class CommonPosition implements IPosition {
     static Positions: typeof CommonPositionType;
@@ -50,10 +64,10 @@ export declare class CommonPosition implements IPosition {
      * @example
      * ```ts
      * new CommonPosition(CommonPosition.Positions.Center);
-     * new CommonPosition("Center");
+     * new CommonPosition("center");
      * ```
      */
-    constructor(position: CommonPositionType | keyof typeof CommonPositionType);
+    constructor(position: CommonPositionType);
     static isCommonPositionType(arg: any): arg is CommonPosition;
     toCSS(): D2Position;
 }

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

@@ -3,10 +3,11 @@ import type { AnimationPlaybackControls, DOMKeyframesDefinition, DynamicAnimatio
 import { DeepPartial } from "../../../../util/data";
 import { GameState } from "../../../player/gameState";
 import { TransformDefinitions } from "./type";
-import { Align, Coord2D, IPosition } from "./position";
+import { Align, Coord2D, IPosition, RawPosition } from "./position";
 import { CSSProps } from "../../elements/transition/type";
 import Sequence = TransformDefinitions.Sequence;
 import SequenceProps = TransformDefinitions.SequenceProps;
+import React from "react";
 export type Transformers = "position" | "opacity" | "scale" | "rotation" | "display" | "src" | "backgroundColor" | "backgroundOpacity" | "transform";
 export type TransformHandler<T> = (value: T) => DOMKeyframesDefinition;
 export type TransformersMap = {
@@ -52,7 +53,7 @@ export declare class Transform<T extends TransformDefinitions.Types = TransformD
         backgroundImage?: string;
         backgroundColor?: string;
     };
-    static mergePosition(a: IPosition | undefined, b: IPosition | undefined): Coord2D;
+    static mergePosition(a: RawPosition | undefined, b: RawPosition | undefined): Coord2D;
     static mergeState<T>(state: any, props: any): DeepPartial<T>;
     /**
      * @example
@@ -62,9 +63,8 @@ export declare class Transform<T extends TransformDefinitions.Types = TransformD
      * return <div ref={scope} />
      * ```
      */
-    animate<U extends Element = any>({ scope, animate, overwrites }: {
-        scope: TransformDefinitions.FramerAnimationScope<U>;
-        animate: TransformDefinitions.FramerAnimate;
+    animate({ scope, overwrites }: {
+        scope: React.MutableRefObject<HTMLImageElement | null>;
         overwrites?: Partial<{
             [K in Transformers]?: TransformHandler<any>;
         }>;

package/dist/game/nlcore/elements/transition/base.d.ts

@@ -1,6 +1,6 @@
 import { EventDispatcher } from "../../../../util/data";
 import { ElementProp, EventTypes, ITransition } from "./type";
-import { AnimationPlaybackControls, ValueAnimationTransition } from "framer-motion";
+import type { AnimationPlaybackControls, ValueAnimationTransition } from "framer-motion";
 export declare class Base<T extends ElementProp> implements ITransition<T> {
     events: EventDispatcher<EventTypes<[T[]]>>;
     start(_onComplete?: () => void): void;

package/dist/game/nlcore/elements/transition/type.d.ts

@@ -1,6 +1,6 @@
 import type { EventDispatcher } from "../../../../util/data";
 import React from "react";
-import { DOMKeyframesDefinition } from "framer-motion";
+import type { DOMKeyframesDefinition } from "framer-motion";
 export type ElementProp<T extends Element = Element, U extends React.HTMLAttributes<T> = React.HTMLAttributes<T>> = React.JSX.IntrinsicAttributes & React.ClassAttributes<T> & React.HTMLAttributes<T> & U;
 export type ImgElementProp = ElementProp<HTMLImageElement, React.ImgHTMLAttributes<HTMLImageElement>>;
 export type CSSElementProp<T extends React.CSSProperties | DOMKeyframesDefinition> = ElementProp & {

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

@@ -1,4 +1,4 @@
-import { IPosition } from "./elements/transform/position";
+import { IPosition, RawPosition } from "./elements/transform/position";
 export type color = string | {
     r: number;
     g: number;
@@ -35,11 +35,9 @@ export type Background = {
 };
 export type CommonImagePosition = "left" | "center" | "right";
 export type CommonImage = {
-    height?: number;
-    width?: number;
     scale?: number;
     rotation?: number;
-    position?: IPosition;
+    position?: RawPosition | IPosition;
     opacity?: number;
     alt?: string;
 };

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

@@ -1,7 +1,8 @@
-import { Sentence } from "../../../nlcore/elements/text";
+import { Character, Sentence } from "../../../nlcore/elements/text";
 export interface SayElementProps {
     action: {
         sentence: Sentence;
+        character: Character | null;
     };
     /**
      * Callback function to be called when player triggers the next action

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

@@ -1,5 +1,5 @@
 import { CalledActionResult } from "@core/gameTypes";
-import { EventDispatcher } from "../../util/data";
+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";
@@ -51,6 +51,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/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/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/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 {};