wasm-image-optimization 1.1.8 → 1.2.0

package/README.md

@@ -1,23 +1,59 @@
 # wasm-image-optimization
 
+## Supported Environments
+
 - Cloudflare workers  
   `import { optimizeImage } from 'wasm-image-optimization';`
-- Next.js(Webpack)  
+- Next.js (Webpack)  
   `import { optimizeImage } from 'wasm-image-optimization/next';`
-- ESM(import base) & Deno Deploy  
-  `import { optimizeImage } from 'wasm-image-optimization/esm';`
-- CJS(file base)  
-  `import { optimizeImage } from 'wasm-image-optimization/node';`
-- Vite(Browser)  
+- ESM (import base) & Deno Deploy  
+  `import { optimizeImage } from 'wasm-image-optimization';`
+- Node.js  
+  `import { optimizeImage } from 'wasm-image-optimization';`
+- Node.js(Multi thread)  
+  `import { optimizeImage } from 'wasm-image-optimization/node-worker';`
+- Vite (Browser)  
   `import { optimizeImage } from 'wasm-image-optimization/vite';`
+- Web Worker (Browser) Multi process  
+  `import { optimizeImage } from 'wasm-image-optimization/web-worker';`
+
+## WebWorker on Vite
 
-- function
+- vite.config.ts
 
 ```ts
-// quality: 1-100
-optimizeImage({image: ArrayBuffer, width?: number, height?:number,quality?: number,format?: "png" | "jpeg" | "avif" | "webp"}): Promise<ArrayBuffer>
+import wasmImageOptimizationPlugin from "wasm-image-optimization/vite-plugin";
 
-optimizeImageExt({image: ArrayBuffer, width?: number, height?:number,quality?: number,format?: "png" | "jpeg" | "avif" | "webp"}): Promise<{data: Uint8Array;originalWidth: number;originalHeight: number; width: number;height: number;}>
+export default defineConfig(() => ({
+  plugins: [wasmImageOptimizationPlugin()],
+}));
+```
+
+## function
+
+```ts
+
+optimizeImage({
+  image: ArrayBuffer,
+  width?: number,
+  height?:number,
+  quality?: number, // quality: 1-100
+  format?: "png" | "jpeg" | "avif" | "webp"})
+    :Promise<
+      ArrayBuffer>
+
+optimizeImageExt({
+  image: ArrayBuffer,
+  width?: number,
+  height?:number,
+  quality?: number,
+  format?: "png" | "jpeg" | "avif" | "webp"})
+    :Promise<{
+      data: Uint8Array;
+      originalWidth: number;
+      originalHeight: number;
+      width: number;
+      height: number;}>
 
 ```
 
@@ -33,9 +69,53 @@ optimizeImageExt({image: ArrayBuffer, width?: number, height?:number,quality?: n
   - webp
   - avif(default)
 
-# usage
+## usage
+
+### Node.js (CLI)
+
+```ts
+import fs from "node:fs";
+import {
+  optimizeImage,
+  waitAll,
+  close,
+} from "wasm-image-optimization/node-worker";
+
+const formats = ["webp", "jpeg", "png", "avif"] as const;
+
+const main = async () => {
+  fs.mkdirSync("./image_output", { recursive: true });
+  const files = fs.readdirSync("./images");
+  for (const file of files) {
+    const image = fs.readFileSync(`./images/${file}`);
+    for (const format of formats) {
+      optimizeImage({
+        image,
+        quality: 100,
+        format,
+        width: 1000,
+      }).then((encoded) => {
+        console.log(
+          !!encoded,
+          file,
+          format,
+          encoded && `${Math.floor(encoded.length / 1024)}KB`
+        );
+        if (encoded) {
+          const fileName = file.split(".")[0];
+          fs.promises.writeFile(`image_output/${fileName}.${format}`, encoded);
+        }
+      });
+    }
+  }
+  await waitAll(); // Wait for all workers to finish before exiting the program.
+  close(); // Close all workers
+  console.log("exit");
+};
+main();
+```
 
-## Next.js image optimization with Cloudflare
+### Next.js image optimization with Cloudflare
 
 ```ts
 import { optimizeImage } from "wasm-image-optimization";
@@ -155,9 +235,9 @@ const config = {
 export default config;
 ```
 
-## Deno Deploy
+### Deno Deploy
 
-### Parameters
+#### Parameters
 
 | Name | Type   | Description |
 | ---- | ------ | ----------- |

package/dist/cjs/lib/optimizeImage.js.map

@@ -1 +1 @@
-{"version":3,"file":"optimizeImage.js","sourceRoot":"","sources":["../../../src/lib/optimizeImage.ts"],"names":[],"mappings":";;;AAUA,MAAM,MAAM,GAAG,CACb,MAAsD,EACtD,aAAyB,EACzB,EAAE;IACF,MAAM,CAAC,GAAG,MAAM;QACd,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACnD,CAAC,CAAC,SAAS,CAAC;IACd,aAAa,EAAE,CAAC;IAChB,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AACK,MAAM,cAAc,GAAG,KAAK,EAAE,EACnC,KAAK,EACL,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,OAAO,GAAG,GAAG,EACb,MAAM,GAAG,MAAM,EACf,QAAQ,GAGT,EAAE,EAAE,CACH,IAAA,yBAAiB,EAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,CACzE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CACf,CAAC;AAZS,QAAA,cAAc,kBAYvB;AAEG,MAAM,iBAAiB,GAAG,KAAK,EAAE,EACtC,KAAK,EACL,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,OAAO,GAAG,GAAG,EACb,MAAM,GAAG,MAAM,EACf,QAAQ,GAGT,EAAE,EAAE,CACH,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,CAC5C,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,CAAC,CACvE,CAAC;AAZS,QAAA,iBAAiB,qBAY1B","sourcesContent":["import { type ModuleType } from \"../esm/libImage.js\";\n\nexport type OptimizeParams = {\n  image: BufferSource | string; // The input image data\n  width?: number; // The desired output width (optional)\n  height?: number; // The desired output height (optional)\n  quality?: number; // The desired output quality (0-100, optional)\n  format?: \"jpeg\" | \"png\" | \"webp\" | \"avif\"; // The desired output format (optional)\n};\n\nconst result = (\n  result: ReturnType<ModuleType[\"optimize\"]> | undefined,\n  releaseResult: () => void\n) => {\n  const r = result\n    ? { ...result, data: Uint8Array.from(result.data) }\n    : undefined;\n  releaseResult();\n  return r;\n};\nexport const _optimizeImage = async ({\n  image,\n  width = 0,\n  height = 0,\n  quality = 100,\n  format = \"avif\",\n  libImage,\n}: OptimizeParams & {\n  libImage: Promise<ModuleType>;\n}) =>\n  _optimizeImageExt({ image, width, height, quality, format, libImage }).then(\n    (r) => r?.data\n  );\n\nexport const _optimizeImageExt = async ({\n  image,\n  width = 0,\n  height = 0,\n  quality = 100,\n  format = \"avif\",\n  libImage,\n}: OptimizeParams & {\n  libImage: Promise<ModuleType>;\n}) =>\n  libImage.then(({ optimize, releaseResult }) =>\n    result(optimize(image, width, height, quality, format), releaseResult)\n  );\n"]}
+{"version":3,"file":"optimizeImage.js","sourceRoot":"","sources":["../../../src/lib/optimizeImage.ts"],"names":[],"mappings":";;;AAUA,MAAM,MAAM,GAAG,CACb,MAAsD,EACtD,aAAyB,EACzB,EAAE;IACF,MAAM,CAAC,GAAG,MAAM;QACd,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;QACnD,CAAC,CAAC,SAAS,CAAC;IACd,aAAa,EAAE,CAAC;IAChB,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AACK,MAAM,cAAc,GAAG,KAAK,EAAE,EACnC,KAAK,EACL,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,OAAO,GAAG,GAAG,EACb,MAAM,GAAG,MAAM,EACf,QAAQ,GAGT,EAAE,EAAE,CACH,IAAA,yBAAiB,EAAC,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC,IAAI,CACzE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CACf,CAAC;AAZS,QAAA,cAAc,kBAYvB;AAEG,MAAM,iBAAiB,GAAG,KAAK,EAAE,EACtC,KAAK,EACL,KAAK,GAAG,CAAC,EACT,MAAM,GAAG,CAAC,EACV,OAAO,GAAG,GAAG,EACb,MAAM,GAAG,MAAM,EACf,QAAQ,GAGT,EAAE,EAAE,CACH,QAAQ,CAAC,IAAI,CAAC,CAAC,EAAE,QAAQ,EAAE,aAAa,EAAE,EAAE,EAAE,CAC5C,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,aAAa,CAAC,CACvE,CAAC;AAZS,QAAA,iBAAiB,qBAY1B","sourcesContent":["import { type ModuleType } from \"../esm/libImage.js\";\n\nexport type OptimizeParams = {\n  image: BufferSource | string; // The input image data\n  width?: number; // The desired output width (optional)\n  height?: number; // The desired output height (optional)\n  quality?: number; // The desired output quality (0-100, optional)\n  format?: \"jpeg\" | \"png\" | \"webp\" | \"avif\"; // The desired output format (optional)\n};\n\nconst result = (\n  result: ReturnType<ModuleType[\"optimize\"]> | undefined,\n  releaseResult: () => void,\n) => {\n  const r = result\n    ? { ...result, data: Uint8Array.from(result.data) }\n    : undefined;\n  releaseResult();\n  return r;\n};\nexport const _optimizeImage = async ({\n  image,\n  width = 0,\n  height = 0,\n  quality = 100,\n  format = \"avif\",\n  libImage,\n}: OptimizeParams & {\n  libImage: Promise<ModuleType>;\n}) =>\n  _optimizeImageExt({ image, width, height, quality, format, libImage }).then(\n    (r) => r?.data,\n  );\n\nexport const _optimizeImageExt = async ({\n  image,\n  width = 0,\n  height = 0,\n  quality = 100,\n  format = \"avif\",\n  libImage,\n}: OptimizeParams & {\n  libImage: Promise<ModuleType>;\n}) =>\n  libImage.then(({ optimize, releaseResult }) =>\n    result(optimize(image, width, height, quality, format), releaseResult),\n  );\n"]}

package/dist/{webworker/worker.d.ts → cjs/node/_node-worker.d.ts}

@@ -1,6 +1,6 @@
 declare const map: {
-    optimizeImage: (params: import("../lib/optimizeImage.js").OptimizeParams) => Promise<Uint8Array<ArrayBuffer> | undefined>;
-    optimizeImageExt: (params: import("../lib/optimizeImage.js").OptimizeParams) => Promise<{
+    optimizeImage: (params: import("../lib/optimizeImage").OptimizeParams) => Promise<Uint8Array<ArrayBuffer> | undefined>;
+    optimizeImageExt: (params: import("../lib/optimizeImage").OptimizeParams) => Promise<{
         data: Uint8Array<ArrayBuffer>;
         originalWidth: number;
         originalHeight: number;

package/dist/cjs/node/_node-worker.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_1 = require("worker-lib/node");
+const _1 = require("./");
+const map = (0, node_1.initWorker)({
+    optimizeImage: _1.optimizeImage,
+    optimizeImageExt: _1.optimizeImageExt,
+});
+//# sourceMappingURL=_node-worker.js.map

package/dist/cjs/node/_node-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"_node-worker.js","sourceRoot":"","sources":["../../../src/node/_node-worker.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAC7C,yBAAqD;AAErD,MAAM,GAAG,GAAG,IAAA,iBAAU,EAAC;IACrB,aAAa,EAAb,gBAAa;IACb,gBAAgB,EAAhB,mBAAgB;CACjB,CAAC,CAAC","sourcesContent":["import { initWorker } from \"worker-lib/node\";\nimport { optimizeImage, optimizeImageExt } from \"./\";\n\nconst map = initWorker({\n  optimizeImage,\n  optimizeImageExt,\n});\n\nexport type WorkerType = typeof map;\n"]}

package/dist/cjs/node/cjs-worker.d.ts

@@ -0,0 +1,11 @@
+import { type OptimizeParams } from "../lib/optimizeImage.js";
+declare const waitAll: () => Promise<void>, close: () => void, setLimit: (limit: number) => void;
+export declare const optimizeImage: (params: OptimizeParams) => Promise<Uint8Array<ArrayBuffer> | undefined>;
+export declare const optimizeImageExt: (params: OptimizeParams) => Promise<{
+    data: Uint8Array<ArrayBuffer>;
+    originalWidth: number;
+    originalHeight: number;
+    width: number;
+    height: number;
+} | undefined>;
+export { waitAll, close, setLimit };

package/dist/cjs/node/cjs-worker.js

@@ -0,0 +1,21 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setLimit = exports.close = exports.waitAll = exports.optimizeImageExt = exports.optimizeImage = void 0;
+const node_path_1 = __importDefault(require("node:path"));
+const node_worker_threads_1 = require("node:worker_threads");
+const node_1 = require("worker-lib/node");
+const { execute, waitAll, close, setLimit } = (0, node_1.createWorker)(() => {
+    const url = node_path_1.default.resolve(__dirname, "./node-worker.js");
+    return new node_worker_threads_1.Worker(url);
+});
+exports.waitAll = waitAll;
+exports.close = close;
+exports.setLimit = setLimit;
+const optimizeImage = async (params) => execute("optimizeImage", params);
+exports.optimizeImage = optimizeImage;
+const optimizeImageExt = async (params) => execute("optimizeImageExt", params);
+exports.optimizeImageExt = optimizeImageExt;
+//# sourceMappingURL=cjs-worker.js.map

package/dist/cjs/node/cjs-worker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cjs-worker.js","sourceRoot":"","sources":["../../../src/node/cjs-worker.ts"],"names":[],"mappings":";;;;;;AAAA,0DAA6B;AAC7B,6DAA6C;AAC7C,0CAA+C;AAQ/C,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,GAAG,IAAA,mBAAY,EAAa,GAAG,EAAE;IAC1E,MAAM,GAAG,GAAG,mBAAI,CAAC,OAAO,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAAC;IACxD,OAAO,IAAI,4BAAM,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC,CAAC,CAAC;AAQM,0BAAO;AAAE,sBAAK;AAAE,4BAAQ;AAN1B,MAAM,aAAa,GAAG,KAAK,EAAE,MAAsB,EAAE,EAAE,CAC5D,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;AADtB,QAAA,aAAa,iBACS;AAE5B,MAAM,gBAAgB,GAAG,KAAK,EAAE,MAAsB,EAAE,EAAE,CAC/D,OAAO,CAAC,kBAAkB,EAAE,MAAM,CAAC,CAAC;AADzB,QAAA,gBAAgB,oBACS","sourcesContent":["import path from \"node:path\";\nimport { Worker } from \"node:worker_threads\";\nimport { createWorker } from \"worker-lib/node\";\nimport {\n  _optimizeImage,\n  _optimizeImageExt,\n  type OptimizeParams,\n} from \"../lib/optimizeImage.js\";\nimport type { WorkerType } from \"./_node-worker.js\";\n\nconst { execute, waitAll, close, setLimit } = createWorker<WorkerType>(() => {\n  const url = path.resolve(__dirname, \"./node-worker.js\");\n  return new Worker(url);\n});\n\nexport const optimizeImage = async (params: OptimizeParams) =>\n  execute(\"optimizeImage\", params);\n\nexport const optimizeImageExt = async (params: OptimizeParams) =>\n  execute(\"optimizeImageExt\", params);\n\nexport { waitAll, close, setLimit };\n"]}

package/dist/cjs/node/index.js

@@ -8,7 +8,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 /* @ts-ignore */
-const libImage_js_1 = __importDefault(require("../../workers/libImage.js"));
+const libImage_js_1 = __importDefault(require("../../cjs/libImage.js"));
 const optimizeImage_js_1 = require("../lib/optimizeImage.js");
 const libImage = (0, libImage_js_1.default)({
     wasmBinary: fs_1.default.readFileSync(path_1.default.resolve(__dirname, "../../esm/libImage.wasm")),

package/dist/cjs/node/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,6DAA6D;AAC7D,gBAAgB;AAChB,4EAAiD;AACjD,8DAIiC;AAEjC,MAAM,QAAQ,GAAG,IAAA,qBAAQ,EAAC;IACxB,UAAU,EAAE,YAAE,CAAC,YAAY,CACzB,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,yBAAyB,CAAC,CAC1C;CACX,CAAC,CAAC;AAEI,MAAM,aAAa,GAAG,KAAK,EAAE,MAAsB,EAAE,EAAE,CAC5D,IAAA,iCAAc,EAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAD7B,QAAA,aAAa,iBACgB;AAEnC,MAAM,gBAAgB,GAAG,KAAK,EAAE,MAAsB,EAAE,EAAE,CAC/D,IAAA,oCAAiB,EAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AADhC,QAAA,gBAAgB,oBACgB","sourcesContent":["import fs from \"fs\";\nimport path from \"path\";\n\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n/* @ts-ignore */\nimport LibImage from \"../../workers/libImage.js\";\nimport {\n  _optimizeImage,\n  _optimizeImageExt,\n  type OptimizeParams,\n} from \"../lib/optimizeImage.js\";\n\nconst libImage = LibImage({\n  wasmBinary: fs.readFileSync(\n    path.resolve(__dirname, \"../../esm/libImage.wasm\")\n  ) as never,\n});\n\nexport const optimizeImage = async (params: OptimizeParams) =>\n  _optimizeImage({ ...params, libImage });\n\nexport const optimizeImageExt = async (params: OptimizeParams) =>\n  _optimizeImageExt({ ...params, libImage });\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/node/index.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AAExB,6DAA6D;AAC7D,gBAAgB;AAChB,wEAA6C;AAC7C,8DAIiC;AAEjC,MAAM,QAAQ,GAAG,IAAA,qBAAQ,EAAC;IACxB,UAAU,EAAE,YAAE,CAAC,YAAY,CACzB,cAAI,CAAC,OAAO,CAAC,SAAS,EAAE,yBAAyB,CAAC,CAC1C;CACX,CAAC,CAAC;AAEI,MAAM,aAAa,GAAG,KAAK,EAAE,MAAsB,EAAE,EAAE,CAC5D,IAAA,iCAAc,EAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AAD7B,QAAA,aAAa,iBACgB;AAEnC,MAAM,gBAAgB,GAAG,KAAK,EAAE,MAAsB,EAAE,EAAE,CAC/D,IAAA,oCAAiB,EAAC,EAAE,GAAG,MAAM,EAAE,QAAQ,EAAE,CAAC,CAAC;AADhC,QAAA,gBAAgB,oBACgB","sourcesContent":["import fs from \"fs\";\nimport path from \"path\";\n\n// eslint-disable-next-line @typescript-eslint/ban-ts-comment\n/* @ts-ignore */\nimport LibImage from \"../../cjs/libImage.js\";\nimport {\n  _optimizeImage,\n  _optimizeImageExt,\n  type OptimizeParams,\n} from \"../lib/optimizeImage.js\";\n\nconst libImage = LibImage({\n  wasmBinary: fs.readFileSync(\n    path.resolve(__dirname, \"../../esm/libImage.wasm\")\n  ) as never,\n});\n\nexport const optimizeImage = async (params: OptimizeParams) =>\n  _optimizeImage({ ...params, libImage });\n\nexport const optimizeImageExt = async (params: OptimizeParams) =>\n  _optimizeImageExt({ ...params, libImage });\n"]}