@sv443-network/userutils 10.0.4 → 10.0.6

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @sv443-network/userutils
 
+## 10.0.6
+
+### Patch Changes
+
+- 85540a2: Updated to [CoreUtils v3.0.5](https://github.com/Sv443-Network/CoreUtils/releases/tag/%40sv443-network%2Fcoreutils%403.0.5)
+
+## 10.0.5
+
+### Patch Changes
+
+- 0c63a9b: Added UMD bundle explicitly made for userscript usage (at `dist/UserUtils.user.js`).
+
 ## 10.0.4
 
 ### 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.4/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
+// node_modules/.pnpm/@sv443-network+coreutils@3.0.5/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
 function bitSetHas(bitSet, checkVal) {
   return (bitSet & checkVal) === checkVal;
 }
@@ -574,7 +574,7 @@ var DataStore = class {
   encodeData;
   decodeData;
   compressionFormat = "deflate-raw";
-  memoryCache = true;
+  memoryCache;
   engine;
   options;
   /**
@@ -601,7 +601,7 @@ var DataStore = class {
     this.id = opts.id;
     this.formatVersion = opts.formatVersion;
     this.defaultData = opts.defaultData;
-    this.memoryCache = Boolean(opts.memoryCache ?? true);
+    this.memoryCache = opts.memoryCache ?? true;
     this.cachedData = this.memoryCache ? opts.defaultData : {};
     this.migrations = opts.migrations;
     if (opts.migrateIds)
@@ -699,7 +699,7 @@ var DataStore = class {
   /**
    * Returns a copy of the data from the in-memory cache.  
    * Use {@linkcode loadData()} to get fresh data from persistent storage (usually not necessary since the cache should always exactly reflect persistent storage).  
-   * ⚠️ If `memoryCache` was set to `false` in the constructor options, this method will throw an error.
+   * ⚠️ Only available when `memoryCache` is `true` (default). When set to `false`, this produces a type and runtime error - use {@linkcode loadData()} instead.
    */
   getData() {
     if (!this.memoryCache)
@@ -776,7 +776,7 @@ var DataStore = class {
           if (!resetOnError)
             throw new MigrationError(`Error while running migration function for format version '${fmtVer}'`, { cause: err });
           await this.saveDefaultData();
-          return this.getData();
+          return this.engine.deepCopy(this.defaultData);
         }
       }
     }

package/dist/UserUtils.mjs

@@ -1,4 +1,4 @@
-// node_modules/.pnpm/@sv443-network+coreutils@3.0.4/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
+// node_modules/.pnpm/@sv443-network+coreutils@3.0.5/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
 function bitSetHas(bitSet, checkVal) {
   return (bitSet & checkVal) === checkVal;
 }
@@ -458,7 +458,7 @@ var DataStore = class {
   encodeData;
   decodeData;
   compressionFormat = "deflate-raw";
-  memoryCache = true;
+  memoryCache;
   engine;
   options;
   /**
@@ -485,7 +485,7 @@ var DataStore = class {
     this.id = opts.id;
     this.formatVersion = opts.formatVersion;
     this.defaultData = opts.defaultData;
-    this.memoryCache = Boolean(opts.memoryCache ?? true);
+    this.memoryCache = opts.memoryCache ?? true;
     this.cachedData = this.memoryCache ? opts.defaultData : {};
     this.migrations = opts.migrations;
     if (opts.migrateIds)
@@ -583,7 +583,7 @@ var DataStore = class {
   /**
    * Returns a copy of the data from the in-memory cache.  
    * Use {@linkcode loadData()} to get fresh data from persistent storage (usually not necessary since the cache should always exactly reflect persistent storage).  
-   * ⚠️ If `memoryCache` was set to `false` in the constructor options, this method will throw an error.
+   * ⚠️ Only available when `memoryCache` is `true` (default). When set to `false`, this produces a type and runtime error - use {@linkcode loadData()} instead.
    */
   getData() {
     if (!this.memoryCache)
@@ -660,7 +660,7 @@ var DataStore = class {
           if (!resetOnError)
             throw new MigrationError(`Error while running migration function for format version '${fmtVer}'`, { cause: err });
           await this.saveDefaultData();
-          return this.getData();
+          return this.engine.deepCopy(this.defaultData);
         }
       }
     }

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.4/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
+// node_modules/.pnpm/@sv443-network+coreutils@3.0.5/node_modules/@sv443-network/coreutils/dist/CoreUtils.mjs
 function bitSetHas(bitSet, checkVal) {
   return (bitSet & checkVal) === checkVal;
 }
@@ -668,7 +668,7 @@ var DataStore = class {
     __publicField(this, "encodeData");
     __publicField(this, "decodeData");
     __publicField(this, "compressionFormat", "deflate-raw");
-    __publicField(this, "memoryCache", true);
+    __publicField(this, "memoryCache");
     __publicField(this, "engine");
     __publicField(this, "options");
     /**
@@ -685,7 +685,7 @@ var DataStore = class {
     this.id = opts.id;
     this.formatVersion = opts.formatVersion;
     this.defaultData = opts.defaultData;
-    this.memoryCache = Boolean((_a = opts.memoryCache) != null ? _a : true);
+    this.memoryCache = (_a = opts.memoryCache) != null ? _a : true;
     this.cachedData = this.memoryCache ? opts.defaultData : {};
     this.migrations = opts.migrations;
     if (opts.migrateIds)
@@ -790,7 +790,7 @@ var DataStore = class {
   /**
    * Returns a copy of the data from the in-memory cache.  
    * Use {@linkcode loadData()} to get fresh data from persistent storage (usually not necessary since the cache should always exactly reflect persistent storage).  
-   * ⚠️ If `memoryCache` was set to `false` in the constructor options, this method will throw an error.
+   * ⚠️ Only available when `memoryCache` is `true` (default). When set to `false`, this produces a type and runtime error - use {@linkcode loadData()} instead.
    */
   getData() {
     if (!this.memoryCache)
@@ -872,7 +872,7 @@ var DataStore = class {
             if (!resetOnError)
               throw new MigrationError(`Error while running migration function for format version '${fmtVer}'`, { cause: err });
             yield this.saveDefaultData();
-            return this.getData();
+            return this.engine.deepCopy(this.defaultData);
           }
         }
       }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "10.0.4",
+  "version": "10.0.6",
   "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.4",
+    "@sv443-network/coreutils": "3.0.5",
     "nanoevents": "9.1.0"
   },
   "devDependencies": {