@sv443-network/userutils 10.0.3 → 10.0.5

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @sv443-network/userutils
 
+## 10.0.5
+
+### Patch Changes
+
+- 0c63a9b: Added UMD bundle explicitly made for userscript usage (at `dist/UserUtils.user.js`).
+
+## 10.0.4
+
+### Patch Changes
+
+- 13159d8: Updated CoreUtils to fix underlying encoding and decoding inconsistencies.
+
 ## 10.0.3
 
 ### Patch Changes

package/README.md

@@ -102,7 +102,6 @@ View the documentation of previous major versions:
     - 🟧 [`class DataStore`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-datastore) - The main class for the data store
       - 🔷 [`type DataStoreOptions`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-datastoreoptions) - Options for the data store
       - 🔷 [`type DataMigrationsDict`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-datamigrationsdict) - Dictionary of data migration functions
-      - 🔷 [`type DataStoreData`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-datastoredata) - The type of the serializable data
     - 🟧 [`class DataStoreSerializer`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-datastoreserializer) - Serializes and deserializes data for multiple DataStore instances
       - 🔷 [`type DataStoreSerializerOptions`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-datastoreserializeroptions) - Options for the DataStoreSerializer
       - 🔷 [`type LoadStoresDataResult`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-loadstoresdataresult) - Result of calling [`loadStoresData()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#datastoreserializer-loadstoresdata)
@@ -164,19 +163,6 @@ View the documentation of previous major versions:
     - 🟣 [`function joinArrayReadable()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-joinarrayreadable) - Joins the given array into a string, using the given separators and last separator
     - 🟣 [`function secsToTimeStr()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-secstotimestr) - Turns the given number of seconds into a string in the format `(hh:)mm:ss` with intelligent zero-padding
     - 🟣 [`function truncStr()`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#function-truncstr) - Truncates the given string to the given length
-  <!-- - *[**TieredCache:**](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#tieredcache)
-    - 🟧 *[`class TieredCache`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-tieredcache) - A multi-tier cache that uses multiple storage engines with different expiration times
-      - 🔷 *[`type TieredCacheOptions`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-tieredcacheoptions) - Options for the [`TieredCache` class](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-tieredcache)
-      - 🔷 *[`type TieredCachePropagateTierOptions`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-tieredcachestaleoptions) - Entry propagation options for each tier
-      - 🔷 *[`type TieredCacheStaleOptions`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-tieredcachepropagatetieroptions) - Entry staleness options for each tier
-      - 🔷 *[`type TieredCacheTierOptions`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-tieredcachetieroptions) - Options for each tier of a [`TieredCache` instance](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-tieredcache)
-  - *[**Translate:**](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#translate)
-    - 🟧 *[`class Translate`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-translate) - JSON-based translation system supporting transformation hooks, value injection, nested objects, etc.
-    - 🔷 *[`type TransformFn`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-transformfn) - The type of the transformation hook functions
-    - 🔷 *[`type TransformFnProps`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-transformfnprops) - The properties passed to the transformation functions
-    - 🔷 *[`type TranslateOptions`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-translateoptions) - The options for the [`Translate` class](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-translate)
-    - 🔷 *[`type TrKeys`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-trkeys) - Generic type that gives you a union of keys from the passed [`TrObject` object](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-trobject)
-    - 🔷 *[`type TrObject`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-trobject) - The translation object for a specific language -->
   - [**Misc. Types:**](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#types)
     - 🔷 [`type LooseUnion`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-looseunion) - A union type that allows for autocomplete suggestions as well as substitutions of the same type
     - 🔷 [`type ListLike`](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#type-listlike) - Any value with a quantifiable `length`, `count` or `size` property
@@ -229,8 +215,8 @@ Shameless plug: I made a [template for userscripts in TypeScript](https://github
   
   Versioned (recommended):
   ```
-  // @require https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js
-  // @require https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js
+  // @require https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/UserUtils.user.js
+  // @require https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/UserUtils.user.js
   ```
   Non-versioned (not recommended because it auto-updates):
   ```
@@ -240,12 +226,12 @@ Shameless plug: I made a [template for userscripts in TypeScript](https://github
 
 - If you are using this library in a generic DOM environment without access to the GreaseMonkey API, either download the latest release from the [releases page](https://github.com/Sv443-Network/UserUtils/releases) to include in your project or add one of the following tags to the &lt;head&gt;:
   ```html
-  <script src="https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js"></script>
-  <script src="https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/index.global.js"></script>
+  <script src="https://cdn.jsdelivr.net/npm/@sv443-network/userutils@INSERT_VERSION/dist/UserUtils.umd.js"></script>
+  <script src="https://unpkg.com/@sv443-network/userutils@INSERT_VERSION/dist/UserUtils.umd.js"></script>
   ```
 
 > [!NOTE]  
-> In order for your script not to break on a major library update, use one the versioned URLs above after replacing `INSERT_VERSION` with the desired version (e.g. `8.3.2`) or the versioned URL that's shown [at the top of the GreasyFork page.](https://greasyfork.org/scripts/472956-userutils)  
+> In order for your script not to break on a major library update, use one the versioned URLs above after replacing `INSERT_VERSION` with the desired version (e.g. `10.0.4`) or the versioned URL that's shown [at the top of the GreasyFork page.](https://greasyfork.org/scripts/472956-userutils)  
 
 <br>
 

package/dist/UserUtils.cjs

@@ -114,7 +114,7 @@ __export(lib_exports, {
 });
 module.exports = __toCommonJS(lib_exports);
 
-// node_modules/.pnpm/@sv443-network+coreutils@3.0.3/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
+// node_modules/.pnpm/@sv443-network+coreutils@3.0.4/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
 function bitSetHas(bitSet, checkVal) {
   return (bitSet & checkVal) === checkVal;
 }
@@ -598,7 +598,6 @@ var DataStore = class {
    * @param opts The options for this DataStore instance
    */
   constructor(opts) {
-    var _a;
     this.id = opts.id;
     this.formatVersion = opts.formatVersion;
     this.defaultData = opts.defaultData;
@@ -607,16 +606,9 @@ var DataStore = class {
     this.migrations = opts.migrations;
     if (opts.migrateIds)
       this.migrateIds = Array.isArray(opts.migrateIds) ? opts.migrateIds : [opts.migrateIds];
-    this.encodeData = opts.encodeData;
-    this.decodeData = opts.decodeData;
     this.engine = typeof opts.engine === "function" ? opts.engine() : opts.engine;
     this.options = opts;
-    if (typeof opts.compressionFormat === "undefined")
-      this.compressionFormat = opts.compressionFormat = ((_a = opts.encodeData) == null ? void 0 : _a[0]) ?? "deflate-raw";
-    if (typeof opts.compressionFormat === "string") {
-      this.encodeData = [opts.compressionFormat, async (data) => await compress(data, opts.compressionFormat, "string")];
-      this.decodeData = [opts.compressionFormat, async (data) => await decompress(data, opts.compressionFormat, "string")];
-    } else if ("encodeData" in opts && "decodeData" in opts && Array.isArray(opts.encodeData) && Array.isArray(opts.decodeData)) {
+    if ("encodeData" in opts && "decodeData" in opts && Array.isArray(opts.encodeData) && Array.isArray(opts.decodeData)) {
       this.encodeData = [opts.encodeData[0], opts.encodeData[1]];
       this.decodeData = [opts.decodeData[0], opts.decodeData[1]];
       this.compressionFormat = opts.encodeData[0] ?? null;
@@ -624,9 +616,17 @@ var DataStore = class {
       this.encodeData = void 0;
       this.decodeData = void 0;
       this.compressionFormat = null;
-    } else
-      throw new TypeError("Either `compressionFormat` or `encodeData` and `decodeData` have to be set and valid, but not all three at a time. Please refer to the documentation for more info.");
-    this.engine.setDataStoreOptions(opts);
+    } else {
+      const fmt = typeof opts.compressionFormat === "string" ? opts.compressionFormat : "deflate-raw";
+      this.compressionFormat = fmt;
+      this.encodeData = [fmt, async (data) => await compress(data, fmt, "string")];
+      this.decodeData = [fmt, async (data) => await decompress(data, fmt, "string")];
+    }
+    this.engine.setDataStoreOptions({
+      id: this.id,
+      encodeData: this.encodeData,
+      decodeData: this.decodeData
+    });
   }
   //#region loadData
   /**
@@ -674,7 +674,7 @@ var DataStore = class {
       }
       const storedData = storedDataRaw ?? JSON.stringify(this.defaultData);
       const encodingFmt = String(await this.engine.getValue(`__ds-${this.id}-enf`, null));
-      const isEncoded = encodingFmt !== "null" && encodingFmt !== "false";
+      const isEncoded = encodingFmt !== "null" && encodingFmt !== "false" && encodingFmt !== "0" && encodingFmt !== "" && encodingFmt !== null;
       let saveData = false;
       if (isNaN(storedFmtVer)) {
         await this.engine.setValue(`__ds-${this.id}-ver`, storedFmtVer = this.formatVersion);
@@ -781,7 +781,7 @@ var DataStore = class {
       }
     }
     await Promise.allSettled([
-      this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(newData)),
+      this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(newData, this.encodingEnabled())),
       this.engine.setValue(`__ds-${this.id}-ver`, lastFmtVer),
       this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat)
     ]);
@@ -810,7 +810,7 @@ var DataStore = class {
         return;
       const parsed = await this.engine.deserializeData(data, isEncoded);
       await Promise.allSettled([
-        this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(parsed)),
+        this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(parsed, this.encodingEnabled())),
         this.engine.setValue(`__ds-${this.id}-ver`, fmtVer),
         this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat),
         this.engine.deleteValue(`__ds-${id}-dat`),

package/dist/UserUtils.mjs

@@ -1,4 +1,4 @@
-// node_modules/.pnpm/@sv443-network+coreutils@3.0.3/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
+// node_modules/.pnpm/@sv443-network+coreutils@3.0.4/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
 function bitSetHas(bitSet, checkVal) {
   return (bitSet & checkVal) === checkVal;
 }
@@ -482,7 +482,6 @@ var DataStore = class {
    * @param opts The options for this DataStore instance
    */
   constructor(opts) {
-    var _a;
     this.id = opts.id;
     this.formatVersion = opts.formatVersion;
     this.defaultData = opts.defaultData;
@@ -491,16 +490,9 @@ var DataStore = class {
     this.migrations = opts.migrations;
     if (opts.migrateIds)
       this.migrateIds = Array.isArray(opts.migrateIds) ? opts.migrateIds : [opts.migrateIds];
-    this.encodeData = opts.encodeData;
-    this.decodeData = opts.decodeData;
     this.engine = typeof opts.engine === "function" ? opts.engine() : opts.engine;
     this.options = opts;
-    if (typeof opts.compressionFormat === "undefined")
-      this.compressionFormat = opts.compressionFormat = ((_a = opts.encodeData) == null ? void 0 : _a[0]) ?? "deflate-raw";
-    if (typeof opts.compressionFormat === "string") {
-      this.encodeData = [opts.compressionFormat, async (data) => await compress(data, opts.compressionFormat, "string")];
-      this.decodeData = [opts.compressionFormat, async (data) => await decompress(data, opts.compressionFormat, "string")];
-    } else if ("encodeData" in opts && "decodeData" in opts && Array.isArray(opts.encodeData) && Array.isArray(opts.decodeData)) {
+    if ("encodeData" in opts && "decodeData" in opts && Array.isArray(opts.encodeData) && Array.isArray(opts.decodeData)) {
       this.encodeData = [opts.encodeData[0], opts.encodeData[1]];
       this.decodeData = [opts.decodeData[0], opts.decodeData[1]];
       this.compressionFormat = opts.encodeData[0] ?? null;
@@ -508,9 +500,17 @@ var DataStore = class {
       this.encodeData = void 0;
       this.decodeData = void 0;
       this.compressionFormat = null;
-    } else
-      throw new TypeError("Either `compressionFormat` or `encodeData` and `decodeData` have to be set and valid, but not all three at a time. Please refer to the documentation for more info.");
-    this.engine.setDataStoreOptions(opts);
+    } else {
+      const fmt = typeof opts.compressionFormat === "string" ? opts.compressionFormat : "deflate-raw";
+      this.compressionFormat = fmt;
+      this.encodeData = [fmt, async (data) => await compress(data, fmt, "string")];
+      this.decodeData = [fmt, async (data) => await decompress(data, fmt, "string")];
+    }
+    this.engine.setDataStoreOptions({
+      id: this.id,
+      encodeData: this.encodeData,
+      decodeData: this.decodeData
+    });
   }
   //#region loadData
   /**
@@ -558,7 +558,7 @@ var DataStore = class {
       }
       const storedData = storedDataRaw ?? JSON.stringify(this.defaultData);
       const encodingFmt = String(await this.engine.getValue(`__ds-${this.id}-enf`, null));
-      const isEncoded = encodingFmt !== "null" && encodingFmt !== "false";
+      const isEncoded = encodingFmt !== "null" && encodingFmt !== "false" && encodingFmt !== "0" && encodingFmt !== "" && encodingFmt !== null;
       let saveData = false;
       if (isNaN(storedFmtVer)) {
         await this.engine.setValue(`__ds-${this.id}-ver`, storedFmtVer = this.formatVersion);
@@ -665,7 +665,7 @@ var DataStore = class {
       }
     }
     await Promise.allSettled([
-      this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(newData)),
+      this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(newData, this.encodingEnabled())),
       this.engine.setValue(`__ds-${this.id}-ver`, lastFmtVer),
       this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat)
     ]);
@@ -694,7 +694,7 @@ var DataStore = class {
         return;
       const parsed = await this.engine.deserializeData(data, isEncoded);
       await Promise.allSettled([
-        this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(parsed)),
+        this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(parsed, this.encodingEnabled())),
         this.engine.setValue(`__ds-${this.id}-ver`, fmtVer),
         this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat),
         this.engine.deleteValue(`__ds-${id}-dat`),

package/dist/UserUtils.umd.js

@@ -183,7 +183,7 @@ __export(lib_exports, {
 });
 module.exports = __toCommonJS(lib_exports);
 
-// node_modules/.pnpm/@sv443-network+coreutils@3.0.3/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
+// node_modules/.pnpm/@sv443-network+coreutils@3.0.4/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
 function bitSetHas(bitSet, checkVal) {
   return (bitSet & checkVal) === checkVal;
 }
@@ -681,40 +681,40 @@ var DataStore = class {
     __publicField(this, "cachedData");
     __publicField(this, "migrations");
     __publicField(this, "migrateIds", []);
-    var _a2, _b, _c;
-    var _a;
+    var _a, _b;
     this.id = opts.id;
     this.formatVersion = opts.formatVersion;
     this.defaultData = opts.defaultData;
-    this.memoryCache = Boolean((_a2 = opts.memoryCache) != null ? _a2 : true);
+    this.memoryCache = Boolean((_a = opts.memoryCache) != null ? _a : true);
     this.cachedData = this.memoryCache ? opts.defaultData : {};
     this.migrations = opts.migrations;
     if (opts.migrateIds)
       this.migrateIds = Array.isArray(opts.migrateIds) ? opts.migrateIds : [opts.migrateIds];
-    this.encodeData = opts.encodeData;
-    this.decodeData = opts.decodeData;
     this.engine = typeof opts.engine === "function" ? opts.engine() : opts.engine;
     this.options = opts;
-    if (typeof opts.compressionFormat === "undefined")
-      this.compressionFormat = opts.compressionFormat = (_b = (_a = opts.encodeData) == null ? void 0 : _a[0]) != null ? _b : "deflate-raw";
-    if (typeof opts.compressionFormat === "string") {
-      this.encodeData = [opts.compressionFormat, (data) => __async(this, null, function* () {
-        return yield compress(data, opts.compressionFormat, "string");
-      })];
-      this.decodeData = [opts.compressionFormat, (data) => __async(this, null, function* () {
-        return yield decompress(data, opts.compressionFormat, "string");
-      })];
-    } else if ("encodeData" in opts && "decodeData" in opts && Array.isArray(opts.encodeData) && Array.isArray(opts.decodeData)) {
+    if ("encodeData" in opts && "decodeData" in opts && Array.isArray(opts.encodeData) && Array.isArray(opts.decodeData)) {
       this.encodeData = [opts.encodeData[0], opts.encodeData[1]];
       this.decodeData = [opts.decodeData[0], opts.decodeData[1]];
-      this.compressionFormat = (_c = opts.encodeData[0]) != null ? _c : null;
+      this.compressionFormat = (_b = opts.encodeData[0]) != null ? _b : null;
     } else if (opts.compressionFormat === null) {
       this.encodeData = void 0;
       this.decodeData = void 0;
       this.compressionFormat = null;
-    } else
-      throw new TypeError("Either `compressionFormat` or `encodeData` and `decodeData` have to be set and valid, but not all three at a time. Please refer to the documentation for more info.");
-    this.engine.setDataStoreOptions(opts);
+    } else {
+      const fmt = typeof opts.compressionFormat === "string" ? opts.compressionFormat : "deflate-raw";
+      this.compressionFormat = fmt;
+      this.encodeData = [fmt, (data) => __async(this, null, function* () {
+        return yield compress(data, fmt, "string");
+      })];
+      this.decodeData = [fmt, (data) => __async(this, null, function* () {
+        return yield decompress(data, fmt, "string");
+      })];
+    }
+    this.engine.setDataStoreOptions({
+      id: this.id,
+      encodeData: this.encodeData,
+      decodeData: this.decodeData
+    });
   }
   //#region loadData
   /**
@@ -764,7 +764,7 @@ var DataStore = class {
         }
         const storedData = storedDataRaw != null ? storedDataRaw : JSON.stringify(this.defaultData);
         const encodingFmt = String(yield this.engine.getValue(`__ds-${this.id}-enf`, null));
-        const isEncoded = encodingFmt !== "null" && encodingFmt !== "false";
+        const isEncoded = encodingFmt !== "null" && encodingFmt !== "false" && encodingFmt !== "0" && encodingFmt !== "" && encodingFmt !== null;
         let saveData = false;
         if (isNaN(storedFmtVer)) {
           yield this.engine.setValue(`__ds-${this.id}-ver`, storedFmtVer = this.formatVersion);
@@ -877,7 +877,7 @@ var DataStore = class {
         }
       }
       yield Promise.allSettled([
-        this.engine.setValue(`__ds-${this.id}-dat`, yield this.engine.serializeData(newData)),
+        this.engine.setValue(`__ds-${this.id}-dat`, yield this.engine.serializeData(newData, this.encodingEnabled())),
         this.engine.setValue(`__ds-${this.id}-ver`, lastFmtVer),
         this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat)
       ]);
@@ -908,7 +908,7 @@ var DataStore = class {
           return;
         const parsed = yield this.engine.deserializeData(data, isEncoded);
         yield Promise.allSettled([
-          this.engine.setValue(`__ds-${this.id}-dat`, yield this.engine.serializeData(parsed)),
+          this.engine.setValue(`__ds-${this.id}-dat`, yield this.engine.serializeData(parsed, this.encodingEnabled())),
           this.engine.setValue(`__ds-${this.id}-ver`, fmtVer),
           this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat),
           this.engine.deleteValue(`__ds-${id}-dat`),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "10.0.3",
+  "version": "10.0.5",
   "description": "General purpose DOM/GreaseMonkey library that allows you to register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and much more",
   "main": "dist/UserUtils.mjs",
   "module": "dist/UserUtils.mjs",
@@ -33,7 +33,7 @@
   },
   "homepage": "https://github.com/Sv443-Network/UserUtils",
   "dependencies": {
-    "@sv443-network/coreutils": "3.0.3",
+    "@sv443-network/coreutils": "3.0.4",
     "nanoevents": "9.1.0"
   },
   "devDependencies": {