graphico 1.1.2 → 1.2.1

package/README.md

@@ -13,6 +13,7 @@
 - **User interaction** captured via keyboard inputs or mouse movements or clicks
 - Multiple audio tracks supported by system **audio player** with volume, mute, and loop toggle
 - Built-in logic for **screenshots** and **screen recordings** that capture both video and audio
+- Secure and convenient **browser storage** that persists across browser and system restarts
 
 ## Caveats
 

package/dist/canvas.js

@@ -410,6 +410,63 @@ var Canvas = /** @class */ (function () {
             this.layers[layer].clearRect(0, 0, this.config.width, this.config.height);
         }
     };
+    /**
+     * Save arbitrary data to the browser storage.
+     * **Warning:** This will overwrite any existing data under these object keys.
+     * @param data The arbirary data object to save
+     * @param name An optional "namespace" to store the data, which can be assigned when a user has multiple profiles, for example
+     */
+    Canvas.prototype.saveData = function (data, name) {
+        if (name === void 0) { name = 'data'; }
+        var key = this.encode(name);
+        var value = this.encode(data);
+        localStorage.setItem(key, value);
+        this.log("Saved \"".concat(data, "\" in ").concat(name, "."));
+    };
+    /**
+     * Load arbitrary data from the browser storage.
+     * **Warning:** The loaded data object is not strictly type-checked or sanitized, so it may have missing fields or contain extra fields. It's good practice to manually validate the data once it's loaded from storage.
+     * @param name An optional "namespace" to load data from, assigned when saving data
+     * @returns The data object loaded from browser storage
+     */
+    Canvas.prototype.loadData = function (name) {
+        if (name === void 0) { name = 'data'; }
+        var key = this.encode(name);
+        var value = localStorage.getItem(key);
+        if (value) {
+            try {
+                var decoded = this.decode(value);
+                this.log("Loaded \"".concat(decoded, "\" from ").concat(name, "."));
+                return decoded;
+            }
+            catch (_a) {
+                this.log("Failed to load ".concat(name, "."));
+            }
+        }
+        return undefined;
+    };
+    /**
+     * Clear **all** saved data. This action is permanent!
+     * @param name An optional "namespace" to clear data from.
+     */
+    Canvas.prototype.clearData = function (name) {
+        if (name === void 0) { name = 'data'; }
+        var key = this.encode(name);
+        localStorage.removeItem(key);
+        this.log("Removed ".concat(name, " from storage."));
+    };
+    /**
+     * Encode data for local browser storage.
+     */
+    Canvas.prototype.encode = function (raw) {
+        return btoa(encodeURIComponent(JSON.stringify(raw)));
+    };
+    /**
+     * Decode data from local browser storage.
+     */
+    Canvas.prototype.decode = function (code) {
+        return JSON.parse(decodeURIComponent(atob(code)));
+    };
     /**
      * Log a message to the debug console.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graphico",
-  "version": "1.1.2",
+  "version": "1.2.1",
   "description": "Canvas 2D rendering toolkit for games and visual projects",
   "homepage": "https://npm.nicfv.com/",
   "bin": "",

package/types/canvas.d.ts

@@ -155,6 +155,33 @@ export declare class Canvas {
      * @param layer The zero-indexed layer to clear, if unset, will clear all layers
      */
     clear(layer?: number): void;
+    /**
+     * Save arbitrary data to the browser storage.
+     * **Warning:** This will overwrite any existing data under these object keys.
+     * @param data The arbirary data object to save
+     * @param name An optional "namespace" to store the data, which can be assigned when a user has multiple profiles, for example
+     */
+    saveData<T>(data: T, name?: string): void;
+    /**
+     * Load arbitrary data from the browser storage.
+     * **Warning:** The loaded data object is not strictly type-checked or sanitized, so it may have missing fields or contain extra fields. It's good practice to manually validate the data once it's loaded from storage.
+     * @param name An optional "namespace" to load data from, assigned when saving data
+     * @returns The data object loaded from browser storage
+     */
+    loadData<T>(name?: string): Partial<T> | undefined;
+    /**
+     * Clear **all** saved data. This action is permanent!
+     * @param name An optional "namespace" to clear data from.
+     */
+    clearData(name?: string): void;
+    /**
+     * Encode data for local browser storage.
+     */
+    private encode;
+    /**
+     * Decode data from local browser storage.
+     */
+    private decode;
     /**
      * Log a message to the debug console.
      */