@sv443-network/userutils 9.0.0 → 9.0.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @sv443-network/userutils
 
+## 9.0.2
+
+### Patch Changes
+
+- 69c4dd1: Fixed wrong readme being included in JSR package and added `@module` comments
+
+## 9.0.1
+
+### Patch Changes
+
+- f24f355: Fixed missing return type signatures for JSR
+
 ## 9.0.0
 
 ### Major Changes

package/dist/index.global.js

@@ -8,7 +8,7 @@
 // ==UserLibrary==
 // @name         UserUtils
 // @description  Lightweight 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 much more
-// @version      9.0.0
+// @version      9.0.2
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 

package/dist/lib/DataStore.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/DataStore  
+ * This module contains the DataStore class, which is a general purpose, sync and async persistent JSON database - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#datastore)  
+ */
 import type { Prettify } from "./types.js";
 /** Dictionary of format version numbers and the function that migrates to them from the previous whole integer */
 export type DataMigrationsDict = Record<number, ((oldData: unknown) => unknown | Promise<unknown>)>;

package/dist/lib/DataStoreSerializer.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/DataStoreSerializer  
+ * This module contains the DataStoreSerializer class, which allows you to import and export serialized DataStore data - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#datastoreserializer)  
+ */
 import { type DataStore } from "./index.js";
 export type DataStoreSerializerOptions = {
     /** Whether to add a checksum to the exported data */

package/dist/lib/Debouncer.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/Debouncer  
+ * This module contains the Debouncer class and debounce function that allow you to reduce the amount of calls in rapidly firing event listeners and such - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer)  
+ */
 import { NanoEmitter } from "./NanoEmitter.js";
 /**
  * The type of edge to use for the debouncer - [see the docs for a diagram and explanation.](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#debouncer)  

package/dist/lib/Dialog.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/Dialog  
+ * This module contains the Dialog class, which allows you to quickly and easily create modal dialogs - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#dialog)  
+ */
 import { NanoEmitter } from "./NanoEmitter.js";
 export declare const defaultDialogCss: string;
 /** ID of the last opened (top-most) dialog */

package/dist/lib/NanoEmitter.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/NanoEmitter  
+ * This module contains the NanoEmitter class, which is a tiny event emitter powered by [nanoevents](https://www.npmjs.com/package/nanoevents) - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#nanoemitter)  
+ */
 import { type DefaultEvents, type Emitter, type EventsMap, type Unsubscribe } from "nanoevents";
 export interface NanoEmitterOptions {
     /** If set to true, allows emitting events through the public method emit() */

package/dist/lib/SelectorObserver.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/SelectorObserver  
+ * This module contains the SelectorObserver class, allowing you to register listeners that get called whenever the element(s) behind a selector exist in the DOM - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#selectorobserver)  
+ */
 import { type DebouncerType } from "./Debouncer.js";
 import type { Prettify } from "./types.js";
 /** Options for the `onSelector()` method of {@linkcode SelectorObserver} */

package/dist/lib/array.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/array  
+ * This module contains various functions for working with arrays - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#arrays)  
+ */
 /** Describes an array with at least one item */
 export type NonEmptyArray<TArray = unknown> = [TArray, ...TArray[]];
 /** Returns a random item from the passed array */

package/dist/lib/colors.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/colors  
+ * This module contains various functions for working with colors - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#colors)  
+ */
 /**
  * Converts a hex color string in the format `#RRGGBB`, `#RRGGBBAA` (or even `RRGGBB` and `RGB`) to a tuple.  
  * @returns Returns a tuple array where R, G and B are an integer from 0-255 and alpha is a float from 0 to 1, or undefined if no alpha channel exists.  

package/dist/lib/crypto.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/crypto  
+ * This module contains various cryptographic functions using the [Web Crypto API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#table-of-contents)  
+ */
 /** 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?: "string"): Promise<string>;
 /** Compresses a string or an ArrayBuffer using the provided {@linkcode compressionFormat} and returns it as an ArrayBuffer */

package/dist/lib/dom.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/dom  
+ * This module contains various functions for working with the DOM - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#dom)  
+ */
 /**
  * Returns `unsafeWindow` if the `@grant unsafeWindow` is given, otherwise falls back to the regular `window`  
  */

package/dist/lib/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module UserUtils  
+ * UserUtils is a lightweight library with various utilities for userscripts, allowing you to register listeners for when CSS selectors exist, intercept events, create persistent & synchronous data stores, modify the DOM more easily and much more  
+ */
 export * from "./array.js";
 export * from "./colors.js";
 export * from "./crypto.js";

package/dist/lib/math.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/math  
+ * This module contains various math functions - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#math)  
+ */
 import type { Stringifiable } from "./types.js";
 /** Ensures the passed {@linkcode value} always stays between {@linkcode min} and {@linkcode max} */
 export declare function clamp(value: number, min: number, max: number): number;

package/dist/lib/misc.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/misc  
+ * This module contains miscellaneous functions that don't fit in another category - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#misc)  
+ */
 import type { Prettify, Stringifiable } from "./types.js";
 /**
  * Automatically appends an `s` to the passed {@linkcode word}, if {@linkcode num} is not equal to 1  

package/dist/lib/translation.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/translation  
+ * This module contains a translation system that supports flat and nested JSON objects and value transformation functions - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#translation)  
+ */
 import type { Stringifiable } from "./types.js";
 /**
  * Translation object to pass to {@linkcode tr.addTranslations()}  
@@ -50,6 +54,35 @@ export type TransformTuple<TTrKey extends string = string> = [RegExp, TransformF
 export type TrKeys<TTrObj, P extends string = ""> = {
     [K in keyof TTrObj]: K extends string | number | boolean | null | undefined ? TTrObj[K] extends object ? TrKeys<TTrObj[K], `${P}${K}.`> : `${P}${K}` : never;
 }[keyof TTrObj];
+/**
+ * Returns the translated text for the specified key in the specified language.  
+ * If the key is not found in the specified previously registered translation, the key itself is returned.  
+ *  
+ * ⚠️ Remember to register a language with {@linkcode tr.addTranslations()} before using this function, otherwise it will always return the key itself.  
+ * @param language Language code or name to use for the translation  
+ * @param key Key of the translation to return  
+ * @param args Optional arguments to be passed to the translated text. They will replace placeholders in the format `%n`, where `n` is the 1-indexed argument number  
+ */
+declare function trFor<TTrKey extends string = string>(language: string, key: TTrKey, ...args: (Stringifiable | Record<string, Stringifiable>)[]): string;
+/**
+ * Prepares a translation function for a specific language.  
+ * @example ```ts  
+ * tr.addTranslations("en", {  
+ *   hello: "Hello, %1!",  
+ * });  
+ * const t = tr.useTr("en");  
+ * t("hello", "John"); // "Hello, John!"  
+ * ```  
+ */
+declare function useTr<TTrKey extends string = string>(language: string): (key: TTrKey, ...args: (Stringifiable | Record<string, Stringifiable>)[]) => ReturnType<typeof trFor<TTrKey>>;
+/**
+ * Checks if a translation exists given its {@linkcode key} in the specified {@linkcode language} or the set fallback language.  
+ * If the given language was not registered with {@linkcode tr.addTranslations()}, this function will return `false`.  
+ * @param key Key of the translation to check for  
+ * @param language Language code or name to check in - defaults to the currently active language (set by {@linkcode tr.setLanguage()})  
+ * @returns Whether the translation key exists in the specified language - always returns `false` if no language is given and no active language was set  
+ */
+declare function hasKey<TTrKey extends string = string>(language: string | undefined, key: TTrKey): boolean;
 /**
  * Registers a new language and its translations - if the language already exists, it will be overwritten.  
  * The translations are a key-value pair where the key is the translation key and the value is the translated text.  
@@ -127,9 +160,9 @@ declare function addTransform<TTrKey extends string = string>(transform: Transfo
  */
 declare function deleteTransform(patternOrFn: RegExp | string | TransformFn): boolean;
 declare const tr: {
-    for: <TTrKey extends string = string>(language: string, key: TTrKey, ...args: (Stringifiable | Record<string, Stringifiable>)[]) => string;
-    use: <TTrKey extends string = string>(language: string) => (key: TTrKey, ...args: (Stringifiable | Record<string, Stringifiable>)[]) => string;
-    hasKey: <TTrKey extends string = string>(language: string | undefined, key: TTrKey) => boolean;
+    for: <TTrKey extends string = string>(language: string, key: TTrKey, ...args: (Stringifiable | Record<string, Stringifiable>)[]) => ReturnType<typeof trFor<TTrKey>>;
+    use: <TTrKey extends string = string>(language: string) => ReturnType<typeof useTr<TTrKey>>;
+    hasKey: <TTrKey extends string = string>(language: string | undefined, key: TTrKey) => ReturnType<typeof hasKey<TTrKey>>;
     addTranslations: typeof addTranslations;
     getTranslations: typeof getTranslations;
     deleteTranslations: (language: string) => boolean;
@@ -138,8 +171,8 @@ declare const tr: {
     addTransform: typeof addTransform;
     deleteTransform: typeof deleteTransform;
     transforms: {
-        templateLiteral: [RegExp, ({ matches, trArgs, trValue }: TransformFnProps<string>) => string];
-        percent: [RegExp, ({ matches, trArgs, trValue }: TransformFnProps<string>) => string];
+        templateLiteral: TransformTuple<string>;
+        percent: TransformTuple<string>;
     };
 };
 export { tr };

package/dist/lib/types.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @module lib/types  
+ * This module contains various TS types - [see the documentation for more info](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#utility-types)  
+ */
 /** 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;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "9.0.0",
+  "version": "9.0.2",
   "description": "Lightweight 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 much more",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -79,6 +79,7 @@
     "update-jsr-version": "node --import tsx ./tools/update-jsr-version.mts",
     "publish-package": "changeset publish",
     "publish-package-jsr": "pnpm update-jsr-version && npx jsr publish --allow-dirty",
+    "check-jsr": "npx jsr publish --allow-dirty --dry-run",
     "change": "changeset",
     "test-serve": "node --import tsx ./test/TestPage/server.mts",
     "test-dev": "cd test/TestScript && pnpm dev",