Feature/support string gravity (#487)

Author: Nir Maoz

__TESTS_BUNDLE_SIZE__/bundleSizeTestCases.ts

@@ -56,7 +56,7 @@ const bundleSizeTestCases:ITestCase[] = [
   },
   {
     name: 'Tests Overlay imports',
-    sizeLimitInKB: 22,
+    sizeLimitInKB: 23,
     importsArray: [
       importFromDist('assets/CloudinaryImage', 'CloudinaryImage'),
       importFromDist('actions/overlay', 'Overlay'),

__TESTS__/unit/toJson/resize.toJson.test.ts

@@ -2,8 +2,9 @@ import {Transformation} from '../../../src';
 import {Resize} from "../../../src/actions";
 import {AspectRatio, Background, GradientDirection} from "../../../src/qualifiers";
 import {Gravity} from "../../../src/qualifiers";
-import {FocusOn} from "../../../src/qualifiers/focusOn";
+import {face, FocusOn} from "../../../src/qualifiers/focusOn";
 import {AutoFocus} from "../../../src/qualifiers/autoFocus";
+import {autoGravity} from "../../../src/qualifiers/gravity";
 
 describe('resize.toJson()', () => {
   it('scale', () => {
@@ -160,11 +161,33 @@ describe('resize.toJson()', () => {
     ]);
   });
 
+  it('should generate auto gravity model', () => {
+    const transformation = new Transformation()
+      .addAction(Resize.fill().width(100).height(100).gravity(autoGravity().autoFocus(AutoFocus.focusOn(face())))
+      );
+
+    const model = transformation.toJson();
+
+    expect(model).toStrictEqual([
+      {
+        actionType: "fill",
+        dimensions: {width: 100, height: 100},
+        gravity: {
+          gravityType: 'auto',
+          autoFocus: [
+            {object: "face"}
+          ]
+        }
+      }
+    ]);
+  });
+
   it('should generate auto gravity model', () => {
     const transformation = new Transformation()
       .addAction(Resize.crop(200).gravity(Gravity.autoGravity().autoFocus(
         AutoFocus.focusOn(FocusOn.person()).weight(100),
-        AutoFocus.focusOn(FocusOn.cat()).weight(50).avoid()
+        AutoFocus.focusOn(FocusOn.cat()).weight(50).avoid(),
+        AutoFocus.focusOn(FocusOn.face()).weight(50).avoid()
       )));
 
     const model = transformation.toJson();
@@ -177,7 +200,8 @@ describe('resize.toJson()', () => {
           gravityType: 'auto',
           autoFocus: [
             {object: "person", weight: 100},
-            {object: "cat", avoid: true}
+            {object: "cat", avoid: true},
+            {object: "face", avoid: true}
           ]
         }
       }
@@ -363,4 +387,36 @@ describe('resize.toJson()', () => {
     ]);
   });
 
+  it('should generate gravity model for string', () => {
+    const transformation = new Transformation()
+      .addAction(Resize.fill(200).gravity('face'))
+      .addAction(Resize.fill(200).gravity('auto:face'));
+
+    const model = transformation.toJson();
+
+    expect(model).toStrictEqual([
+      {
+        actionType: "fill",
+        dimensions: {
+          width: 200
+        },
+        gravity: {
+          focusOnObjects: ["face"],
+          gravityType: "object"
+        }
+      },
+      {
+        actionType: "fill",
+        dimensions: {
+          width: 200,
+        },
+        gravity: {
+          gravityType: 'auto',
+          autoFocus: [
+            {object: "face"}
+          ]
+        }
+      }
+    ]);
+  });
 });

src/internal/models/createGravityModel.ts

@@ -4,6 +4,9 @@ import {AutoGravity} from "../../qualifiers/gravity/autoGravity/AutoGravity.js";
 import {AutoFocus} from "../../qualifiers/autoFocus.js";
 import {FocusOnGravity} from "../../qualifiers/gravity/focusOnGravity/FocusOnGravity.js";
 import {autoGravity} from "../../qualifiers/gravity.js";
+import {FocusOnValue} from "../../qualifiers/focusOn.js";
+
+type IAutoGravityString = 'auto' | 'auto:';
 
 export interface IGravityModel {
   gravityType: string;
@@ -31,6 +34,14 @@ export interface IFocusOnGravityModel extends IGravityModel {
   fallbackGravity?: IAutoGravityModel
 }
 
+/**
+ * true if gravity starts with 'auto' or 'auto:'
+ * @param gravity
+ */
+function isIAutoGravityString(gravity: unknown): gravity is IAutoGravityString {
+  return gravity && `${gravity}`.split(':')[0] === 'auto';
+}
+
 /**
  * Validate that given val is an ICompassGravity
  * @param gravity
@@ -111,9 +122,16 @@ function createIAutoFocusObject(gravity: AutoFocus): IAutoGravityObjectModel {
  * Creates an auto gravity model from given AutoGravity
  * @param gravity
  */
-function createAutoGravityModel(gravity: 'auto' | AutoGravity): IAutoGravityModel {
-  const gravityQualifier = gravity === 'auto' ? new AutoGravity() : gravity;
-  const values = gravityQualifier.qualifierValue.values.filter((v) => v !== 'auto');
+function createAutoGravityModel(gravity: IAutoGravityString | AutoGravity): IAutoGravityModel {
+  let values;
+  const gravityQualifier = gravity === 'auto' ? new AutoGravity() : gravity as AutoGravity;
+
+  if (`${gravity}`.startsWith('auto:')) {
+    values = `${gravity}`.split(':').filter((v) => v !== 'auto');
+  } else {
+    values = gravityQualifier.qualifierValue.values.filter((v) => v !== 'auto');
+  }
+
   const autoFocus = values.map(createIAutoFocusObject);
 
   return {
@@ -138,14 +156,24 @@ function createFocusOnGravityModel(gravity: FocusOnGravity): IFocusOnGravityMode
 
   if (hasAutoGravity) {
     // Remove the first 'auto' value by slicing it, because it's added by autoGravity()
-    const autoFocusObjects = values[values.length -1].values.slice(1);
+    const autoFocusObjects = values[values.length - 1].values.slice(1);
     const autoGravityInstance = autoGravity().autoFocus(...autoFocusObjects);
     result.fallbackGravity = createAutoGravityModel(autoGravityInstance);
   }
 
   return result;
 }
 
+/**
+ * Creates a FocusOnGravity from given string
+ * @param gravity
+ */
+function createFocusOnGravity(gravity: string): FocusOnGravity {
+  const values = gravity.split(':');
+  const focusOnValues = values.map((g) => new FocusOnValue(g));
+  return new FocusOnGravity(focusOnValues);
+}
+
 /**
  * Create a model of given gravity
  * @param gravity
@@ -159,9 +187,11 @@ export function createGravityModel(gravity: IGravity): IGravityModel {
     return createOcrGravityModel();
   }
 
-  if (gravity === 'auto' || isAutoGravity(gravity)){
+  if (isIAutoGravityString(gravity) || isAutoGravity(gravity)) {
     return createAutoGravityModel(gravity);
   }
 
-  return createFocusOnGravityModel(gravity as FocusOnGravity);
+  return createFocusOnGravityModel(
+    typeof gravity === 'string' ? createFocusOnGravity(gravity) : gravity as FocusOnGravity
+  );
 }

src/qualifiers/gravity/GravityQualifier.ts

@@ -9,7 +9,7 @@ import {CompassQualifier} from "./qualifiers/compass/CompassQualifier.js";
 import {XYCenterGravity} from "./xyCenterGravity/XYCenterGravity.js";
 
 export type IGravityString = 'auto' | ICompassGravity;
-export type IGravity = CompassGravity | AutoGravity | FocusOnGravity | XYCenterGravity | IGravityString;
+export type IGravity = CompassGravity | AutoGravity | FocusOnGravity | XYCenterGravity | IGravityString | string;
 export type IGravityValue = CompassQualifier | FocusOnValue | AutoFocus;
 
 /**