@design-edito/tools 0.2.39 → 0.2.40

package/node/images/transform/operations/rotate/index.d.ts

@@ -1,5 +1,5 @@
 import sharp from 'sharp';
-import { Outcome } from '../../../../../agnostic/misc/outcome/index.js';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import type { RotateOperationParams } from '../../../types.js';
 export declare function isRotateOperationParams(obj: unknown): Outcome.Either<RotateOperationParams, string>;
 export declare function rotate(sharpInstance: sharp.Sharp, params: RotateOperationParams): Promise<sharp.Sharp>;

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

@@ -1,27 +1,17 @@
 import {
   isRotateOperationParams,
   rotate
-} from "../../../../../chunks/chunk-QWNWZBIO.js";
-import "../../../../../chunks/chunk-DZ2T5DTY.js";
-import "../../../../../chunks/chunk-D5CCWCEI.js";
-import "../../../../../chunks/chunk-JMU5PDBD.js";
-import "../../../../../chunks/chunk-3KZNRSDD.js";
-import "../../../../../chunks/chunk-5CTAKAIP.js";
-import "../../../../../chunks/chunk-L7PIZQFC.js";
-import "../../../../../chunks/chunk-WSC3WODJ.js";
-import "../../../../../chunks/chunk-EGBJXHCW.js";
-import "../../../../../chunks/chunk-XPGAVZGK.js";
-import "../../../../../chunks/chunk-3LCD73SB.js";
-import "../../../../../chunks/chunk-MFIGSRSO.js";
-import "../../../../../chunks/chunk-YXLHZ2KW.js";
-import "../../../../../chunks/chunk-NCYE5WML.js";
-import "../../../../../chunks/chunk-FNQAF6CQ.js";
-import "../../../../../chunks/chunk-DNIOWD7K.js";
+} from "../../../../../chunks/chunk-53ILYMIY.js";
+import "../../../../../chunks/chunk-LFHDJTZJ.js";
+import "../../../../../chunks/chunk-ENOTZXFS.js";
+import "../../../../../chunks/chunk-QEKI6WGQ.js";
+import "../../../../../chunks/chunk-2QDYPY2O.js";
 import "../../../../../chunks/chunk-OSAXBA7G.js";
-import "../../../../../chunks/chunk-67V4BGOB.js";
+import "../../../../../chunks/chunk-JDINERKY.js";
 import "../../../../../chunks/chunk-HQLRJ7XW.js";
-import "../../../../../chunks/chunk-7UGMWTP5.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
+import "../../../../../chunks/chunk-DNIOWD7K.js";
+import "../../../../../chunks/chunk-KRYJVBO5.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
 export {
   isRotateOperationParams,
   rotate

package/node/images/transform/operations/saturate/index.d.ts

@@ -1,5 +1,5 @@
 import sharp from 'sharp';
-import { Outcome } from '../../../../../agnostic/misc/outcome/index.js';
+import * as Outcome from '../../../../../agnostic/misc/outcome/index.js';
 import type { SaturateOperationParams } from '../../../types.js';
 export declare function isSaturateOperationParams(obj: unknown): Outcome.Either<SaturateOperationParams, string>;
 export declare function saturate(sharpInstance: sharp.Sharp, params: SaturateOperationParams): Promise<sharp.Sharp>;

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

@@ -1,10 +1,10 @@
 import {
   isSaturateOperationParams,
   saturate
-} from "../../../../../chunks/chunk-QTA7ZEVX.js";
-import "../../../../../chunks/chunk-DZ2T5DTY.js";
-import "../../../../../chunks/chunk-JMU5PDBD.js";
-import "../../../../../chunks/chunk-WSFCRVEQ.js";
+} from "../../../../../chunks/chunk-AYGAQQXD.js";
+import "../../../../../chunks/chunk-LFHDJTZJ.js";
+import "../../../../../chunks/chunk-QEKI6WGQ.js";
+import "../../../../../chunks/chunk-XCBH6NLF.js";
 export {
   isSaturateOperationParams,
   saturate

package/node/images/types.d.ts

@@ -1,105 +1,189 @@
 import type { Sharp } from 'sharp';
 import type { Color } from '../../agnostic/colors/types.js';
+/** Union type representing any valid image input. */
+export type ImageLike = Sharp | Buffer | CreateOptions | string;
 export type CreateOptions = {
+    /** Image width in pixels. */
     width?: number;
+    /** Image height in pixels. */
     height?: number;
+    /** Number of color channels (3 for RGB, 4 for RGBA). */
     channels?: 3 | 4;
+    /** Background color for the image. */
     background?: Color;
+    /** Gaussian noise configuration. */
     noise?: {
+        /** Mean value for noise generation. */
         mean?: number;
+        /** Standard deviation (sigma) for noise generation. */
         sigma?: number;
     };
+    /** Page height for multi-page images. */
     pageHeight?: number;
 };
-export type ImageLike = Sharp | Buffer | CreateOptions | string;
 export type FormatCommonOptions = {
+    /** Target width in pixels. */
     width?: number;
+    /** Target height in pixels. */
     height?: number;
+    /** How the image should be resized to fit the dimensions. */
     fit?: 'contain' | 'cover' | 'fill' | 'inside' | 'outside';
+    /** Position for the fit mode (gravity or coordinates). */
     position?: number | string;
+    /** Background color for areas not covered by the image. */
     background?: Color;
+    /** Interpolation kernel to use for resizing. */
     kernel?: 'nearest' | 'cubic' | 'linear' | 'mitchell' | 'lanczos2' | 'lanczos3' | 'mks2013' | 'mks2021';
+    /** If `true`, do not enlarge the image if dimensions are smaller. */
     withoutEnlargement?: boolean;
+    /** If `true`, do not reduce the image if dimensions are larger. */
     withoutReduction?: boolean;
+    /** If `true`, use fast shrink-on-load for JPEG images. */
     fastShrinkOnLoad?: boolean;
 };
 export type FormatJpgOptions = FormatCommonOptions & {
+    /** Format type identifier. */
     type: 'jpg' | 'jpeg';
+    /** Quality level (1-100). */
     quality?: number;
+    /** Force output format even if input is different. */
     force?: boolean;
+    /** Use progressive encoding. */
     progressive?: boolean;
+    /** Chroma subsampling format. */
     chromaSubsampling?: string;
+    /** Enable trellis quantisation. */
     trellisQuantisation?: boolean;
+    /** Enable overshoot deringing. */
     overshootDeringing?: boolean;
+    /** Optimize scans. */
     optimizeScans?: boolean;
+    /** Optimize coding. */
     optimizeCoding?: boolean;
+    /** Quantization table to use. */
     quantizationTable?: number;
+    /** Use mozjpeg encoder. */
     mozjpeg?: boolean;
 };
 export type FormatPngOptions = FormatCommonOptions & {
+    /** Format type identifier. */
     type: 'png';
+    /** Quality level (1-100). */
     quality?: number;
+    /** Force output format even if input is different. */
     force?: boolean;
+    /** Use progressive encoding. */
     progressive?: boolean;
+    /** Compression level (0-9). */
     compressionLevel?: number;
+    /** Enable adaptive filtering. */
     adaptiveFiltering?: boolean;
+    /** Compression effort (1-10). */
     effort?: number;
+    /** Use palette mode. */
     palette?: boolean;
+    /** Number of colors in palette (1-256). */
     colors?: number;
+    /** Dither level (0-1). */
     dither?: number;
 };
 export type FormatWebpOptions = FormatCommonOptions & {
+    /** Format type identifier. */
     type: 'webp';
+    /** Quality level (1-100). */
     quality?: number;
+    /** Force output format even if input is different. */
     force?: boolean;
+    /** Alpha channel quality (1-100). */
     alphaQuality?: number;
+    /** Use lossless encoding. */
     lossless?: boolean;
+    /** Use near-lossless encoding. */
     nearLossless?: boolean;
+    /** Enable smart subsample. */
     smartSubsample?: boolean;
+    /** Enable smart deblock. */
     smartDeblock?: boolean;
+    /** Compression effort (0-6). */
     effort?: number;
+    /** Optimize for minimum file size. */
     minSize?: boolean;
+    /** Use mixed encoding mode. */
     mixed?: boolean;
+    /** Preset for encoding. */
     preset?: 'default' | 'picture' | 'photo' | 'drawing' | 'icon' | 'text';
+    /** Number of animation loops. */
     loop?: number;
+    /** Animation frame delays. */
     delay?: number | number[];
 };
 export type FormatAvifOptions = FormatCommonOptions & {
+    /** Format type identifier. */
     type: 'avif';
+    /** Quality level (1-100). */
     quality?: number;
+    /** Force output format even if input is different. */
     force?: boolean;
+    /** Use lossless encoding. */
     lossless?: boolean;
+    /** Compression effort (0-9). */
     effort?: number;
+    /** Chroma subsampling format. */
     chromaSubsampling?: string;
+    /** Bit depth (8, 10, or 12 bits). */
     bitdepth?: 8 | 10 | 12;
 };
 export type FormatTiffOptions = FormatCommonOptions & {
+    /** Format type identifier. */
     type: 'tiff';
+    /** Quality level (1-100). */
     quality?: number;
+    /** Force output format even if input is different. */
     force?: boolean;
+    /** Compression method. */
     compression?: 'none' | 'jpeg' | 'deflate' | 'packbits' | 'ccittfax4' | 'lzw' | 'webp' | 'zstd' | 'jp2k';
+    /** Predictor for compression. */
     predictor?: 'none' | 'horizontal' | 'float';
+    /** Use pyramid structure. */
     pyramid?: boolean;
+    /** Use tiled structure. */
     tile?: boolean;
+    /** Tile width in pixels. */
     tileWidth?: number;
+    /** Tile height in pixels. */
     tileHeight?: number;
+    /** Horizontal resolution. */
     xres?: number;
+    /** Vertical resolution. */
     yres?: number;
+    /** Bit depth (1, 2, 4, or 8 bits). */
     bitdepth?: 1 | 2 | 4 | 8;
+    /** If `true`, minimum value is white. */
     miniswhite?: boolean;
+    /** Resolution unit. */
     resolutionUnit?: 'inch' | 'cm';
 };
 export type FormatHeifOptions = FormatCommonOptions & {
+    /** Format type identifier. */
     type: 'heif';
+    /** Quality level (1-100). */
     quality?: number;
+    /** Force output format even if input is different. */
     force?: boolean;
+    /** Compression codec. */
     compression?: 'av1' | 'hevc';
+    /** Use lossless encoding. */
     lossless?: boolean;
+    /** Compression effort (0-9). */
     effort?: number;
+    /** Chroma subsampling format. */
     chromaSubsampling?: string;
+    /** Bit depth (8, 10, or 12 bits). */
     bitdepth?: 8 | 10 | 12;
 };
+/** Union type representing all supported format options. */
 export type FormatOptions = FormatJpgOptions | FormatPngOptions | FormatWebpOptions | FormatAvifOptions | FormatTiffOptions | FormatHeifOptions | FormatCommonOptions;
+/** Enumeration of available image transformation operation names. */
 export declare enum OpName {
     BLUR = "blur",
     BRIGHTEN = "brighten",
@@ -118,73 +202,117 @@ export declare enum OpName {
     SATURATE = "saturate"
 }
 export type BlurOperationParams = {
+    /** Blur sigma value (standard deviation). */
     sigma: number;
 };
 export type BrightenOperationParams = {
+    /** Brightness factor. */
     factor: number;
 };
 export type ExtendOperationParams = {
+    /** Pixels to extend on the left side. */
     left?: number;
+    /** Pixels to extend on the right side. */
     right?: number;
+    /** Pixels to extend on the top side. */
     top?: number;
+    /** Pixels to extend on the bottom side. */
     bottom?: number;
+    /** Method to use for extending. */
     extendWith?: 'background' | 'copy' | 'repeat' | 'mirror';
+    /** Background color for extension. */
     background?: Color;
 };
 export type ExtractOperationParams = {
+    /** Left coordinate of the extraction region. */
     left: number;
+    /** Top coordinate of the extraction region. */
     top: number;
+    /** Width of the extraction region. */
     width: number;
+    /** Height of the extraction region. */
     height: number;
 };
 export type FlattenOperationParams = {
+    /** Background color for flattening. */
     background?: Color;
 };
 export type HueOperationParams = {
+    /** Hue rotation in degrees. */
     rotateDeg?: number;
 };
 export type LevelOperationParams = {
+    /** Multiplier for level adjustment. */
     multiplier?: number;
+    /** Offset for level adjustment. */
     offset?: number;
 };
 export type LightenOperationParams = {
+    /** Lightening amount. */
     amount?: number;
 };
 export type NormalizeOperationParams = {
+    /** Lower bound for normalization. */
     lower?: number;
+    /** Upper bound for normalization. */
     upper?: number;
 };
 export type OverlayOperationParams = {
+    /** Image to overlay. */
     input: ImageLike;
+    /** Top position for overlay. */
     top?: number;
+    /** Left position for overlay. */
     left?: number;
+    /** If `true`, tile the overlay image. */
     tile?: boolean;
+    /** If `true`, use premultiplied alpha. */
     premultiplied?: boolean;
+    /** Density for vector images. */
     density?: number;
+    /** If `true`, process animated images. */
     animated?: boolean;
+    /** If `true`, auto-orient the image. */
     autoOrient?: boolean;
+    /** If `true`, ignore ICC profile. */
     ignoreIcc?: boolean;
+    /** Number of pages to process. */
     pages?: number;
+    /** Specific page to process. */
     page?: number;
+    /** Blend mode for overlay. */
     blend?: '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';
+    /** Gravity for positioning the overlay. */
     gravity?: 'north' | 'northeast' | 'southeast' | 'south' | 'southwest' | 'west' | 'northwest' | 'east' | 'center' | 'centre';
 };
 export type ResizeOperationParams = {
+    /** Target width in pixels. */
     width?: number;
+    /** Target height in pixels. */
     height?: number;
+    /** How the image should be resized to fit the dimensions. */
     fit?: 'contain' | 'cover' | 'fill' | 'inside' | 'outside';
+    /** Position for the fit mode (gravity or coordinates). */
     position?: number | string;
+    /** Background color for areas not covered by the image. */
     background?: Color;
+    /** Interpolation kernel to use for resizing. */
     kernel?: 'nearest' | 'cubic' | 'linear' | 'mitchell' | 'lanczos2' | 'lanczos3' | 'mks2013' | 'mks2021';
+    /** If `true`, do not enlarge the image if dimensions are smaller. */
     withoutEnlargement?: boolean;
+    /** If `true`, do not reduce the image if dimensions are larger. */
     withoutReduction?: boolean;
+    /** If `true`, use fast shrink-on-load for JPEG images. */
     fastShrinkOnLoad?: boolean;
 };
 export type RotateOperationParams = {
+    /** Rotation angle in degrees. */
     angleDeg?: number;
+    /** Background color for areas revealed by rotation. */
     background?: Color;
 };
 export type SaturateOperationParams = {
+    /** Saturation level. */
     saturation?: number;
 };
 export type BlurOperationDescriptor = {
@@ -234,11 +362,16 @@ export type SaturateOperationDescriptor = {
 } & SaturateOperationParams;
 export type OperationDescriptor = BlurOperationDescriptor | BrightenOperationDescriptor | ExtendOperationDescriptor | ExtractOperationDescriptor | FlattenOperationDescriptor | FlipOperationDescriptor | FlopOperationDescriptor | HueOperationDescriptor | LevelOperationDescriptor | LightenOperationDescriptor | NormalizeOperationDescriptor | OverlayOperationDescriptor | ResizeOperationDescriptor | RotateOperationDescriptor | SaturateOperationDescriptor;
 export type TransformLimits = {
+    /** Maximum time allowed for the entire transformation process in milliseconds. */
     timeoutMs?: number;
+    /** Maximum time allowed for a single operation in milliseconds. */
     opTimeoutMs?: number;
+    /** Maximum allowed image width in pixels. */
     width?: number;
+    /** Maximum allowed image height in pixels. */
     height?: number;
 };
+/** Error codes for transformation operations. */
 export declare enum TransformErrCodes {
     PROCESS_TIMEOUT = "process-timeout",
     OP_TIMEOUT = "op-timeout",
@@ -247,6 +380,8 @@ export declare enum TransformErrCodes {
     UNKNOWN_ERROR = "unknown-error"
 }
 export type TransformErr = {
+    /** Error code indicating the type of error. */
     code: TransformErrCodes;
+    /** Human-readable error details. */
     details: string;
 };

package/node/images/types.js

@@ -1,8 +1,8 @@
 import {
   OpName,
   TransformErrCodes
-} from "../../chunks/chunk-FKDPPFHV.js";
-import "../../chunks/chunk-WSFCRVEQ.js";
+} from "../../chunks/chunk-5NTPCRFH.js";
+import "../../chunks/chunk-XCBH6NLF.js";
 export {
   OpName,
   TransformErrCodes

package/node/images/utils/index.d.ts

@@ -1,7 +1,27 @@
 import sharp from 'sharp';
 import type { Color } from '../../../agnostic/colors/types.js';
 import type { CreateOptions, ImageLike } from '../types.js';
+/** Converts a Color to Sharp RGBA format. */
 export declare function toSharpColor(color: Color): sharp.RGBA;
+/**
+ * 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 declare function isDuckTypedSharpInstance(obj: unknown): obj is sharp.Sharp;
+/** Converts CreateOptions to Sharp create options with defaults applied. */
 export declare function toCreateOptions(options: CreateOptions): sharp.SharpOptions['create'];
+/**
+ * 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 declare function toSharpInstance(imageLike: ImageLike, clone?: boolean): Promise<sharp.Sharp>;

package/node/images/utils/index.js

@@ -3,24 +3,14 @@ import {
   toCreateOptions,
   toSharpColor,
   toSharpInstance
-} from "../../../chunks/chunk-D5CCWCEI.js";
-import "../../../chunks/chunk-3KZNRSDD.js";
-import "../../../chunks/chunk-5CTAKAIP.js";
-import "../../../chunks/chunk-L7PIZQFC.js";
-import "../../../chunks/chunk-WSC3WODJ.js";
-import "../../../chunks/chunk-EGBJXHCW.js";
-import "../../../chunks/chunk-XPGAVZGK.js";
-import "../../../chunks/chunk-3LCD73SB.js";
-import "../../../chunks/chunk-MFIGSRSO.js";
-import "../../../chunks/chunk-YXLHZ2KW.js";
-import "../../../chunks/chunk-NCYE5WML.js";
-import "../../../chunks/chunk-FNQAF6CQ.js";
-import "../../../chunks/chunk-DNIOWD7K.js";
+} from "../../../chunks/chunk-ENOTZXFS.js";
+import "../../../chunks/chunk-2QDYPY2O.js";
 import "../../../chunks/chunk-OSAXBA7G.js";
-import "../../../chunks/chunk-67V4BGOB.js";
+import "../../../chunks/chunk-JDINERKY.js";
 import "../../../chunks/chunk-HQLRJ7XW.js";
-import "../../../chunks/chunk-7UGMWTP5.js";
-import "../../../chunks/chunk-WSFCRVEQ.js";
+import "../../../chunks/chunk-DNIOWD7K.js";
+import "../../../chunks/chunk-KRYJVBO5.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
 export {
   isDuckTypedSharpInstance,
   toCreateOptions,

package/node/process/on-exit/index.d.ts

@@ -1,5 +1,28 @@
+/** Events that trigger a forced exit of the process. */
 export declare const forceExitEvents: string[];
+/**
+ * Registers a callback to run before forced exit events (SIGINT, SIGTERM, uncaughtException).
+ *
+ * @param callback - Function to execute before forced exit. Can be async.
+ */
 export declare function beforeForcedExit(callback: () => void | Promise<void>): void;
+/**
+ * Registers a callback to run before the process exits normally.
+ *
+ * @param callback - Function to execute before exit. Can be async.
+ */
 export declare function beforeExit(callback: () => void | Promise<void>): void;
+/**
+ * Registers a callback to run when the process exits.
+ *
+ * @param callback - Function to execute on exit. Can be async.
+ */
 export declare function onExit(callback: () => void | Promise<void>): void;
+/**
+ * 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 declare function onAllExits(callback: () => void | Promise<void>): void;

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

@@ -1,11 +1,28 @@
-import {
-  beforeExit,
-  beforeForcedExit,
-  forceExitEvents,
-  onAllExits,
-  onExit
-} from "../../../chunks/chunk-LEXQ6E6L.js";
-import "../../../chunks/chunk-WSFCRVEQ.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
+
+// src/node/process/on-exit/index.ts
+var forceExitEvents = ["SIGINT", "SIGTERM", "uncaughtException"];
+function beforeForcedExit(callback) {
+  forceExitEvents.forEach((ev) => process.on(ev, callback));
+}
+function beforeExit(callback) {
+  process.on("beforeExit", callback);
+}
+function onExit(callback) {
+  process.on("exit", callback);
+}
+function onAllExits(callback) {
+  let alreadyCalled = false;
+  const actualCallback = () => {
+    if (!alreadyCalled) {
+      alreadyCalled = true;
+      callback();
+    }
+  };
+  beforeForcedExit(actualCallback);
+  beforeExit(actualCallback);
+  onExit(actualCallback);
+}
 export {
   beforeExit,
   beforeForcedExit,

package/node/process/prompt-continue/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 declare function promptContinue(message?: string, throws?: boolean): Promise<boolean>;