@design-edito/tools 0.4.4 → 0.4.6

package/node/images/transform/operations/level/index.js

@@ -1,10 +1,15 @@
-import {
-  isLevelOperationParams,
-  level
-} from "../../../../../chunks/chunk-VPBZS3S4.js";
-import "../../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isLevelOperationParams,
-  level
-};
+import z from 'zod';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
+export function isLevelOperationParams(obj) {
+    const schema = z.object({
+        multiplier: z.number().optional(),
+        offset: z.number().optional()
+    });
+    const result = schema.safeParse(obj);
+    if (!result.success)
+        return Outcome.makeFailure(result.error.message);
+    return Outcome.makeSuccess(result.data);
+}
+export async function level(sharpInstance, params) {
+    return sharpInstance.linear(params.multiplier, params.offset);
+}

package/node/images/transform/operations/lighten/index.js

@@ -1,10 +1,14 @@
-import {
-  isLightenOperationParams,
-  lighten
-} from "../../../../../chunks/chunk-W7PJ5NQQ.js";
-import "../../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isLightenOperationParams,
-  lighten
-};
+import z from 'zod';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
+export function isLightenOperationParams(obj) {
+    const schema = z.object({
+        amount: z.number().optional()
+    });
+    const result = schema.safeParse(obj);
+    if (!result.success)
+        return Outcome.makeFailure(result.error.message);
+    return Outcome.makeSuccess(result.data);
+}
+export async function lighten(sharpInstance, params) {
+    return sharpInstance.modulate({ lightness: params.amount });
+}

package/node/images/transform/operations/normalize/index.js

@@ -1,10 +1,15 @@
-import {
-  isNormalizeOperationParams,
-  normalize
-} from "../../../../../chunks/chunk-TNZGRXKJ.js";
-import "../../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isNormalizeOperationParams,
-  normalize
-};
+import z from 'zod';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
+export function isNormalizeOperationParams(obj) {
+    const schema = z.object({
+        lower: z.number().optional(),
+        upper: z.number().optional()
+    });
+    const result = schema.safeParse(obj);
+    if (!result.success)
+        return Outcome.makeFailure(result.error.message);
+    return Outcome.makeSuccess(result.data);
+}
+export async function normalize(sharpInstance, params) {
+    return sharpInstance.normalize(params);
+}

package/node/images/transform/operations/overlay/index.js

@@ -1,17 +1,90 @@
-import {
-  isOverlayOperationParams,
-  overlay
-} from "../../../../../chunks/chunk-3RNLPW7B.js";
-import "../../../../../chunks/chunk-HMMPT3UM.js";
-import "../../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../../chunks/chunk-CVMYA5XK.js";
-import "../../../../../chunks/chunk-OBSTP7YR.js";
-import "../../../../../chunks/chunk-HQLRJ7XW.js";
-import "../../../../../chunks/chunk-DNIOWD7K.js";
-import "../../../../../chunks/chunk-PUQUSA6S.js";
-import "../../../../../chunks/chunk-OSAXBA7G.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isOverlayOperationParams,
-  overlay
-};
+import sharp from 'sharp';
+import z from 'zod';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
+import { isColor } from '../../../../../agnostic/colors/typechecks/index.js';
+import { isDuckTypedSharpInstance, toSharpInstance } from '../../../utils/index.js';
+export function isOverlayOperationParams(obj) {
+    const schema = z.object({
+        input: z.union([
+            z.custom(isDuckTypedSharpInstance),
+            z.custom(data => Buffer.isBuffer(data)),
+            z.string(),
+            z.object({
+                width: z.number().optional(),
+                height: z.number().optional(),
+                channels: z.union([z.literal(3), z.literal(4)]).optional(),
+                background: z.custom(isColor).optional(),
+                noise: z.object({
+                    mean: z.number().optional(),
+                    sigma: z.number().optional()
+                }).optional(),
+                pageHeight: z.number().optional()
+            })
+        ]),
+        top: z.number().optional(),
+        left: z.number().optional(),
+        tile: z.boolean().optional(),
+        premultiplied: z.boolean().optional(),
+        density: z.number().optional(),
+        animated: z.boolean().optional(),
+        autoOrient: z.boolean().optional(),
+        ignoreIcc: z.boolean().optional(),
+        pages: z.number().optional(),
+        page: z.number().optional(),
+        blend: z.enum([
+            'clear',
+            'source',
+            'over',
+            'in',
+            'out',
+            'atop',
+            'dest',
+            'dest-over',
+            'dest-in',
+            'dest-out',
+            'dest-atop',
+            'xor',
+            'add',
+            'saturate',
+            'multiply',
+            'screen',
+            'overlay',
+            'darken',
+            'lighten',
+            'color-dodge',
+            'colour-dodge',
+            'color-burn',
+            'colour-burn',
+            'hard-light',
+            'soft-light',
+            'difference',
+            'exclusion'
+        ]).optional(),
+        gravity: z.enum([
+            'north',
+            'northeast',
+            'southeast',
+            'south',
+            'southwest',
+            'west',
+            'northwest',
+            'east',
+            'center',
+            'centre'
+        ]).optional()
+    });
+    const result = schema.safeParse(obj);
+    if (!result.success)
+        return Outcome.makeFailure(result.error.message);
+    return Outcome.makeSuccess(result.data);
+}
+export async function overlay(sharpInstance, params) {
+    const inputBuffer = params.input instanceof Buffer
+        ? params.input
+        : await (await toSharpInstance(params.input)).toBuffer();
+    /* Pour pouvoir chainer plusieurs composites à la suite, on a d'abord besoin d'"applatir" l'image courante et de lui donner un format */
+    return sharp(await sharpInstance.composite([{
+            ...params,
+            input: inputBuffer
+        }]).webp().toBuffer());
+}

package/node/images/transform/operations/resize/index.js

@@ -1,17 +1,47 @@
-import {
-  isResizeOperationParams,
-  resize
-} from "../../../../../chunks/chunk-NIBRPZJD.js";
-import "../../../../../chunks/chunk-HMMPT3UM.js";
-import "../../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../../chunks/chunk-CVMYA5XK.js";
-import "../../../../../chunks/chunk-OBSTP7YR.js";
-import "../../../../../chunks/chunk-HQLRJ7XW.js";
-import "../../../../../chunks/chunk-DNIOWD7K.js";
-import "../../../../../chunks/chunk-PUQUSA6S.js";
-import "../../../../../chunks/chunk-OSAXBA7G.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isResizeOperationParams,
-  resize
-};
+import z from 'zod';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
+import { isColor } from '../../../../../agnostic/colors/typechecks/index.js';
+import { toSharpColor } from '../../../utils/index.js';
+export function isResizeOperationParams(obj) {
+    const schema = z.object({
+        width: z.number().optional(),
+        height: z.number().optional(),
+        fit: z.enum([
+            'contain',
+            'cover',
+            'fill',
+            'inside',
+            'outside'
+        ]).optional(),
+        position: z.union([
+            z.number(),
+            z.string()
+        ]).optional(),
+        background: z.custom(isColor).optional(),
+        kernel: z.enum([
+            'nearest',
+            'cubic',
+            'linear',
+            'mitchell',
+            'lanczos2',
+            'lanczos3',
+            'mks2013',
+            'mks2021'
+        ]).optional(),
+        withoutEnlargement: z.boolean().optional(),
+        withoutReduction: z.boolean().optional(),
+        fastShrinkOnLoad: z.boolean().optional()
+    });
+    const result = schema.safeParse(obj);
+    if (!result.success)
+        return Outcome.makeFailure(result.error.message);
+    return Outcome.makeSuccess(result.data);
+}
+export async function resize(sharpInstance, params) {
+    return sharpInstance.resize({
+        ...params,
+        background: params.background !== undefined
+            ? toSharpColor(params.background)
+            : undefined
+    });
+}

package/node/images/transform/operations/rotate/index.js

@@ -1,17 +1,21 @@
-import {
-  isRotateOperationParams,
-  rotate
-} from "../../../../../chunks/chunk-U6SGKHHA.js";
-import "../../../../../chunks/chunk-HMMPT3UM.js";
-import "../../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../../chunks/chunk-CVMYA5XK.js";
-import "../../../../../chunks/chunk-OBSTP7YR.js";
-import "../../../../../chunks/chunk-HQLRJ7XW.js";
-import "../../../../../chunks/chunk-DNIOWD7K.js";
-import "../../../../../chunks/chunk-PUQUSA6S.js";
-import "../../../../../chunks/chunk-OSAXBA7G.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isRotateOperationParams,
-  rotate
-};
+import z from 'zod';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
+import { isColor } from '../../../../../agnostic/colors/typechecks/index.js';
+import { toSharpColor } from '../../../utils/index.js';
+export function isRotateOperationParams(obj) {
+    const schema = z.object({
+        angleDeg: z.number().optional(),
+        background: z.custom(isColor).optional()
+    });
+    const result = schema.safeParse(obj);
+    if (!result.success)
+        return Outcome.makeFailure(result.error.message);
+    return Outcome.makeSuccess(result.data);
+}
+export async function rotate(sharpInstance, params) {
+    return sharpInstance.rotate(params.angleDeg, {
+        background: params.background !== undefined
+            ? toSharpColor(params.background)
+            : undefined
+    });
+}

package/node/images/transform/operations/saturate/index.js

@@ -1,10 +1,16 @@
-import {
-  isSaturateOperationParams,
-  saturate
-} from "../../../../../chunks/chunk-MDVGDZU6.js";
-import "../../../../../chunks/chunk-LUAYN7VJ.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isSaturateOperationParams,
-  saturate
-};
+import z from 'zod';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
+export function isSaturateOperationParams(obj) {
+    const schema = z.object({
+        saturation: z.number().optional()
+    });
+    const result = schema.safeParse(obj);
+    if (!result.success)
+        return Outcome.makeFailure(result.error.message);
+    return Outcome.makeSuccess(result.data);
+}
+export async function saturate(sharpInstance, params) {
+    return sharpInstance.modulate({
+        saturation: params.saturation
+    });
+}

package/node/images/types.js

@@ -1,9 +1,34 @@
-import {
-  OpName,
-  TransformErrCodes
-} from "../../chunks/chunk-5NTPCRFH.js";
-import "../../chunks/chunk-WSFCRVEQ.js";
-export {
-  OpName,
-  TransformErrCodes
-};
+/* * * * * * * * * * * * * * *
+ * TRANSFORM
+ * * * * * * * * * * * * * * */
+/** Enumeration of available image transformation operation names. */
+export var OpName;
+(function (OpName) {
+    OpName["BLUR"] = "blur";
+    OpName["BRIGHTEN"] = "brighten";
+    OpName["EXTEND"] = "extend";
+    OpName["EXTRACT"] = "extract";
+    OpName["FLATTEN"] = "flatten";
+    OpName["FLIP"] = "flip";
+    OpName["FLOP"] = "flop";
+    // [WIP] Frame ?
+    OpName["HUE"] = "hue";
+    OpName["LEVEL"] = "level";
+    OpName["LIGHTEN"] = "lighten";
+    // Modulate will duplicate with hue, brighten, saturate and lighten
+    OpName["NORMALIZE"] = "normalize";
+    OpName["OVERLAY"] = "overlay";
+    OpName["RESIZE"] = "resize";
+    OpName["ROTATE"] = "rotate";
+    OpName["SATURATE"] = "saturate";
+    // No need for scale, since resize can do the same thing
+})(OpName || (OpName = {}));
+/** Error codes for transformation operations. */
+export var TransformErrCodes;
+(function (TransformErrCodes) {
+    TransformErrCodes["PROCESS_TIMEOUT"] = "process-timeout";
+    TransformErrCodes["OP_TIMEOUT"] = "op-timeout";
+    TransformErrCodes["WIDTH_LIMIT_EXCEEDED"] = "width-limit-exceeded";
+    TransformErrCodes["HEIGHT_LIMIT_EXCEEDED"] = "height-limit-exceeded";
+    TransformErrCodes["UNKNOWN_ERROR"] = "unknown-error";
+})(TransformErrCodes || (TransformErrCodes = {}));

package/node/images/utils/index.js

@@ -1,19 +1,85 @@
-import {
-  isDuckTypedSharpInstance,
-  toCreateOptions,
-  toSharpColor,
-  toSharpInstance
-} from "../../../chunks/chunk-HMMPT3UM.js";
-import "../../../chunks/chunk-CVMYA5XK.js";
-import "../../../chunks/chunk-OBSTP7YR.js";
-import "../../../chunks/chunk-HQLRJ7XW.js";
-import "../../../chunks/chunk-DNIOWD7K.js";
-import "../../../chunks/chunk-PUQUSA6S.js";
-import "../../../chunks/chunk-OSAXBA7G.js";
-import "../../../chunks/chunk-WSFCRVEQ.js";
-export {
-  isDuckTypedSharpInstance,
-  toCreateOptions,
-  toSharpColor,
-  toSharpInstance
-};
+import { readFile } from 'node:fs/promises';
+import sharp from 'sharp';
+import { toRgb } from '../../../agnostic/colors/convert/index.js';
+import { tidy } from '../../../agnostic/colors/tidy/index.js';
+import { isNonNullObject } from '../../../agnostic/objects/is-object/index.js';
+/** Converts a Color to Sharp RGBA format. */
+export function toSharpColor(color) {
+    const rgb = tidy(toRgb(color));
+    return {
+        r: rgb.r,
+        g: rgb.g,
+        b: rgb.b,
+        alpha: rgb.a
+    };
+}
+/**
+ * Type guard to check if an object is a duck-typed Sharp instance.
+ *
+ * Checks for the presence and correct types of Sharp's characteristic methods.
+ *
+ * @param obj - The object to check.
+ * @returns `true` if the object appears to be a Sharp instance, `false` otherwise.
+ */
+export function isDuckTypedSharpInstance(obj) {
+    if (!isNonNullObject(obj))
+        return false;
+    return 'avif' in obj
+        && 'clone' in obj
+        && 'gif' in obj
+        && 'heif' in obj
+        && 'jpeg' in obj
+        && 'heif' in obj
+        && 'metadata' in obj
+        && 'png' in obj
+        && 'resize' in obj
+        && 'tiff' in obj
+        && 'webp' in obj
+        && typeof obj.avif === 'function'
+        && typeof obj.clone === 'function'
+        && typeof obj.gif === 'function'
+        && typeof obj.heif === 'function'
+        && typeof obj.jpeg === 'function'
+        && typeof obj.heif === 'function'
+        && typeof obj.metadata === 'function'
+        && typeof obj.png === 'function'
+        && typeof obj.resize === 'function'
+        && typeof obj.tiff === 'function'
+        && typeof obj.webp === 'function';
+}
+/** Converts CreateOptions to Sharp create options with defaults applied. */
+export function toCreateOptions(options) {
+    return {
+        width: options.width ?? 100,
+        height: options.height ?? 100,
+        channels: options.channels ?? 4,
+        background: options.background !== undefined
+            ? toSharpColor(options.background)
+            : toSharpColor('white'),
+        noise: options.noise !== undefined
+            ? { ...options.noise, type: 'gaussian' }
+            : undefined,
+        pageHeight: options.pageHeight
+    };
+}
+/**
+ * Converts an ImageLike input to a Sharp instance.
+ *
+ * Handles different input types: file paths (reads from disk), Buffers, existing Sharp
+ * instances, and CreateOptions (creates a new image).
+ *
+ * @param imageLike - The image input. Can be a file path, Buffer, Sharp instance, or CreateOptions.
+ * @param [clone=false] - If `true` and input is a Sharp instance, returns a cloned instance.
+ * @returns A Sharp instance ready for image operations.
+ */
+export async function toSharpInstance(imageLike, clone = false) {
+    if (typeof imageLike === 'string')
+        return sharp(await readFile(imageLike));
+    if (Buffer.isBuffer(imageLike))
+        return sharp(imageLike);
+    if (isDuckTypedSharpInstance(imageLike))
+        return clone
+            ? imageLike.clone()
+            : imageLike;
+    return sharp({ create: toCreateOptions(imageLike) });
+}

package/node/index.d.ts

@@ -1,11 +1,11 @@
-export * as awsS3 from './@aws-s3/index.js'
 export * as designEdito from './@design-edito/index.js'
+export * as awsS3 from './@aws-s3/index.js'
 export * as express from './@express/index.js'
 export * as googleCloud from './@google-cloud/index.js'
 export * as cloudStorage from './cloud-storage/index.js'
 export * as encryption from './encryption/index.js'
 export * as files from './files/index.js'
-export * as ftps from './ftps/index.js'
 export * as images from './images/index.js'
-export * as process from './process/index.js'
+export * as ftps from './ftps/index.js'
 export * as sftp from './sftp/index.js'
+export * as process from './process/index.js'

package/node/index.js

@@ -1,11 +1,11 @@
-export * as awsS3 from './@aws-s3/index.js'
 export * as designEdito from './@design-edito/index.js'
+export * as awsS3 from './@aws-s3/index.js'
 export * as express from './@express/index.js'
 export * as googleCloud from './@google-cloud/index.js'
 export * as cloudStorage from './cloud-storage/index.js'
 export * as encryption from './encryption/index.js'
 export * as files from './files/index.js'
-export * as ftps from './ftps/index.js'
 export * as images from './images/index.js'
-export * as process from './process/index.js'
+export * as ftps from './ftps/index.js'
 export * as sftp from './sftp/index.js'
+export * as process from './process/index.js'

package/node/process/on-exit/index.js

@@ -1,32 +1,49 @@
-import "../../../chunks/chunk-WSFCRVEQ.js";
-
-// src/node/process/on-exit/index.ts
-var forceExitEvents = ["SIGINT", "SIGTERM", "uncaughtException"];
-function beforeForcedExit(callback) {
-  forceExitEvents.forEach((ev) => process.on(ev, callback));
+/** Events that trigger a forced exit of the process. */
+export const forceExitEvents = ['SIGINT', 'SIGTERM', 'uncaughtException'];
+/**
+ * Registers a callback to run before forced exit events (SIGINT, SIGTERM, uncaughtException).
+ *
+ * @param callback - Function to execute before forced exit. Can be async.
+ */
+export function beforeForcedExit(callback) {
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    forceExitEvents.forEach(ev => process.on(ev, callback));
 }
-function beforeExit(callback) {
-  process.on("beforeExit", callback);
+/**
+ * Registers a callback to run before the process exits normally.
+ *
+ * @param callback - Function to execute before exit. Can be async.
+ */
+export function beforeExit(callback) {
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    process.on('beforeExit', callback);
 }
-function onExit(callback) {
-  process.on("exit", callback);
+/**
+ * Registers a callback to run when the process exits.
+ *
+ * @param callback - Function to execute on exit. Can be async.
+ */
+export function onExit(callback) {
+    // eslint-disable-next-line @typescript-eslint/no-misused-promises
+    process.on('exit', callback);
 }
-function onAllExits(callback) {
-  let alreadyCalled = false;
-  const actualCallback = () => {
-    if (!alreadyCalled) {
-      alreadyCalled = true;
-      callback();
-    }
-  };
-  beforeForcedExit(actualCallback);
-  beforeExit(actualCallback);
-  onExit(actualCallback);
+/**
+ * Registers a callback to run on all exit scenarios (forced exit, before exit, and exit).
+ *
+ * The callback is guaranteed to be called only once, even if multiple exit events occur.
+ *
+ * @param callback - Function to execute on any exit. Can be async.
+ */
+export function onAllExits(callback) {
+    let alreadyCalled = false;
+    const actualCallback = () => {
+        if (!alreadyCalled) {
+            alreadyCalled = true;
+            // eslint-disable-next-line @typescript-eslint/no-misused-promises, @typescript-eslint/no-floating-promises
+            callback();
+        }
+    };
+    beforeForcedExit(actualCallback);
+    beforeExit(actualCallback);
+    onExit(actualCallback);
 }
-export {
-  beforeExit,
-  beforeForcedExit,
-  forceExitEvents,
-  onAllExits,
-  onExit
-};

package/node/process/prompt-continue/index.js

@@ -1,17 +1,30 @@
-import "../../../chunks/chunk-WSFCRVEQ.js";
-
-// src/node/process/prompt-continue/index.ts
-import * as inquirer from "@inquirer/prompts";
-async function promptContinue(message, throws = false) {
-  console.log("");
-  const answer = await inquirer.confirm({
-    message: message ?? "Continue?",
-    default: false
-  });
-  if (answer) return true;
-  if (throws) throw new Error("Aborted");
-  return false;
+import * as inquirer from '@inquirer/prompts';
+/**
+ * Prompts the user with a yes/no confirmation in the terminal.
+ *
+ * @param {string} [message] - The message to display in the prompt. Defaults to "Continue?" if not provided.
+ * @param {boolean} [throws=false] - If true, the function will throw an error when the user declines.
+ * @returns {Promise<boolean>} - Resolves to `true` if the user confirms, `false` if the user declines and `throws` is false.
+ *
+ * @throws {Error} - Throws an error with message 'Aborted' if the user declines and `throws` is true.
+ *
+ * @example
+ * const result = await promptContinue('Do you want to proceed?');
+ * if (result) {
+ *   console.log('User confirmed');
+ * } else {
+ *   console.log('User declined');
+ * }
+ */
+export async function promptContinue(message, throws = false) {
+    console.log('');
+    const answer = await inquirer.confirm({
+        message: message ?? 'Continue?',
+        default: false
+    });
+    if (answer)
+        return true;
+    if (throws)
+        throw new Error('Aborted');
+    return false;
 }
-export {
-  promptContinue
-};