@push.rocks/smartmime

@push.rocks/smartmime detects MIME types from paths, buffers, and Node streams and classifies their encoding as binary or UTF-8. Path lookup uses a versioned registry owned by this package, with no runtime mime, mime-db, or filesystem dependency.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

Install

pnpm add @push.rocks/smartmime

Node.js 20 or newer is required.

Path-Based Lookup

Use getMimeTypeForPathSync() when only an extension-based MIME value is needed. It returns null for unknown extensions.

import {
  getEncodingForPathSync,
  getMimeTypeForPathSync,
  mimeRegistrySourceVersion,
} from '@push.rocks/smartmime';

getMimeTypeForPathSync('assets/photo.jpg'); // 'image/jpeg'
getMimeTypeForPathSync('unknown.extension'); // null
getEncodingForPathSync('assets/photo.jpg'); // 'binary'

console.log(mimeRegistrySourceVersion); // the upstream snapshot used for compatibility

The in-code extension registry currently preserves the final lookup mappings from [email protected]. Its source version, provenance, upstream MIT notices, and update procedure are recorded next to the registry in ts/mime-registry.ts.

Unified Detection

detectMimeType() accepts exactly one path, byte buffer, or Node stream. Path detection is extension-based. Buffer and stream detection inspect content through file-type.

import { Readable } from 'node:stream';
import { detectMimeType, getEncoding, isBinary } from '@push.rocks/smartmime';

const pathResult = await detectMimeType({ path: 'assets/font.woff2' });
// { mime: 'font/woff2', ext: '.woff2' }

const pngBytes = Uint8Array.from([/* PNG bytes */]);
const bufferResult = await detectMimeType({ buffer: pngBytes });
const streamResult = await detectMimeType({
  stream: Readable.from([pngBytes], { objectMode: false }),
});

await isBinary({ path: 'assets/font.woff2' }); // true
await getEncoding({ path: 'assets/document.json' }); // 'utf8'

Unknown buffer or stream content throws a stable detection error. Unknown path extensions return a result whose mime field is null.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.

Please note: The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

Company Information

Task Venture Capital GmbH Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at [email protected].

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.