narraleaf-react 0.7.0 → 0.8.0

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

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

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

@@ -0,0 +1 @@
+export { Gallery } from "../elements/built-in/Gallery";

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

@@ -6,4 +6,3 @@ import { usePathname, useParams, useQueryParams } from "../../player/lib/PageRou
 export * from "../../player/type";
 export * from "../../player/libElements";
 export { GameProviders, Player, useGame, useRouter, usePathname, useParams, useQueryParams, };
-export { PresenceContext } from "motion/react";

package/dist/game/nlcore/elements/built-in/Gallery.d.ts

@@ -0,0 +1,151 @@
+import { Lambda } from "../condition";
+import { ScriptCtx } from "../script";
+import { Service } from "../service";
+type GalleryActions<T extends Record<string, any>> = {
+    "add": [name: string, metadata: T | ((ctx: ScriptCtx) => T)];
+    "remove": [name: string];
+    "clear": [];
+};
+/**
+ * A utility to manage a gallery of items
+ * @template Metadata - The metadata of the items
+ * @class
+ * @example
+ * ```ts
+ * const gallery = new Gallery<{timestamp: number}>();
+ *
+ * scene.action([
+ *   gallery.add("item", () => ({
+ *     timestamp: Date.now(),
+ *   }))
+ * ]);
+ *
+ * scene.action([
+ *   gallery.remove("item")
+ * ]);
+ *
+ * scene.action([
+ *   Condition.If(gallery.has("item"), [
+ *     // ...
+ *   ])
+ * ]);
+ * ```
+ *
+ * to use this class, you need to register it in the story:
+ * ```ts
+ * story.registerService("gallery", gallery);
+ * ```
+ *
+ * After registering, you can access the gallery using game context:
+ * ```ts
+ * const liveGame = useLiveGame();
+ *
+ * const gallery = liveGame.story?.getService<Gallery<{timestamp: number}>>("gallery");
+ *
+ * if (gallery) {
+ *   console.log("All items in the gallery:", gallery.$getAll());
+ * }
+ * ```
+ */
+export declare class Gallery<Metadata extends Record<string, any>> extends Service<GalleryActions<Metadata>> {
+    private unlocked;
+    constructor();
+    serialize(): Record<string, any> | null;
+    deserialize(data: Record<string, any>): void;
+    /**
+     * Add an item to the gallery
+     * @chainable
+     * @param name - The name of the item to add
+     * @example
+     * ```ts
+     * scene.action([
+     *   gallery.add("item", {
+     *     // ...
+     *   })
+     * ]);
+     *
+     * // or
+     *
+     * scene.action([
+     *   gallery.add("item", (ctx) => {
+     *     return {
+     *       timestamp: Date.now(),
+     *     };
+     *   })
+     * ]);
+     * ```
+     */
+    add(name: string, metadata: Metadata | ((ctx: ScriptCtx) => Metadata)): never;
+    /**
+     * Check if an item is in the gallery
+     * @param name - The name of the item to check
+     * @returns A lambda that returns true if the item is in the gallery, false otherwise
+     * @example
+     * ```ts
+     * Condition.If(gallery.has("item"), [
+     *     // ...
+     * ])
+     * ```
+     */
+    has(name: string): Lambda<boolean>;
+    /**
+     * Remove an item from the gallery
+     * @chainable
+     * @param name - The name of the item to remove
+     * @example
+     * ```ts
+     * scene.action([
+     *   gallery
+     *     .remove("item")
+     *     .remove("item2"),
+     * ]);
+     * ```
+     */
+    remove(name: string): never;
+    /**
+     * Clear the gallery
+     * @chainable
+     * @example
+     * ```ts
+     * scene.action([
+     *   gallery.clear()
+     * ]);
+     * ```
+     */
+    clear(): never;
+    /**
+     * Remove an item from the gallery INSTANTLY
+     * @param name - The name of the item to remove
+     */
+    $remove(name: string): void;
+    /**
+     * Clear the gallery
+     *
+     * After calling this method, the gallery will be empty INSTANTLY
+     */
+    $clear(): void;
+    /**
+     * Get the metadata of an item
+     * @param name - The name of the item to get the metadata of
+     * @returns The metadata of the item
+     */
+    $get(name: string): Metadata;
+    /**
+     * Set the metadata of an item
+     * @param name - The name of the item to set the metadata of
+     * @param metadata - The metadata of the item to set
+     */
+    $set(name: string, metadata: Metadata): void;
+    /**
+     * Get all the items in the gallery
+     * @returns All the items in the gallery
+     */
+    $getAll(): Record<string, Metadata>;
+    /**
+     * Check if an item is in the gallery
+     * @param name - The name of the item to check
+     * @returns True if the item is in the gallery, false otherwise
+     */
+    $has(name: string): boolean;
+}
+export {};

package/dist/game/nlcore/elements/built-in/built-in.d.ts

@@ -0,0 +1 @@
+export { Gallery } from "./Gallery";

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

@@ -15,13 +15,33 @@ export declare abstract class Displayable<StateData extends Record<string, any>,
      */
     pos(position: TransformDefinitions.ImageTransformProps["position"], duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
     /**
-     * Set Image Scale
-     * @param scale - The scale of the image, between 0 and 1
-     * @param duration - The duration of the scale animation
-     * @param easing - The easing of the scale animation
-     * @chainable
+     * Set the zoom of the current staging sequence.
+     * @param zoom - The zoom of the transform. use `1` to keep the original size
+     */
+    zoom(zoom: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Set the scale of the current staging sequence on x axis.
+     * @param scaleX - The scale of the transform on x axis.
+     */
+    scaleX(scaleX: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Set the scale of the current staging sequence on y axis.
+     * @param scaleY - The scale of the transform on y axis.
+     */
+    scaleY(scaleY: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Set the scale of the current staging sequence.
+     * @param scaleX - The scale of the transform on x axis. use negative value to invert the scale
+     * @param scaleY - The scale of the transform on y axis. use negative value to invert the scale
+     */
+    scale(scaleX: number, scaleY: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    /**
+     * Set the scale of the current staging sequence on x and y axis.
+     * @param scaleX - The scale of the transform on x axis. use negative value to invert the scale
+     * @param scaleY - The scale of the transform on y axis. use negative value to invert the scale
+     * @alias {@link Displayable.scale}
      */
-    scale(scale: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
+    scaleXY(scaleX: number, scaleY: number, duration?: number, easing?: TransformDefinitions.EasingDefinition): Proxied<Self, Chained<LogicAction.Actions>>;
     /**
      * Set Image Rotation
      * @param rotation - The rotation of the image, in degrees

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

@@ -51,9 +51,5 @@ export declare abstract class Service<Content extends ServiceContentType = Servi
      * @param data data exported from toData
      */
     abstract deserialize?(data: RawData): void;
-    /**
-     * Called when the service is initialized
-     */
-    abstract init?(): void;
 }
 export {};

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

@@ -1,13 +1,7 @@
-import React from "react";
 import type { CommonDisplayableConfig } from "../../types";
-import type { DOMKeyframesDefinition } from "motion";
 import { TransformDefinitions } from "./type";
 import { CSSProps } from "../../elements/transition/type";
-export type Transformers = "position" | "opacity" | "scale" | "rotation" | "display" | "src" | "backgroundColor" | "backgroundOpacity" | "transform" | "fontColor";
-export type TransformHandler<T> = (value: T) => DOMKeyframesDefinition;
 type OverwriteMap = {
-    transform: React.CSSProperties["transform"];
-    scale: React.CSSProperties["scale"];
     overwrite: CSSProps;
 };
 export type OverwriteDefinition = {
@@ -86,11 +80,26 @@ export declare class Transform<T extends TransformDefinitions.Types = CommonDisp
      */
     commit(options?: Partial<TransformDefinitions.SequenceOptions>): this;
     /**
-     * Scale the current staging sequence.
-     * @param {number} scale - The scale of the transform.
-     * @returns {this} The current Transform instance for method chaining.
+     * Set the zoom of the current staging sequence.
+     * @param zoom - The zoom of the transform. use `1` to keep the original size
+     */
+    zoom(zoom: TransformDefinitions.Types["zoom"]): this;
+    /**
+     * Set the scale of the current staging sequence on x axis.
+     * @param scaleX - The scale of the transform on x axis.
+     */
+    scaleX(scaleX: TransformDefinitions.Types["scaleX"]): this;
+    /**
+     * Set the scale of the current staging sequence on y axis.
+     * @param scaleY - The scale of the transform on y axis.
+     */
+    scaleY(scaleY: TransformDefinitions.Types["scaleY"]): this;
+    /**
+     * Set the scale of the current staging sequence.
+     * @param scaleX - The scale of the transform on x axis. use negative value to invert the scale
+     * @param scaleY - The scale of the transform on y axis. use negative value to invert the scale
      */
-    scale(scale: TransformDefinitions.Types["scale"]): this;
+    scale(scaleX: TransformDefinitions.Types["scaleX"], scaleY: TransformDefinitions.Types["scaleY"]): this;
     /**
      * Rotate the current staging sequence.
      * @param {number} rotation - The rotation of the transform.

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

@@ -1,4 +1,5 @@
 import { Storable } from "../elements/persistent/storable";
+import { Story } from "../elements/story";
 import { Game } from "../game";
 import type { NotificationToken, SavedGame } from "../gameTypes";
 import { LiveGameEventHandler, LiveGameEventToken } from "../types";
@@ -19,6 +20,7 @@ export declare class LiveGame {
     };
     game: Game;
     events: EventDispatcher<LiveGameEvent>;
+    story: Story | null;
     getStorable(): Storable;
     get storable(): Storable;
     /**

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

@@ -28,11 +28,6 @@ export type Length = number | `${number}px`;
 export type RelativeLength = Length | "100%";
 export type CommonImagePosition = "left" | "center" | "right";
 export type CommonDisplayableConfig = {
-    /**
-     * Scale of the element, between 0 and 1
-     * @default 1
-     */
-    scale?: number;
     /**
      * Rotation of the element, in degrees
      * @default 0
@@ -52,6 +47,21 @@ export type CommonDisplayableConfig = {
      * Alt text of the element
      */
     alt?: string;
+    /**
+     * Scale of the element on x axis, use negative value to invert the scale
+     * @default 1
+     */
+    scaleX?: number;
+    /**
+     * Scale of the element on y axis, use negative value to invert the scale
+     * @default 1
+     */
+    scaleY?: number;
+    /**
+     * Zoom of the element, use `1` to keep the original size
+     * @default 1
+     */
+    zoom?: number;
 };
 export declare const ImagePosition: {
     [K in CommonImagePosition]: K;

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

@@ -12,4 +12,5 @@ import { Page, PageInjectContext } from "./lib/PageRouter/Page";
 import { Layout, LayoutRouterProvider } from "./lib/PageRouter/Layout";
 import { RootPath } from "./lib/PageRouter/router";
 import { useKeyBinding } from "./lib/keyMap";
-export { Isolated, usePreference, Stage, GameMenu, Item, Notifications, Texts, Nametag, Dialog, useDialog, Page, Layout, LayoutRouterProvider, PageInjectContext, RootPath, useKeyBinding, };
+import { useLiveGame } from "./lib/useLiveGame";
+export { Isolated, usePreference, Stage, GameMenu, Item, Notifications, Texts, Nametag, Dialog, useDialog, Page, Layout, LayoutRouterProvider, PageInjectContext, RootPath, useKeyBinding, useLiveGame, };