pixeli 0.1.9 → 1.0.3

package/dist/cli/commands/collage/index.js

@@ -0,0 +1,125 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
+import { buildCommandFromSchema } from '../../utils/buildCommandFromSchema.js';
+import { collageMerge } from '../../../core/merges/collage/index.js';
+import { loadImages } from '../../modules/loadImages.js';
+import { MergeProgressBar } from '../../modules/progressBar.js';
+import { MessageRenderer, MESSAGES } from '../../../core/modules/messages.js';
+import { toErrorMessage } from '../../utils/toErrorMessage.js';
+import { cliCollageSchema } from '../../schemas/collage.js';
+const collageCommand = buildCommandFromSchema('collage', 'Arranges images in a messy, photo wall style grid.', cliCollageSchema, {
+    files: {
+        flags: '[files...]',
+        description: 'Image filepaths to merge (use --dir for directories)',
+    },
+}, {
+    dir: {
+        flags: '-d, --dir <path>',
+        description: 'Directory of images to merge',
+    },
+    recursive: {
+        flags: '-r, --recursive',
+        description: 'Recursively include subdirectories',
+    },
+    shuffle: {
+        flags: '--sh, --shuffle',
+        description: 'Shuffle up images to randomize order in the grid',
+    },
+    cornerRadius: {
+        flags: '--cr, --corner-radius <px>',
+        description: 'How much to round the corners of each image',
+    },
+    gap: {
+        flags: '-g, --gap <px>',
+        description: 'Gap between images',
+    },
+    canvasColor: {
+        flags: '--bg, --canvas-color <hex|transparent>',
+        description: 'Background color for canvas',
+    },
+    borderWidth: {
+        flags: '--bw, --border-width <px>',
+        description: 'Width of the border around each image. Borders are placed internally in each image',
+    },
+    borderColor: {
+        flags: '--bc, --border-color <hex>',
+        description: 'Color of the border around each image',
+    },
+    output: {
+        flags: '-o, --output <file>',
+        description: 'Output file path',
+    },
+    aspectRatio: {
+        flags: '--ar, --aspect-ratio <width/height|number>',
+        description: 'The aspect ratio of all the images (examples: 16/9, 4:3, 1.777)',
+    },
+    imageWidth: {
+        flags: '-w, --image-width <px>',
+        description: 'The width of each image, defaults to the smallest image',
+    },
+    columns: {
+        flags: '-c, --columns <n>',
+        description: 'The number of columns',
+    },
+    overlapPercentage: {
+        flags: '--op, --overlap-percentage <percent>',
+        description: 'The estimated percentage of overlap for every image pair. A higher percentage creates a tighter collage',
+    },
+    rotationRange: {
+        flags: '--rr, --rotation-range <deg>',
+        description: 'The maximum and minimum degrees to randomly rotate each image',
+    },
+    imageWidthVariance: {
+        flags: '--wv, --image-width-variance <px>',
+        description: 'The number of pixels to potentially variate imageWidth by. Used to create random-sized images in the collage',
+    },
+}).action(async (files, opts) => {
+    const input = { files, ...opts };
+    // Use progress bar module to track progress
+    const bar = new MergeProgressBar();
+    try {
+        const validatedOptions = await cliCollageSchema.parseAsync(input);
+        // Use load images module
+        const { images, ignoredPaths } = await loadImages({
+            input: { files: validatedOptions.files, dir: validatedOptions.dir },
+            recursive: validatedOptions.recursive,
+        });
+        // Ensure user knows about ignored files
+        if (ignoredPaths.length) {
+            const warning = new MessageRenderer(MESSAGES.WARNINGS.IGNORED_FILES, ignoredPaths.join('\n') + '\n');
+            const confirmation = await warning.confirm();
+            if (!confirmation)
+                return;
+        }
+        // Collect merge options
+        const { recursive, output, files, dir, ...cliOptions } = validatedOptions;
+        const format = path.extname(output).replace('.', '');
+        const mergeOptions = {
+            format,
+            ...cliOptions,
+        };
+        // Get grid buffer
+        const buffer = await collageMerge(images, mergeOptions, (progressInfo) => {
+            if (!bar.progressBar.isActive) {
+                bar.startBar(progressInfo.phase);
+            }
+            else {
+                bar.updateBar(progressInfo);
+            }
+        });
+        // Write file and display success message
+        await fs.writeFile(output, buffer);
+        bar.endBar();
+        const success = new MessageRenderer(MESSAGES.SUCCESS.OUTPUT, output);
+        success.render();
+    }
+    catch (err) {
+        // End the progress bar
+        bar.endBar();
+        // Create and render error
+        const errorMessage = toErrorMessage(err);
+        const error = new MessageRenderer(errorMessage);
+        error.render();
+    }
+});
+export default collageCommand;

package/dist/cli/commands/grid/index.d.ts

@@ -0,0 +1,2 @@
+declare const gridCommand: import("commander").Command;
+export default gridCommand;

package/dist/cli/commands/grid/index.js

@@ -0,0 +1,127 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
+import { buildCommandFromSchema } from '../../utils/buildCommandFromSchema.js';
+import { gridMerge } from '../../../core/merges/grid/index.js';
+import { cliGridSchema } from '../../schemas/grid.js';
+import { loadImages } from '../../modules/loadImages.js';
+import { MergeProgressBar } from '../../modules/progressBar.js';
+import { MessageRenderer, MESSAGES } from '../../../core/modules/messages.js';
+import { toErrorMessage } from '../../utils/toErrorMessage.js';
+const gridCommand = buildCommandFromSchema('grid', 'Arranges images in an organized grid.', cliGridSchema, {
+    files: {
+        flags: '[files...]',
+        description: 'Image filepaths to merge (use --dir for directories)',
+    },
+}, {
+    dir: {
+        flags: '-d, --dir <path>',
+        description: 'Directory of images to merge',
+    },
+    recursive: {
+        flags: '-r, --recursive',
+        description: 'Recursively include subdirectories',
+    },
+    shuffle: {
+        flags: '--sh, --shuffle',
+        description: 'Shuffle up images to randomize order in the grid',
+    },
+    cornerRadius: {
+        flags: '--cr, --corner-radius <px>',
+        description: 'How much to round the corners of each image',
+    },
+    gap: {
+        flags: '-g, --gap <px>',
+        description: 'Gap between images',
+    },
+    canvasColor: {
+        flags: '--bg, --canvas-color <hex|transparent>',
+        description: 'Background color for canvas',
+    },
+    borderWidth: {
+        flags: '--bw, --border-width <px>',
+        description: 'Width of the border around each image. Borders are placed internally in each image',
+    },
+    borderColor: {
+        flags: '--bc, --border-color <hex>',
+        description: 'Color of the border around each image',
+    },
+    output: {
+        flags: '-o, --output <file>',
+        description: 'Output file path',
+    },
+    aspectRatio: {
+        flags: '--ar, --aspect-ratio <width/height|number>',
+        description: 'The aspect ratio of all the images (examples: 16/9, 4:3, 1.777)',
+    },
+    imageWidth: {
+        flags: '-w, --image-width <px>',
+        description: 'The width of each image, defaults to the smallest image',
+    },
+    columns: {
+        flags: '-c, --columns <n>',
+        description: 'The number of columns',
+    },
+    caption: {
+        flags: '--ca, --caption',
+        description: 'Whether to caption each image',
+    },
+    captionColor: {
+        flags: '--cc, --caption-color <hex>',
+        description: 'Image caption color',
+    },
+    maxCaptionSize: {
+        flags: '--mcs, --max-caption-size <pt>',
+        description: 'The maximum allowed caption size',
+    },
+}).action(async (files, opts) => {
+    const input = { files, ...opts };
+    // Use progress bar module to track progress
+    const bar = new MergeProgressBar();
+    try {
+        const validatedOptions = await cliGridSchema.parseAsync(input);
+        // Use load images module
+        const { images, imagePaths, ignoredPaths } = await loadImages({
+            input: { files: validatedOptions.files, dir: validatedOptions.dir },
+            recursive: validatedOptions.recursive,
+        });
+        // Ensure user knows about ignored files
+        if (ignoredPaths.length) {
+            const warning = new MessageRenderer(MESSAGES.WARNINGS.IGNORED_FILES, ignoredPaths.join('\n') + '\n');
+            const confirmation = await warning.confirm();
+            if (!confirmation)
+                return;
+        }
+        // Collect merge options
+        const { recursive, output, files, dir, ...cliOptions } = validatedOptions;
+        const format = path.extname(output).replace('.', '');
+        const captions = imagePaths.map((p) => path.basename(p));
+        const mergeOptions = {
+            format,
+            captions,
+            ...cliOptions,
+        };
+        // Get grid buffer
+        const buffer = await gridMerge(images, mergeOptions, (progressInfo) => {
+            if (!bar.progressBar.isActive) {
+                bar.startBar(progressInfo.phase);
+            }
+            else {
+                bar.updateBar(progressInfo);
+            }
+        });
+        // Write file and display success message
+        await fs.writeFile(output, buffer);
+        bar.endBar();
+        const success = new MessageRenderer(MESSAGES.SUCCESS.OUTPUT, output);
+        success.render();
+    }
+    catch (err) {
+        // End the progress bar
+        bar.endBar();
+        // Create and render error
+        const errorMessage = toErrorMessage(err);
+        const error = new MessageRenderer(errorMessage);
+        error.render();
+    }
+});
+export default gridCommand;

package/dist/cli/commands/masonry/index.d.ts

@@ -0,0 +1,2 @@
+declare const masonryCommand: import("commander").Command;
+export default masonryCommand;

package/dist/cli/commands/masonry/index.js

@@ -0,0 +1,129 @@
+import path from 'node:path';
+import fs from 'node:fs/promises';
+import { buildCommandFromSchema } from '../../utils/buildCommandFromSchema.js';
+import { masonryMerge } from '../../../core/merges/masonry/index.js';
+import { cliMasonrySchema } from '../../schemas/masonry.js';
+import { loadImages } from '../../modules/loadImages.js';
+import { MergeProgressBar } from '../../modules/progressBar.js';
+import { MessageRenderer, MESSAGES } from '../../../core/modules/messages.js';
+import { toErrorMessage } from '../../utils/toErrorMessage.js';
+const masonryCommand = buildCommandFromSchema('masonry', "Use a ragged-grid layout, preserves images' aspect ratios", cliMasonrySchema, {
+    files: {
+        flags: '[files...]',
+        description: 'Image filepaths to merge (use --dir for directories)',
+    },
+}, {
+    dir: {
+        flags: '-d, --dir <path>',
+        description: 'Directory of images to merge',
+    },
+    recursive: {
+        flags: '-r, --recursive',
+        description: 'Recursively include subdirectories',
+    },
+    shuffle: {
+        flags: '--sh, --shuffle',
+        description: 'Shuffle up images to randomize order in the grid',
+    },
+    cornerRadius: {
+        flags: '--cr, --corner-radius <px>',
+        description: 'How much to round the corners of each image',
+    },
+    gap: {
+        flags: '-g, --gap <px>',
+        description: 'Gap between images',
+    },
+    canvasColor: {
+        flags: '--bg, --canvas-color <hex|transparent>',
+        description: 'Background color for canvas',
+    },
+    borderWidth: {
+        flags: '--bw, --border-width <px>',
+        description: 'Width of the border around each image. Borders are placed internally in each image',
+    },
+    borderColor: {
+        flags: '--bc, --border-color <hex>',
+        description: 'Color of the border around each image',
+    },
+    output: {
+        flags: '-o, --output <file>',
+        description: 'Output file path',
+    },
+    rowHeight: {
+        flags: '--rh, --row-height <px>',
+        description: 'The height of each row, defaults to the trimmed median image height if undefined. Only applied in horizontal flows.',
+    },
+    columnWidth: {
+        flags: '--cw, --column-width <px>',
+        description: 'The width of each column, defaults to the trimmed median image width if undefined. Only applied in vertical flows.',
+    },
+    canvasWidth: {
+        flags: '--cvw, --canvas-width <px>',
+        description: 'The width of the entire canvas. Only required in horizontal flows.',
+    },
+    canvasHeight: {
+        flags: '--cvh, --canvas-height <px>',
+        description: 'The width of the entire canvas. Only required in vertical flows.',
+    },
+    flow: {
+        flags: '-f, --flow <horizontal|vertical>',
+        description: 'The orientation of the masonry layout.',
+    },
+    hAlign: {
+        flags: '--ha, --h-align <left|center|right|justified>',
+        description: 'The horizontal alignment of each row. Only applied in horizontal layouts.',
+    },
+    vAlign: {
+        flags: '--va, --v-align <top|middle|bottom|justified>',
+        description: 'The vertical alignment of each column. Only applied in vertical layouts.',
+    },
+}).action(async (files, opts) => {
+    const input = { files, ...opts };
+    // Use progress bar module to track progress
+    const bar = new MergeProgressBar();
+    try {
+        const validatedOptions = await cliMasonrySchema.parseAsync(input);
+        // Use load images module
+        const { images, ignoredPaths } = await loadImages({
+            input: { files: validatedOptions.files, dir: validatedOptions.dir },
+            recursive: validatedOptions.recursive,
+        });
+        // Ensure user knows about ignored files
+        if (ignoredPaths.length) {
+            const warning = new MessageRenderer(MESSAGES.WARNINGS.IGNORED_FILES, ignoredPaths.join('\n') + '\n');
+            const confirmation = await warning.confirm();
+            if (!confirmation)
+                return;
+        }
+        // Collect merge options
+        const { recursive, output, files, dir, ...cliOptions } = validatedOptions;
+        const format = path.extname(output).replace('.', '');
+        let mergeOptions = {
+            format,
+            ...cliOptions,
+        };
+        // Get grid buffer
+        const buffer = await masonryMerge(images, mergeOptions, (progressInfo) => {
+            if (!bar.progressBar.isActive) {
+                bar.startBar(progressInfo.phase);
+            }
+            else {
+                bar.updateBar(progressInfo);
+            }
+        });
+        // Write file and display success message
+        await fs.writeFile(output, buffer);
+        bar.endBar();
+        const success = new MessageRenderer(MESSAGES.SUCCESS.OUTPUT, output);
+        success.render();
+    }
+    catch (err) {
+        // End the progress bar
+        bar.endBar();
+        // Create and render error
+        const errorMessage = toErrorMessage(err);
+        const error = new MessageRenderer(errorMessage);
+        error.render();
+    }
+});
+export default masonryCommand;

package/dist/cli/commands/template/index.d.ts

@@ -0,0 +1,2 @@
+declare const templateCommand: import("commander").Command;
+export default templateCommand;

package/dist/cli/commands/template/index.js

@@ -0,0 +1,123 @@
+import path from 'node:path';
+import fs, { readFile } from 'node:fs/promises';
+import { buildCommandFromSchema } from '../../utils/buildCommandFromSchema.js';
+import { templateMerge } from '../../../core/merges/template/index.js';
+import { cliTemplateSchema } from '../../schemas/template.js';
+import { PRESETS } from './presets.js';
+import { loadImages } from '../../modules/loadImages.js';
+import { MergeProgressBar } from '../../modules/progressBar.js';
+import { MessageRenderer, MESSAGES } from '../../../core/modules/messages.js';
+import { toErrorMessage } from '../../utils/toErrorMessage.js';
+const templateCommand = buildCommandFromSchema('template', 'Use JSON layouts to build custom collages', cliTemplateSchema, {
+    files: {
+        flags: '[files...]',
+        description: 'Image filepaths to merge (use --dir for directories)',
+    },
+}, {
+    dir: {
+        flags: '-d, --dir <path>',
+        description: 'Directory of images to merge',
+    },
+    recursive: {
+        flags: '-r, --recursive',
+        description: 'Recursively include subdirectories',
+    },
+    shuffle: {
+        flags: '--sh, --shuffle',
+        description: 'Shuffle up images to randomize order in the grid',
+    },
+    cornerRadius: {
+        flags: '--cr, --corner-radius <px>',
+        description: 'How much to round the corners of each image',
+    },
+    gap: {
+        flags: '-g, --gap <px>',
+        description: 'Gap between images',
+    },
+    canvasColor: {
+        flags: '--bg, --canvas-color <hex|transparent>',
+        description: 'Background color for canvas',
+    },
+    borderWidth: {
+        flags: '--bw, --border-width <px>',
+        description: 'Width of the border around each image. Borders are placed internally in each image',
+    },
+    borderColor: {
+        flags: '--bc, --border-color <hex>',
+        description: 'Color of the border around each image',
+    },
+    output: {
+        flags: '-o, --output <file>',
+        description: 'Output file path',
+    },
+    template: {
+        flags: '-t, --template <path>',
+        description: 'The path to the JSON file describing the template',
+    },
+    preset: {
+        flags: '-p, --preset <preset-id>',
+        description: `Template preset ID to use. Available collage IDs: ${Object.keys(PRESETS).join(', ')}`,
+    },
+}).action(async (files, opts) => {
+    const input = { files, ...opts };
+    // Use progress bar module to track progress
+    const bar = new MergeProgressBar();
+    try {
+        const validatedOptions = await cliTemplateSchema.parseAsync(input);
+        // Use load images module
+        const { images, ignoredPaths } = await loadImages({
+            input: { files: validatedOptions.files, dir: validatedOptions.dir },
+            recursive: validatedOptions.recursive,
+        });
+        // Ensure user knows about ignored files
+        if (ignoredPaths.length) {
+            const warning = new MessageRenderer(MESSAGES.WARNINGS.IGNORED_FILES, ignoredPaths.join('\n') + '\n');
+            const confirmation = await warning.confirm();
+            if (!confirmation)
+                return;
+        }
+        // Collect merge options
+        const { recursive, output, files, dir, template, preset, ...cliOptions } = validatedOptions;
+        // Get the template file
+        let templateObj;
+        if (validatedOptions.template !== undefined) {
+            const templateJson = await readFile(validatedOptions.template, 'utf-8');
+            templateObj = JSON.parse(templateJson);
+        }
+        else if (validatedOptions.preset !== undefined) {
+            templateObj = PRESETS[validatedOptions.preset];
+        }
+        else {
+            throw new Error(MESSAGES.ERROR.INTERNAL.message);
+        }
+        const format = path.extname(output).replace('.', '');
+        let mergeOptions = {
+            format,
+            template: templateObj,
+            ...cliOptions,
+        };
+        // Get grid buffer
+        const buffer = await templateMerge(images, mergeOptions, (progressInfo) => {
+            if (!bar.progressBar.isActive) {
+                bar.startBar(progressInfo.phase);
+            }
+            else {
+                bar.updateBar(progressInfo);
+            }
+        });
+        // Write file and display success message
+        await fs.writeFile(output, buffer);
+        bar.endBar();
+        const success = new MessageRenderer(MESSAGES.SUCCESS.OUTPUT, output);
+        success.render();
+    }
+    catch (err) {
+        // End the progress bar
+        bar.endBar();
+        // Create and render error
+        const errorMessage = toErrorMessage(err);
+        const error = new MessageRenderer(errorMessage);
+        error.render();
+    }
+});
+export default templateCommand;

package/dist/cli/commands/template/presets/artGallery.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    canvas: {
+        width: number;
+        height: number;
+        columns: number;
+        rows: number;
+    };
+    slots: {
+        col: number;
+        row: number;
+        colSpan: number;
+        rowSpan: number;
+    }[];
+};
+export default _default;

package/dist/cli/commands/template/presets/artGallery.js

@@ -0,0 +1,15 @@
+export default {
+    canvas: {
+        width: 4000,
+        height: 3000,
+        columns: 5,
+        rows: 5,
+    },
+    slots: [
+        { col: 1, row: 1, colSpan: 3, rowSpan: 3 },
+        { col: 4, row: 1, colSpan: 2, rowSpan: 2 },
+        { col: 4, row: 3, colSpan: 2, rowSpan: 1 },
+        { col: 1, row: 4, colSpan: 2, rowSpan: 2 },
+        { col: 3, row: 4, colSpan: 3, rowSpan: 2 },
+    ],
+};

package/dist/cli/commands/template/presets/dashboardShot.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    canvas: {
+        width: number;
+        height: number;
+        columns: number;
+        rows: number;
+    };
+    slots: {
+        col: number;
+        row: number;
+        colSpan: number;
+        rowSpan: number;
+    }[];
+};
+export default _default;

package/dist/cli/commands/template/presets/dashboardShot.js

@@ -0,0 +1,16 @@
+export default {
+    canvas: {
+        width: 3600,
+        height: 2400,
+        columns: 6,
+        rows: 4,
+    },
+    slots: [
+        { col: 1, row: 1, colSpan: 3, rowSpan: 2 },
+        { col: 4, row: 1, colSpan: 3, rowSpan: 1 },
+        { col: 4, row: 2, colSpan: 3, rowSpan: 1 },
+        { col: 1, row: 3, colSpan: 2, rowSpan: 2 },
+        { col: 3, row: 3, colSpan: 2, rowSpan: 2 },
+        { col: 5, row: 3, colSpan: 2, rowSpan: 2 },
+    ],
+};

package/dist/cli/commands/template/presets/horizontalBookSpread.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    canvas: {
+        width: number;
+        height: number;
+        columns: number;
+        rows: number;
+    };
+    slots: {
+        col: number;
+        row: number;
+        colSpan: number;
+        rowSpan: number;
+    }[];
+};
+export default _default;

package/dist/cli/commands/template/presets/horizontalBookSpread.js

@@ -0,0 +1,13 @@
+export default {
+    canvas: {
+        width: 4800,
+        height: 2800,
+        columns: 8,
+        rows: 3,
+    },
+    slots: [
+        { col: 1, row: 1, colSpan: 3, rowSpan: 3 },
+        { col: 4, row: 1, colSpan: 5, rowSpan: 1 },
+        { col: 4, row: 2, colSpan: 5, rowSpan: 2 },
+    ],
+};

package/dist/cli/commands/template/presets/instagramGrid.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    canvas: {
+        width: number;
+        height: number;
+        columns: number;
+        rows: number;
+    };
+    slots: {
+        col: number;
+        row: number;
+        colSpan: number;
+        rowSpan: number;
+    }[];
+};
+export default _default;

package/dist/cli/commands/template/presets/instagramGrid.js

@@ -0,0 +1,16 @@
+export default {
+    canvas: {
+        width: 2400,
+        height: 3200,
+        columns: 3,
+        rows: 6,
+    },
+    slots: [
+        { col: 1, row: 1, colSpan: 2, rowSpan: 2 },
+        { col: 3, row: 1, colSpan: 1, rowSpan: 1 },
+        { col: 3, row: 2, colSpan: 1, rowSpan: 1 },
+        { col: 1, row: 3, colSpan: 1, rowSpan: 2 },
+        { col: 2, row: 3, colSpan: 2, rowSpan: 2 },
+        { col: 1, row: 5, colSpan: 3, rowSpan: 2 },
+    ],
+};

package/dist/cli/commands/template/presets/verticalBookSpread.d.ts

@@ -0,0 +1,15 @@
+declare const _default: {
+    canvas: {
+        width: number;
+        height: number;
+        columns: number;
+        rows: number;
+    };
+    slots: {
+        col: number;
+        row: number;
+        colSpan: number;
+        rowSpan: number;
+    }[];
+};
+export default _default;

package/dist/cli/commands/template/presets/verticalBookSpread.js

@@ -0,0 +1,13 @@
+export default {
+    canvas: {
+        width: 2800,
+        height: 4200,
+        columns: 2,
+        rows: 3,
+    },
+    slots: [
+        { col: 1, row: 1, colSpan: 2, rowSpan: 1 },
+        { col: 1, row: 2, colSpan: 1, rowSpan: 2 },
+        { col: 2, row: 2, colSpan: 1, rowSpan: 2 },
+    ],
+};