@kaviyarasan022/image-compressor-target 1.0.1

package/bin/cli.js

@@ -0,0 +1,92 @@
+#!/usr/bin/env node
+const yargs = require("yargs/yargs");
+const { hideBin } = require("yargs/helpers");
+const path = require("path");
+const fs = require("fs");
+const axios = require("axios");
+const os = require("os");
+const { compressToTarget } = require("../lib/compressor");
+
+/**
+ * Download image from a URL to a temporary local file
+ * @param {string} url - direct image URL
+ * @returns {Promise<string>} - path to downloaded temp file
+ */
+async function downloadImage(url) {
+  const tmpPath = path.join(os.tmpdir(), "img_compress_temp_" + Date.now() + path.extname(url.split("?")[0]));
+  const writer = fs.createWriteStream(tmpPath);
+  const response = await axios({
+    url,
+    method: "GET",
+    responseType: "stream",
+  });
+
+  response.data.pipe(writer);
+
+  return new Promise((resolve, reject) => {
+    writer.on("finish", () => resolve(tmpPath));
+    writer.on("error", reject);
+  });
+}
+
+(async () => {
+  const argv = yargs(hideBin(process.argv))
+    .usage("Usage: node bin/cli.js <input> --target 300kb --out output.jpg")
+    .demandCommand(1, "Please provide an image path or URL")
+    .option("target", {
+      alias: "t",
+      type: "string",
+      describe: "Target file size (e.g., 300kb, 1mb)",
+      demandOption: true,
+    })
+    .option("out", {
+      alias: "o",
+      type: "string",
+      describe: "Output file path (default: input_compressed.jpg)",
+    })
+    .help()
+    .argv;
+
+  let inputPath = argv._[0];
+  let tempDownloaded = false;
+
+  const isURL = /^https?:\/\//i.test(inputPath);
+  if (isURL) {
+    console.log("🌐 Downloading image from URL...");
+    inputPath = await downloadImage(inputPath);
+    tempDownloaded = true;
+  } else {
+    // Check local file exists
+    if (!fs.existsSync(inputPath)) {
+      console.error("❌ Input file not found:", inputPath);
+      process.exit(1);
+    }
+  }
+
+  const outputPath =
+    argv.out ||
+    path.join(
+      path.dirname(inputPath),
+      path.basename(inputPath, path.extname(inputPath)) + "_compressed" + path.extname(inputPath)
+    );
+
+  // ✅ Ensure output folder exists
+  const outputFolder = path.dirname(outputPath);
+  if (!fs.existsSync(outputFolder)) {
+    fs.mkdirSync(outputFolder, { recursive: true });
+  }
+
+  console.log(`🧠 Compressing ${inputPath} to around ${argv.target}...`);
+  try {
+    const result = await compressToTarget(inputPath, outputPath, argv.target);
+    console.log(`✅ Done! Final size: ${result.finalSizeKB} KB`);
+    console.log(`📁 Saved to: ${outputPath}`);
+  } catch (e) {
+    console.error("❌ Compression failed:", e.message);
+  } finally {
+    // Clean up temp file if downloaded
+    if (tempDownloaded && fs.existsSync(inputPath)) {
+      fs.unlinkSync(inputPath);
+    }
+  }
+})();

package/examples/example.js

@@ -0,0 +1,6 @@
+const { compressToTarget } = require("../lib/compressor");
+
+(async () => {
+  const result = await compressToTarget("./images/test.jpg", "./images/test_small.jpg", "300kb");
+  console.log(result);
+})();

package/index.js

@@ -0,0 +1,34 @@
+
+
+const { compressToTarget } = require("./lib/compressor");
+
+/**
+
+ * 
+ * @param {string} inputPath - Path to input image file (jpg/png/webp)
+ * @param {string} outputPath - Path where compressed image will be saved
+ * @param {string|number} targetSize - e.g. "300kb", "1mb", or bytes number
+ * @returns {Promise<object>} - compression result info
+ * 
+ * Example:
+ *  const { compressToTarget } = require("image-compressor-target");
+ *  await compressToTarget("photo.jpg", "photo_small.jpg", "300kb");
+ */
+module.exports = { compressToTarget };
+
+// If executed directly (like `node index.js`), show quick usage help
+if (require.main === module) {
+  console.log(`
+🖼️  Image Compressor CLI
+=============================
+Usage:
+  node index.js <input> --target 300kb --out output.jpg
+
+Or after linking:
+  img-compress ./photo.jpg --target 300kb --out photo_small.jpg
+
+You can also import in JS:
+  const { compressToTarget } = require('image-compressor-target');
+  await compressToTarget('photo.jpg', 'photo_small.jpg', '300kb');
+`);
+}

package/lib/compressor.js

@@ -0,0 +1,50 @@
+const fs = require("fs").promises;
+const sharp = require("sharp");
+
+function parseSize(sizeStr) {
+  if (typeof sizeStr === "number") return sizeStr;
+
+  const s = String(sizeStr).trim().toLowerCase().replace(/\s+/g, "");
+  const match = s.match(/^(\d+(?:\.\d+)?)(b|kb|mb)?$/);
+  if (!match) throw new Error("Invalid size format. Use e.g. 300kb, 0.3mb, or 50000.");
+
+  const value = parseFloat(match[1]);
+  const unit = match[2] || "b";
+
+  if (unit === "b") return Math.round(value);
+  if (unit === "kb") return Math.round(value * 1024);
+  if (unit === "mb") return Math.round(value * 1024 * 1024);
+
+  return Math.round(value);
+}
+
+async function compressToTarget(inputPath, outputPath, targetSizeStr) {
+  const targetBytes = parseSize(targetSizeStr);
+  const inputBuffer = await fs.readFile(inputPath);
+  let quality = 90;
+  let buffer = inputBuffer;
+
+  for (let i = 0; i < 10; i++) {
+    const { data } = await sharp(buffer)
+      .jpeg({ quality })
+      .toBuffer({ resolveWithObject: true });
+
+    if (data.length <= targetBytes || quality < 30) {
+      await fs.writeFile(outputPath, data);
+      return {
+        success: true,
+        finalSizeKB: (data.length / 1024).toFixed(2),
+        quality,
+      };
+    }
+
+    quality -= 10;
+    buffer = data;
+  }
+
+  throw new Error(
+    "Could not reach target size. Try a larger target or smaller image."
+  );
+}
+
+module.exports = { compressToTarget };

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@kaviyarasan022/image-compressor-target",
+  "version": "1.0.1",
+  "description": "A Node.js CLI tool to compress images to a target size.",
+  "main": "index.js",
+  "bin": {
+    "image-compressor": "./bin/cli.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["image", "compressor", "cli", "tool", "image-optimization"],
+  "author": "Kaviyarasan M",
+  "license": "MIT",
+  "dependencies": {
+    "axios": "^1.12.2"
+  }
+}