@lesjoursfr/gifsicle-wrapper 6.0.0 → 6.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@lesjoursfr/gifsicle-wrapper",
-	"version": "6.0.0",
+	"version": "6.0.1",
 	"description": "Wrapper for Gifsicle",
 	"license": "MIT",
 	"repository": {
@@ -17,14 +17,19 @@
 	"engines": {
 		"node": "22.x || 24.x"
 	},
-	"exports": "./lib/index.js",
-	"types": "./lib/index.d.ts",
-	"files": [
-		"install/**/*",
-		"vendor/v1.96/source/gifsicle.tar.gz",
-		"lib/**/*",
-		"src/**/*"
+	"keywords": [
+		"gif",
+		"gifsicle",
+		"image",
+		"img",
+		"compress",
+		"resize",
+		"minify",
+		"optimize"
 	],
+	"main": "./lib/index.js",
+	"types": "./lib/index.d.ts",
+	"type": "module",
 	"scripts": {
 		"freshlock": "rm -rf node_modules/ && rm .yarn/install-state.gz && rm yarn.lock && yarn",
 		"postinstall": "node install/install.js",
@@ -37,19 +42,8 @@
 		"build": "tsc",
 		"test": "NODE_OPTIONS='--loader=ts-node/esm' mocha"
 	},
-	"keywords": [
-		"gif",
-		"gifsicle",
-		"image",
-		"img",
-		"compress",
-		"resize",
-		"minify",
-		"optimize"
-	],
-	"type": "module",
 	"dependencies": {
-		"@lesjoursfr/bin-wrapper": "^13.1.0",
+		"@lesjoursfr/bin-wrapper": "^13.1.1",
 		"execa": "^9.6.1",
 		"image-size": "^2.0.2",
 		"tar": "^7.5.13",
@@ -60,14 +54,14 @@
 		"@tsconfig/node22": "22.0.5",
 		"@types/mocha": "10.0.10",
 		"@types/node": "24.12.2",
-		"eslint": "10.2.0",
+		"eslint": "10.2.1",
 		"eslint-config-prettier": "10.1.8",
 		"globals": "17.5.0",
 		"mocha": "11.7.5",
 		"prettier": "3.8.3",
 		"ts-node": "10.9.2",
-		"typescript": "6.0.2",
-		"typescript-eslint": "8.58.2"
+		"typescript": "6.0.3",
+		"typescript-eslint": "8.59.0"
 	},
 	"packageManager": "yarn@4.14.1"
 }

package/src/core/color.ts

@@ -1,28 +0,0 @@
-import { Gifsicle } from "../gifsicle.js";
-
-/**
- * Convert to 8-bit greyscale.
- *
- * @param {Boolean} [greyscale=true]
- * @returns {Gifsicle}
- * @throws {TypeError} Invalid parameters
- */
-export function greyscale(this: Gifsicle, greyscale: boolean | undefined): Gifsicle {
-  if (greyscale !== undefined) {
-    this.options.greyscale = greyscale;
-  } else {
-    this.options.greyscale = true;
-  }
-  return this;
-}
-
-/**
- * Alternative spelling of `greyscale`.
- *
- * @param {Boolean} [grayscale=true]
- * @returns {Gifsicle}
- * @throws {TypeError} Invalid parameters
- */
-export function grayscale(this: Gifsicle, grayscale: boolean | undefined) {
-  return this.greyscale(grayscale);
-}

package/src/core/input.ts

@@ -1,14 +0,0 @@
-import { readFileSync } from "fs";
-import { isGif } from "../toolbox/is-gif.js";
-
-export function readFile(input: string | Buffer): Buffer {
-  if (typeof input === "string") {
-    input = readFileSync(input);
-  }
-
-  if (!isGif(input)) {
-    throw new TypeError("Expected 'input' to be a gif file");
-  }
-
-  return input;
-}

package/src/core/optimize.ts

@@ -1,49 +0,0 @@
-import { Gifsicle } from "../gifsicle.js";
-
-/**
- * Optimization levels.
- */
-export enum OptimizationLevel {
-  O1 = "O1",
-  O2 = "O2",
-  O3 = "O3",
-}
-
-/**
- * Optimization options.
- */
-export type OptimizeOptions = {
-  level?: OptimizationLevel;
-  lossiness?: number;
-};
-
-/**
- * Optimize the gif.
- *
- * @param {Object} [options]
- * @param {OptimizationLevel} [options.level=OptimizationLevel.O1] - the optimization level.
- * @param {Number} [options.lossiness=20] - the lossiness value to shrink the number of colors [0,200].
- * @returns {Gifsicle}
- * @throws {TypeError} Invalid parameters
- */
-export function optimize(this: Gifsicle, options: OptimizeOptions | undefined): Gifsicle {
-  // Default options
-  this.options.optimize = { level: OptimizationLevel.O1, lossiness: 20 };
-
-  // Process parameters
-  if (options !== undefined) {
-    // Level
-    if (options.level !== undefined) {
-      this.options.optimize.level = options.level;
-    }
-    // Lossiness
-    if (options.lossiness !== undefined) {
-      if (Number.isInteger(options.lossiness) && options.lossiness > 0 && options.lossiness < 200) {
-        this.options.optimize.lossiness = options.lossiness;
-      } else {
-        throw new TypeError("Expected 'lossiness' to be an integer in the range [0,200]");
-      }
-    }
-  }
-  return this;
-}

package/src/core/output.ts

@@ -1,63 +0,0 @@
-import { execa } from "execa";
-import { writeFileSync } from "fs";
-import { Gifsicle, GifsicleInternalOptions } from "../gifsicle.js";
-import { gifsicleWrapper } from "../wrapper.js";
-import { computeCroppingPoint } from "./resize.js";
-
-async function processFile(input: Buffer, options: GifsicleInternalOptions) {
-  const args = ["--no-warnings", "--no-app-extensions"];
-
-  if (options.greyscale === true) {
-    args.push("--use-colormap=gray");
-  }
-
-  if (options.crop !== undefined) {
-    const { x, y } = computeCroppingPoint(input, options.crop);
-    args.push(`--crop=${x}, ${y}+${options.crop.width}x${options.crop.height}`);
-  }
-
-  if (options.resize !== undefined) {
-    if (options.resize.width !== undefined || options.resize.height !== undefined) {
-      if (options.resize.withoutEnlargement === true) {
-        args.push(`--resize-fit=${options.resize.width || "_"}x${options.resize.height || "_"}`);
-      } else {
-        args.push(`--resize-touch=${options.resize.width || "_"}x${options.resize.height || "_"}`);
-      }
-    }
-  }
-
-  if (options.optimize !== undefined) {
-    if (options.optimize.level !== undefined) {
-      args.push(`-${options.optimize.level}`);
-    }
-    if (options.optimize.lossiness !== undefined) {
-      args.push(`--lossy=${options.optimize.lossiness}`);
-    }
-  }
-
-  const { stdout } = await execa(gifsicleWrapper.path, args, {
-    encoding: "buffer",
-    maxBuffer: Infinity,
-    input,
-  });
-
-  return stdout;
-}
-
-/**
- * Save the result in a file.
- *
- * @param {String} [fileOut]
- */
-export async function toFile(this: Gifsicle, fileOut: string): Promise<void> {
-  writeFileSync(fileOut, await processFile(this.input, this.options));
-}
-
-/**
- * Get the result file as a Buffer.
- *
- * @returns {Uint8Array}
- */
-export async function toBuffer(this: Gifsicle): Promise<Uint8Array> {
-  return processFile(this.input, this.options);
-}

package/src/core/resize.ts

@@ -1,178 +0,0 @@
-import { imageSize } from "image-size";
-import { Gifsicle } from "../gifsicle.js";
-
-/**
- * Reduction kernels.
- */
-export enum ReductionKernel {
-  sample = "sample",
-  mix = "mix",
-  catrom = "catrom",
-  mitchell = "mitchell",
-  lanczos2 = "lanczos2",
-  lanczos3 = "lanczos3",
-}
-
-/**
- * Position modes for cropping.
- */
-export enum CroppingPosition {
-  center = "center",
-  top = "top",
-  right = "right",
-  bottom = "bottom",
-  left = "left",
-  topRight = "topRight",
-  bottomRight = "bottomRight",
-  bottomLeft = "bottomLeft",
-  topLeft = "topLeft",
-}
-
-/**
- * Resize options.
- */
-export type ResizeOptions = {
-  kernel: ReductionKernel | undefined;
-  withoutEnlargement: boolean | undefined;
-};
-
-/**
- * Cropping options.
- */
-export type CroppingOptions = {
-  position: CroppingPosition | undefined;
-};
-
-/**
- * Resize image to `width`, `height` or `width x height`.
- *
- * @param {Number} [width] - pixels wide the resultant image should be. Use `null` or `undefined` to auto-scale the width to match the height.
- * @param {Number} [height] - pixels high the resultant image should be. Use `null` or `undefined` to auto-scale the height to match the width.
- * @param {Object} [options]
- * @param {ReductionKernel} [options.kernel=ReductionKernel.lanczos3] - the kernel to use for image reduction.
- * @param {Boolean} [options.withoutEnlargement=false] - do not enlarge if the width *or* height are already less than the specified dimensions, equivalent to GraphicsMagick's `>` geometry option. *
- * @returns {Gifsicle}
- * @throws {TypeError} Invalid parameters
- */
-export function resize(
-  this: Gifsicle,
-  width: number | undefined,
-  height: number | undefined,
-  options: ResizeOptions | undefined
-): Gifsicle {
-  // Default options
-  this.options.resize = { kernel: ReductionKernel.lanczos3, withoutEnlargement: false };
-
-  // Process parameters
-  if (width !== undefined) {
-    if (Number.isInteger(width) && width > 0) {
-      this.options.resize.width = width;
-    } else {
-      throw new TypeError("Expected 'width' to be a positive integer");
-    }
-  }
-  if (height !== undefined) {
-    if (Number.isInteger(height) && height > 0) {
-      this.options.resize.height = height;
-    } else {
-      throw new TypeError("Expected 'height' to be a positive integer");
-    }
-  }
-  if (options !== undefined) {
-    // Kernel
-    if (options.kernel !== undefined) {
-      this.options.resize.kernel = options.kernel;
-    }
-    // Without enlargement
-    if (options.withoutEnlargement !== undefined) {
-      this.options.resize.withoutEnlargement = options.withoutEnlargement;
-    }
-  }
-  return this;
-}
-
-/**
- * Crop the image to `width x height`.
- *
- * @param {number} [width] - pixels wide the resultant image should be.
- * @param {number} [height] - pixels high the resultant image should be.
- * @param {Object} [options]
- * @param {CroppingPosition} [options.position=CroppingPosition.center] - position of the cropping rectangle.
- * @returns {Gifsicle}
- * @throws {TypeError} Invalid parameters
- */
-export function crop(this: Gifsicle, width: number, height: number, options: CroppingOptions | undefined): Gifsicle {
-  // Default options
-  this.options.crop = { width: 0, height: 0, position: CroppingPosition.center };
-
-  // Process parameters
-  if (Number.isInteger(width) && width > 0) {
-    this.options.crop.width = width;
-  } else {
-    throw new TypeError("Expected 'width' to be a positive integer");
-  }
-  if (Number.isInteger(height) && height > 0) {
-    this.options.crop.height = height;
-  } else {
-    throw new TypeError("Expected 'height' to be a positive integer");
-  }
-  if (options !== undefined) {
-    // Position
-    if (options.position !== undefined) {
-      this.options.crop.position = options.position;
-    }
-  }
-  return this;
-}
-
-export function computeCroppingPoint(
-  input: Buffer,
-  crop: { width: number; height: number; position: CroppingPosition }
-): { x: number; y: number } {
-  const size = imageSize(input);
-  if (size.width === undefined || size.height === undefined) {
-    throw new Error("Can't compute the image size");
-  }
-
-  let px = 0;
-  let py = 0;
-  switch (crop.position) {
-    case CroppingPosition.center:
-      px = Math.floor((size.width - crop.width) / 2);
-      py = Math.floor((size.height - crop.height) / 2);
-      break;
-    case CroppingPosition.top:
-      px = Math.floor((size.width - crop.width) / 2);
-      py = 0;
-      break;
-    case CroppingPosition.right:
-      px = size.width - crop.width;
-      py = Math.floor((size.height - crop.height) / 2);
-      break;
-    case CroppingPosition.bottom:
-      px = Math.floor((size.width - crop.width) / 2);
-      py = size.height - crop.height;
-      break;
-    case CroppingPosition.left:
-      px = 0;
-      py = Math.floor((size.height - crop.height) / 2);
-      break;
-    case CroppingPosition.topRight:
-      px = size.width - crop.width;
-      py = 0;
-      break;
-    case CroppingPosition.bottomRight:
-      px = size.width - crop.width;
-      py = size.height - crop.height;
-      break;
-    case CroppingPosition.bottomLeft:
-      px = 0;
-      py = size.height - crop.height;
-      break;
-    case CroppingPosition.topLeft:
-      px = 0;
-      py = 0;
-      break;
-  }
-  return { x: px, y: py };
-}

package/src/gifsicle.ts

@@ -1,33 +0,0 @@
-import { grayscale, greyscale } from "./core/color.js";
-import { readFile } from "./core/input.js";
-import { OptimizeOptions, optimize } from "./core/optimize.js";
-import { toBuffer, toFile } from "./core/output.js";
-import { CroppingPosition, ReductionKernel, crop, resize } from "./core/resize.js";
-
-export interface GifsicleInternalOptions {
-  greyscale?: boolean;
-  resize?: { width?: number; height?: number; kernel: ReductionKernel; withoutEnlargement: boolean };
-  crop?: { width: number; height: number; position: CroppingPosition };
-  optimize?: OptimizeOptions;
-}
-
-/**
- * Export Gifsicle class.
- */
-export class Gifsicle {
-  options: GifsicleInternalOptions;
-  input: Buffer;
-
-  constructor(input: string | Buffer) {
-    this.input = readFile(input);
-    this.options = {};
-  }
-
-  public greyscale = greyscale;
-  public grayscale = grayscale;
-  public resize = resize;
-  public crop = crop;
-  public optimize = optimize;
-  public toFile = toFile;
-  public toBuffer = toBuffer;
-}

package/src/index.ts

@@ -1,13 +0,0 @@
-import { OptimizationLevel } from "./core/optimize.js";
-import { CroppingPosition, ReductionKernel } from "./core/resize.js";
-import { Gifsicle } from "./gifsicle.js";
-
-function gifsicle(input: string | Buffer): Gifsicle {
-  return new Gifsicle(input);
-}
-
-gifsicle.kernel = ReductionKernel;
-gifsicle.position = CroppingPosition;
-gifsicle.level = OptimizationLevel;
-
-export default gifsicle;

package/src/install.ts

@@ -1,51 +0,0 @@
-import { execa } from "execa";
-import { mkdir, rm } from "fs/promises";
-import process from "process";
-import { x as extract } from "tar";
-import { temporaryFile } from "tempy";
-import { gifsicleSourcePath, gifsicleWrapper } from "./wrapper.js";
-
-async function buildFromSource(file: string, cmd: Array<string>): Promise<void> {
-  const temporary = temporaryFile();
-  console.log(`use the temporary folder : ${temporary}`);
-  await mkdir(temporary, { recursive: true });
-
-  await extract({ file: file, cwd: temporary, strip: 1 });
-
-  for (const x of cmd) {
-    await execa(x, { cwd: temporary, shell: true, encoding: "utf8" });
-  }
-
-  await rm(temporary, { recursive: true });
-}
-
-(async () => {
-  try {
-    await gifsicleWrapper.run(["--version"]);
-    console.log("gifsicle pre-build test passed successfully");
-  } catch (error) {
-    if (error instanceof Error) {
-      console.warn(error.message);
-    }
-    console.warn("gifsicle pre-build test failed");
-    console.info("compiling from source");
-
-    try {
-      const source = gifsicleSourcePath;
-      const destination = gifsicleWrapper.dest;
-      await buildFromSource(source, [
-        "autoreconf -ivf",
-        `./configure --disable-gifview --disable-gifdiff --prefix="${destination}" --bindir="${destination}"`,
-        "make install",
-      ]);
-
-      console.log("gifsicle built successfully");
-    } catch (error) {
-      if (error instanceof Error) {
-        console.error(error.stack);
-      }
-
-      process.exit(1);
-    }
-  }
-})();

package/src/toolbox/is-gif.ts

@@ -1,9 +0,0 @@
-// Based on isGif function from https://github.com/sindresorhus/is-gif
-// https://github.com/sindresorhus/is-gif/blob/main/index.js
-export function isGif(buffer: Buffer) {
-  if (!buffer || buffer.length < 3) {
-    return false;
-  }
-
-  return buffer[0] === 0x47 && buffer[1] === 0x49 && buffer[2] === 0x46;
-}

package/src/wrapper.ts

@@ -1,16 +0,0 @@
-import BinWrapper from "@lesjoursfr/bin-wrapper";
-import { platform } from "process";
-import { fileURLToPath } from "url";
-
-const version = "1.96";
-const base = `https://raw.githubusercontent.com/lesjoursfr/gifsicle-wrapper/main/vendor/v${version}`;
-
-export const gifsicleWrapper = new BinWrapper({ strip: 0 });
-gifsicleWrapper.addSrc(`${base}/linux/x64/gifsicle.tar.gz`, "linux", "x64");
-gifsicleWrapper.setDest(fileURLToPath(new URL("../vendor", import.meta.url)));
-gifsicleWrapper.setUse(platform === "win32" ? "gifsicle.exe" : "gifsicle");
-gifsicleWrapper.setVersion(`>=${version}`);
-
-export const gifsicleSourcePath = fileURLToPath(
-  new URL(`../vendor/v${version}/source/gifsicle.tar.gz`, import.meta.url)
-);