uti 8.4.0 → 8.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "uti",
-  "version": "8.4.0",
+  "version": "8.4.1",
   "publishConfig": {
     "access": "public",
     "provenance": true
@@ -26,23 +26,24 @@
   ],
   "license": "BSD-2-Clause",
   "scripts": {
-    "prepare": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs",
+    "prepare": "npm run prepare:typescript",
+    "prepare:typescript": "tsc --allowJs --declaration --emitDeclarationOnly --declarationDir types -t esnext -m esnext --module nodenext --moduleResolution nodenext --rootDir src ./src**/*.mjs",
     "test": "npm run test:browser-ava && npm run test:ava",
     "test:ava": "ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs",
     "test:browser-ava": "browser-ava --headless --no-keep-open tests/*-ava.mjs tests/*-ava-browser.mjs",
     "cover": "c8 -x 'tests/**/*' --temp-directory build/tmp ava --timeout 4m tests/*-ava.mjs tests/*-ava-node.mjs && c8 report -r lcov -o build/coverage --temp-directory build/tmp",
     "docs": "documentation readme --section=API ./src/**/*.mjs",
-    "lint": "npm run lint:docs && npm run lint:tsc",
+    "lint": "npm run lint:docs && npm run lint:typescript",
     "lint:docs": "documentation lint ./src/**/*.mjs",
-    "lint:tsc": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
+    "lint:typescript": "tsc --allowJs --checkJs --noEmit -t esnext -m esnext --module nodenext --moduleResolution nodenext ./src**/*.mjs"
   },
   "devDependencies": {
-    "ava": "^6.1.1",
-    "browser-ava": "^2.2.0",
+    "ava": "^6.1.2",
+    "browser-ava": "^2.2.2",
     "c8": "^9.1.0",
     "documentation": "^14.0.3",
     "semantic-release": "^23.0.2",
-    "typescript": "^5.3.3"
+    "typescript": "^5.4.2"
   },
   "engines": {
     "node": ">=20.11.1",

package/src/uti.mjs

@@ -9,6 +9,14 @@ import types from "./well-known-utis.mjs";
  * @property {Set<UTI>} conforms
  */
 class UTI {
+  /**
+   * Object representing a UTI.
+   * @param {string} name
+   * @param {Set<UTI>} conforms
+   *
+   * @property {string} name
+   * @property {Set<UTI>} conforms
+   */
   constructor(name, conforms) {
     this.name = name;
     this.conforms = conforms;
@@ -32,6 +40,10 @@ class UTI {
     return false;
   }
 
+  /**
+   * name of the UTI.
+   * @returns {string}
+   */
   toString() {
     return this.name;
   }
@@ -45,7 +57,7 @@ class UTI {
    *   "conformsTo": [ "uti1", "uti2"]
    * }
    * ```
-   * @return {Object} json representation of the UTI
+   * @return {{name:string, conforms: string[]}} json representation of the UTI
    */
   toJSON() {
     return {
@@ -62,7 +74,7 @@ class UTI {
  * @property {Map<string,UTI>} utiByFileNameExtension
  */
 export class UTIController {
-  registry = new Map();
+  /** @type {Map<string,UTI>} */ registry = new Map();
   /** @type {Map<string,string[]>} */ utiByMimeType = new Map();
   /** @type {Map<string,string[]>} */ utiByFileNameExtension = new Map();
 
@@ -116,7 +128,7 @@ export class UTIController {
   /**
    * Lookup a given UTI.
    * @param {string} name UTI
-   * @return {string|undefined} UTI for the given name or undefined if UTI is not present.
+   * @return {UTI|undefined} UTI for the given name or undefined if UTI is not present.
    */
   getUTI(name) {
     return this.registry.get(name);
@@ -187,24 +199,34 @@ export class UTIController {
     return false;
   }
 
-  assignMimeTypes(name, mimTypes) {
-    mimTypes.forEach(type => {
+  /**
+   * Assign mime types to a UTI
+   * @param {string} uti
+   * @param {string[]} mimeTypes
+   */
+  assignMimeTypes(uti, mimeTypes) {
+    mimeTypes.forEach(type => {
       const u = this.utiByMimeType.get(type);
       if (u === undefined) {
-        this.utiByMimeType.set(type, [name]);
+        this.utiByMimeType.set(type, [uti]);
       } else {
-        u.push(name);
+        u.push(uti);
       }
     });
   }
 
-  assignExtensions(name, extensions) {
+  /**
+   * Assign mime types to a UTI
+   * @param {string} uti
+   * @param {string[]} extensions
+   */
+  assignExtensions(uti, extensions) {
     extensions.forEach(ext => {
       const e = this.utiByFileNameExtension.get(ext);
       if (e === undefined) {
-        this.utiByFileNameExtension.set(ext, [name]);
+        this.utiByFileNameExtension.set(ext, [uti]);
       } else {
-        e.push(name);
+        e.push(uti);
       }
     });
   }

package/types/uti.d.mts

@@ -5,7 +5,7 @@
  * @property {Map<string,UTI>} utiByFileNameExtension
  */
 export class UTIController {
-    registry: Map<any, any>;
+    /** @type {Map<string,UTI>} */ registry: Map<string, UTI>;
     /** @type {Map<string,string[]>} */ utiByMimeType: Map<string, string[]>;
     /** @type {Map<string,string[]>} */ utiByFileNameExtension: Map<string, string[]>;
     /**
@@ -16,9 +16,9 @@ export class UTIController {
     /**
      * Lookup a given UTI.
      * @param {string} name UTI
-     * @return {string|undefined} UTI for the given name or undefined if UTI is not present.
+     * @return {UTI|undefined} UTI for the given name or undefined if UTI is not present.
      */
-    getUTI(name: string): string | undefined;
+    getUTI(name: string): UTI | undefined;
     /**
      * Lookup a UTIs for a mime type.
      * @param {string} mimeType mime type to get UTIs for
@@ -48,6 +48,64 @@ export class UTIController {
      * @return {boolean} ture if utils for file name are conformant
      */
     fileNameConformsTo(fileName: string, uti: string): boolean;
-    assignMimeTypes(name: any, mimTypes: any): void;
-    assignExtensions(name: any, extensions: any): void;
+    /**
+     * Assign mime types to a UTI
+     * @param {string} uti
+     * @param {string[]} mimeTypes
+     */
+    assignMimeTypes(uti: string, mimeTypes: string[]): void;
+    /**
+     * Assign mime types to a UTI
+     * @param {string} uti
+     * @param {string[]} extensions
+     */
+    assignExtensions(uti: string, extensions: string[]): void;
+}
+/**
+ * Object representing a UTI.
+ * @param {string} name
+ * @param {Set<UTI>} conforms
+ *
+ * @property {string} name
+ * @property {Set<UTI>} conforms
+ */
+declare class UTI {
+    /**
+     * Object representing a UTI.
+     * @param {string} name
+     * @param {Set<UTI>} conforms
+     *
+     * @property {string} name
+     * @property {Set<UTI>} conforms
+     */
+    constructor(name: string, conforms: Set<UTI>);
+    name: string;
+    conforms: Set<UTI>;
+    /**
+     * Check for conformity.
+     * @param {UTI} other
+     * @return {boolean} true if other conforms to the receiver
+     */
+    conformsTo(other: UTI): boolean;
+    /**
+     * name of the UTI.
+     * @returns {string}
+     */
+    toString(): string;
+    /**
+     * Deliver JSON representation of the UTI.
+     * Sample result
+     * ```json
+     * {
+     *   "name": "myUTI",
+     *   "conformsTo": [ "uti1", "uti2"]
+     * }
+     * ```
+     * @return {{name:string, conforms: string[]}} json representation of the UTI
+     */
+    toJSON(): {
+        name: string;
+        conforms: string[];
+    };
 }
+export {};