pixeli 0.1.9 → 1.0.3

package/commands/merge/collage.js

@@ -1,83 +0,0 @@
-import { Command } from 'commander';
-import chalk from 'chalk';
-import {
-  cliConfirm,
-  displayInfoMessage,
-  displaySuccessMessage,
-  displayWarningMessage,
-  handleError,
-  writeImage,
-} from '../../lib/helpers/utils.js';
-import { validateCollageOptions, validateSharedOptions } from './helpers/validations.js';
-import { loadImages } from '../../lib/helpers/loadImages.js';
-import { addSharedOptions } from './helpers/utils.js';
-import { validateTemplate } from '../../lib/helpers/templateValidator.js';
-import { collageMerge } from '../../lib/merges/collage-merge/index.js';
-
-const collageCommand = new Command('collage');
-
-collageCommand
-  .description('Use JSON layouts to build custom collages.')
-  .option('-t, --template <path>', 'The path to the JSON file describing the collage template', null)
-  .option('-m, --mapping <json>', 'Inline JSON template override straight from the command line', null)
-  .option('-p, --preset <preset-id>', 'Collage preset ID to use. Available collage IDs: ', null)
-  .action(async (files, opts) => {
-    await main(files, opts);
-  });
-
-const main = async (files, opts) => {
-  // Collect and validate parameters
-  try {
-    const params = { files, ...opts };
-    const sharedOptions = await validateSharedOptions(params);
-    const collageOptions = await validateCollageOptions(opts);
-    const validatedParams = { ...sharedOptions, ...collageOptions };
-
-    // Load images, create collage, and write on disk
-    await generateAndSaveCollage(validatedParams);
-
-    // Output success message
-  } catch (e) {
-    handleError(e);
-  }
-};
-
-const generateAndSaveCollage = async (validatedParams) => {
-  // Replace gap and background if not provided with command line values
-  if (validatedParams.template?.canvas?.gap === undefined) {
-    validatedParams.template.canvas.gap = validatedParams.gap;
-  }
-  if (validatedParams.template?.canvas?.background === undefined) {
-    validatedParams.template.canvas.background = validatedParams.canvasColor;
-  }
-
-  // Validate the template and update it
-  const validatedTemplate = validateTemplate(validatedParams.template);
-  validatedParams.template = validatedTemplate;
-
-  // Load images from file
-  const { images, ignoredFiles } = await loadImages({ ...validatedParams, count: validatedParams.template.slots.length });
-
-  // Display warnings if needed
-  if (ignoredFiles.length) {
-    displayWarningMessage('\nThese files will be ignored due to unsupported formats:');
-    for (const file of ignoredFiles) {
-      displayInfoMessage(file);
-    }
-
-    const confirmation = await cliConfirm('\nAre you sure you want to continue?');
-    if (!confirmation) return;
-  }
-
-  const collage = await collageMerge(images, validatedParams);
-
-  const success = await writeImage(collage, validatedParams.output);
-
-  // Display success message
-  if (success) {
-    displaySuccessMessage(`\nImage has been created successfully: ${chalk.bold(validatedParams.output)}\n`);
-  }
-};
-
-addSharedOptions(collageCommand);
-export default collageCommand;

package/commands/merge/grid.js

@@ -1,71 +0,0 @@
-import { Command } from 'commander';
-import chalk from 'chalk';
-import {
-  cliConfirm,
-  displayInfoMessage,
-  displaySuccessMessage,
-  displayWarningMessage,
-  handleError,
-  writeImage,
-} from '../../lib/helpers/utils.js';
-import { addSharedOptions } from './helpers/utils.js';
-import { validateGridOptions, validateSharedOptions } from './helpers/validations.js';
-import { loadImages } from '../../lib/helpers/loadImages.js';
-import { gridMerge } from '../../lib/merges/grid-merge/index.js';
-
-const gridCommand = new Command('grid');
-
-gridCommand
-  .description('Arranges images in an organized grid.')
-  .option('--ar, --aspect-ratio <width/height|number>', 'The aspect ratio of all the images (examples: 16/9, 4:3, 1.777)', '1:1')
-  .option('-w, --image-width <px>', 'The width of each image, defaults to the smallest image', null)
-  .option('-c, --columns <n>', 'The number of columns', 4)
-  .option('--ca, --caption', 'Whether to caption each image', false)
-  .option('--cc, --caption-color <hex>', 'Image Caption color', '#000000')
-  .option('--mcs, --max-caption-size <pt>', 'The maximum allowed caption size', 100)
-  .action(async (files, opts) => {
-    await main(files, opts);
-  });
-
-const main = async (files, opts) => {
-  // Collect and validate parameters
-  try {
-    const params = { files, ...opts };
-    const sharedOptions = await validateSharedOptions(params);
-    const gridOptions = validateGridOptions(sharedOptions, params);
-    const validatedParams = { ...sharedOptions, ...gridOptions };
-
-    // Load images, create grid, and write grid on disk
-    await generateAndSaveGrid(validatedParams);
-
-    // Output success message
-  } catch (e) {
-    handleError(e);
-  }
-};
-
-const generateAndSaveGrid = async (validatedParams) => {
-  const { files, images, ignoredFiles } = await loadImages(validatedParams);
-
-  // Display warnings if needed
-  if (ignoredFiles.length) {
-    displayWarningMessage('\nThese files will be ignored due to unsupported formats:');
-    for (const file of ignoredFiles) {
-      displayInfoMessage(file);
-    }
-
-    const confirmation = await cliConfirm('\nAre you sure you want to continue?');
-    if (!confirmation) return;
-  }
-
-  const grid = await gridMerge(files, images, validatedParams);
-  const success = await writeImage(grid, validatedParams.output);
-
-  // Display success message
-  if (success) {
-    displaySuccessMessage(`\nImage has been created successfully: ${chalk.bold(validatedParams.output)}\n`);
-  }
-};
-
-addSharedOptions(gridCommand);
-export default gridCommand;

package/commands/merge/helpers/utils.js

@@ -1,11 +0,0 @@
-export const addSharedOptions = (cmd) => {
-  return cmd
-    .argument('[files...]', 'Image filepaths to merge (use --dir for directories)')
-    .option('-d, --dir <path>', 'Directory of images to merge')
-    .option('-r, --recursive', 'Recursively include subdirectories', false)
-    .option('--sh, --shuffle', 'Shuffle up images to randomize order in the grid', false)
-    .option('--cr, --corner-radius <px>', 'How much to round the corners of each image', 0)
-    .option('-g, --gap <px>', 'Gap between images', 50)
-    .option('--bg, --canvas-color <hex|transparent>', 'Background color for canvas', '#ffffff')
-    .option('-o, --output <file>', 'Output file path', './pixeli.png');
-};

package/commands/merge/helpers/validations.js

@@ -1,269 +0,0 @@
-import fs from 'node:fs/promises';
-
-import {
-  displayWarningMessage,
-  handleError,
-  isSupportedOutputImage,
-  isValidHexadecimal,
-  parseAspectRatio,
-  SUPPORTED_OUTPUT_FORMATS,
-} from '../../../lib/helpers/utils.js';
-import { isValidPreset, PRESETS } from '../../../lib/merges/collage-merge/presets.js';
-
-export const validateSharedOptions = async (sharedOptions) => {
-  // Extract params
-  const { files, dir, recursive, shuffle, cornerRadius, gap, canvasColor, output } = sharedOptions;
-
-  // Conduct validations
-  if ((!files || !files.length) && !dir) {
-    throw new Error('You must specify either [files...] or --dir.');
-  }
-
-  // Ensure dir is a valid dir path
-  if (dir.length) {
-    let stats;
-
-    try {
-      stats = await fs.stat(dir);
-    } catch (e) {
-      throw new Error('Path does not exist.');
-    }
-
-    if (!stats.isDirectory()) {
-      throw new Error('Path is not a directory.');
-    }
-  }
-
-  if (isNaN(gap) || !Number.isInteger(Number(gap)) || gap < 0) {
-    throw new Error('--gap must be a positive integer.');
-  }
-
-  if (isNaN(cornerRadius) || !Number.isInteger(Number(cornerRadius)) || cornerRadius < 0) {
-    throw new Error('--corner-radius must be a positive integer.');
-  }
-
-  if (canvasColor !== 'transparent' && !isValidHexadecimal(canvasColor)) {
-    throw new Error('--canvas-color must be a valid hexadecimal value.');
-  }
-
-  if (!isSupportedOutputImage(output)) {
-    throw new Error('Invalid output format. Choose one of the following: ' + SUPPORTED_OUTPUT_FORMATS.join(', '));
-  }
-
-  const formattedParams = {
-    files: files || [],
-    dir,
-    recursive,
-    shuffle,
-    cornerRadius: Number(cornerRadius),
-    gap: Number(gap),
-    canvasColor: canvasColor === 'transparent' ? { r: 0, g: 0, b: 0, alpha: 0 } : canvasColor,
-    output,
-  };
-
-  return formattedParams;
-};
-
-export const validateMasonryOptions = (sharedOptions, masonryOptions) => {
-  // Extract params
-  const { gap } = sharedOptions;
-  const { rowHeight, columnWidth, canvasWidth, canvasHeight, flow, hAlign, vAlign } = masonryOptions;
-
-  // Define orientations and alignments for validation
-  const FLOWS = ['horizontal', 'vertical'];
-  const HORIZONTAL_ALIGNMENTS = ['left', 'center', 'right', 'justified'];
-  const VERTICAL_ALIGNMENTS = ['top', 'middle', 'bottom', 'justified'];
-
-  // Define orientation dependent options which are ignored if defined for the wrong orientation
-  const IGNORED_FLOW_DEPENDENT_OPTIONS = {
-    horizontal: [
-      {
-        option: '--v-align',
-        value: vAlign,
-      },
-      {
-        option: '--canvas-height',
-        value: canvasHeight,
-      },
-      {
-        option: '--column-width',
-        value: columnWidth,
-      },
-    ],
-    vertical: [
-      {
-        option: '--h-align',
-        value: hAlign,
-      },
-      {
-        option: '--canvas-width',
-        value: canvasWidth,
-      },
-      {
-        option: '--row-height',
-        value: rowHeight,
-      },
-    ],
-  };
-
-  // Validate orientations and alignments
-  if (!FLOWS.includes(flow)) {
-    throw new Error('Invalid orientation. Choose one of the following: ' + FLOWS.join(', '));
-  }
-
-  if (hAlign && !HORIZONTAL_ALIGNMENTS.includes(hAlign)) {
-    throw new Error('Invalid horizontal alignment. Choose one of the following: ' + HORIZONTAL_ALIGNMENTS.join(', '));
-  }
-
-  if (vAlign && !VERTICAL_ALIGNMENTS.includes(vAlign)) {
-    throw new Error('Invalid vertical orientation. Choose one of the following: ' + VERTICAL_ALIGNMENTS.join(', '));
-  }
-
-  // Ensure numeric values are positive integers
-  if (rowHeight && (isNaN(rowHeight) || !Number.isInteger(Number(rowHeight)) || Number(rowHeight) < 1)) {
-    throw new Error('--row-height must be a positive integer.');
-  }
-
-  if (columnWidth && (isNaN(columnWidth) || !Number.isInteger(Number(columnWidth)) || Number(columnWidth) < 1)) {
-    throw new Error('--column-width must be a positive integer.');
-  }
-
-  // Ensure canvas width is given
-  if (flow === 'horizontal' && !canvasWidth) {
-    throw new Error('--canvas-width must be given.');
-  }
-  // and is a positive integer
-  else if (flow === 'horizontal' && (isNaN(canvasWidth) || !Number.isInteger(Number(canvasWidth)) || Number(canvasWidth) < 1)) {
-    throw new Error('--canvas-width must be a positive integer.');
-  }
-  // and it accomodates for the minimum width needed
-  else if (flow === 'horizontal' && canvasWidth <= gap * 2) {
-    throw new Error(`--canvas-width must be greater than 2 gaps or ${gap * 2}px.`);
-  }
-
-  // Ensure canvas height is given
-  if (flow === 'vertical' && !canvasHeight) {
-    throw new Error('--canvas-height must be given.');
-  }
-  // and is a positive integer
-  else if (flow === 'vertical' && (isNaN(canvasHeight) || !Number.isInteger(Number(canvasHeight)) || Number(canvasHeight) < 1)) {
-    throw new Error('--canvas-height must be a positive integer.');
-  }
-  // and it accomodates for the minimum height needed
-  else if (flow === 'vertical' && canvasHeight <= gap * 2) {
-    throw new Error(`--canvas-height must be greater than 2 gaps or ${gap * 2}px.`);
-  }
-
-  // Validate dependent options by showing warnings when incorrect parameters
-  // are used with incorrect orientation
-  const ignoredFlowOptions = IGNORED_FLOW_DEPENDENT_OPTIONS[flow];
-  for (const { option, value } of ignoredFlowOptions) {
-    if (value) {
-      displayWarningMessage(`"${option}" option is ignored due to ${flow} flow.`);
-    }
-  }
-
-  const params = {
-    rowHeight: Number(rowHeight) || null,
-    columnWidth: Number(columnWidth) || null,
-    canvasHeight: Number(canvasHeight) || null,
-    canvasWidth: Number(canvasWidth) || null,
-    flow,
-    hAlign,
-    vAlign,
-  };
-
-  return params;
-};
-
-export const validateGridOptions = (sharedOptions, gridOptions) => {
-  // Extract params
-  const { aspectRatio, imageWidth, columns, caption, captionColor, maxCaptionSize } = gridOptions;
-
-  // Ensure aspect ratio is valid
-  const parsedAspectRatio = parseAspectRatio(aspectRatio);
-  if (!parsedAspectRatio) {
-    throw new Error('--aspect-ratio must be a valid ratio. Examples: 16/9, 2:3, 1x2, 1.77');
-  }
-
-  if (imageWidth && (isNaN(imageWidth) || !Number.isInteger(Number(imageWidth)) || Number(imageWidth) < 1)) {
-    throw new Error('--image-width must be a positive integer.');
-  }
-
-  if (isNaN(columns) || !Number.isInteger(Number(columns)) || Number(columns) < 1) {
-    throw new Error('--columns must be a positive integer.');
-  }
-
-  if (isNaN(maxCaptionSize) || !Number.isInteger(Number(maxCaptionSize)) || Number(maxCaptionSize) < 2) {
-    throw new Error('--max-caption-size must be a positive integer >= 2 (minimum caption size).');
-  }
-
-  if (!isValidHexadecimal(captionColor)) {
-    throw new Error('--caption-color must be a valid hexadecimal value.');
-  }
-
-  const formattedParams = {
-    aspectRatio: parsedAspectRatio,
-    imageWidth: Number(imageWidth) || null,
-    columns: Number(columns),
-    caption,
-    captionColor,
-    maxCaptionSize,
-  };
-
-  return formattedParams;
-};
-
-export const validateCollageOptions = async (collageOptions) => {
-  const { template, mapping, preset } = collageOptions;
-
-  // If a valid preset is given, use it
-  if (preset && isValidPreset(preset)) {
-    return { template: PRESETS[preset] };
-  }
-  // If preset is invalid, throw error
-  else if (preset && !isValidPreset(preset)) {
-    const validPresets = Object.keys(PRESETS).join(', ');
-    throw new Error(`"${preset}" is not a valid preset ID. Choose one of the following: \n${validPresets}`);
-  }
-
-  // Ensure only one of the two are given
-  if (!template && !mapping) {
-    throw new Error('Either --template, --mapping, or --preset need to be provided.');
-  } else if (template && mapping) {
-    throw new Error('Either use --template or --mapping, not both.');
-  }
-
-  // Ensure mapping is actually a json string
-  if (!template && mapping) {
-    try {
-      JSON.parse(mapping);
-    } catch {
-      throw new Error('--mapping should be a valid JSON string.');
-    }
-  }
-
-  // Ensure template is a valid dir path
-  if (template && !mapping) {
-    let stats;
-
-    try {
-      stats = await fs.stat(template);
-    } catch (e) {
-      throw new Error('Template path does not exist.');
-    }
-  }
-
-  // Parse and return respective JSON data
-  try {
-    if (template) {
-      const jsonStr = await fs.readFile(template, 'utf8');
-      return { template: JSON.parse(jsonStr) };
-    }
-
-    // mapping is already a JSON string
-    return { template: JSON.parse(mapping) };
-  } catch (err) {
-    throw new Error('Could not read or parse the provided template or mapping JSON.');
-  }
-};

package/commands/merge/index.js

@@ -1,12 +0,0 @@
-import { Command } from 'commander';
-import masonryCommand from './masonry.js';
-import gridCommand from './grid.js';
-import collageCommand from './collage.js';
-
-const mergeCommand = new Command('merge').description('Merge images into a grid layout.');
-
-mergeCommand.addCommand(masonryCommand);
-mergeCommand.addCommand(gridCommand);
-mergeCommand.addCommand(collageCommand);
-
-export default mergeCommand;

package/commands/merge/masonry.js

@@ -1,72 +0,0 @@
-import { Command } from 'commander';
-import chalk from 'chalk';
-import {
-  cliConfirm,
-  displayInfoMessage,
-  displaySuccessMessage,
-  displayWarningMessage,
-  handleError,
-  writeImage,
-} from '../../lib/helpers/utils.js';
-import { addSharedOptions } from './helpers/utils.js';
-import { validateMasonryOptions, validateSharedOptions } from './helpers/validations.js';
-import { loadImages } from '../../lib/helpers/loadImages.js';
-import { masonryMerge } from '../../lib/merges/masonry-merge/index.js';
-
-const masonryCommand = new Command('masonry');
-
-masonryCommand
-  .description("Use a ragged-grid layout, preserves images' aspect ratios")
-  .option('--rh, --row-height <px>', 'The height of each row, defaults to the smallest image height', null)
-  .option('--cw, --column-width <px>', 'The width of each column, defaults to the smallest image width', null)
-  .option('--cvw, --canvas-width <px>', 'The width of the canvas', null)
-  .option('--cvh, --canvas-height <px>', 'The height of the canvas', null)
-  .option('-f, --flow <horizontal|vertical>', 'The flow of the masonry layout', 'horizontal')
-  .option('--ha, --h-align <left|center|right|justified>', 'Horizontal alignment of the grid (for horizontal flows)', null)
-  .option('--va, --v-align <top|middle|bottom|justified>', 'Vertical alignment of the grid (for vertical flows)', null)
-  .action((files, opts) => {
-    main(files, opts);
-  });
-
-const main = async (files, opts) => {
-  try {
-    // Collect and validate parameters
-    const params = { files, ...opts };
-    const sharedOptions = await validateSharedOptions(params);
-    const masonryOptions = validateMasonryOptions(sharedOptions, opts);
-    const validatedParams = { ...sharedOptions, ...masonryOptions };
-
-    // Load images, create grid, and write grid on disk
-    generateAndSaveGrid(validatedParams);
-
-    // Output success message
-  } catch (e) {
-    handleError(e);
-  }
-};
-
-const generateAndSaveGrid = async (validatedParams) => {
-  const { images, ignoredFiles } = await loadImages(validatedParams);
-
-  // Display warnings if needed
-  if (ignoredFiles.length) {
-    displayWarningMessage('\nThese files will be ignored due to unsupported formats:');
-    for (const file of ignoredFiles) {
-      displayInfoMessage(file);
-    }
-
-    const confirmation = await cliConfirm('\nAre you sure you want to continue?');
-    if (!confirmation) return;
-  }
-
-  const grid = await masonryMerge(images, validatedParams);
-  const success = await writeImage(grid, validatedParams.output);
-
-  // Display success message
-  if (success) {
-    displaySuccessMessage(`\nImage has been created successfully: ${chalk.bold(validatedParams.output)}\n`);
-  }
-};
-
-addSharedOptions(masonryCommand);
-export default masonryCommand;

package/lib/helpers/loadImages.js

@@ -1,94 +0,0 @@
-import sharp from 'sharp';
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { isSupportedInputImage, shuffleTogether } from './utils.js';
-
-const MAX_RECURSION_DEPTH = 10;
-
-export const loadImages = async ({ files, dir, recursive, shuffle, count }) => {
-  let ignoredFiles = [];
-  let filepaths = files;
-  let images = [];
-
-  if (files && files.length) {
-    // Load directly from provided file list
-    images = await loadFromFiles(files, count);
-  } else {
-    // Get all files from directory
-    const { skippedFiles, paths } = await getFilesFromDirectory(dir, recursive);
-    filepaths = paths;
-    ignoredFiles = skippedFiles;
-    images = await loadFromFiles(filepaths, count);
-  }
-
-  // Ensure filepaths and images match
-  if (images.length !== filepaths.length) {
-    filepaths = filepaths.slice(0, images.length);
-  }
-
-  // Optional: shuffle filepaths and images together
-  if (shuffle) {
-    [filepaths, images] = shuffleTogether(filepaths, images);
-  }
-
-  return { images, files: filepaths, ignoredFiles };
-};
-
-const loadFromFiles = async (files, count) => {
-  const images = [];
-  const total = count || files.length;
-  for (let i = 0; i < total; i++) {
-    // End the loop if count is higher than number of available files
-    if (i >= files.length) break;
-
-    // Load images
-    const filepath = files[i];
-    let image;
-
-    if (filepath.endsWith('.svg')) {
-      const svgBuffer = await fs.readFile(filepath);
-      image = sharp(svgBuffer);
-    } else {
-      image = sharp(filepath);
-    }
-
-    images.push(image);
-  }
-
-  return images;
-};
-
-const getFilesFromDirectory = async (dir, recursive, depth = 0) => {
-  // Use to collect warnings
-  const skippedFiles = [];
-
-  // Ensure recursiveness ends at the max recursion depth
-  if (depth >= MAX_RECURSION_DEPTH) return { paths: [], skippedFiles: [] };
-
-  // Get entries
-  const entries = await fs.readdir(dir, { withFileTypes: true });
-  const files = [];
-
-  for (const entry of entries) {
-    const file = path.join(entry.parentPath, entry.name);
-
-    // If the entry is a valid image file, add it to the list
-    if (entry.isFile() && isSupportedInputImage(entry.name)) {
-      files.push(file);
-    }
-    // If it is an invalid file format, add to skipped files
-    else if (entry.isFile() && !isSupportedInputImage(entry.name) && entry.name !== '.DS_Store') {
-      skippedFiles.push(entry.name);
-    }
-    // If it's a directory AND the recursive option is true,
-    // recursively get all the files
-    else if (recursive && entry.isDirectory() && !entry.isSymbolicLink()) {
-      const dirpath = path.join(entry.parentPath, entry.name);
-      const dirObj = await getFilesFromDirectory(dirpath, recursive, depth + 1);
-      files.push(...dirObj?.paths);
-      skippedFiles.push(...dirObj.skippedFiles);
-    }
-  }
-
-  return { paths: files, skippedFiles };
-};

package/lib/helpers/progressBar.js

@@ -1,20 +0,0 @@
-import { SingleBar } from 'cli-progress';
-import chalk from 'chalk';
-
-const title = chalk.gray('Creating Image:');
-const bar = chalk.blue('{bar}');
-const percentage = chalk.yellow('{percentage}%');
-const eta = chalk.blue('ETA: ') + chalk.yellow('{eta_formatted}');
-const stage = chalk.gray('{stage}...');
-const divider = chalk.blue('|');
-
-export const WRITING_TO_FILE_PERCENTAGE = 0.05;
-
-export const progressBar = new SingleBar({
-  format: `${title} ${divider}${bar}${divider} ${percentage} ${divider} ${eta} ${divider} ${stage} `,
-  barCompleteChar: '\u2588',
-  barIncompleteChar: '\u2591',
-  stopOnComplete: true,
-  barsize: 40,
-  etaBuffer: 50,
-});