@react-text-game/core 0.1.0

package/dist/saves/hooks/useLoadGame.js

@@ -0,0 +1,40 @@
+import { Game } from "../../game";
+import { loadGame } from "../../saves";
+/**
+ * React hook that provides a function to load a saved game by its ID.
+ * Restores the game state from the specified save.
+ *
+ * @returns Function that accepts an optional save ID and loads the game, returning a result object on failure
+ *
+ * @example
+ * ```tsx
+ * const loadGame = useLoadGame();
+ * const handleLoad = async () => {
+ *   const result = await loadGame(saveId);
+ *   if (result?.success === false) {
+ *     console.error('Load failed:', result.message);
+ *   }
+ * };
+ * ```
+ */
+export const useLoadGame = () => async (id) => {
+    try {
+        const data = await loadGame(id);
+        if (!data) {
+            return {
+                success: false,
+                message: "The requested game save does not exist",
+            };
+        }
+        Game.setState(data.gameData);
+    }
+    catch (e) {
+        console.error("Failed to load game:", e);
+        return {
+            success: false,
+            message: e.message ||
+                "Failed to load game. Check console for more info.",
+        };
+    }
+};
+//# sourceMappingURL=useLoadGame.js.map

package/dist/saves/hooks/useLoadGame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLoadGame.js","sourceRoot":"","sources":["../../../src/saves/hooks/useLoadGame.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,EAAU,EAAE,EAAE;IAClD,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,EAAE,CAAC,CAAC;QAChC,IAAI,CAAC,IAAI,EAAE,CAAC;YACR,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,wCAAwC;aACpD,CAAC;QACN,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;QACzC,OAAO;YACH,OAAO,EAAE,KAAK;YACd,OAAO,EACF,CAAW,CAAC,OAAO;gBACpB,mDAAmD;SAC1D,CAAC;IACN,CAAC;AACL,CAAC,CAAC"}

package/dist/saves/hooks/useRestartGame.d.ts

@@ -0,0 +1,20 @@
+/**
+ * React hook that provides a function to restart the game from the initial state.
+ * Loads the system save (initial game state), clears auto-save, and navigates to start passage.
+ *
+ * @returns Callback function that restarts the game
+ *
+ * @example
+ * ```tsx
+ * const restartGame = useRestartGame();
+ * <button onClick={restartGame}>Restart Game</button>
+ * ```
+ */
+export declare const useRestartGame: () => () => Promise<{
+    success: boolean;
+    error: string;
+} | {
+    success: boolean;
+    error: null;
+}>;
+//# sourceMappingURL=useRestartGame.d.ts.map

package/dist/saves/hooks/useRestartGame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRestartGame.d.ts","sourceRoot":"","sources":["../../../src/saves/hooks/useRestartGame.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc;;;;;;EAe1B,CAAC"}

package/dist/saves/hooks/useRestartGame.js

@@ -0,0 +1,29 @@
+import { useCallback } from "react";
+import { SYSTEM_PASSAGE_NAMES } from "../../constants";
+import { Game } from "../../game";
+import { getSystemSave } from "../../saves";
+/**
+ * React hook that provides a function to restart the game from the initial state.
+ * Loads the system save (initial game state), clears auto-save, and navigates to start passage.
+ *
+ * @returns Callback function that restarts the game
+ *
+ * @example
+ * ```tsx
+ * const restartGame = useRestartGame();
+ * <button onClick={restartGame}>Restart Game</button>
+ * ```
+ */
+export const useRestartGame = () => {
+    return useCallback(async () => {
+        const systemSave = await getSystemSave();
+        if (!systemSave) {
+            return { success: false, error: "System save not found. Cannot restart game." };
+        }
+        Game.clearAutoSave();
+        Game.setState(systemSave.gameData);
+        Game.jumpTo(SYSTEM_PASSAGE_NAMES.START_MENU);
+        return { success: true, error: null };
+    }, []);
+};
+//# sourceMappingURL=useRestartGame.js.map

package/dist/saves/hooks/useRestartGame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRestartGame.js","sourceRoot":"","sources":["../../../src/saves/hooks/useRestartGame.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAEpC,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAClD,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAEvC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,EAAE;IAC/B,OAAO,WAAW,CAAC,KAAK,IAAI,EAAE;QAC1B,MAAM,UAAU,GAAG,MAAM,aAAa,EAAE,CAAC;QAEzC,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,6CAA6C,EAAE,CAAA;QACnF,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACrB,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAEnC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC;QAE7C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAC1C,CAAC,EAAE,EAAE,CAAC,CAAC;AACX,CAAC,CAAC"}

package/dist/saves/hooks/useSaveGame.d.ts

@@ -0,0 +1,22 @@
+/**
+ * React hook that provides a function to save the current game state to a specific slot.
+ * The save is stored in IndexedDB with the slot number as the save name.
+ *
+ * @returns Function that accepts a slot number and saves the game, returning a result object on failure
+ *
+ * @example
+ * ```tsx
+ * const saveGame = useSaveGame();
+ * const handleSave = async () => {
+ *   const result = await saveGame(1);
+ *   if (result?.success === false) {
+ *     console.error('Save failed:', result.message);
+ *   }
+ * };
+ * ```
+ */
+export declare const useSaveGame: () => (id: number) => Promise<{
+    success: boolean;
+    message: string;
+} | undefined>;
+//# sourceMappingURL=useSaveGame.d.ts.map

package/dist/saves/hooks/useSaveGame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSaveGame.d.ts","sourceRoot":"","sources":["../../../src/saves/hooks/useSaveGame.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,WAAW,SAAgB,IAAI,MAAM;;;cAcjD,CAAC"}

package/dist/saves/hooks/useSaveGame.js

@@ -0,0 +1,34 @@
+import { Game } from "../../game";
+import { saveGame } from "../../saves";
+/**
+ * React hook that provides a function to save the current game state to a specific slot.
+ * The save is stored in IndexedDB with the slot number as the save name.
+ *
+ * @returns Function that accepts a slot number and saves the game, returning a result object on failure
+ *
+ * @example
+ * ```tsx
+ * const saveGame = useSaveGame();
+ * const handleSave = async () => {
+ *   const result = await saveGame(1);
+ *   if (result?.success === false) {
+ *     console.error('Save failed:', result.message);
+ *   }
+ * };
+ * ```
+ */
+export const useSaveGame = () => async (id) => {
+    const data = Game.getState();
+    try {
+        await saveGame(id, data);
+    }
+    catch (e) {
+        console.error("Failed to save game:", e);
+        return {
+            success: false,
+            message: e.message ||
+                "Failed to save game. Check console for more info.",
+        };
+    }
+};
+//# sourceMappingURL=useSaveGame.js.map

package/dist/saves/hooks/useSaveGame.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSaveGame.js","sourceRoot":"","sources":["../../../src/saves/hooks/useSaveGame.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAElC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,GAAG,EAAE,CAAC,KAAK,EAAE,EAAU,EAAE,EAAE;IAClD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;IAE7B,IAAI,CAAC;QACD,MAAM,QAAQ,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,CAAC,CAAC,CAAC;QACzC,OAAO;YACH,OAAO,EAAE,KAAK;YACd,OAAO,EACF,CAAW,CAAC,OAAO;gBACpB,mDAAmD;SAC1D,CAAC;IACN,CAAC;AACL,CAAC,CAAC"}

package/dist/saves/hooks/useSaveSlots.d.ts

@@ -0,0 +1,45 @@
+import { GameSave } from "../../saves";
+/**
+ * React hook that provides an array of save slots with live updates from IndexedDB.
+ * Each slot includes the save data and methods to save, load, and delete.
+ *
+ * @param config - Configuration object
+ * @param config.count - Number of save slots to create (defaults to 1)
+ * @returns Array of save slot objects, each containing data and action methods
+ *
+ * @example
+ * ```tsx
+ * const slots = useSaveSlots({ count: 5 });
+ *
+ * return (
+ *   <div>
+ *     {slots.map((slot, index) => (
+ *       <div key={index}>
+ *         <p>Slot {index}: {slot.data ? 'Saved' : 'Empty'}</p>
+ *         <button onClick={() => slot.save()}>Save</button>
+ *         <button onClick={() => slot.load()} disabled={!slot.data}>Load</button>
+ *         <button onClick={() => slot.delete()} disabled={!slot.data}>Delete</button>
+ *       </div>
+ *     ))}
+ *   </div>
+ * );
+ * ```
+ */
+export declare const useSaveSlots: ({ count }?: {
+    count: number;
+}) => {
+    data: GameSave | null;
+    save: () => Promise<{
+        success: boolean;
+        message: string;
+    } | undefined>;
+    load: () => Promise<{
+        success: boolean;
+        message: string;
+    } | undefined>;
+    delete: () => Promise<{
+        success: boolean;
+        message: string;
+    } | undefined>;
+}[];
+//# sourceMappingURL=useSaveSlots.d.ts.map

package/dist/saves/hooks/useSaveSlots.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSaveSlots.d.ts","sourceRoot":"","sources":["../../../src/saves/hooks/useSaveSlots.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,QAAQ,EAAwD,MAAM,QAAQ,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,YAAY,GAAI;;CAAwB;;;;;;;;;;;;;;GAkBpD,CAAC"}

package/dist/saves/hooks/useSaveSlots.js

@@ -0,0 +1,42 @@
+import { useLiveQuery } from "dexie-react-hooks";
+import { useMemo } from "react";
+import { getAllSaves, useDeleteGame, useLoadGame, useSaveGame } from "../../saves";
+/**
+ * React hook that provides an array of save slots with live updates from IndexedDB.
+ * Each slot includes the save data and methods to save, load, and delete.
+ *
+ * @param config - Configuration object
+ * @param config.count - Number of save slots to create (defaults to 1)
+ * @returns Array of save slot objects, each containing data and action methods
+ *
+ * @example
+ * ```tsx
+ * const slots = useSaveSlots({ count: 5 });
+ *
+ * return (
+ *   <div>
+ *     {slots.map((slot, index) => (
+ *       <div key={index}>
+ *         <p>Slot {index}: {slot.data ? 'Saved' : 'Empty'}</p>
+ *         <button onClick={() => slot.save()}>Save</button>
+ *         <button onClick={() => slot.load()} disabled={!slot.data}>Load</button>
+ *         <button onClick={() => slot.delete()} disabled={!slot.data}>Delete</button>
+ *       </div>
+ *     ))}
+ *   </div>
+ * );
+ * ```
+ */
+export const useSaveSlots = ({ count } = { count: 1 }) => {
+    const data = useLiveQuery(() => getAllSaves(), [], []);
+    const deleteGameHandler = useDeleteGame();
+    const saveGameHandler = useSaveGame();
+    const loadGameHandler = useLoadGame();
+    return useMemo(() => Array.from({ length: count }).map((_, index) => ({
+        data: data?.find((slot) => slot.name === `${index}`) || null,
+        save: async () => saveGameHandler(index),
+        load: async () => loadGameHandler(index),
+        delete: async () => deleteGameHandler(index),
+    })), [data, count, deleteGameHandler, loadGameHandler, saveGameHandler]);
+};
+//# sourceMappingURL=useSaveSlots.js.map

package/dist/saves/hooks/useSaveSlots.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSaveSlots.js","sourceRoot":"","sources":["../../../src/saves/hooks/useSaveSlots.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAEhC,OAAO,EAAY,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAC;AAExF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,EAAE,EAAE;IACrD,MAAM,IAAI,GAAG,YAAY,CAAC,GAAG,EAAE,CAAC,WAAW,EAAE,EAAE,EAAE,EAAE,EAAgB,CAAC,CAAC;IACrE,MAAM,iBAAiB,GAAG,aAAa,EAAE,CAAC;IAC1C,MAAM,eAAe,GAAG,WAAW,EAAE,CAAC;IACtC,MAAM,eAAe,GAAG,WAAW,EAAE,CAAC;IAEtC,OAAO,OAAO,CACV,GAAG,EAAE,CACD,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,GAAG,CAC7B,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QACX,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,GAAG,KAAK,EAAE,CAAC,IAAI,IAAI;QAC5D,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC;QACxC,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC;QACxC,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,iBAAiB,CAAC,KAAK,CAAC;KAC/C,CAAC,CACL,EACL,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,EAAE,eAAe,EAAE,eAAe,CAAC,CACrE,CAAC;AACN,CAAC,CAAC"}

package/dist/saves/index.d.ts

@@ -0,0 +1,4 @@
+export * from './db';
+export * from './hooks';
+export type * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/saves/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/saves/index.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC;AACrB,cAAc,SAAS,CAAC;AACxB,mBAAmB,SAAS,CAAC"}

package/dist/saves/index.js

@@ -0,0 +1,3 @@
+export * from './db';
+export * from './hooks';
+//# sourceMappingURL=index.js.map

package/dist/saves/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/saves/index.ts"],"names":[],"mappings":"AAAA,cAAc,MAAM,CAAC;AACrB,cAAc,SAAS,CAAC"}

package/dist/saves/types.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Represents a saved game state
+ */
+export interface GameSave {
+    /** Database auto-generated ID */
+    id?: number;
+    /** User-defined name for the save */
+    name: string;
+    /** Serialized game state data */
+    gameData: Record<string, unknown>;
+    /** When the save was created */
+    timestamp: Date;
+    /** Game version when the save was created */
+    version: string;
+    /** Base64 encoded screenshot (optional) */
+    screenshot?: string;
+    /** User-provided description (optional) */
+    description?: string;
+    /** Mark as system save (won't be shown in UI) */
+    isSystemSave?: boolean;
+}
+/**
+ * Represents a game setting stored in the database
+ */
+export interface GameSettings {
+    /** Database auto-generated ID */
+    id?: number;
+    /** Unique key for the setting */
+    key: string;
+    /** Setting value (can be string, number, boolean, or object) */
+    value: string | number | boolean | object;
+    /** When the setting was last updated */
+    timestamp: Date;
+    /** Game version when the setting was created/updated */
+    version: string;
+}
+/**
+ * Represents the state of save slots, used by React hooks
+ */
+export type SaveSlotsData = {
+    /** Whether there are no saves */
+    isEmpty: boolean;
+    /** Whether saves are currently being loaded */
+    isLoading: boolean;
+    /** Whether there was an error loading saves */
+    isError: boolean;
+    /** Error object if an error occurred */
+    error: Error | null;
+    /** Array of game saves */
+    data: GameSave[];
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/saves/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/saves/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,iCAAiC;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,iCAAiC;IACjC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAClC,gCAAgC;IAChC,SAAS,EAAE,IAAI,CAAC;IAChB,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,2CAA2C;IAC3C,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iDAAiD;IACjD,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,iCAAiC;IACjC,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,gEAAgE;IAChE,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;IAC1C,wCAAwC;IACxC,SAAS,EAAE,IAAI,CAAC;IAChB,wDAAwD;IACxD,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IACxB,iCAAiC;IACjC,OAAO,EAAE,OAAO,CAAC;IACjB,+CAA+C;IAC/C,SAAS,EAAE,OAAO,CAAC;IACnB,+CAA+C;IAC/C,OAAO,EAAE,OAAO,CAAC;IACjB,wCAAwC;IACxC,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC;IACpB,0BAA0B;IAC1B,IAAI,EAAE,QAAQ,EAAE,CAAC;CACpB,CAAC"}

package/dist/saves/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/saves/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/saves/types.ts"],"names":[],"mappings":""}

package/dist/storage.d.ts

@@ -0,0 +1,124 @@
+import { GameSaveState, JsonPath } from "./types";
+/**
+ * JSONPath-based storage system for game state persistence.
+ *
+ * The Storage class provides a flexible way to store and retrieve game state using
+ * JSONPath queries. It supports nested data structures and protects system paths
+ * from accidental modification.
+ *
+ * @see https://www.npmjs.com/package/jsonpath-plus - JSONPath Plus library documentation
+ *
+ * @example
+ * ```typescript
+ * // Set values
+ * Storage.setValue('$.player.health', 100);
+ * Storage.setValue('$.inventory.items', ['sword', 'shield']);
+ *
+ * // Get values
+ * const health = Storage.getValue<number>('$.player.health');
+ * const items = Storage.getValue<string[]>('$.inventory.items');
+ *
+ * // Full state
+ * const state = Storage.getState();
+ * Storage.setState(state);
+ * ```
+ */
+export declare class Storage {
+    /**
+     * Retrieves values from storage using a JSONPath query.
+     *
+     * Returns an array of matching values. If no matches are found, returns an empty array.
+     * The JSONPath Plus library supports complex queries including wildcards, filters, and deep scanning.
+     *
+     * @template T - The expected type of values to retrieve
+     * @param jsonPath - The JSONPath query string (e.g., '$.player.health', '$.inventory.items[*]')
+     * @returns Array of values matching the JSONPath query
+     *
+     * @example
+     * ```typescript
+     * // Get a single value (returns array with one element)
+     * const health = Storage.getValue<number>('$.player.health');
+     * if (health.length > 0) {
+     *   console.log(health[0]); // 100
+     * }
+     *
+     * // Get multiple values with wildcard
+     * const allItems = Storage.getValue<string>('$.inventory.*.name');
+     * ```
+     */
+    static getValue<T>(jsonPath: JsonPath): Array<T>;
+    /**
+     * Sets a value in storage at the specified JSONPath.
+     *
+     * If the path exists, updates the value. If the path doesn't exist, creates it.
+     * System paths (prefixed with STORAGE_SYSTEM_PATH) are protected from external modification.
+     *
+     * @template T - The type of value to set
+     * @param jsonPath - The JSONPath where the value should be set
+     * @param value - The value to set at the specified JSONPath
+     * @param _isSystem - Internal flag to allow system path modification (default: false)
+     * @throws Error if attempting to modify a system path without _isSystem flag
+     *
+     * @example
+     * ```typescript
+     * // Set a simple value
+     * Storage.setValue('$.player.health', 75);
+     *
+     * // Set a complex object
+     * Storage.setValue('$.player.stats', { str: 10, dex: 8 });
+     *
+     * // System paths are protected
+     * Storage.setValue('$._system.game', {}); // Throws error
+     * ```
+     */
+    static setValue<T>(jsonPath: JsonPath, value: T, _isSystem?: boolean): void;
+    /**
+     * Retrieves the entire storage state as a plain object.
+     *
+     * @returns The complete storage state, ready for serialization
+     *
+     * @example
+     * ```typescript
+     * const state = Storage.getState();
+     * localStorage.setItem('save', JSON.stringify(state));
+     * ```
+     */
+    static getState(): GameSaveState;
+    /**
+     * Replaces the entire storage state with a new state object.
+     *
+     * Clears all existing storage data and replaces it with the provided state.
+     * Useful for loading saved games or resetting to a specific state.
+     *
+     * @param state - The new state to set for the storage
+     * @throws Error if state is not a valid object
+     *
+     * @example
+     * ```typescript
+     * const savedState = JSON.parse(localStorage.getItem('save'));
+     * Storage.setState(savedState);
+     * ```
+     */
+    static setState(state: GameSaveState): void;
+    /**
+     * Creates a nested path in storage and assigns a value.
+     *
+     * Parses the JSONPath and creates all necessary intermediate objects/arrays
+     * to build the path if it doesn't exist. Supports both object properties and array indices.
+     *
+     * @private - Used internally by setValue when creating new paths
+     * @template T - The type of value to set at the path
+     * @param obj - The target object where the path will be created
+     * @param jsonPath - The JSONPath string specifying the location
+     * @param value - The value to set at the specified location
+     *
+     * @example
+     * ```typescript
+     * // Creates $.player.inventory.items[0] = 'sword'
+     * // Will create player object, inventory object, items array automatically
+     * Storage.createPath(storage, '$.player.inventory.items[0]', 'sword');
+     * ```
+     */
+    private static createPath;
+}
+//# sourceMappingURL=storage.d.ts.map

package/dist/storage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"storage.d.ts","sourceRoot":"","sources":["../src/storage.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAIjD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,OAAO;IAChB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC;IAIhD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,MAAM,CAAC,QAAQ,CAAC,CAAC,EACb,QAAQ,EAAE,QAAQ,EAClB,KAAK,EAAE,CAAC,EACR,SAAS,GAAE,OAAe,GAC3B,IAAI;IAkCP;;;;;;;;;;OAUG;IACH,MAAM,CAAC,QAAQ,IAAI,aAAa;IAIhC;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI;IAY3C;;;;;;;;;;;;;;;;;;OAkBG;IACH,OAAO,CAAC,MAAM,CAAC,UAAU;CA8E5B"}