mime-xdg 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,199 @@
+# mime-xdg
+mimetypes, mimeheads and mimenotes from xdg/shared-mime-info
+
+## Note
+
+This library contains mime types from two sources:
+- [apache.mime.types](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types) - have the highest priority
+- [gitlab.freedesktop.org/xdg/shared-mime-info](https://gitlab.freedesktop.org/xdg/shared-mime-info) - included in packages for defining mime types in Linux systems
+
+In addition to this, there are top-level types (mime heads) and mime descriptions (mime notes).
+
+All mime types and their descriptions are contained in an optimized form. Therefore, the library does not weigh so much.
+
+## Usage
+### mimeType
+basic library with all mime types
+```js
+import { 
+  EXTENSIONS, MIME_TYPES,
+  ext, extname, 
+  mimeType, mimeList 
+} from 'mime-xdg'
+
+
+// OBJECTS
+
+/**
+  * 1. EXTENSIONS
+  */
+console.log(EXTENSIONS)
+// EXTENSIONS equal to:
+{
+  "123": [
+    "application/vnd.lotus-1-2-3",
+    "application/x-lotus123",
+    "application/x-123",
+    "application/lotus123",
+    "application/wk1",
+    "zz-application/zz-winassoc-123"
+  ],
+  "602": [
+    "application/x-t602"
+  ],
+  "7z.001": [
+    "application/x-7z-compressed"
+  ],
+  "svg.gz": [
+    "image/svg+xml-compressed"
+  ],
+  "aw": [
+    "application/applixware",
+    "application/x-applix-word"
+  ],
+  /* etc... */
+}
+
+/**
+  * 2. MIME_TYPES
+  */
+console.log(MIME_TYPES)
+// MIME_TYPES equal to:
+{
+  application: {
+    "x-riff": true,
+    "x-matroska": true,
+    "x-iff": true,
+    "x-ole-storage": true,
+    /* etc... */
+  },
+  audio: {
+    "tta": true,
+    "x-tta": true,
+    "x-xi": true,
+    "x-voc": true,
+    /* etc... */
+  },
+  font: { /* etc... */ },
+  image: { /* etc... */ },
+  text: { /* etc... */ },
+  /* etc... */
+}
+
+// FUNCTIONS
+
+/**
+  * 3. ext
+  */
+// returns the extname if it is in the EXTENSIONS or empty string
+ext('test.js') // 'js'
+ext('test.foobar') // '' - empty string
+ext('test.abw.CRASHED') // 'abw.CRASHED' - because it exists exactly in this form
+ext('test.abw.crashed') // '' - empty string
+
+/**
+  * 4. extname
+  */
+// works the same way as 'extname' from 'node:path', but
+// returns the extname if it is in the EXTENSIONS or find it herself
+extname('test.foobar') // '.foobar'
+extname('test.abw.CRASHED') // '.abw.CRASHED'
+extname('test.abw.crashed') // '.crashed'
+
+/**
+  * 5. mimeType
+  */
+// returns the mime type or empty string
+mimeType('test.foobar') // '' - empty string
+mimeType('test.js') // 'text/javascript'
+mimeType('test.JS') // 'text/javascript'
+// but, in the schema 'shared-mime-info', sometimes the register matters:
+mimeType('test.c') // text/x-c
+mimeType('test.C') // text/x-c++src
+// I do not know if this is right or not,
+// but I think the Linux developers know better
+
+/**
+  * 6. mimeList
+  */
+// returns an array of all mime types
+mimeList('test.js')
+/*
+[
+  "text/javascript",
+  "application/x-javascript",
+  "application/javascript"
+]
+*/
+mimeList('test.foobar') // []
+```
+
+### mimeHead
+many mime types have their own main mime type
+```js
+import { 
+  MIME_HEADS,
+  mimeHead
+} from 'mime-xdg/heads'
+
+// OBJECT
+
+/**
+  * 1. MIME_HEADS
+  */
+console.log(MIME_HEADS)
+// MIME_HEADS equal to:
+{
+  "message/rfc822": "text/plain",
+  "font/otf": "font/ttf",
+  "video/x-theora+ogg": "video/ogg",
+  "video/x-theora": "video/ogg",
+  /* etc... */
+}
+
+// FUNCTION
+
+/**
+  * 2. mimeHead
+  */
+// returns main mime type or empty string
+mimeHead('foobar') // '' - empty string
+mimeHead('text/javascript') // 'application/ecmascript'
+```
+
+### mimeNote
+some mime types have a short description
+```js
+import { 
+  MIME_NOTES,
+  mimeNote
+} from 'mime-xdg/notes'
+
+// OBJECT
+
+/**
+  * 1. MIME_NOTES
+  */
+console.log(MIME_NOTES)
+// MIME_NOTES equal to:
+{
+  "flv-application/octet-stream": "Flash video",
+  "message/rfc822": "email message",
+  "font/woff2": "WOFF2 font",
+  "font/woff": "WOFF font",
+  /* etc... */
+}
+
+// FUNCTION
+
+/**
+  * 2. mimeNote
+  */
+// returns note or empty string
+mimeNote('foobar') // '' - empty string
+mimeNote('text/javascript') // 'JavaScript program'
+```
+
+## License
+
+[MIT](LICENSE)

package/heads/index.d.ts

@@ -0,0 +1,3 @@
+export * from "../types/heads";
+export { MIME_HEADS } from "../types/heads";
+export { mimeHead } from "../types/heads";

package/heads/index.js

@@ -0,0 +1,16 @@
+/* eslint-disable */
+/*
+dester builds:
+heads.ts
+*/
+Object.defineProperty(exports, "__esModule", {
+    value: !0
+});
+
+var e = require("../lib"), r = require("../lib/heads"), _ = require("../lib/mimes"), E = (() => {
+    for (var E, M = e.createObject(), A = r._HEADS_DATA.length; A--; ) for (var i in r._HEADS_DATA[A]) E = r._HEADS_DATA[A][i = +i], 
+    M[_._MIME_TYPES[A] + "/" + _._MIME_NAMES[A][i]] = _._MIME_TYPES[E[0]] + "/" + _._MIME_NAMES[E[0]][E[1]];
+    return M;
+})();
+
+exports.MIME_HEADS = E, exports.mimeHead = e => E[e] || "";

package/heads/index.mjs

@@ -0,0 +1,18 @@
+/* eslint-disable */
+/*
+dester builds:
+heads.ts
+*/
+import { createObject as r } from "../lib";
+
+import { _HEADS_DATA as o } from "../lib/heads";
+
+import { _MIME_TYPES as i, _MIME_NAMES as m } from "../lib/mimes";
+
+var t = (() => {
+    for (var t, e = r(), f = o.length; f--; ) for (var a in o[f]) t = o[f][a = +a], 
+    e[i[f] + "/" + m[f][a]] = i[t[0]] + "/" + m[t[0]][t[1]];
+    return e;
+})(), e = r => t[r] || "";
+
+export { t as MIME_HEADS, e as mimeHead };

package/heads/package.json

@@ -0,0 +1,10 @@
+{
+  "main": "index",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "files": [
+    "index.d.ts",
+    "index.js",
+    "index.mjs"
+  ]
+}

package/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./types";
+export { EXTENSIONS } from "./types";
+export { MIME_TYPES } from "./types";
+export { ext } from "./types";
+export { extname } from "./types";
+export { mimeList } from "./types";
+export { mimeType } from "./types";

package/index.js

@@ -0,0 +1,38 @@
+/* eslint-disable */
+/*
+dester builds:
+index.ts
+*/
+Object.defineProperty(exports, "__esModule", {
+    value: !0
+});
+
+var e = require("./lib"), r = require("./lib/mimes"), t = (() => {
+    var t = e.createObject();
+    for (var E in r._EXTENSIONS) {
+        t[E] = [];
+        for (var M = r._EXTENSIONS[E], i = 0, _ = 0; _ < M.length; _++) t[E][i++] = r._MIME_TYPES[M[_]] + "/" + r._MIME_NAMES[M[_++]][M[_]];
+    }
+    return t;
+})(), E = (() => {
+    for (var t = e.createObject(), E = r._MIME_TYPES.length; E-- > 0; ) {
+        t[r._MIME_TYPES[E]] = e.createObject();
+        for (var M = r._MIME_NAMES[E].length; M-- > 0; ) t[r._MIME_TYPES[E]][r._MIME_NAMES[E][M]] = !0;
+    }
+    return t;
+})(), M = e => {
+    for (var r, E = "", M = "", i = "", _ = "", a = (e = e.trim()).length; a-- > 0; ) {
+        if ("." === (r = e[a])) M in t && (E = M) || i in t && (E = i) || _ in t && (E = _); else if ("/" === r || "\\" === r) break;
+        M = r + M, i = r.toUpperCase() + i, _ = r.toLowerCase() + _;
+    }
+    return E;
+};
+
+exports.EXTENSIONS = t, exports.MIME_TYPES = E, exports.ext = M, exports.extname = e => {
+    var r = M(e);
+    if (!r) {
+        var t = e.lastIndexOf(".");
+        t > -1 && (r = e.slice(t + 1));
+    }
+    return r ? "." + r : "";
+}, exports.mimeList = e => (e = M(e)) ? t[e].slice(0) : [], exports.mimeType = e => (e = M(e)) ? t[e][0] : e;

package/index.mjs

@@ -0,0 +1,38 @@
+/* eslint-disable */
+/*
+dester builds:
+index.ts
+*/
+import { createObject as r } from "./lib";
+
+import { _EXTENSIONS as e, _MIME_TYPES as i, _MIME_NAMES as t } from "./lib/mimes";
+
+var a = (() => {
+    var a = r();
+    for (var n in e) {
+        a[n] = [];
+        for (var o = e[n], f = 0, l = 0; l < o.length; l++) a[n][f++] = i[o[l]] + "/" + t[o[l++]][o[l]];
+    }
+    return a;
+})(), n = (() => {
+    for (var e = r(), a = i.length; a-- > 0; ) {
+        e[i[a]] = r();
+        for (var n = t[a].length; n-- > 0; ) e[i[a]][t[a][n]] = !0;
+    }
+    return e;
+})(), o = r => {
+    for (var e, i = "", t = "", n = "", o = "", f = (r = r.trim()).length; f-- > 0; ) {
+        if ("." === (e = r[f])) t in a && (i = t) || n in a && (i = n) || o in a && (i = o); else if ("/" === e || "\\" === e) break;
+        t = e + t, n = e.toUpperCase() + n, o = e.toLowerCase() + o;
+    }
+    return i;
+}, f = r => {
+    var e = o(r);
+    if (!e) {
+        var i = r.lastIndexOf(".");
+        i > -1 && (e = r.slice(i + 1));
+    }
+    return e ? "." + e : "";
+}, l = r => (r = o(r)) ? a[r][0] : r, v = r => (r = o(r)) ? a[r].slice(0) : [];
+
+export { a as EXTENSIONS, n as MIME_TYPES, o as ext, f as extname, v as mimeList, l as mimeType };

package/lib/heads/index.d.ts

@@ -0,0 +1,2 @@
+export * from "../../types/lib/heads";
+export { _HEADS_DATA } from "../../types/lib/heads";