@pi-r/jimp 0.8.3 → 0.9.1

package/LICENSE

@@ -1,7 +1,7 @@
-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:
-
-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.
+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:
+
+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

@@ -4,4 +4,4 @@ https://e-mc.readthedocs.io/en/latest/image
 
 ### LICENSE
 
-MIT
+MIT

package/index.js

@@ -1,12 +1,13 @@
 "use strict";
-const path = require("path");
-const fs = require("fs");
-const child_process = require("child_process");
+const path = require("node:path");
+const fs = require("node:fs");
+const child_process = require("node:child_process");
 const jimp = require("jimp");
 const gifwrap = require("gifwrap");
 const bmp = require("bmp-js");
-const crypto_1 = require("crypto");
+const node_crypto_1 = require("node:crypto");
 const types_1 = require("@e-mc/types");
+const util_1 = require("@pi-r/jimp/util");
 const Image = require('@e-mc/image');
 let WEBPMUX = null, WEBPMUX_INIT = false;
 try {
@@ -15,7 +16,6 @@ try {
 }
 catch {
 }
-const util_1 = require("@pi-r/jimp/util");
 const CACHE_TRANSFORM = {};
 let CACHE_INIT = false;
 let TEMP_DIR = '';
@@ -31,7 +31,7 @@ const METHOD_ALIAS = {
     composite: 'cp',
     mask: 'ma',
     convolute: 'cl',
-    convolution: 'cl',
+    convolution: 'cu',
     flip: 'fl',
     mirror: 'mi',
     rotate: 'ro',
@@ -68,22 +68,22 @@ const METHOD_ALIAS = {
     threshold: 'th'
 };
 function getMethodName(value) {
-    const name = value.toLowerCase();
-    if (METHOD_ALIAS[name]) {
-        return name;
-    }
-    if (name.length === 2) {
+    if (value.length === 2) {
+        value = value.toLowerCase();
         for (const alias in METHOD_ALIAS) {
-            if (METHOD_ALIAS[alias] === name) {
+            if (METHOD_ALIAS[alias] === value) {
                 return alias;
             }
         }
     }
+    else if (METHOD_ALIAS[value] || METHOD_ALIAS[value = value.toLowerCase()]) {
+        return value;
+    }
 }
-async function performCommand(host, instance, localUri, command, outputType, finalAs, buffer, parent) {
+async function performCommand(host, instance, localUri, command, outputType, outputAs, buffer, parent) {
     return await jimp.read((buffer || localUri))
         .then(async (img) => {
-        return await transformCommand(localUri, new JimpHandler(img, instance, host), command, outputType, finalAs, parent);
+        return await transformCommand(localUri, new JimpHandler(img, instance, host), command, outputType, outputAs, parent);
     });
 }
 function execOptions(settings) {
@@ -120,22 +120,22 @@ async function transformCommand(localFile, handler, command, outputType, outputA
             return handler.rotate();
     }
     return handler.rotate(localFile, (err, result) => {
-        if (!err && handler.host?.moduleName === 'filemanager') {
+        if (!err) {
             try {
-                handler.host.add(result, parent);
+                handler.host?.add(result, parent);
             }
             catch {
             }
         }
     });
 }
-function setImageCache(instance, tempKey, tempFile, output, localFile) {
+async function setImageCache(instance, tempKey, tempFile, output, localFile) {
     try {
         if (typeof output === 'string') {
-            fs.copyFileSync(output, tempFile);
+            await fs.promises.copyFile(output, tempFile);
         }
         else {
-            fs.writeFileSync(tempFile, output);
+            await fs.promises.writeFile(tempFile, output);
         }
         const stored = getCacheData(instance);
         if (localFile) {
@@ -174,7 +174,7 @@ function getImageCache(instance, tempKey) {
         delete stored[tempKey];
     }
     TEMP_DIR ||= instance.getTempDir({ moduleDir: true, increment: 5 });
-    return [null, TEMP_DIR ? path.join(TEMP_DIR, (0, crypto_1.randomUUID)()) : ''];
+    return [null, TEMP_DIR ? path.join(TEMP_DIR, (0, node_crypto_1.randomUUID)()) : ''];
 }
 function getCacheData(instance) {
     if (!CACHE_INIT) {
@@ -228,7 +228,7 @@ function formatMessage(instance, value, startTime, failed, cTimeMs) {
 }
 function getTempPath(instance, ext) {
     const tempDir = TEMP_DIR || instance.getTempDir({ moduleDir: true, createDir: true }) || instance.getTempDir();
-    return path.join(tempDir, (0, crypto_1.randomUUID)() + '.' + ext);
+    return path.join(tempDir, (0, node_crypto_1.randomUUID)() + '.' + ext);
 }
 function rotateAnim(cmd) {
     const rotate = cmd.rotate;
@@ -239,18 +239,16 @@ function rotateAnim(cmd) {
 function removeFile(pathname) {
     fs.unlink(pathname, () => { });
 }
-const hasTransform = (cmd) => !!(cmd.rotate || cmd.opacity >= 0 && cmd.opacity < 1 || cmd.resize || cmd.crop || cmd.method);
+const hasTransform = (cmd) => !!(cmd.rotate || cmd.resize || cmd.crop || cmd.method || typeof cmd.opacity === 'number' && cmd.opacity >= 0 && cmd.opacity < 1);
 const emptyResult = (options) => (options.tempFile ? '' : null);
 class JimpHandler {
     handler;
     instance;
-    _host = null;
-    constructor(handler, instance, host) {
+    _host;
+    constructor(handler, instance, _host = null) {
         this.handler = handler;
         this.instance = instance;
-        if (host) {
-            this._host = host;
-        }
+        this._host = _host;
     }
     async rotate(localFile, callback) {
         if (this.aborted) {
@@ -479,20 +477,23 @@ class JimpHandler {
         }
     }
     async getBuffer(tempFile, saveAs) {
-        const empty = () => tempFile ? '' : null;
-        const output = getTempPath(this.instance, this.instance.outputAs || (saveAs && util_1.MIME_OUTPUT.has('image/' + (saveAs === 'jpg' ? 'jpeg' : saveAs)) ? saveAs : this.handler.getMIME().split('/').pop()));
-        return !output ? empty() : new Promise(resolve => {
+        const emptyData = () => tempFile ? '' : null;
+        const output = getTempPath(this.instance, saveAs && util_1.MIME_OUTPUT.has('image/' + (saveAs === 'jpg' ? 'jpeg' : saveAs)) ? saveAs : this.handler.getMIME().split('/').pop());
+        if (!output) {
+            return emptyData();
+        }
+        return new Promise(resolve => {
             this.handler.write(output, error => {
                 if (error) {
-                    resolve(empty());
+                    resolve(emptyData());
                     return;
                 }
                 this.finalize(output, (error, result) => {
                     if (error) {
-                        resolve(empty());
+                        resolve(emptyData());
                     }
                     else if (tempFile) {
-                        resolve(output);
+                        resolve(result || output);
                     }
                     else {
                         try {
@@ -589,7 +590,7 @@ class JimpHandler {
 }
 class Jimp extends Image {
     static async transform(file, command, options = {}) {
-        const [outputType, saveAs, finalAs] = (0, util_1.parseFormat)(command = command.trim(), options.mimeType);
+        const [outputType, saveAs, outputAs] = (0, util_1.parseFormat)(command = command.trim(), options.mimeType);
         if (!outputType) {
             return emptyResult(options);
         }
@@ -603,7 +604,7 @@ class Jimp extends Image {
             try {
                 const { ext } = await this.resolveMime(file) || { ext: 'unknown' };
                 buffer = file;
-                fs.writeFileSync(file = path.join(tempDir, (0, crypto_1.randomUUID)() + '.' + ext), buffer);
+                fs.writeFileSync(file = path.join(tempDir, (0, node_crypto_1.randomUUID)() + '.' + ext), buffer);
             }
             catch {
                 return emptyResult(options);
@@ -625,7 +626,7 @@ class Jimp extends Image {
         }
         const writeMessage = (failed, cTimeMs) => {
             if (cTimeMs || options.startTime) {
-                formatMessage(instance, filename + (0, util_1.showOutputType)(options.mimeType, outputType, finalAs), options.startTime, failed, cTimeMs);
+                formatMessage(instance, filename + (0, util_1.showOutputType)(options.mimeType, outputType, outputAs), options.startTime, failed, cTimeMs);
             }
         };
         let tempKey, tempFile;
@@ -639,13 +640,13 @@ class Jimp extends Image {
         }
         instance.formatMessage(Image.LOG_TYPE.IMAGE, "jimp", ["Transforming image...", filename], command);
         Image.initCpuUsage(instance);
-        return performCommand(null, instance, file, command, outputType, finalAs)
+        return performCommand(null, instance, file, command, outputType, outputAs)
             .then(async (handler) => {
             const result = await handler.getBuffer(options.tempFile, saveAs);
             instance.flushLog();
             writeMessage(!result || instance.errors.length > 0);
             if (result && tempKey && tempFile) {
-                setImageCache(instance, tempKey, tempFile, result, file);
+                void setImageCache(instance, tempKey, tempFile, result, file);
             }
             return result;
         })
@@ -660,6 +661,12 @@ class Jimp extends Image {
     }
     _moduleName = "jimp";
     _threadable = true;
+    resizeData = null;
+    cropData = null;
+    rotateData = null;
+    qualityData = null;
+    methodData = null;
+    opacityValue = NaN;
     parseRotate(value) {
         const data = super.parseRotate(value);
         if (data && this.settings.jimp?.rotate_clockwise) {
@@ -686,7 +693,7 @@ class Jimp extends Image {
                 reject((0, types_1.errorValue)("Not permitted to read file", localUri));
                 return;
             }
-            const [outputType, saveAs, finalAs] = (0, util_1.parseFormat)(command = command.trim(), mimeType, true);
+            const [outputType, saveAs, outputAs] = (0, util_1.parseFormat)(command = command.trim(), mimeType, true);
             if (!outputType) {
                 reject((0, types_1.errorValue)("Invalid format", /^\w+/.exec(command)?.[0] || "Unknown"));
                 return;
@@ -728,7 +735,7 @@ class Jimp extends Image {
                 if (replace && file.localUri !== output && !host.assets.find(item => item.localUri === output && !item.invalid)) {
                     host.filesToRemove.add(output);
                 }
-                formatMessage(this, (0, util_1.showInputType)(mimeType, outputType, finalAs) + filename, startTime, false, ctimeMs);
+                formatMessage(this, (0, util_1.showInputType)(mimeType, outputType, outputAs) + filename, startTime, false, ctimeMs);
                 resolve();
             };
             let tempKey, tempFile;
@@ -736,7 +743,7 @@ class Jimp extends Image {
                 let buffer, ctimeMs;
                 [buffer, tempFile] = getImageCache(this, tempKey = (file.etag || Image.asHash(file.buffer)) + command + mimeType);
                 if (buffer) {
-                    const result = finalAs === 'webp' ? (0, util_1.renameExt)(output, 'webp', replace) : output;
+                    const result = outputAs === 'webp' ? (0, util_1.renameExt)(output, 'webp', replace) : output;
                     fs.writeFileSync(result, file.buffer = buffer);
                     success(result, ctimeMs);
                     return;
@@ -744,7 +751,7 @@ class Jimp extends Image {
             }
             const finalize = (value) => {
                 if (tempFile && tempKey) {
-                    setImageCache(this, tempKey, tempFile, value);
+                    void setImageCache(this, tempKey, tempFile, value);
                 }
                 if (replace) {
                     delete file.buffer;
@@ -753,7 +760,7 @@ class Jimp extends Image {
             };
             const transformBuffer = (bmpFile) => {
                 startMessage();
-                performCommand(host, this, localUri, command, outputType, finalAs, bmpFile || file.buffer, file)
+                performCommand(host, this, localUri, command, bmpFile ? jimp.MIME_BMP : outputType, outputAs, bmpFile || file.buffer, file)
                     .then((img) => {
                     if (typeof bmpFile === 'string') {
                         removeFile(bmpFile);
@@ -804,7 +811,7 @@ class Jimp extends Image {
                 if (outputType === jimp.MIME_GIF || outputType === "image/webp") {
                     const cmd = this.parseCommand(command);
                     const transformWebP = (target, modified) => {
-                        if (finalAs === 'webp') {
+                        if (outputAs === 'webp') {
                             if (!modified) {
                                 startMessage();
                             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pi-r/jimp",
-  "version": "0.8.3",
-  "description": "Jimp image constructor for E-mc.",
+  "version": "0.9.1",
+  "description": "Jimp V0 image constructor for E-mc.",
   "main": "index.js",
   "publishConfig": {
     "access": "public"
@@ -13,15 +13,14 @@
   },
   "keywords": [
     "squared",
-    "e-mc",
-    "squared-functions"
+    "e-mc"
   ],
   "author": "An Pham <anpham6@gmail.com>",
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/image": "^0.10.3",
-    "@e-mc/types": "^0.10.3",
+    "@e-mc/image": "^0.11.2",
+    "@e-mc/types": "^0.11.2",
     "bmp-js": "^0.1.0",
     "gifwrap": "^0.10.1",
     "jimp": "^0.22.12"

package/types/index.d.ts

@@ -21,13 +21,14 @@ export type ResultCallback<T = unknown, U = void, V = unknown> = (err: V, result
 
 export interface IJimpHandler<T extends IHost = IHost, U extends ImageModule = ImageModule> extends ImageHandler<jimp, T, IImage<T, U>> {
     method(): Promise<void>;
+    quality(): void;
     rotate(localFile?: string, callback?: ResultCallback<string>): Promise<this>;
     background(value: number | [number, number, number, number]): void;
     writeAsync(output: string, callback?: ResultCallback): Promise<void>;
 }
 
 export interface JimpImageConstructor<T extends IFileManager<U>, U extends ExternalAsset = ExternalAsset, V extends ImageModule = ImageModule<JimpSettings>> extends ConstructorDerived<ImageConstructor<T, V>> {
-    transform<W extends TransformOptions>(file: string, command: string, options?: W): Promise<W extends { tempFile: true } ? string : Null<Buffer>>;
+    transform<W extends TransformOptions>(file: string, command: string, options?: W): Promise<W extends { tempFile: true } ? string : Buffer | null>;
     readonly prototype: IImage<T, V>;
     new(module?: V, ...args: unknown[]): IImage<T, V>;
 }

package/util.js

@@ -6,34 +6,38 @@ exports.normalizePath = normalizePath;
 exports.getWebP_bin = getWebP_bin;
 exports.showInputType = showInputType;
 exports.showOutputType = showOutputType;
-const path = require("path");
-const fs = require("fs");
+const path = require("node:path");
+const fs = require("node:fs");
 const jimp = require("jimp");
-const types_1 = require("@e-mc/types");
+const types = require("@e-mc/types");
 const Image = require("@e-mc/image");
-exports.MIME_INPUT = new Set([jimp.MIME_PNG, jimp.MIME_JPEG, jimp.MIME_BMP, jimp.MIME_GIF, jimp.MIME_TIFF, "image/webp"]);
-exports.MIME_OUTPUT = new Set([jimp.MIME_PNG, jimp.MIME_JPEG, jimp.MIME_BMP, jimp.MIME_GIF, "image/webp"]);
+exports.MIME_INPUT = new Set([
+    jimp.MIME_PNG,
+    jimp.MIME_JPEG,
+    jimp.MIME_BMP,
+    jimp.MIME_GIF,
+    jimp.MIME_TIFF,
+    "image/webp"
+]);
+exports.MIME_OUTPUT = new Set([
+    jimp.MIME_PNG,
+    jimp.MIME_JPEG,
+    jimp.MIME_BMP,
+    jimp.MIME_GIF,
+    "image/webp"
+]);
 function parseFormat(command, mimeType, gif) {
     command = command.toLowerCase();
     for (let mime of exports.MIME_OUTPUT) {
         let saveAs = mime.split('/')[1];
         if (command.startsWith(saveAs)) {
-            let finalAs = '';
+            let outputAs = '';
             if (saveAs !== 'gif') {
                 switch (saveAs) {
                     case 'jpeg':
                         saveAs = 'jpg';
                         break;
                     case 'webp':
-                        if (mimeType === "image/webp") {
-                            try {
-                                require('node-webpmux');
-                                mime = "image/webp";
-                                break;
-                            }
-                            catch {
-                            }
-                        }
                         if (mimeType === jimp.MIME_JPEG) {
                             mime = jimp.MIME_JPEG;
                             saveAs = 'jpg';
@@ -42,24 +46,28 @@ function parseFormat(command, mimeType, gif) {
                             mime = jimp.MIME_GIF;
                             saveAs = 'gif';
                         }
-                        else {
+                        else if (mimeType === jimp.MIME_PNG) {
                             mime = jimp.MIME_PNG;
                             saveAs = 'png';
                         }
-                        finalAs = 'webp';
+                        else {
+                            mime = jimp.MIME_BMP;
+                            saveAs = 'bmp';
+                        }
+                        outputAs = 'webp';
                         break;
                 }
             }
             else if (!gif) {
                 break;
             }
-            return [mime, saveAs, finalAs];
+            return [mime, saveAs, outputAs];
         }
     }
     return ['', '', ''];
 }
 function renameExt(output, ext, replace) {
-    let result = (0, types_1.renameExt)(output.replace('.__copy__.', '.'), ext);
+    let result = types.renameExt(output.replace('.__copy__.', '.'), ext);
     if (!replace) {
         const pathname = result;
         let i = 0;
@@ -80,15 +88,15 @@ function getWebP_bin(name, pathname) {
     }
     return require(name + '-bin');
 }
-function showInputType(value, outputType, finalAs) {
-    if (finalAs) {
-        outputType = 'image/' + finalAs;
+function showInputType(value, outputType, outputAs) {
+    if (outputAs) {
+        outputType = 'image/' + outputAs;
     }
     return value && outputType !== value ? value.split('/').pop() + ' -> ' : '';
 }
-function showOutputType(value, outputType, finalAs) {
-    if (finalAs) {
-        outputType = 'image/' + finalAs;
+function showOutputType(value, outputType, outputAs) {
+    if (outputAs) {
+        outputType = 'image/' + outputAs;
     }
     return value !== outputType ? ' -> ' + outputType.split('/').pop() : '';
 }