UserUtils-Mirror

UserUtils

Library with various utilities for userscripts - register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and more.
Contains builtin TypeScript declarations. Supports ESM and CJS imports via a bundler and global declaration via @require
Licensed under the MIT license.

You may want to check out my template for userscripts in TypeScript that you can use to get started quickly. It also includes this library by default.

If you like using this library, please consider supporting the development ❤️

> Full documentation on GitHub <

or view the documentation of previous major releases:
8.0.0, 7.0.0, 6.0.0, 5.0.0, 4.0.0, 3.0.0, 2.0.0, 1.0.0, 0.5.3

Feature Summary:

• DOM:
  • SelectorObserver - class that manages listeners that are called when selectors are found in the DOM
  • getUnsafeWindow() - get the unsafeWindow object or fall back to the regular window object
  • addParent() - add a parent element around another element
  • addGlobalStyle() - add a global style to the page
  • preloadImages() - preload images into the browser cache for faster loading later on
  • openInNewTab() - open a link in a new tab
  • interceptEvent() - conditionally intercepts events registered by addEventListener() on any given EventTarget object
  • interceptWindowEvent() - conditionally intercepts events registered by addEventListener() on the window object
  • isScrollable() - check if an element has a horizontal or vertical scroll bar
  • observeElementProp() - observe changes to an element's property that can't be observed with MutationObserver
  • getSiblingsFrame() - returns a frame of an element's siblings, with a given alignment and size
  • setInnerHtmlUnsafe() - set the innerHTML of an element using a Trusted Types policy without sanitizing or escaping it
• Math:
  • clamp() - constrain a number between a min and max value
  • mapRange() - map a number from one range to the same spot in another range
  • randRange() - generate a random number between a min and max boundary
  • digitCount() - calculate the amount of digits in a number
• Misc:
  • DataStore - class that manages a hybrid sync & async persistent JSON database, including data migration
  • DataStoreSerializer - class for importing & exporting data of multiple DataStore instances, including compression, checksumming and running migrations
  • Dialog - class for creating custom modal dialogs with a promise-based API and a generic, default style
  • NanoEmitter - tiny event emitter class with a focus on performance and simplicity (based on nanoevents)
  • autoPlural() - automatically pluralize a string
  • pauseFor() - pause the execution of a function for a given amount of time
  • debounce() - call a function only once in a series of calls, after or before a given timeout
  • fetchAdvanced() - wrapper around the fetch API with a timeout option
  • insertValues() - insert values into a string at specified placeholders
  • compress() - compress a string with Gzip or Deflate
  • decompress() - decompress a previously compressed string
  • computeHash() - compute the hash / checksum of a string or ArrayBuffer
  • randomId() - generate a random ID of a given length and radix
• Arrays:
  • randomItem() - returns a random item from an array
  • randomItemIndex() - returns a tuple of a random item and its index from an array
  • takeRandomItem() - returns a random item from an array and mutates it to remove the item
  • randomizeArray() - returns a copy of the array with its items in a random order
• Translation:
  • tr() - simple translation of a string to another language
  • tr.forLang() - specify a language besides the currently set one for the translation
  • tr.addLanguage() - add a language and its translations
  • tr.setLanguage() - set the currently active language for translations
  • tr.getLanguage() - returns the currently active language
  • tr.getTranslations() - returns the translations for the given language or the currently active one
• Colors:
  • hexToRgb() - convert a hex color string to an RGB or RGBA value tuple
  • rgbToHex() - convert RGB or RGBA values to a hex color string
  • lightenColor() - lighten a CSS color string (hex, rgb or rgba) by a given percentage
  • darkenColor() - darken a CSS color string (hex, rgb or rgba) by a given percentage
• Utility types for TypeScript:
  • Stringifiable - any value that is a string or can be converted to one (implicitly or explicitly)
  • NonEmptyArray - any array that should have at least one item
  • NonEmptyString - any string that should have at least one character
  • LooseUnion - a union that gives autocomplete in the IDE but also allows any other value of the same type
  • Prettify - expands a complex type into a more readable format while keeping functionality the same

Installation:

Shameless plug: I made a template for userscripts in TypeScript that you can use to get started quickly. It also includes this library by default.

• If you are using a bundler (like webpack, rollup, vite, etc.), you can install this package in one of the following ways:

  npm i @sv443-network/userutils
  pnpm i @sv443-network/userutils
  yarn add @sv443-network/userutils
  npx jsr install @sv443-network/userutils
  deno add jsr:@sv443-network/userutils
  

  Then import it in your script as usual:

  import { addGlobalStyle } from "@sv443-network/userutils";
  
  // or just import everything (not recommended because of worse treeshaking support):
  
  import * as UserUtils from "@sv443-network/userutils";
  

• If you are not using a bundler, want to reduce the size of your userscript, or declared the package as external in your bundler, you can include the latest release by adding one of these directives to the userscript header, depending on your preferred CDN:
  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
  

  Non-versioned (not recommended because auto-updating):

  // @require https://update.greasyfork.org/scripts/472956/UserUtils.js
  // @require https://openuserjs.org/src/libs/Sv443/UserUtils.js
  

  Note:
  In order for your userscript 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.

• Then, access the functions on the global variable UserUtils:

  UserUtils.addGlobalStyle("body { background-color: red; }");
  
  // or using object destructuring:
  
  const { clamp } = UserUtils;
  console.log(clamp(1, 5, 10)); // 5
  

• If you're using TypeScript and it complains about the missing global variable UserUtils, install the library using the package manager of your choice and add the following inside a .d.ts file somewhere in the directory (or a subdirectory) defined in your tsconfig.json's baseUrl option or include array:

  declare const UserUtils: typeof import("@sv443-network/userutils");
  
  declare global {
      interface Window {
          UserUtils: typeof UserUtils;
      }
  }
  

• If you're using a linter like ESLint, it might complain about the global variable UserUtils not being defined. To fix this, add the following to your ESLint configuration file:

  "globals": {
      "UserUtils": "readonly"
  }