@e-mc/compress 0.8.5 → 0.8.7

package/LICENSE

@@ -1,7 +1,11 @@
-Copyright 2024 Mile Square Park
+Copyright 2024 An Pham
 
-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:
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
 
-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.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,7 +1,60 @@
 # @e-mc/compress
 
-PEP 402
+* NodeJS 14
+* ES2020
+
+## General Usage
+
+* [Read the Docs](https://e-mc.readthedocs.io)
+
+## Interface
+
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/index.d.ts
+
+```typescript
+import type { CompressLevel } from "./squared";
+
+import type { IModule, ModuleConstructor } from "./index";
+import type { BufferResult, CompressFormat, TryFileCompressor, TryFileResult, TryImageResult } from "./compress";
+import type { CompressModule, CompressSettings } from "./settings";
+
+import type { WriteStream } from 'fs';
+import type { Readable } from "stream";
+import type { BrotliCompress, Gzip } from "zlib";
+
+interface ICompress extends IModule {
+    module: CompressModule;
+    level: Record<string, number>;
+    compressors: Record<string, TryFileCompressor>;
+    chunkSize?: number;
+    init(...args: unknown[]): this;
+    register(format: string, callback: TryFileCompressor): void;
+    getLevel(value: string, fallback?: number): number | undefined;
+    getReadable(file: string | URL | Buffer): Readable;
+    createGzip(file: string | Buffer, options?: CompressLevel): Gzip;
+    createBrotliCompress(file: string | Buffer, options?: CompressLevel): BrotliCompress;
+    createWriteStreamAsGzip(file: string | Buffer, output: string, options?: CompressLevel): WriteStream;
+    createWriteStreamAsBrotli(file: string | Buffer, output: string, options?: CompressLevel): WriteStream;
+    tryFile(file: string | Buffer, config: CompressFormat, callback?: TryFileResult): Promise<BufferResult>;
+    tryFile(file: string | Buffer, output: string, config: CompressFormat, callback?: TryFileResult): Promise<BufferResult>;
+    tryImage(file: string, config: CompressFormat, callback?: TryImageResult): Promise<BufferResult>;
+    tryImage(file: string | Buffer, output: string, config: CompressFormat, callback?: TryImageResult): Promise<BufferResult>;
+    get settings(): CompressSettings;
+}
+
+interface CompressConstructor extends ModuleConstructor {
+    singleton(): ICompress;
+    readonly prototype: ICompress;
+    new(module?: CompressModule): ICompress;
+}
+```
+
+## References
+
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/squared.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/compress.d.ts
+- https://www.unpkg.com/@e-mc/types@0.8.7/lib/settings.d.ts
 
 ## LICENSE
 
-MIT
+BSD 3-Clause

package/index.js

@@ -6,9 +6,9 @@ const stream = require("stream");
 const zlib = require("zlib");
 const wawoff2 = require("wawoff2");
 const { toSfnt, toWoff } = require('woff2sfnt-sfnt2woff');
-const types_1 = require("../types");
-const lib_v4_1 = require("../module/lib-v4");
-const module_1 = require("../module");
+const types_1 = require("@e-mc/types");
+const lib_v4_1 = require("@e-mc/module/lib-v4");
+const module_1 = require("@e-mc/module");
 const CACHE_IMAGE = {};
 const CACHE_FONT = {};
 const CACHE_FONTFROM = {};
@@ -53,7 +53,7 @@ function setCacheData(index) {
                                 try {
                                     const stat = fs.lstatSync(pathname);
                                     if (stat.atimeMs + expires > current) {
-                                        if (index === 0 /* CACHE_TYPE.FONT */) {
+                                        if (index === 0) {
                                             CACHE_FONT[paths.concat(filename).join('_')] = [pathname, stat.ctime];
                                             CACHE_FONTFROM[filename] = paths[0];
                                             CACHE_FONTTO[filename] = paths[1];
@@ -244,7 +244,7 @@ class Compress extends module_1.default {
                 }
                 else {
                     if (!fromCache) {
-                        this.writeTimeProcess(ext || format, (0, types_1.isString)(result) ? path.basename(result) : filename || "Completed" /* VAL_MESSAGE.COMPLETED */, startTime, { type: 8 /* LOG_TYPE.COMPRESS */, sessionId, broadcastId });
+                        this.writeTimeProcess(ext || format, (0, types_1.isString)(result) ? path.basename(result) : filename || "Completed", startTime, { type: 8, sessionId, broadcastId });
                     }
                     if (callback) {
                         callback(null, result || data, ext);
@@ -256,10 +256,10 @@ class Compress extends module_1.default {
                 if (timeout > 0) {
                     timer = setTimeout(() => {
                         aborted = true;
-                        endProcess((0, types_1.errorValue)("Timeout was exceeded" /* ERR_MESSAGE.TIMEOUT */, format));
+                        endProcess((0, types_1.errorValue)("Timeout was exceeded", format));
                     }, timeout);
                 }
-                this.formatMessage(8 /* LOG_TYPE.COMPRESS */, format, [compressing ? 'Compressing file...' : 'Decompressing file...', filename || (output ? path.basename(output) : '')], (0, types_1.isString)(file) ? file : '', { titleColor: 'magenta', sessionId, broadcastId });
+                this.formatMessage(8, format, [compressing ? 'Compressing file...' : 'Decompressing file...', filename || (output ? path.basename(output) : '')], (0, types_1.isString)(file) ? file : '', { titleColor: 'magenta', sessionId, broadcastId });
             };
             try {
                 const writeFont = (data, ext, from) => {
@@ -296,7 +296,7 @@ class Compress extends module_1.default {
                 };
                 const hasFont = () => {
                     let from, to;
-                    if (cache && (CACHE_INIT[0] || setCacheData.call(this, 0 /* CACHE_TYPE.FONT */)) && (from = CACHE_FONTFROM[hash]) && (to = CACHE_FONTTO[hash])) {
+                    if (cache && (CACHE_INIT[0] || setCacheData.call(this, 0)) && (from = CACHE_FONTFROM[hash]) && (to = CACHE_FONTTO[hash])) {
                         const cacheKey = from + `_${to}_` + hash;
                         const tempFont = CACHE_FONT[cacheKey];
                         if (tempFont) {
@@ -311,7 +311,7 @@ class Compress extends module_1.default {
                                     else {
                                         endProcess(null, data, to, '', true);
                                     }
-                                    this.formatMessage(8 /* LOG_TYPE.COMPRESS */, from, [pathname ? path.basename(pathname) : "Completed" /* VAL_MESSAGE.COMPLETED */ + ` -> font/${to}`, 'cache'], tempFont[1].toLocaleString(), { ...module_1.default.LOG_STYLE_NOTICE, hintBold: true, sessionId, broadcastId });
+                                    this.formatMessage(8, from, [pathname ? path.basename(pathname) : "Completed" + ` -> font/${to}`, 'cache'], tempFont[1].toLocaleString(), { ...module_1.default.LOG_STYLE_NOTICE, hintBold: true, sessionId, broadcastId });
                                     return true;
                                 }
                                 catch {
@@ -322,7 +322,7 @@ class Compress extends module_1.default {
                         return false;
                     }
                 };
-                const errorResponse = (font) => endProcess((0, types_1.errorValue)('Invalid MIME', (font ? font.mime : "Unknown" /* ERR_MESSAGE.UNKNOWN */) + ': ' + (output || filename || "Unknown" /* ERR_MESSAGE.UNKNOWN */)));
+                const errorResponse = (font) => endProcess((0, types_1.errorValue)('Invalid MIME', (font ? font.mime : "Unknown") + ': ' + (output || filename || "Unknown")));
                 const data = Buffer.isBuffer(file) ? file : fs.readFileSync(file);
                 switch (format = format.toLowerCase()) {
                     case 'gz':
@@ -357,8 +357,8 @@ class Compress extends module_1.default {
                         const checkResult = (result, from) => {
                             module_1.default.resolveMime(result).then(font => {
                                 switch (font?.mime) {
-                                    case "font/ttf" /* MIME_TYPE.TTF */:
-                                    case "font/otf" /* MIME_TYPE.OTF */:
+                                    case "font/ttf":
+                                    case "font/otf":
                                         writeFont(result, font.ext, from);
                                         break;
                                     default:
@@ -370,13 +370,13 @@ class Compress extends module_1.default {
                         module_1.default.resolveMime(data).then(font => {
                             try {
                                 switch (font?.mime) {
-                                    case "font/woff" /* MIME_TYPE.WOFF */:
+                                    case "font/woff":
                                         if (cache) {
                                             CACHE_FONTFROM[hash] = 'woff';
                                         }
                                         checkResult(toSfnt(data), 'woff');
                                         break;
-                                    case "font/woff2" /* MIME_TYPE.WOFF2 */:
+                                    case "font/woff2":
                                         if (cache) {
                                             CACHE_FONTFROM[hash] = 'woff2';
                                         }
@@ -412,17 +412,17 @@ class Compress extends module_1.default {
                         module_1.default.resolveMime(data).then(font => {
                             try {
                                 switch (font?.mime) {
-                                    case "font/ttf" /* MIME_TYPE.TTF */:
+                                    case "font/ttf":
                                         if (cache) {
                                             CACHE_FONTFROM[hash] = 'ttf';
                                         }
-                                        wawoff2.compress(data).then(result => checkResult(result, "font/woff2" /* MIME_TYPE.WOFF2 */, 'ttf'));
+                                        wawoff2.compress(data).then(result => checkResult(result, "font/woff2", 'ttf'));
                                         break;
-                                    case "font/otf" /* MIME_TYPE.OTF */:
+                                    case "font/otf":
                                         if (cache) {
                                             CACHE_FONTFROM[hash] = 'otf';
                                         }
-                                        checkResult(toWoff(data), "font/woff" /* MIME_TYPE.WOFF */, 'otf');
+                                        checkResult(toWoff(data), "font/woff", 'otf');
                                         break;
                                     default:
                                         errorResponse(font);
@@ -483,7 +483,7 @@ class Compress extends module_1.default {
         if (!(0, types_1.isString)(output)) {
             output = typeof file === 'string' ? file : '';
         }
-        const ext = output ? path.extname(output).substring(1) : config.format || "Unknown" /* ERR_MESSAGE.UNKNOWN */;
+        const ext = output ? path.extname(output).substring(1) : config.format || "Unknown";
         const format = config.format || ext;
         return new Promise((resolve, reject) => {
             let timer = null, hash, cacheKey, aborted, apiKey;
@@ -509,12 +509,12 @@ class Compress extends module_1.default {
                 }
                 const complete = (err) => {
                     const value = output ? path.basename(output) : filename || (0, types_1.isString)(file) && path.basename(file);
-                    const status = value ? plugin + ' -> ' + value : "Completed" /* VAL_MESSAGE.COMPLETED */;
+                    const status = value ? plugin + ' -> ' + value : "Completed";
                     if (ctime) {
-                        this.formatMessage(8 /* LOG_TYPE.COMPRESS */, value ? path.extname(value).substring(1) : '', [status, 'cache'], ctime.toLocaleString(), { ...module_1.default.LOG_STYLE_NOTICE, hintBold: true, sessionId, broadcastId });
+                        this.formatMessage(8, value ? path.extname(value).substring(1) : '', [status, 'cache'], ctime.toLocaleString(), { ...module_1.default.LOG_STYLE_NOTICE, hintBold: true, sessionId, broadcastId });
                     }
                     else {
-                        this.writeTimeProcess(ext, status, startTime, { type: 8 /* LOG_TYPE.COMPRESS */, sessionId, broadcastId });
+                        this.writeTimeProcess(ext, status, startTime, { type: 8, sessionId, broadcastId });
                     }
                     if (callback) {
                         callback(err, result);
@@ -546,7 +546,7 @@ class Compress extends module_1.default {
                     case 'jpg':
                     case 'jpeg':
                     case 'webp':
-                        apiKey = config.options?.apiKey || (module_1.default.enabled("process.env.apply" /* KEY_NAME.PROCESS_ENV_APPLY */) ? process.env.TINIFY_KEY : '');
+                        apiKey = config.options?.apiKey || (module_1.default.enabled("process.env.apply") ? process.env.TINIFY_KEY : '');
                         break;
                     default:
                         failed((0, types_1.errorMessage)(plugin, 'Unsupported MIME', format));
@@ -557,9 +557,9 @@ class Compress extends module_1.default {
                     return;
                 }
                 switch (module_1.default.lookupMime(ext)) {
-                    case "image/jpeg" /* MIME_TYPE.JPEG */:
-                    case "image/png" /* MIME_TYPE.PNG */:
-                    case "image/webp" /* MIME_TYPE.WEBP */:
+                    case "image/jpeg":
+                    case "image/png":
+                    case "image/webp":
                         break;
                     default:
                         failed((0, types_1.errorMessage)(plugin, 'Unsupported format', getFormat()));
@@ -574,7 +574,7 @@ class Compress extends module_1.default {
                 failed(err);
                 return;
             }
-            if (this.settings.cache && setCacheData.call(this, 1 /* CACHE_TYPE.IMAGE */)) {
+            if (this.settings.cache && setCacheData.call(this, 1)) {
                 let stored;
                 try {
                     stored = (CACHE_IMAGE[plugin] || (CACHE_IMAGE[plugin] = {}))[hash = module_1.default.asHash(data)];
@@ -591,12 +591,12 @@ class Compress extends module_1.default {
                     }
                 }
             }
-            this.formatMessage(8 /* LOG_TYPE.COMPRESS */, ext, ['Compressing image...', plugin], filename || output, { titleColor: 'magenta', sessionId, broadcastId });
+            this.formatMessage(8, ext, ['Compressing image...', plugin], filename || output, { titleColor: 'magenta', sessionId, broadcastId });
             if (timeout > 0) {
-                timer = setTimeout(() => failed((0, types_1.errorMessage)(plugin, "Timeout was exceeded" /* ERR_MESSAGE.TIMEOUT */)), timeout);
+                timer = setTimeout(() => failed((0, types_1.errorMessage)(plugin, "Timeout was exceeded")), timeout);
             }
             if (apiKey) {
-                const apiProxy = proxyUrl && (typeof proxyUrl === 'function' ? proxyUrl("https://api.tinify.com" /* VALUES.TINIFY_API_ENDPOINT */) : proxyUrl) || this.module.tinify?.proxy || module_1.default.enabled("process.env.apply" /* KEY_NAME.PROCESS_ENV_APPLY */) && process.env.TINIFY_PROXY || '';
+                const apiProxy = proxyUrl && (typeof proxyUrl === 'function' ? proxyUrl("https://api.tinify.com") : proxyUrl) || this.module.tinify?.proxy || module_1.default.enabled("process.env.apply") && process.env.TINIFY_PROXY || '';
                 const key = apiKey + apiProxy;
                 let tinypng = CACHE_TINIFY[key];
                 const validate = () => {
@@ -628,7 +628,7 @@ class Compress extends module_1.default {
                             validate();
                         }
                         else {
-                            failed(err || new Error("Unknown" /* ERR_MESSAGE.UNKNOWN */));
+                            failed(err || new Error("Unknown"));
                         }
                     });
                 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@e-mc/compress",
-  "version": "0.8.5",
+  "version": "0.8.7",
   "description": "Compress constructor for E-mc.",
   "main": "index.js",
   "types": "index.d.ts",
@@ -20,11 +20,11 @@
     "name": "An Pham",
     "email": "anpham6@gmail.com"
   },
-  "license": "MIT",
+  "license": "BSD 3-Clause",
   "homepage": "https://github.com/anpham6/e-mc#readme",
   "dependencies": {
-    "@e-mc/module": "0.8.5",
-    "@e-mc/types": "0.8.5",
+    "@e-mc/module": "0.8.7",
+    "@e-mc/types": "0.8.7",
     "tinify": "^1.7.1",
     "wawoff2": "^2.0.1",
     "woff2sfnt-sfnt2woff": "^1.0.0"