@design-edito/tools 0.2.39 → 0.2.41

package/node/ftps/file/upload/index.d.ts

@@ -1,6 +1,6 @@
 import { Readable } from 'node:stream';
 import { Client, UploadOptions as BasicFtpUploadOptions } from 'basic-ftp';
-import { Outcome } from '../../../../agnostic/misc/outcome/index.js';
+import * as Outcome from '../../../../agnostic/misc/outcome/index.js';
 export type UploadOptions = BasicFtpUploadOptions & {
     ensureDir?: boolean;
     overwrite?: boolean;

package/node/ftps/file/upload/index.js

@@ -1,9 +1,9 @@
 import {
   upload
-} from "../../../../chunks/chunk-CVDCTI7F.js";
-import "../../../../chunks/chunk-JMU5PDBD.js";
+} from "../../../../chunks/chunk-AOEOW5XW.js";
+import "../../../../chunks/chunk-QEKI6WGQ.js";
 import "../../../../chunks/chunk-FENXVJYO.js";
-import "../../../../chunks/chunk-WSFCRVEQ.js";
+import "../../../../chunks/chunk-XCBH6NLF.js";
 export {
   upload
 };

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

@@ -1,3 +1,9 @@
 import sharp from 'sharp';
 import type { CreateOptions } from '../types.js';
+/**
+ * Creates a new image using Sharp with the specified options.
+ *
+ * @param options - Image creation options. See `CreateOptions` for details.
+ * @returns A Sharp instance ready for further image operations.
+ */
 export declare function create(options: CreateOptions): Promise<sharp.Sharp>;

package/node/images/create/index.js

@@ -1,24 +1,19 @@
 import {
-  create
-} from "../../../chunks/chunk-PVRYR5KX.js";
-import "../../../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";
+  toCreateOptions
+} from "../../../chunks/chunk-6KOJFWH3.js";
+import "../../../chunks/chunk-RNXRHCHQ.js";
 import "../../../chunks/chunk-DNIOWD7K.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-KRYJVBO5.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
+
+// src/node/images/create/index.ts
+import sharp from "sharp";
+async function create(options) {
+  return sharp({ create: toCreateOptions(options) });
+}
 export {
   create
 };

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

@@ -1,27 +1,62 @@
 import sharp from 'sharp';
-import { Outcome } from '../../../agnostic/misc/outcome/index.js';
+import * as Outcome from '../../../agnostic/misc/outcome/index.js';
 import type { FormatCommonOptions, FormatJpgOptions, FormatPngOptions, FormatWebpOptions, FormatAvifOptions, FormatTiffOptions, FormatHeifOptions, FormatOptions, ImageLike } from '../types.js';
+/** Type guard to check if options match FormatCommonOptions. */
 export declare const isFormatCommonOptions: (options: unknown) => options is FormatCommonOptions;
+/** Type guard to check if options match FormatJpgOptions. */
 export declare const isFormatJpgOptions: (options: unknown) => options is FormatJpgOptions;
+/** Type guard to check if options match FormatPngOptions. */
 export declare const isFormatPngOptions: (options: unknown) => options is FormatPngOptions;
+/** Type guard to check if options match FormatWebpOptions. */
 export declare const isFormatWebpOptions: (options: unknown) => options is FormatWebpOptions;
+/** Type guard to check if options match FormatAvifOptions. */
 export declare const isFormatAvifOptions: (options: unknown) => options is FormatAvifOptions;
+/** Type guard to check if options match FormatTiffOptions. */
 export declare const isFormatTiffOptions: (options: unknown) => options is FormatTiffOptions;
+/** Type guard to check if options match FormatHeifOptions. */
 export declare const isFormatHeifOptions: (options: unknown) => options is FormatHeifOptions;
+/** Type guard to check if options match FormatOptions. */
 export declare const isFormatOptions: (options: unknown) => options is FormatOptions;
+/** Converts FormatCommonOptions to Sharp resize options. */
 export declare const toSharpResizeOptions: (options: FormatCommonOptions) => sharp.ResizeOptions;
+/** Converts FormatJpgOptions to Sharp JPEG options. */
 export declare const toSharpJpegOptions: (options: FormatJpgOptions) => sharp.JpegOptions;
+/** Converts FormatPngOptions to Sharp PNG options. */
 export declare const toSharpPngOptions: (options: FormatPngOptions) => sharp.PngOptions;
+/** Converts FormatWebpOptions to Sharp WebP options. */
 export declare const toSharpWebpOptions: (options: FormatWebpOptions) => sharp.WebpOptions;
+/** Converts FormatAvifOptions to Sharp AVIF options. */
 export declare const toSharpAvifOptions: (options: FormatAvifOptions) => sharp.AvifOptions;
+/** Converts FormatTiffOptions to Sharp TIFF options. */
 export declare const toSharpTiffOptions: (options: FormatTiffOptions) => sharp.TiffOptions;
+/** Converts FormatHeifOptions to Sharp HEIF options. */
 export declare const toSharpHeifOptions: (options: FormatHeifOptions) => sharp.HeifOptions;
+/**
+ * Formats an image with the specified options.
+ *
+ * The function resizes and converts the image to the specified format (JPG, PNG, WebP,
+ * AVIF, TIFF, HEIF, or keeps the original format) based on the provided options.
+ *
+ * @param input - The image to format. Can be a Sharp instance, Buffer, CreateOptions, or file path.
+ * @param options - Format and resize options. See `FormatOptions` for details.
+ * @returns
+ * - On success:  `Outcome.makeSuccess(buffer)` containing the formatted image.
+ * - On failure:  `Outcome.makeFailure(errStr)`.
+ */
 export declare function format(input: ImageLike, options: FormatOptions): Promise<Outcome.Either<Buffer, string>>;
+/** Resizes an image to a specific width while maintaining aspect ratio. */
 export declare const toWidth: (input: ImageLike, width: number) => Promise<Buffer>;
+/** Resizes an image to a specific height while maintaining aspect ratio. */
 export declare const toHeight: (input: ImageLike, height: number) => Promise<Buffer>;
+/** Converts an image to JPEG format. */
 export declare const toJpg: (input: ImageLike, quality?: number) => Promise<Buffer>;
+/** Converts an image to PNG format. */
 export declare const toPng: (input: ImageLike, quality?: number, compressionLevel?: FormatPngOptions["compressionLevel"]) => Promise<Buffer>;
+/** Converts an image to WebP format. */
 export declare const toWebp: (input: ImageLike, quality?: number) => Promise<Buffer>;
+/** Converts an image to AVIF format. */
 export declare const toAvif: (input: ImageLike, quality?: number) => Promise<Buffer>;
+/** Converts an image to TIFF format. */
 export declare const toTiff: (input: ImageLike, quality?: number, compression?: FormatTiffOptions["compression"]) => Promise<Buffer>;
+/** Converts an image to HEIF format. */
 export declare const toHeif: (input: ImageLike, quality?: number) => Promise<Buffer>;

package/node/images/format/index.js

@@ -1,49 +1,246 @@
 import {
-  format,
-  isFormatAvifOptions,
-  isFormatCommonOptions,
-  isFormatHeifOptions,
-  isFormatJpgOptions,
-  isFormatOptions,
-  isFormatPngOptions,
-  isFormatTiffOptions,
-  isFormatWebpOptions,
-  toAvif,
-  toHeif,
-  toHeight,
-  toJpg,
-  toPng,
-  toSharpAvifOptions,
-  toSharpHeifOptions,
-  toSharpJpegOptions,
-  toSharpPngOptions,
-  toSharpResizeOptions,
-  toSharpTiffOptions,
-  toSharpWebpOptions,
-  toTiff,
-  toWebp,
-  toWidth
-} from "../../../chunks/chunk-DKITT7OT.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";
+  toSharpColor,
+  toSharpInstance
+} from "../../../chunks/chunk-6KOJFWH3.js";
+import {
+  zod_default
+} from "../../../chunks/chunk-LFHDJTZJ.js";
+import {
+  makeSuccess
+} from "../../../chunks/chunk-QEKI6WGQ.js";
+import "../../../chunks/chunk-RNXRHCHQ.js";
 import "../../../chunks/chunk-DNIOWD7K.js";
-import "../../../chunks/chunk-OSAXBA7G.js";
-import "../../../chunks/chunk-67V4BGOB.js";
+import {
+  clamp
+} from "../../../chunks/chunk-OSAXBA7G.js";
+import {
+  isColor
+} from "../../../chunks/chunk-JDINERKY.js";
 import "../../../chunks/chunk-HQLRJ7XW.js";
-import "../../../chunks/chunk-7UGMWTP5.js";
-import "../../../chunks/chunk-WSFCRVEQ.js";
+import "../../../chunks/chunk-KRYJVBO5.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
+
+// src/node/images/format/index.ts
+var formatCommonOptionsSchema = zod_default.object({
+  width: zod_default.number().optional(),
+  height: zod_default.number().optional(),
+  fit: zod_default.enum(["contain", "cover", "fill", "inside", "outside"]).optional(),
+  position: zod_default.union([zod_default.number(), zod_default.string()]).optional(),
+  background: zod_default.custom(isColor).optional(),
+  kernel: zod_default.enum(["nearest", "cubic", "mitchell", "lanczos2", "lanczos3", "mks2013", "mks2021"]).optional(),
+  withoutEnlargement: zod_default.boolean().optional(),
+  withoutReduction: zod_default.boolean().optional(),
+  fastShrinkOnLoad: zod_default.boolean().optional()
+});
+var formatJpgOptionsSchema = formatCommonOptionsSchema.extend({
+  type: zod_default.union([zod_default.literal("jpg"), zod_default.literal("jpeg")]),
+  quality: zod_default.number().optional(),
+  force: zod_default.boolean().optional(),
+  progressive: zod_default.boolean().optional(),
+  chromaSubsampling: zod_default.string().optional(),
+  trellisQuantisation: zod_default.boolean().optional(),
+  overshootDeringing: zod_default.boolean().optional(),
+  optimizeScans: zod_default.boolean().optional(),
+  optimizeCoding: zod_default.boolean().optional(),
+  quantizationTable: zod_default.number().optional(),
+  mozjpeg: zod_default.boolean().optional()
+});
+var formatPngOptionsSchema = formatCommonOptionsSchema.extend({
+  type: zod_default.literal("png"),
+  quality: zod_default.number().optional(),
+  force: zod_default.boolean().optional(),
+  progressive: zod_default.boolean().optional(),
+  compressionLevel: zod_default.number().min(0).max(9).optional(),
+  adaptiveFiltering: zod_default.boolean().optional(),
+  effort: zod_default.number().min(1).max(10).optional(),
+  palette: zod_default.boolean().optional(),
+  colors: zod_default.number().min(1).max(256).optional(),
+  dither: zod_default.number().min(0).max(1).optional()
+});
+var formatWebpOptionsSchema = formatCommonOptionsSchema.extend({
+  type: zod_default.literal("webp"),
+  quality: zod_default.number().optional(),
+  force: zod_default.boolean().optional(),
+  alphaQuality: zod_default.number().optional(),
+  lossless: zod_default.boolean().optional(),
+  nearLossless: zod_default.boolean().optional(),
+  smartSubsample: zod_default.boolean().optional(),
+  smartDeblock: zod_default.boolean().optional(),
+  effort: zod_default.number().optional(),
+  minSize: zod_default.boolean().optional(),
+  mixed: zod_default.boolean().optional(),
+  preset: zod_default.enum(["default", "picture", "photo", "drawing", "icon", "text"]).optional(),
+  loop: zod_default.number().optional(),
+  delay: zod_default.union([zod_default.number(), zod_default.array(zod_default.number())]).optional()
+});
+var formatAvifOptionsSchema = formatCommonOptionsSchema.extend({
+  type: zod_default.literal("avif"),
+  quality: zod_default.number().optional(),
+  force: zod_default.boolean().optional(),
+  lossless: zod_default.boolean().optional(),
+  effort: zod_default.number().optional(),
+  chromaSubsampling: zod_default.string().optional(),
+  bitdepth: zod_default.union([zod_default.literal(8), zod_default.literal(10), zod_default.literal(12)]).optional()
+});
+var formatTiffOptionsSchema = formatCommonOptionsSchema.extend({
+  type: zod_default.literal("tiff"),
+  quality: zod_default.number().optional(),
+  compression: zod_default.enum(["none", "jpeg", "deflate", "packbits", "ccittfax4", "lzw", "webp", "zstd", "jp2k"]).optional(),
+  force: zod_default.boolean().optional(),
+  predictor: zod_default.enum(["none", "horizontal", "float"]).optional(),
+  pyramid: zod_default.boolean().optional(),
+  tile: zod_default.boolean().optional(),
+  tileWidth: zod_default.number().optional(),
+  tileHeight: zod_default.number().optional(),
+  xres: zod_default.number().optional(),
+  yres: zod_default.number().optional(),
+  bitdepth: zod_default.union([zod_default.literal(1), zod_default.literal(2), zod_default.literal(4), zod_default.literal(8)]).optional(),
+  miniswhite: zod_default.boolean().optional(),
+  resolutionUnit: zod_default.enum(["inch", "cm"]).optional()
+});
+var formatHeifOptionsSchema = formatCommonOptionsSchema.extend({
+  type: zod_default.literal("heif"),
+  quality: zod_default.number().optional(),
+  force: zod_default.boolean().optional(),
+  compression: zod_default.enum(["av1", "hevc"]).optional(),
+  lossless: zod_default.boolean().optional(),
+  effort: zod_default.number().optional(),
+  chromaSubsampling: zod_default.string().optional(),
+  bitdepth: zod_default.union([zod_default.literal(8), zod_default.literal(10), zod_default.literal(12)]).optional()
+});
+var formatKeepOptionsSchema = formatCommonOptionsSchema;
+var formatOptionsSchema = zod_default.union([
+  formatJpgOptionsSchema,
+  formatPngOptionsSchema,
+  formatWebpOptionsSchema,
+  formatAvifOptionsSchema,
+  formatTiffOptionsSchema,
+  formatHeifOptionsSchema,
+  formatKeepOptionsSchema
+]);
+var isFormatCommonOptions = (options) => formatCommonOptionsSchema.safeParse(options).success;
+var isFormatJpgOptions = (options) => formatJpgOptionsSchema.safeParse(options).success;
+var isFormatPngOptions = (options) => formatPngOptionsSchema.safeParse(options).success;
+var isFormatWebpOptions = (options) => formatWebpOptionsSchema.safeParse(options).success;
+var isFormatAvifOptions = (options) => formatAvifOptionsSchema.safeParse(options).success;
+var isFormatTiffOptions = (options) => formatTiffOptionsSchema.safeParse(options).success;
+var isFormatHeifOptions = (options) => formatHeifOptionsSchema.safeParse(options).success;
+var isFormatOptions = (options) => formatOptionsSchema.safeParse(options).success;
+var toSharpResizeOptions = (options) => {
+  return {
+    width: options.width,
+    height: options.height,
+    fit: options.fit,
+    position: options.position,
+    background: options.background ? toSharpColor(options.background) : void 0,
+    kernel: options.kernel,
+    withoutEnlargement: options.withoutEnlargement,
+    withoutReduction: options.withoutReduction,
+    fastShrinkOnLoad: options.fastShrinkOnLoad
+  };
+};
+var toSharpJpegOptions = (options) => {
+  return {
+    quality: options.quality,
+    force: options.force,
+    progressive: options.progressive,
+    chromaSubsampling: options.chromaSubsampling,
+    trellisQuantisation: options.trellisQuantisation,
+    overshootDeringing: options.overshootDeringing,
+    optimizeScans: options.optimizeScans,
+    optimizeCoding: options.optimizeCoding,
+    quantizationTable: options.quantizationTable,
+    mozjpeg: options.mozjpeg
+  };
+};
+var toSharpPngOptions = (options) => {
+  return {
+    quality: options.quality,
+    force: options.force,
+    progressive: options.progressive,
+    compressionLevel: options.compressionLevel,
+    adaptiveFiltering: options.adaptiveFiltering,
+    effort: options.effort,
+    palette: options.palette,
+    colors: options.colors,
+    dither: options.dither
+  };
+};
+var toSharpWebpOptions = (options) => {
+  return {
+    quality: options.quality,
+    loop: options.loop,
+    delay: options.delay,
+    force: options.force,
+    alphaQuality: options.alphaQuality,
+    lossless: options.lossless,
+    nearLossless: options.nearLossless,
+    smartSubsample: options.smartSubsample,
+    smartDeblock: options.smartDeblock,
+    effort: options.effort,
+    minSize: options.minSize,
+    mixed: options.mixed,
+    preset: options.preset
+  };
+};
+var toSharpAvifOptions = (options) => {
+  return {
+    force: options.force,
+    quality: options.quality,
+    lossless: options.lossless,
+    effort: options.effort,
+    chromaSubsampling: options.chromaSubsampling,
+    bitdepth: options.bitdepth
+  };
+};
+var toSharpTiffOptions = (options) => {
+  return {
+    force: options.force,
+    quality: options.quality,
+    compression: options.compression,
+    predictor: options.predictor,
+    pyramid: options.pyramid,
+    tile: options.tile,
+    tileWidth: options.tileWidth,
+    tileHeight: options.tileHeight,
+    xres: options.xres,
+    yres: options.yres,
+    bitdepth: options.bitdepth,
+    miniswhite: options.miniswhite,
+    resolutionUnit: options.resolutionUnit
+  };
+};
+var toSharpHeifOptions = (options) => {
+  return {
+    force: options.force,
+    quality: options.quality,
+    compression: options.compression,
+    lossless: options.lossless,
+    effort: options.effort,
+    chromaSubsampling: options.chromaSubsampling,
+    bitdepth: options.bitdepth
+  };
+};
+async function format(input, options) {
+  const sharpInstance = await toSharpInstance(input);
+  const resizeOptions = toSharpResizeOptions(options);
+  const resizedInstance = sharpInstance.resize(resizeOptions);
+  if (isFormatJpgOptions(options)) return makeSuccess(await resizedInstance.jpeg(toSharpJpegOptions(options)).toBuffer());
+  if (isFormatPngOptions(options)) return makeSuccess(await resizedInstance.png(toSharpPngOptions(options)).toBuffer());
+  if (isFormatWebpOptions(options)) return makeSuccess(await resizedInstance.webp(toSharpWebpOptions(options)).toBuffer());
+  if (isFormatAvifOptions(options)) return makeSuccess(await resizedInstance.avif(toSharpAvifOptions(options)).toBuffer());
+  if (isFormatTiffOptions(options)) return makeSuccess(await resizedInstance.tiff(toSharpTiffOptions(options)).toBuffer());
+  if (isFormatHeifOptions(options)) return makeSuccess(await resizedInstance.heif(toSharpHeifOptions(options)).toBuffer());
+  return makeSuccess(await resizedInstance.toBuffer());
+}
+var toWidth = async (input, width) => (await toSharpInstance(input)).resize({ width }).toBuffer();
+var toHeight = async (input, height) => (await toSharpInstance(input)).resize({ height }).toBuffer();
+var toJpg = async (input, quality) => (await toSharpInstance(input)).jpeg({ quality: clamp(quality ?? 100, 1, 100) }).toBuffer();
+var toPng = async (input, quality, compressionLevel) => (await toSharpInstance(input)).png({ quality: clamp(quality ?? 100, 1, 100), compressionLevel }).toBuffer();
+var toWebp = async (input, quality) => (await toSharpInstance(input)).webp({ quality: clamp(quality ?? 100, 1, 100) }).toBuffer();
+var toAvif = async (input, quality) => (await toSharpInstance(input)).avif({ quality: clamp(quality ?? 100, 1, 100) }).toBuffer();
+var toTiff = async (input, quality, compression) => (await toSharpInstance(input)).tiff({ quality: clamp(quality ?? 100, 1, 100), compression }).toBuffer();
+var toHeif = async (input, quality) => (await toSharpInstance(input)).heif({ quality: clamp(quality ?? 100, 1, 100) }).toBuffer();
 export {
   format,
   isFormatAvifOptions,

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

@@ -1,3 +1,9 @@
 import sharp from 'sharp';
 import type { ImageLike } from '../types.js';
+/**
+ * Retrieves metadata from an image.
+ *
+ * @param imageInput - The image to get metadata from. Can be a Sharp instance, Buffer, CreateOptions, or file path.
+ * @returns Image metadata including dimensions, format, color space, and other properties.
+ */
 export declare function metadata(imageInput: ImageLike): Promise<sharp.Metadata>;

package/node/images/metadata/index.js

@@ -1,24 +1,19 @@
 import {
-  metadata
-} from "../../../chunks/chunk-ZLBSI4TR.js";
-import "../../../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";
+  toSharpInstance
+} from "../../../chunks/chunk-6KOJFWH3.js";
+import "../../../chunks/chunk-RNXRHCHQ.js";
 import "../../../chunks/chunk-DNIOWD7K.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-KRYJVBO5.js";
+import "../../../chunks/chunk-XCBH6NLF.js";
+
+// src/node/images/metadata/index.ts
+async function metadata(imageInput) {
+  const sharpInstance = await toSharpInstance(imageInput);
+  return sharpInstance.metadata();
+}
 export {
   metadata
 };

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

@@ -1,5 +1,27 @@
 import sharp from 'sharp';
-import { Outcome } from '../../../agnostic/misc/outcome/index.js';
+import * as Outcome from '../../../agnostic/misc/outcome/index.js';
 import { OperationDescriptor, TransformLimits, TransformErr, ImageLike } from '../types.js';
+/**
+ * Validates and checks if an object is a valid operation descriptor.
+ *
+ * @param obj - The object to validate.
+ * @returns
+ * - On success:  `Outcome.makeSuccess(descriptor)` with the validated operation descriptor.
+ * - On failure:  `Outcome.makeFailure(errStr)` describing the validation error.
+ */
 export declare function isOperationDescriptor(obj: unknown): Outcome.Either<OperationDescriptor, string>;
+/**
+ * Applies a sequence of transformations to an image.
+ *
+ * The function processes operations in order, applying each transformation to the image.
+ * Supports timeout limits for both individual operations and the entire process, as well
+ * as dimension limits to prevent excessive memory usage.
+ *
+ * @param input - The image to transform. Can be a Sharp instance, Buffer, CreateOptions, or file path.
+ * @param operationsSequence - Array of operation descriptors to apply in sequence.
+ * @param [limits] - Optional limits for timeouts and dimensions. See `TransformLimits` for details.
+ * @returns
+ * - On success:  `Outcome.makeSuccess(sharpInstance)` with the transformed Sharp instance.
+ * - On failure:  `Outcome.makeFailure(error)` with error code and details.
+ */
 export declare function transform(input: ImageLike, operationsSequence: OperationDescriptor[], limits?: TransformLimits): Promise<Outcome.Either<sharp.Sharp, TransformErr>>;