mime-explorer 1.1.0 → 2.0.0

package/dist/module.d.ts

@@ -1,38 +1,16 @@
-import type { TypeMap, TypeMeta } from './type';
-/**
- * Define meta information/extensions for a mime type.
- *
- * @param key
- * @param value
- */
-export declare function define(key: string, value: string[] | TypeMeta): void;
-/**
- * Remove meta information.
- *
- * @param input
- */
-export declare function undefine(input: string): void;
-/**
- * Define multiple mime type -> extension/meta mappings.
- *
- * e.g. mime.define({'audio/ogg', ['oga', 'ogg', 'spx']});
- */
-export declare function defineMany(typeMap: TypeMap): void;
-/**
- * Lookup a mime type based on extension
- *
- * @param input
- */
-export declare function getType(input: string): string | undefined;
-/**
- * Get the file extension associated with a mime type.
- *
- * @param input
- */
-export declare function getExtension(input: string): string | undefined;
-/**
- * Retrieve meta information associated with a mime type.
- *
- * @param input
- */
-export declare function get(input: string): TypeMeta | undefined;
+import type { IMimeExplorer, RegisterOptions, TypeMeta, TypeMetaCollection } from './types.ts';
+export declare class MimeExplorer implements IMimeExplorer {
+    #private;
+    /**
+     * Create an independent registry, empty by default. Never throws: the first definition
+     * of a type or extension wins and unusable entries are skipped without being reported.
+     *
+     * @param definitions - Extensions or metadata per MIME type, such as the `mime-explorer/db` export.
+     */
+    constructor(definitions?: TypeMetaCollection);
+    register(definitions: TypeMetaCollection, options?: RegisterOptions): boolean;
+    unregister(contentType: string): boolean;
+    getMeta(contentType: string): TypeMeta | undefined;
+    getExtension(contentType: string): string | undefined;
+    getType(path: string): string | undefined;
+}

package/dist/type.d.ts

@@ -1,20 +1 @@
-export type TypeMap = Record<string, string[] | TypeMetaInput>;
-export type TypeMeta = {
-    /**
-     * Source of the mime type and associated information.
-     */
-    source?: string;
-    /**
-     * Extensions associated with the mime type.
-     */
-    extensions: string[];
-    /**
-     * Charset of the mime type content.
-     */
-    charset?: string;
-    /**
-     * Content of mime type is compressible?
-     */
-    compressible?: boolean;
-};
-export type TypeMetaInput = Partial<TypeMeta>;
+export * from './types.ts';

package/dist/types.d.ts

@@ -0,0 +1,69 @@
+export type TypeMeta = {
+    /**
+     * Source of the mime type and associated information.
+     */
+    readonly source?: string;
+    /**
+     * Extensions associated with the mime type. The first one is the default; empty for a
+     * type known only by its metadata.
+     */
+    readonly extensions: readonly string[];
+    /**
+     * Charset of the mime type content.
+     */
+    readonly charset?: string;
+    /**
+     * Content of mime type is compressible?
+     */
+    readonly compressible?: boolean;
+};
+export type TypeMetaInput = Partial<TypeMeta>;
+export type TypeMetaCollection = Readonly<Record<string, readonly string[] | TypeMetaInput>>;
+export type TypeMap = TypeMetaCollection;
+export type RegisterOptions = {
+    /**
+     * Apply nothing and throw `RegistrationError` when any part cannot be applied.
+     *
+     * @default false
+     */
+    readonly throwOnFailure?: boolean;
+};
+export interface IMimeExplorer {
+    /**
+     * Add definitions keyed by MIME type. The first definition of a type or extension wins.
+     *
+     * @param definitions - Extensions or metadata per MIME type, such as `{ 'text/plain': ['txt'] }`.
+     * @param options - Set `throwOnFailure` to apply nothing and throw `RegistrationError` on any failure.
+     * @returns `true` when everything was applied, `false` when any part could not be. A contested
+     * extension stays listed on its record, but `getType()` keeps returning its first owner.
+     */
+    register(definitions: TypeMetaCollection, options?: RegisterOptions): boolean;
+    /**
+     * Remove a MIME type and every extension it owns.
+     *
+     * @param contentType - A MIME type or Content-Type header, such as `text/plain; charset=utf-8`.
+     * @returns `true` when a record was removed, `false` when the type is unknown.
+     */
+    unregister(contentType: string): boolean;
+    /**
+     * Find the read-only record of a MIME type.
+     *
+     * @param contentType - A MIME type or Content-Type header, such as `text/html; charset=utf-8`.
+     * @returns The record, or `undefined` when the type is unknown.
+     */
+    getMeta(contentType: string): TypeMeta | undefined;
+    /**
+     * Find the MIME type of a file.
+     *
+     * @param path - An extension, dotted extension, file name or path, such as `/uploads/report.JSON`.
+     * @returns The MIME type, such as `application/json`, or `undefined` when the extension is unknown.
+     */
+    getType(path: string): string | undefined;
+    /**
+     * Find the default file extension of a MIME type.
+     *
+     * @param contentType - A MIME type or Content-Type header, such as `text/html; charset=utf-8`.
+     * @returns The extension without a leading dot, such as `html`, or `undefined` when the type is unknown or has no extensions.
+     */
+    getExtension(contentType: string): string | undefined;
+}

package/package.json

@@ -1,16 +1,19 @@
 {
     "name": "mime-explorer",
-    "version": "1.1.0",
-    "description": "This is a library for mime types. It provides an ESM and CJS build.",
-    "main": "dist/index.cjs",
-    "module": "dist/index.mjs",
+    "version": "2.0.0",
+    "description": "Look up MIME types, file extensions and metadata, and register your own mappings.",
+    "type": "module",
+    "main": "dist/index.mjs",
     "types": "dist/index.d.ts",
     "exports": {
         "./package.json": "./package.json",
         ".": {
             "types": "./dist/index.d.ts",
-            "import": "./dist/index.mjs",
-            "require": "./dist/index.cjs"
+            "default": "./dist/index.mjs"
+        },
+        "./db": {
+            "types": "./dist/db.d.ts",
+            "default": "./dist/db.mjs"
         }
     },
     "files": [
@@ -18,14 +21,16 @@
     ],
     "scripts": {
         "build:types": "tsc --emitDeclarationOnly",
-        "build:js": "rollup -c",
-        "build": "node bin/db.js && npm run build:types && npm run build:js",
+        "build:js": "tsdown",
+        "build": "node bin/db.cjs && node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && npm run build:js",
         "commit": "npx git-cz",
-        "lint": "eslint --ext .js,.ts ./src",
+        "lint": "eslint src AGENTS.md CLAUDE.md .agents",
         "lint:fix": "npm run lint -- --fix",
-        "test": "cross-env NODE_ENV=test jest --config ./test/jest.config.js",
-        "test:coverage": "npm run test -- --coverage",
-        "prepare": "npx husky install",
+        "test": "npm run test:types && cross-env NODE_ENV=test vitest run --config test/vitest.config.mts",
+        "test:types": "tsc -p test/types/tsconfig.json",
+        "test:package": "tsc -p test/package/tsconfig.json && node test/package/esm.mjs && node test/package/cjs.cjs",
+        "test:coverage": "npm test -- --coverage",
+        "prepare": "husky",
         "prepublishOnly": "npm run build"
     },
     "author": {
@@ -50,24 +55,21 @@
     },
     "homepage": "https://github.com/Tada5hi/mime-explorer#readme",
     "devDependencies": {
-        "@rollup/plugin-json": "^6.0.1",
-        "@rollup/plugin-node-resolve": "^15.2.3",
-        "@rollup/plugin-swc": "^0.3.0",
-        "@rollup/plugin-terser": "^0.4.4",
-        "@tada5hi/commitlint-config": "^1.1.4",
-        "@tada5hi/eslint-config-typescript": "^1.2.7",
-        "@tada5hi/semantic-release": "^0.3.0",
-        "@tada5hi/tsconfig": "^0.5.0",
-        "@types/jest": "^29.4.0",
-        "@types/node": "^20.10.0",
-        "cross-env": "^7.0.3",
-        "eslint": "^8.54.0",
-        "husky": "^8.0.3",
-        "jest": "^29.7.0",
-        "mime-db": "^1.52.0",
-        "rollup": "^4.6.0",
-        "semantic-release": "^22.0.8",
-        "ts-jest": "^29.1.1",
-        "typescript": "^5.3.2"
+        "@tada5hi/commitlint-config": "^1.3.3",
+        "@tada5hi/eslint-config": "^3.3.1",
+        "@tada5hi/tsconfig": "^0.7.2",
+        "@types/node": "^24.19.2",
+        "@vitest/coverage-v8": "^5.1.0",
+        "cross-env": "^10.1.0",
+        "eslint": "^10.14.0",
+        "husky": "^9.1.7",
+        "mime-db": "^1.54.0",
+        "tsdown": "^0.23.7",
+        "typescript": "~6.0.3",
+        "typescript-eslint": "^8.72.1",
+        "vitest": "^5.1.0"
+    },
+    "dependencies": {
+        "@ebec/core": "^1.3.2"
     }
 }