@sv443-network/userutils 4.2.1 → 5.0.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @sv443-network/userutils
 
+## 5.0.0
+
+### Major Changes
+
+- c980ff3: `compress()` now uses the same value "string" (unlike previously "base64") for the outputType parameter like `decompress()`
+
+### Minor Changes
+
+- ca1b596: Added `encodeData()` and `decodeData()` to the ConfigManager options to allow for easy data compression
+
 ## 4.2.1
 
 ### Patch Changes

package/README.md

@@ -873,6 +873,8 @@ The options object has the following properties:
 | `defaultConfig` | The default config data to use if no data is saved in persistent storage yet. Until the data is loaded from persistent storage, this will be the data returned by `getData()`. For TypeScript, the type of the data passed here is what will be used for all other methods of the instance. |
 | `formatVersion` | An incremental version of the data format. If the format of the data is changed in any way, this number should be incremented, in which case all necessary functions of the migrations dictionary will be run consecutively. Never decrement this number or skip numbers. |
 | `migrations?` | (Optional) A dictionary of functions that can be used to migrate data from older versions of the configuration to newer ones. The keys of the dictionary should be the format version that the functions can migrate to, from the previous whole integer value. The values should be functions that take the data in the old format and return the data in the new format. The functions will be run in order from the oldest to the newest version. If the current format version is not in the dictionary, no migrations will be run. |
+| `encodeData?` | (Optional, but required when decodeData is set) Function that encodes the data before saving - you can use [compress()](#compress) here to save space at the cost of a little bit of performance |
+| `decodeData?` | (Optional, but required when encodeData is set) Function that decodes the data when loading - you can use [decompress()](#decompress) here to decode data that was previously compressed with [compress()](#compress) |
 
 <br>
 
@@ -903,7 +905,7 @@ If `loadData()` or `setData()` are called after this, the persistent storage wil
 <details><summary><b>Example - click to view</b></summary>
 
 ```ts
-import { ConfigManager } from "@sv443-network/userutils";
+import { ConfigManager, compress, decompress } from "@sv443-network/userutils";
 
 interface MyConfig {
   foo: string;
@@ -953,6 +955,15 @@ const manager = new ConfigManager({
   formatVersion,
   /** Data format migration functions */
   migrations,
+
+  // Compression example:
+  // Adding this will save space at the cost of a little bit of performance while initially loading and saving the data
+  // Only both of these properties or none of them should be set
+  // Everything else will be handled by the ConfigManager instance
+  /** Encode data using the "deflate-raw" algorithm and digests it as a base64 string */
+  encodeData: (data) => compress(data, "deflate-raw", "base64"),
+  /** Decode the "deflate-raw" encoded data as a base64 string */
+  decodeData: (data) => decompress(data, "deflate-raw", "base64"),
 });
 
 /** Entrypoint of the userscript */

package/dist/index.global.js

@@ -9,7 +9,7 @@
 // ==UserLibrary==
 // @name         UserUtils
 // @description  Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, manage persistent user configurations, modify the DOM more easily and more
-// @version      4.2.1
+// @version      5.0.0
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 
@@ -155,11 +155,15 @@ var UserUtils = (function (exports) {
       __publicField(this, "defaultConfig");
       __publicField(this, "cachedConfig");
       __publicField(this, "migrations");
+      __publicField(this, "encodeData");
+      __publicField(this, "decodeData");
       this.id = options.id;
       this.formatVersion = options.formatVersion;
       this.defaultConfig = options.defaultConfig;
       this.cachedConfig = options.defaultConfig;
       this.migrations = options.migrations;
+      this.encodeData = options.encodeData;
+      this.decodeData = options.decodeData;
     }
     /**
      * Loads the data saved in persistent storage into the in-memory cache and also returns it.  
@@ -175,13 +179,15 @@ var UserUtils = (function (exports) {
             yield this.saveDefaultData();
             return this.defaultConfig;
           }
+          const isEncoded = yield GM.getValue(`_uucfgenc-${this.id}`, false);
           if (isNaN(gmFmtVer))
             yield GM.setValue(`_uucfgver-${this.id}`, gmFmtVer = this.formatVersion);
-          let parsed = JSON.parse(gmData);
+          let parsed = yield this.deserializeData(gmData, isEncoded);
           if (gmFmtVer < this.formatVersion && this.migrations)
             parsed = yield this.runMigrations(parsed, gmFmtVer);
-          return this.cachedConfig = typeof parsed === "object" ? parsed : void 0;
+          return this.cachedConfig = parsed;
         } catch (err) {
+          console.warn("Error while loading config data, resetting it to the default value.", err);
           yield this.saveDefaultData();
           return this.defaultConfig;
         }
@@ -197,10 +203,12 @@ var UserUtils = (function (exports) {
     /** Saves the data synchronously to the in-memory cache and asynchronously to the persistent storage */
     setData(data) {
       this.cachedConfig = data;
+      const useEncoding = Boolean(this.encodeData && this.decodeData);
       return new Promise((resolve) => __async(this, null, function* () {
         yield Promise.all([
-          GM.setValue(`_uucfg-${this.id}`, JSON.stringify(data)),
-          GM.setValue(`_uucfgver-${this.id}`, this.formatVersion)
+          GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(data, useEncoding)),
+          GM.setValue(`_uucfgver-${this.id}`, this.formatVersion),
+          GM.setValue(`_uucfgenc-${this.id}`, useEncoding)
         ]);
         resolve();
       }));
@@ -209,10 +217,12 @@ var UserUtils = (function (exports) {
     saveDefaultData() {
       return __async(this, null, function* () {
         this.cachedConfig = this.defaultConfig;
+        const useEncoding = Boolean(this.encodeData && this.decodeData);
         return new Promise((resolve) => __async(this, null, function* () {
           yield Promise.all([
-            GM.setValue(`_uucfg-${this.id}`, JSON.stringify(this.defaultConfig)),
-            GM.setValue(`_uucfgver-${this.id}`, this.formatVersion)
+            GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(this.defaultConfig, useEncoding)),
+            GM.setValue(`_uucfgver-${this.id}`, this.formatVersion),
+            GM.setValue(`_uucfgenc-${this.id}`, useEncoding)
           ]);
           resolve();
         }));
@@ -229,7 +239,8 @@ var UserUtils = (function (exports) {
       return __async(this, null, function* () {
         yield Promise.all([
           GM.deleteValue(`_uucfg-${this.id}`),
-          GM.deleteValue(`_uucfgver-${this.id}`)
+          GM.deleteValue(`_uucfgver-${this.id}`),
+          GM.deleteValue(`_uucfgenc-${this.id}`)
         ]);
       });
     }
@@ -249,17 +260,41 @@ var UserUtils = (function (exports) {
               newData = migRes instanceof Promise ? yield migRes : migRes;
               lastFmtVer = oldFmtVer = ver;
             } catch (err) {
-              console.error(`Error while running migration function for format version ${fmtVer}:`, err);
+              console.error(`Error while running migration function for format version '${fmtVer}' - resetting to the default value.`, err);
+              yield this.saveDefaultData();
+              return this.getData();
             }
           }
         }
         yield Promise.all([
-          GM.setValue(`_uucfg-${this.id}`, JSON.stringify(newData)),
-          GM.setValue(`_uucfgver-${this.id}`, lastFmtVer)
+          GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(newData)),
+          GM.setValue(`_uucfgver-${this.id}`, lastFmtVer),
+          GM.setValue(`_uucfgenc-${this.id}`, Boolean(this.encodeData && this.decodeData))
         ]);
         return newData;
       });
     }
+    /** Serializes the data using the optional this.encodeData() and returns it as a string */
+    serializeData(data, useEncoding = true) {
+      return __async(this, null, function* () {
+        const stringData = JSON.stringify(data);
+        if (!this.encodeData || !this.decodeData || !useEncoding)
+          return stringData;
+        const encRes = this.encodeData(stringData);
+        if (encRes instanceof Promise)
+          return yield encRes;
+        return encRes;
+      });
+    }
+    /** Deserializes the data using the optional this.decodeData() and returns it as a JSON object */
+    deserializeData(data, useEncoding = true) {
+      return __async(this, null, function* () {
+        let decRes = this.decodeData && this.encodeData && useEncoding ? this.decodeData(data) : void 0;
+        if (decRes instanceof Promise)
+          decRes = yield decRes;
+        return JSON.parse(decRes != null ? decRes : data);
+      });
+    }
     /** Copies a JSON-compatible object and loses its internal references */
     deepCopy(obj) {
       return JSON.parse(JSON.stringify(obj));
@@ -405,7 +440,7 @@ var UserUtils = (function (exports) {
       return (_b = (_a = values[argIndex]) != null ? _a : match) == null ? void 0 : _b.toString();
     });
   }
-  function compress(input, compressionFormat, outputType = "base64") {
+  function compress(input, compressionFormat, outputType = "string") {
     return __async(this, null, function* () {
       const byteArray = typeof input === "string" ? new TextEncoder().encode(input) : input;
       const comp = new CompressionStream(compressionFormat);

package/dist/index.js

@@ -134,11 +134,15 @@ var ConfigManager = class {
     __publicField(this, "defaultConfig");
     __publicField(this, "cachedConfig");
     __publicField(this, "migrations");
+    __publicField(this, "encodeData");
+    __publicField(this, "decodeData");
     this.id = options.id;
     this.formatVersion = options.formatVersion;
     this.defaultConfig = options.defaultConfig;
     this.cachedConfig = options.defaultConfig;
     this.migrations = options.migrations;
+    this.encodeData = options.encodeData;
+    this.decodeData = options.decodeData;
   }
   /**
    * Loads the data saved in persistent storage into the in-memory cache and also returns it.  
@@ -154,13 +158,15 @@ var ConfigManager = class {
           yield this.saveDefaultData();
           return this.defaultConfig;
         }
+        const isEncoded = yield GM.getValue(`_uucfgenc-${this.id}`, false);
         if (isNaN(gmFmtVer))
           yield GM.setValue(`_uucfgver-${this.id}`, gmFmtVer = this.formatVersion);
-        let parsed = JSON.parse(gmData);
+        let parsed = yield this.deserializeData(gmData, isEncoded);
         if (gmFmtVer < this.formatVersion && this.migrations)
           parsed = yield this.runMigrations(parsed, gmFmtVer);
-        return this.cachedConfig = typeof parsed === "object" ? parsed : void 0;
+        return this.cachedConfig = parsed;
       } catch (err) {
+        console.warn("Error while loading config data, resetting it to the default value.", err);
         yield this.saveDefaultData();
         return this.defaultConfig;
       }
@@ -176,10 +182,12 @@ var ConfigManager = class {
   /** Saves the data synchronously to the in-memory cache and asynchronously to the persistent storage */
   setData(data) {
     this.cachedConfig = data;
+    const useEncoding = Boolean(this.encodeData && this.decodeData);
     return new Promise((resolve) => __async(this, null, function* () {
       yield Promise.all([
-        GM.setValue(`_uucfg-${this.id}`, JSON.stringify(data)),
-        GM.setValue(`_uucfgver-${this.id}`, this.formatVersion)
+        GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(data, useEncoding)),
+        GM.setValue(`_uucfgver-${this.id}`, this.formatVersion),
+        GM.setValue(`_uucfgenc-${this.id}`, useEncoding)
       ]);
       resolve();
     }));
@@ -188,10 +196,12 @@ var ConfigManager = class {
   saveDefaultData() {
     return __async(this, null, function* () {
       this.cachedConfig = this.defaultConfig;
+      const useEncoding = Boolean(this.encodeData && this.decodeData);
       return new Promise((resolve) => __async(this, null, function* () {
         yield Promise.all([
-          GM.setValue(`_uucfg-${this.id}`, JSON.stringify(this.defaultConfig)),
-          GM.setValue(`_uucfgver-${this.id}`, this.formatVersion)
+          GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(this.defaultConfig, useEncoding)),
+          GM.setValue(`_uucfgver-${this.id}`, this.formatVersion),
+          GM.setValue(`_uucfgenc-${this.id}`, useEncoding)
         ]);
         resolve();
       }));
@@ -208,7 +218,8 @@ var ConfigManager = class {
     return __async(this, null, function* () {
       yield Promise.all([
         GM.deleteValue(`_uucfg-${this.id}`),
-        GM.deleteValue(`_uucfgver-${this.id}`)
+        GM.deleteValue(`_uucfgver-${this.id}`),
+        GM.deleteValue(`_uucfgenc-${this.id}`)
       ]);
     });
   }
@@ -228,17 +239,41 @@ var ConfigManager = class {
             newData = migRes instanceof Promise ? yield migRes : migRes;
             lastFmtVer = oldFmtVer = ver;
           } catch (err) {
-            console.error(`Error while running migration function for format version ${fmtVer}:`, err);
+            console.error(`Error while running migration function for format version '${fmtVer}' - resetting to the default value.`, err);
+            yield this.saveDefaultData();
+            return this.getData();
           }
         }
       }
       yield Promise.all([
-        GM.setValue(`_uucfg-${this.id}`, JSON.stringify(newData)),
-        GM.setValue(`_uucfgver-${this.id}`, lastFmtVer)
+        GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(newData)),
+        GM.setValue(`_uucfgver-${this.id}`, lastFmtVer),
+        GM.setValue(`_uucfgenc-${this.id}`, Boolean(this.encodeData && this.decodeData))
       ]);
       return newData;
     });
   }
+  /** Serializes the data using the optional this.encodeData() and returns it as a string */
+  serializeData(data, useEncoding = true) {
+    return __async(this, null, function* () {
+      const stringData = JSON.stringify(data);
+      if (!this.encodeData || !this.decodeData || !useEncoding)
+        return stringData;
+      const encRes = this.encodeData(stringData);
+      if (encRes instanceof Promise)
+        return yield encRes;
+      return encRes;
+    });
+  }
+  /** Deserializes the data using the optional this.decodeData() and returns it as a JSON object */
+  deserializeData(data, useEncoding = true) {
+    return __async(this, null, function* () {
+      let decRes = this.decodeData && this.encodeData && useEncoding ? this.decodeData(data) : void 0;
+      if (decRes instanceof Promise)
+        decRes = yield decRes;
+      return JSON.parse(decRes != null ? decRes : data);
+    });
+  }
   /** Copies a JSON-compatible object and loses its internal references */
   deepCopy(obj) {
     return JSON.parse(JSON.stringify(obj));
@@ -384,7 +419,7 @@ function insertValues(input, ...values) {
     return (_b = (_a = values[argIndex]) != null ? _a : match) == null ? void 0 : _b.toString();
   });
 }
-function compress(input, compressionFormat, outputType = "base64") {
+function compress(input, compressionFormat, outputType = "string") {
   return __async(this, null, function* () {
     const byteArray = typeof input === "string" ? new TextEncoder().encode(input) : input;
     const comp = new CompressionStream(compressionFormat);

package/dist/index.mjs

@@ -132,11 +132,15 @@ var ConfigManager = class {
     __publicField(this, "defaultConfig");
     __publicField(this, "cachedConfig");
     __publicField(this, "migrations");
+    __publicField(this, "encodeData");
+    __publicField(this, "decodeData");
     this.id = options.id;
     this.formatVersion = options.formatVersion;
     this.defaultConfig = options.defaultConfig;
     this.cachedConfig = options.defaultConfig;
     this.migrations = options.migrations;
+    this.encodeData = options.encodeData;
+    this.decodeData = options.decodeData;
   }
   /**
    * Loads the data saved in persistent storage into the in-memory cache and also returns it.  
@@ -152,13 +156,15 @@ var ConfigManager = class {
           yield this.saveDefaultData();
           return this.defaultConfig;
         }
+        const isEncoded = yield GM.getValue(`_uucfgenc-${this.id}`, false);
         if (isNaN(gmFmtVer))
           yield GM.setValue(`_uucfgver-${this.id}`, gmFmtVer = this.formatVersion);
-        let parsed = JSON.parse(gmData);
+        let parsed = yield this.deserializeData(gmData, isEncoded);
         if (gmFmtVer < this.formatVersion && this.migrations)
           parsed = yield this.runMigrations(parsed, gmFmtVer);
-        return this.cachedConfig = typeof parsed === "object" ? parsed : void 0;
+        return this.cachedConfig = parsed;
       } catch (err) {
+        console.warn("Error while loading config data, resetting it to the default value.", err);
         yield this.saveDefaultData();
         return this.defaultConfig;
       }
@@ -174,10 +180,12 @@ var ConfigManager = class {
   /** Saves the data synchronously to the in-memory cache and asynchronously to the persistent storage */
   setData(data) {
     this.cachedConfig = data;
+    const useEncoding = Boolean(this.encodeData && this.decodeData);
     return new Promise((resolve) => __async(this, null, function* () {
       yield Promise.all([
-        GM.setValue(`_uucfg-${this.id}`, JSON.stringify(data)),
-        GM.setValue(`_uucfgver-${this.id}`, this.formatVersion)
+        GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(data, useEncoding)),
+        GM.setValue(`_uucfgver-${this.id}`, this.formatVersion),
+        GM.setValue(`_uucfgenc-${this.id}`, useEncoding)
       ]);
       resolve();
     }));
@@ -186,10 +194,12 @@ var ConfigManager = class {
   saveDefaultData() {
     return __async(this, null, function* () {
       this.cachedConfig = this.defaultConfig;
+      const useEncoding = Boolean(this.encodeData && this.decodeData);
       return new Promise((resolve) => __async(this, null, function* () {
         yield Promise.all([
-          GM.setValue(`_uucfg-${this.id}`, JSON.stringify(this.defaultConfig)),
-          GM.setValue(`_uucfgver-${this.id}`, this.formatVersion)
+          GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(this.defaultConfig, useEncoding)),
+          GM.setValue(`_uucfgver-${this.id}`, this.formatVersion),
+          GM.setValue(`_uucfgenc-${this.id}`, useEncoding)
         ]);
         resolve();
       }));
@@ -206,7 +216,8 @@ var ConfigManager = class {
     return __async(this, null, function* () {
       yield Promise.all([
         GM.deleteValue(`_uucfg-${this.id}`),
-        GM.deleteValue(`_uucfgver-${this.id}`)
+        GM.deleteValue(`_uucfgver-${this.id}`),
+        GM.deleteValue(`_uucfgenc-${this.id}`)
       ]);
     });
   }
@@ -226,17 +237,41 @@ var ConfigManager = class {
             newData = migRes instanceof Promise ? yield migRes : migRes;
             lastFmtVer = oldFmtVer = ver;
           } catch (err) {
-            console.error(`Error while running migration function for format version ${fmtVer}:`, err);
+            console.error(`Error while running migration function for format version '${fmtVer}' - resetting to the default value.`, err);
+            yield this.saveDefaultData();
+            return this.getData();
           }
         }
       }
       yield Promise.all([
-        GM.setValue(`_uucfg-${this.id}`, JSON.stringify(newData)),
-        GM.setValue(`_uucfgver-${this.id}`, lastFmtVer)
+        GM.setValue(`_uucfg-${this.id}`, yield this.serializeData(newData)),
+        GM.setValue(`_uucfgver-${this.id}`, lastFmtVer),
+        GM.setValue(`_uucfgenc-${this.id}`, Boolean(this.encodeData && this.decodeData))
       ]);
       return newData;
     });
   }
+  /** Serializes the data using the optional this.encodeData() and returns it as a string */
+  serializeData(data, useEncoding = true) {
+    return __async(this, null, function* () {
+      const stringData = JSON.stringify(data);
+      if (!this.encodeData || !this.decodeData || !useEncoding)
+        return stringData;
+      const encRes = this.encodeData(stringData);
+      if (encRes instanceof Promise)
+        return yield encRes;
+      return encRes;
+    });
+  }
+  /** Deserializes the data using the optional this.decodeData() and returns it as a JSON object */
+  deserializeData(data, useEncoding = true) {
+    return __async(this, null, function* () {
+      let decRes = this.decodeData && this.encodeData && useEncoding ? this.decodeData(data) : void 0;
+      if (decRes instanceof Promise)
+        decRes = yield decRes;
+      return JSON.parse(decRes != null ? decRes : data);
+    });
+  }
   /** Copies a JSON-compatible object and loses its internal references */
   deepCopy(obj) {
     return JSON.parse(JSON.stringify(obj));
@@ -382,7 +417,7 @@ function insertValues(input, ...values) {
     return (_b = (_a = values[argIndex]) != null ? _a : match) == null ? void 0 : _b.toString();
   });
 }
-function compress(input, compressionFormat, outputType = "base64") {
+function compress(input, compressionFormat, outputType = "string") {
   return __async(this, null, function* () {
     const byteArray = typeof input === "string" ? new TextEncoder().encode(input) : input;
     const comp = new CompressionStream(compressionFormat);

package/dist/lib/ConfigManager.d.ts

@@ -3,7 +3,7 @@ type MigrationFunc = (oldData: any) => any | Promise<any>;
 /** Dictionary of format version numbers and the function that migrates to them from the previous whole integer */
 export type ConfigMigrationsDict = Record<number, MigrationFunc>;
 /** Options for the ConfigManager instance */
-export interface ConfigManagerOptions<TData> {
+export type ConfigManagerOptions<TData> = {
     /** A unique internal ID for this configuration - choose wisely as changing it is not supported yet. */
     id: string;
     /**
@@ -28,7 +28,27 @@ export interface ConfigManagerOptions<TData> {
      * If the current format version is not in the dictionary, no migrations will be run.
      */
     migrations?: ConfigMigrationsDict;
-}
+} & ({
+    /**
+     * Function to use to encode the data prior to saving it in persistent storage.
+     * If this is specified, make sure to declare {@linkcode decodeData()} as well.
+     *
+     * You can make use of UserUtils' [`compress()`](https://github.com/Sv443-Network/UserUtils?tab=readme-ov-file#compress) function here to make the data use up less space at the cost of a little bit of performance.
+     * @param data The input data as a serialized object (JSON string)
+     */
+    encodeData: (data: string) => string | Promise<string>;
+    /**
+     * Function to use to decode the data after reading it from persistent storage.
+     * If this is specified, make sure to declare {@linkcode encodeData()} as well.
+     *
+     * You can make use of UserUtils' [`decompress()`](https://github.com/Sv443-Network/UserUtils?tab=readme-ov-file#decompress) function here to make the data use up less space at the cost of a little bit of performance.
+     * @returns The resulting data as a valid serialized object (JSON string)
+     */
+    decodeData: (data: string) => string | Promise<string>;
+} | {
+    encodeData?: never;
+    decodeData?: never;
+});
 /**
  * Manages a user configuration that is cached in memory and persistently saved across sessions.
  * Supports migrating data from older versions of the configuration to newer ones and populating the cache with default data if no persistent data is found.
@@ -44,6 +64,8 @@ export declare class ConfigManager<TData = any> {
     readonly defaultConfig: TData;
     private cachedConfig;
     private migrations?;
+    private encodeData;
+    private decodeData;
     /**
      * Creates an instance of ConfigManager to manage a user configuration that is cached in memory and persistently saved across sessions.
      * Supports migrating data from older versions of the configuration to newer ones and populating the cache with default data if no persistent data is found.
@@ -80,6 +102,10 @@ export declare class ConfigManager<TData = any> {
     deleteConfig(): Promise<void>;
     /** Runs all necessary migration functions consecutively - may be overwritten in a subclass */
     protected runMigrations(oldData: any, oldFmtVer: number): Promise<TData>;
+    /** Serializes the data using the optional this.encodeData() and returns it as a string */
+    private serializeData;
+    /** Deserializes the data using the optional this.decodeData() and returns it as a JSON object */
+    private deserializeData;
     /** Copies a JSON-compatible object and loses its internal references */
     private deepCopy;
 }

package/dist/lib/misc.d.ts

@@ -1,4 +1,4 @@
-/** Represents any value that is either a string itself or can be converted to one (implicitly or explicitly) because it has a toString() method */
+/** Represents any value that is either a string itself or can be converted to one (implicitly and explicitly) because it has a toString() method */
 export type Stringifiable = string | {
     toString(): string;
 };
@@ -43,7 +43,7 @@ export declare function fetchAdvanced(input: RequestInfo | URL, options?: FetchA
  */
 export declare function insertValues(input: string, ...values: Stringifiable[]): string;
 /** Compresses a string or an ArrayBuffer using the provided {@linkcode compressionFormat} and returns it as a base64 string */
-export declare function compress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType?: "base64"): Promise<string>;
+export declare function compress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType?: "string"): Promise<string>;
 /** Compresses a string or an ArrayBuffer using the provided {@linkcode compressionFormat} and returns it as an ArrayBuffer */
 export declare function compress(input: string | ArrayBuffer, compressionFormat: CompressionFormat, outputType: "arrayBuffer"): Promise<ArrayBuffer>;
 /** Decompresses a previously compressed base64 string or ArrayBuffer, with the format passed by {@linkcode compressionFormat}, converted to a string */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sv443-network/userutils",
-  "version": "4.2.1",
+  "version": "5.0.0",
   "description": "Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, manage persistent user configurations, modify the DOM more easily and more",
   "main": "dist/index.js",
   "module": "dist/index.mjs",