tiny-essentials 1.19.0 → 1.19.2

package/dist/v1/TinyEssentials.js

@@ -18860,6 +18860,22 @@ const customEncoders = new Map();
 /** @type {Map<any, DecodeFn>} */
 const customDecoders = new Map();
 
+/** @type {Set<any>} */
+const customTypesFreezed = new Set([
+  'string',
+  'boolean',
+  'number',
+  'object',
+  'array',
+  String,
+  Boolean,
+  Number,
+  Object,
+  Array,
+  BigInt,
+  Symbol,
+]);
+
 /**
  * A function that encodes a value into a serializable JSON-compatible format.
  *
@@ -19131,26 +19147,49 @@ class TinyLocalStorage {
 
   ///////////////////////////////////////////////////
 
+  /**
+   * Checks whether a JSON-serializable type is already registered.
+   *
+   * @param {any} type - The type identifier, which can be a string (e.g., `"bigint"`, `"symbol"`)
+   *                     or a reference to a class/constructor function.
+   * @returns {boolean} True if the type has both an encoder and decoder registered.
+   */
+  static hasJsonType(type) {
+    return (customEncoders.has(type) && customDecoders.has(type)) || customTypesFreezed.has(type);
+  }
+
   /**
    * Registers a new JSON-serializable type with its encoder and decoder.
    *
-   * @param {any} type - The type or primitive type name (e.g. `"bigint"`, `"symbol"`, etc).
-   * @param {EncodeFn} encodeFn - The function that encodes the value.
-   * @param {DecodeFn} decodeFn - An object with `check` and `decode` methods for restoring the value.
+   * @param {any} type - The type identifier, which can be a string (e.g., `"bigint"`, `"symbol"`)
+   *                     or a reference to a class/constructor function.
+   * @param {EncodeFn} encodeFn - A function that receives a value of this type and returns a JSON-safe representation.
+   * @param {DecodeFn} decodeFn - An object with `check(value)` to identify this type and `decode(value)` to restore it.
+   * @param {boolean} [freezeType=false] - If true, prevents this type from being unregistered later.
+   * @throws {Error} Throws an error if the type is frozen and cannot be registered.
    */
-  static registerJsonType(type, encodeFn, decodeFn) {
+  static registerJsonType(type, encodeFn, decodeFn, freezeType = false) {
+    if (customTypesFreezed.has(type))
+      throw new Error(`Cannot register type "${type}" because it is frozen.`);
     customEncoders.set(type, encodeFn);
     customDecoders.set(type, decodeFn);
+    if (freezeType) customTypesFreezed.add(type);
   }
 
   /**
-   * Removes a previously registered custom type from the encoding/decoding system.
+   * Unregisters a previously registered custom type from the encoding/decoding system.
    *
-   * @param {string} type - The primitive name or constructor reference used in registration.
+   * @param {any} type - The primitive name or constructor reference used in the registration.
+   * @returns {boolean} Returns true if the type existed and was removed, or false if it wasn't found.
+   * @throws {Error} Throws an error if the type is frozen and cannot be unregistered.
    */
   static deleteJsonType(type) {
-    customEncoders.delete(type);
-    customDecoders.delete(type);
+    if (customTypesFreezed.has(type))
+      throw new Error(`Cannot remove type "${type}" because it is frozen.`);
+    let isDeleted = false;
+    if (customEncoders.delete(type)) isDeleted = true;
+    if (customDecoders.delete(type)) isDeleted = true;
+    return isDeleted;
   }
 
   //////////////////////////////////////////////////////
@@ -19297,7 +19336,7 @@ class TinyLocalStorage {
     }
     const encoded = this.#setJson(name, data);
     this.emit('setJson', name, data);
-    this.#localStorage.setItem(name, JSON.stringify(encoded));
+    return this.#localStorage.setItem(name, JSON.stringify(encoded));
   }
 
   /**
@@ -19367,8 +19406,8 @@ class TinyLocalStorage {
   setDate(name, data) {
     if (!(data instanceof Date)) throw new Error('Value must be a Date.');
     const encoded = this.#setJson(name, data);
-    this.#localStorage.setItem(name, JSON.stringify(encoded));
     this.emit('setDate', name, data);
+    return this.#localStorage.setItem(name, JSON.stringify(encoded));
   }
 
   /**
@@ -19389,8 +19428,8 @@ class TinyLocalStorage {
   setRegExp(name, data) {
     if (!(data instanceof RegExp)) throw new Error('Value must be a RegExp.');
     const encoded = this.#setJson(name, data);
-    this.#localStorage.setItem(name, JSON.stringify(encoded));
     this.emit('setRegExp', name, data);
+    return this.#localStorage.setItem(name, JSON.stringify(encoded));
   }
 
   /**
@@ -19411,8 +19450,8 @@ class TinyLocalStorage {
   setBigInt(name, data) {
     if (typeof data !== 'bigint') throw new Error('Value must be a BigInt.');
     const encoded = this.#setJson(name, data);
-    this.#localStorage.setItem(name, JSON.stringify(encoded));
     this.emit('setBigInt', name, data);
+    return this.#localStorage.setItem(name, JSON.stringify(encoded));
   }
 
   /**
@@ -19434,8 +19473,8 @@ class TinyLocalStorage {
   setSymbol(name, data) {
     if (typeof data !== 'symbol') throw new Error('Value must be a Symbol.');
     const encoded = this.#setJson(name, data);
-    this.#localStorage.setItem(name, JSON.stringify(encoded));
     this.emit('setSymbol', name, data);
+    return this.#localStorage.setItem(name, JSON.stringify(encoded));
   }
 
   /**
@@ -19495,7 +19534,13 @@ class TinyLocalStorage {
     if (typeof data !== 'string') throw new Error('Value must be a string.');
 
     this.emit('setString', name, data);
-    return this.#localStorage.setItem(name, data);
+    return this.#localStorage.setItem(
+      name,
+      JSON.stringify({
+        __string__: true,
+        value: data,
+      }),
+    );
   }
 
   /**
@@ -19508,6 +19553,15 @@ class TinyLocalStorage {
     if (typeof name !== 'string' || !name.length)
       throw new Error('Key must be a non-empty string.');
     let value = this.#localStorage.getItem(name);
+    try {
+      /** @type {{ value: string; __string__: boolean }} */
+      // @ts-ignore
+      value = JSON.parse(value);
+      if (!isJsonObject(value) || !value.__string__ || typeof value.value !== 'string') return null;
+      value = value.value;
+    } catch {
+      value = null;
+    }
     if (typeof value === 'string') return value;
     return null;
   }
@@ -19597,7 +19651,7 @@ class TinyLocalStorage {
    * Clears all data from `localStorage`.
    */
   clearLocalStorage() {
-    this.#localStorage.clear();
+    return this.#localStorage.clear();
   }
 
   /**
@@ -19624,6 +19678,7 @@ TinyLocalStorage.registerJsonType(
     decode: (value, decodeSpecialJson) =>
       new Map(value.data.map(([k, v]) => [k, decodeSpecialJson(v)])),
   },
+  true,
 );
 
 // Set
@@ -19637,6 +19692,7 @@ TinyLocalStorage.registerJsonType(
     check: (value) => value.__set__,
     decode: (value, decodeSpecialJson) => new Set(value.data.map(decodeSpecialJson)),
   },
+  true,
 );
 
 // Date
@@ -19650,6 +19706,7 @@ TinyLocalStorage.registerJsonType(
     check: (value) => value.__date__,
     decode: (value) => new Date(value.value),
   },
+  true,
 );
 
 // Regex
@@ -19664,6 +19721,7 @@ TinyLocalStorage.registerJsonType(
     check: (value) => value.__regexp__,
     decode: (value) => new RegExp(value.source, value.flags),
   },
+  true,
 );
 
 // Big Int
@@ -19677,6 +19735,7 @@ TinyLocalStorage.registerJsonType(
     check: (value) => value.__bigint__,
     decode: (value) => BigInt(value.value),
   },
+  true,
 );
 
 // Symbol
@@ -19693,6 +19752,7 @@ TinyLocalStorage.registerJsonType(
       return key != null ? Symbol.for(key) : Symbol();
     },
   },
+  true,
 );
 
 /* harmony default export */ const libs_TinyLocalStorage = (TinyLocalStorage);