Merge pull request #238 from dharamghevariya/feature-auto-pad-crop-mode

feat: Add support for `auto_pad` cropping mode

Author: eportis-cloudinary

packages/url-loader/src/constants/parameters.ts

@@ -6,6 +6,7 @@ import type { StringifiablePrimative } from "../lib/utils.js";
  */
 export type CropMode =
   | "auto"
+  | "auto_pad"
   | "crop"
   | "fill"
   | "fill_pad"

packages/url-loader/src/plugins/cropping.ts

@@ -13,8 +13,8 @@ import { plugin } from "../lib/plugin.js";
 import { isArray } from "../lib/utils.js";
 import type { PluginResults } from "../types/plugins.js";
 
-const cropsAspectRatio = ["auto", "crop", "fill", "lfill", "fill_pad", "thumb"];
-const cropsGravityAuto = ["auto", "crop", "fill", "lfill", "fill_pad", "thumb"];
+const cropsAspectRatio = ["auto", "auto_pad", "crop", "fill", "lfill", "fill_pad", "thumb"];
+const cropsGravityAuto = ["auto", "auto_pad", "crop", "fill", "lfill", "fill_pad", "thumb"];
 const cropsWithZoom = ["crop", "thumb"];
 
 const DEFAULT_CROP = "limit";

packages/url-loader/tests/plugins/cropping.spec.ts

@@ -411,4 +411,60 @@ describe("Cropping plugin", () => {
       `image/upload/c_${options.crop.type},w_${options.width},h_${options.height},x_${options.crop.x},y_${options.crop.y}`,
     );
   });
+
+  it("should apply auto_pad crop mode with explicit gravity auto", () => {
+    const cldImage = cld.image(TEST_PUBLIC_ID);
+    const options = {
+      src: TEST_PUBLIC_ID,
+      width: 960,
+      aspectRatio: "16:9",
+      crop: "auto_pad",
+      gravity: "auto",
+    } as const;
+    const result = CroppingPlugin.apply(cldImage, options);
+
+    if (result.options?.resize === undefined)
+      throw new Error(`Expected result.options.resize to not be undefined`);
+
+    expect(result.options?.resize).toBe(
+      `c_auto_pad,ar_16:9,w_960,g_auto`,
+    );
+  });
+
+  it("should apply auto_pad crop mode with auto gravity by default", () => {
+    const cldImage = cld.image(TEST_PUBLIC_ID);
+    const options = {
+      src: TEST_PUBLIC_ID,
+      width: 960,
+      aspectRatio: "16:9",
+      crop: "auto_pad",
+    } as const;
+    const result = CroppingPlugin.apply(cldImage, options);
+
+    if (result.options?.resize === undefined)
+      throw new Error(`Expected result.options.resize to not be undefined`);
+
+    expect(result.options?.resize).toBe(
+      `c_auto_pad,ar_16:9,w_960,g_auto`,
+    );
+  });
+
+  it("should apply auto_pad crop mode with width and height", () => {
+    const cldImage = cld.image(TEST_PUBLIC_ID);
+    const options = {
+      src: TEST_PUBLIC_ID,
+      width: 960,
+      height: 540,
+      crop: "auto_pad",
+      gravity: "auto",
+    } as const;
+    const result = CroppingPlugin.apply(cldImage, options);
+
+    if (result.options?.resize === undefined)
+      throw new Error(`Expected result.options.resize to not be undefined`);
+
+    expect(result.options?.resize).toBe(
+      `c_auto_pad,w_960,h_540,g_auto`,
+    );
+  });
 });