@sv443-network/userutils 9.0.0 → 9.0.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @sv443-network/userutils
 
+## 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.1
 // @license      MIT
 // @copyright    Sv443 (https://github.com/Sv443)
 

package/dist/lib/translation.d.ts

@@ -50,6 +50,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 +156,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 +167,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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sv443-network/userutils",
   "libName": "UserUtils",
-  "version": "9.0.0",
+  "version": "9.0.1",
   "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",