@design-edito/tools 0.1.54 → 0.1.56

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

@@ -1,9 +1,29 @@
 import sharp from "sharp";
+declare const OperationNames: {
+    readonly Rotate: "rotate";
+    readonly Resize: "resize";
+    readonly InnerResize: "inner-resize";
+    readonly Extract: "extract";
+    readonly Extend: "extend";
+    readonly AreaComposition: "area-composition";
+    readonly Composite: "composite";
+    readonly Flop: "flop";
+    readonly Flip: "flip";
+    readonly Blur: "blur";
+    readonly Flatten: "flatten";
+    readonly Normalise: "normalise";
+    readonly Brightness: "brightness";
+    readonly Saturation: "saturation";
+    readonly Hue: "hue";
+    readonly Lightness: "lightness";
+    readonly Modulate: "modulate";
+    readonly Linear: "linear";
+};
 export type RotateOperationParams = {
     angle: number;
 };
 export type RotateOperation = {
-    name: 'rotate';
+    name: typeof OperationNames.Rotate;
     params: RotateOperationParams;
 };
 export type ResizeOperationParams = {
@@ -12,19 +32,176 @@ export type ResizeOperationParams = {
     fit?: keyof sharp.FitEnum;
 };
 export type ResizeOperation = {
-    name: 'resize';
+    name: typeof OperationNames.Resize;
     params: ResizeOperationParams;
 };
+export type InnerResizeOperationParams = {
+    ratio: number;
+    background?: {
+        r: number;
+        g: number;
+        b: number;
+    } | string;
+};
+export type InnerResizeOperation = {
+    name: typeof OperationNames.InnerResize;
+    params: InnerResizeOperationParams;
+};
+export type ExtractOperationParams = {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+};
+export type ExtractOperation = {
+    name: typeof OperationNames.Extract;
+    params: ExtractOperationParams;
+};
+export type ExtendOperationParams = {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+    extendWith?: sharp.ExtendWith;
+    background?: {
+        r: number;
+        g: number;
+        b: number;
+    } | string;
+};
+export type ExtendOperation = {
+    name: typeof OperationNames.Extend;
+    params: ExtendOperationParams;
+};
 export type AreaCompositionOperationParams = Partial<{}>;
 export type AreaCompositionOperation = {
-    name: 'area-composition';
+    name: typeof OperationNames.AreaComposition;
     params: AreaCompositionOperationParams;
 };
-export type Operation = RotateOperation | ResizeOperation | AreaCompositionOperation;
+export type FlipOperationParams = {
+    flip?: boolean;
+};
+export type FlipOperation = {
+    name: typeof OperationNames.Flip;
+    params: FlipOperationParams;
+};
+export type FlopOperationParams = {
+    flop?: boolean;
+};
+export type FlopOperation = {
+    name: typeof OperationNames.Flop;
+    params: FlopOperationParams;
+};
+export type BlurOperationParams = {
+    sigma: number;
+};
+export type BlurOperation = {
+    name: typeof OperationNames.Blur;
+    params: BlurOperationParams;
+};
+export type FlattenOperationParams = {
+    background: {
+        r: number;
+        g: number;
+        b: number;
+    } | string;
+};
+export type FlattenOperation = {
+    name: typeof OperationNames.Flatten;
+    params: FlattenOperationParams;
+};
+export type NormaliseOperationParams = {
+    lower: number;
+    upper: number;
+};
+export type NormaliseOperation = {
+    name: typeof OperationNames.Normalise;
+    params: NormaliseOperationParams;
+};
+export type BrightnessOperationParams = {
+    brightness: number;
+};
+export type BrightnessOperation = {
+    name: typeof OperationNames.Brightness;
+    params: BrightnessOperationParams;
+};
+export type SaturationOperationParams = {
+    saturation: number;
+};
+export type SaturationOperation = {
+    name: typeof OperationNames.Saturation;
+    params: SaturationOperationParams;
+};
+export type HueOperationParams = {
+    hue: number;
+};
+export type HueOperation = {
+    name: typeof OperationNames.Hue;
+    params: HueOperationParams;
+};
+export type LightnessOperationParams = {
+    lightness: number;
+};
+export type LightnessOperation = {
+    name: typeof OperationNames.Lightness;
+    params: LightnessOperationParams;
+};
+export type ModulateOperationParams = {
+    brightness?: number;
+    lightness?: number;
+    hue?: number;
+    saturation?: number;
+};
+export type ModulateOperation = {
+    name: typeof OperationNames.Modulate;
+    params: ModulateOperationParams;
+};
+export type LinearOperationParams = {
+    multiplier: number | [number, number, number];
+    offset?: number | [number, number, number];
+};
+export type LinearOperation = {
+    name: typeof OperationNames.Linear;
+    params: LinearOperationParams;
+};
+export type CompositeOperationParamsOverlayFill = {
+    mode: 'fill';
+    channels?: sharp.Create['channels'];
+    background: sharp.Create['background'];
+};
+export type CompositeOperationParamsOverlayGradient = {
+    mode: 'gradient';
+    angle: number;
+    stops: {
+        color: string;
+        offset: number;
+    }[];
+};
+export type CompositeOperationParams = {
+    images: {
+        input: Buffer | {
+            overlay: {
+                width?: sharp.Create['width'];
+                height?: sharp.Create['height'];
+            } & (CompositeOperationParamsOverlayFill | CompositeOperationParamsOverlayGradient);
+        };
+        blend: sharp.Blend;
+        gravity: sharp.Gravity;
+        top?: number;
+        left?: number;
+        tile?: boolean;
+    }[];
+};
+export type CompositeOperation = {
+    name: typeof OperationNames.Composite;
+    params: CompositeOperationParams;
+};
+export type Operation = RotateOperation | InnerResizeOperation | ResizeOperation | ExtractOperation | AreaCompositionOperation | CompositeOperation | FlipOperation | FlopOperation | BlurOperation | BrightnessOperation | SaturationOperation | HueOperation | FlattenOperation | NormaliseOperation | ExtendOperation | LightnessOperation | ModulateOperation | LinearOperation;
 export type Operations = Operation[];
 export type Dimensions = {
     width: number;
     height: number;
 };
 export declare function transformImage(imageBuffer: Buffer, operations: Operations, maxDimensions: Dimensions): Promise<Buffer<ArrayBufferLike>>;
-export declare function isOperation(operation: any): boolean;
+export declare function isOperation(operation: unknown): operation is Operation;
+export {};

package/node/images/transform/index.js

@@ -1,14 +1,14 @@
 import {
   isOperation,
   transformImage
-} from "../../../chunks/chunk-VV72XGJJ.js";
-import "../../../chunks/chunk-422KBDRV.js";
+} from "../../../chunks/chunk-MV7CCO4Y.js";
+import "../../../chunks/chunk-XC2YGMNJ.js";
 import "../../../chunks/chunk-L7EUEQZP.js";
-import "../../../chunks/chunk-UVSTFYSD.js";
+import "../../../chunks/chunk-OPO25SDO.js";
 import "../../../chunks/chunk-X5FAZBWL.js";
-import "../../../chunks/chunk-BONBND7I.js";
-import "../../../chunks/chunk-7DDXALPH.js";
+import "../../../chunks/chunk-454MZ5UE.js";
 import "../../../chunks/chunk-JJWKHBXD.js";
+import "../../../chunks/chunk-7DDXALPH.js";
 import "../../../chunks/chunk-WSFCRVEQ.js";
 export {
   isOperation,

package/node/index.d.ts

@@ -1,8 +1,12 @@
+import * as AwsS3 from './@aws-s3';
 import * as DesignEdito from './@design-edito';
 import * as Express from './@express';
 import * as GoogleCloud from './@google-cloud';
+import * as CloudStorage from './cloud-storage';
 import * as Encryption from './encryption';
 import * as Files from './files';
+import * as Ftps from './ftps';
 import * as Images from './images';
 import * as Process from './process';
-export { DesignEdito, Express, GoogleCloud, Encryption, Files, Images, Process };
+import * as Sftp from './sftp';
+export { AwsS3, DesignEdito, Express, GoogleCloud, CloudStorage, Encryption, Files, Ftps, Images, Process, Sftp };

package/node/sftp/file/download/index.d.ts

@@ -0,0 +1,20 @@
+import { Readable } from 'node:stream';
+import { ReadStreamOptions } from 'ssh2';
+import Client from 'ssh2-sftp-client';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type DownloadOptions = ReadStreamOptions;
+/**
+ * Downloads a file from a specified SFTP server.
+ *
+ * This function downloads a file from the given SFTP server at the specified source path,
+ * returning the file content as a Readable stream. The download process can be customized
+ * using optional download options.
+ *
+ * @param {string} sourcePath - The path of the file to be downloaded from the SFTP server.
+ * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param {DownloadOptions} [options] - Optional settings for configuring the download process.
+ * @returns {Promise<Outcome.Either<Readable, string>>} A promise that resolves to an Outcome.Either.
+ * - On success: Outcome.makeSuccess(stream) containing the downloaded file's content as a Readable stream.
+ * - On failure: Outcome.makeFailure(errStr) with an error message if the download fails.
+ */
+export declare function download(sourcePath: string, sftp: Client, options?: DownloadOptions): Promise<Outcome.Either<Readable, string>>;

package/node/sftp/file/download/index.js

@@ -0,0 +1,9 @@
+import {
+  download
+} from "../../../../chunks/chunk-OD33BN4K.js";
+import "../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  download
+};

package/node/sftp/file/index.d.ts

@@ -0,0 +1,3 @@
+import * as Download from './download';
+import * as Upload from './upload';
+export { Download, Upload };

package/node/sftp/file/index.js

@@ -0,0 +1,14 @@
+import "../../../chunks/chunk-WDXNM5YB.js";
+import {
+  download_exports
+} from "../../../chunks/chunk-OD33BN4K.js";
+import {
+  upload_exports
+} from "../../../chunks/chunk-AZLVQV5A.js";
+import "../../../chunks/chunk-JMU5PDBD.js";
+import "../../../chunks/chunk-FENXVJYO.js";
+import "../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  download_exports as Download,
+  upload_exports as Upload
+};

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

@@ -0,0 +1,24 @@
+import { Readable } from 'node:stream';
+import Client, { TransferOptions } from 'ssh2-sftp-client';
+import { Outcome } from '~/agnostic/misc/outcome';
+export type UploadOptions = TransferOptions & {
+    ensureDir?: boolean;
+    overwrite?: boolean;
+};
+/**
+ * Uploads a file stream to a specified SFTP server.
+ *
+ * This function uploads the provided file stream to the given SFTP server at the specified target path.
+ * The upload process can be customized using optional upload options.
+ * If the `ensureDir` option is true, it ensures that the target directory exists before uploading.
+ * If the `overwrite` option is false and a file already exists at the target path, the upload is aborted.
+ *
+ * @param {Readable} fileStream - The file content to be uploaded.
+ * @param {string} targetPath - The target path where the file will be stored on the SFTP server.
+ * @param {Client} sftp - The ssh2-sftp-client instance used to interact with the SFTP server.
+ * @param {UploadOptions} [options] - Optional settings for configuring the upload process.
+ * @returns {Promise<Outcome.Either<true, string>>} A promise that resolves to an Outcome.Either.
+ * - On success: Outcome.makeSuccess(true) indicating the upload was successful.
+ * - On failure: Outcome.makeFailure(errStr) with an error message if the upload fails.
+ */
+export declare function upload(fileStream: Readable, targetPath: string, sftp: Client, options?: UploadOptions): Promise<Outcome.Either<true, string>>;

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

@@ -0,0 +1,9 @@
+import {
+  upload
+} from "../../../../chunks/chunk-AZLVQV5A.js";
+import "../../../../chunks/chunk-JMU5PDBD.js";
+import "../../../../chunks/chunk-FENXVJYO.js";
+import "../../../../chunks/chunk-WSFCRVEQ.js";
+export {
+  upload
+};

package/node/sftp/index.d.ts

@@ -0,0 +1,2 @@
+import * as File from './file';
+export { File };

package/node/sftp/index.js

@@ -0,0 +1,11 @@
+import {
+  file_exports
+} from "../../chunks/chunk-WDXNM5YB.js";
+import "../../chunks/chunk-OD33BN4K.js";
+import "../../chunks/chunk-AZLVQV5A.js";
+import "../../chunks/chunk-JMU5PDBD.js";
+import "../../chunks/chunk-FENXVJYO.js";
+import "../../chunks/chunk-WSFCRVEQ.js";
+export {
+  file_exports as File
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@design-edito/tools",
-  "version": "0.1.54",
+  "version": "0.1.56",
   "description": "",
   "author": "Maxime Fabas",
   "license": "ISC",
@@ -14,30 +14,35 @@
   "peerDependencies": {
     "@google-cloud/storage": "^7.15.2",
     "archiver": "^7.0.1",
+    "aws-sdk": "^2.1692.0",
+    "basic-ftp": "^5.0.5",
     "chalk": "^5.4.1",
-    "express": "^4.21.2",
+    "express": "^5.1.0",
     "multer": "^1.4.5-lts.2",
+    "puppeteer": "^24.5.0",
     "quantize": "^1.0.2",
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0",
-    "sharp": "^0.33.5"
+    "react": "^19.1.0",
+    "react-dom": "^19.1.0",
+    "sharp": "^0.33.5",
+    "ssh2-sftp-client": "^12.0.0"
   },
   "devDependencies": {
     "@types/archiver": "^6.0.3",
     "@types/express": "^5.0.1",
     "@types/multer": "^1.4.12",
-    "@types/node": "^22.13.10",
+    "@types/node": "^22.13.16",
     "@types/prompts": "^2.4.9",
     "@types/quantize": "^1.0.2",
-    "@types/react": "^19.0.11",
+    "@types/react": "^19.0.12",
     "@types/react-dom": "^19.0.4",
-    "@types/semver": "^7.5.8",
+    "@types/semver": "^7.7.0",
     "@types/sharp": "^0.31.1",
+    "@types/ssh2-sftp-client": "^9.0.4",
     "chokidar-cli": "^3.0.0",
     "concurrently": "^9.1.2",
-    "esbuild": "^0.25.1",
+    "esbuild": "^0.25.2",
     "prompts": "^2.4.2",
-    "puppeteer": "^23.6.0",
+    "puppeteer": "24.5.0",
     "semver": "^7.7.1",
     "simple-git": "^3.27.0",
     "typescript": "^5.8.2"