Add compass gravity model (#475)

Author: Nir Maoz

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

@@ -66,7 +66,10 @@ describe('resize.toJson()', () => {
         },
         x: 3,
         y: 4,
-        gravity: 'north_east',
+        gravity: {
+          compass: "north_east",
+          gravityType: "direction"
+        },
         zoom: 10
       },
       {
@@ -76,7 +79,10 @@ describe('resize.toJson()', () => {
         },
         x: 3,
         y: 4,
-        gravity: 'south'
+        gravity: {
+          compass: "south",
+          gravityType: "direction"
+        }
       },
       {
         "actionType": "limitFill",
@@ -85,22 +91,31 @@ describe('resize.toJson()', () => {
         },
         x: 3,
         y: 4,
-        gravity: 'south'
+        gravity: {
+          compass: "south",
+          gravityType: "direction"
+        }
       },
       {
         "actionType": "thumbnail",
         "dimensions": {
           "width": 100
         },
-        gravity: 'south',
+        gravity: {
+          compass: "south",
+          gravityType: "direction"
+        },
         zoom: 4
       },
       {
         "actionType": "pad",
         "dimensions": {
           "width": 100
         },
-        gravity: 'south',
+        gravity: {
+          compass: "south",
+          gravityType: "direction"
+        },
         x: 3,
         y: 4
       },
@@ -109,7 +124,10 @@ describe('resize.toJson()', () => {
         "dimensions": {
           "width": 100
         },
-        gravity: 'south',
+        gravity: {
+          compass: "south",
+          gravityType: "direction"
+        },
         x: 3,
         y: 4
       },
@@ -118,7 +136,10 @@ describe('resize.toJson()', () => {
         "dimensions": {
           "width": 100
         },
-        gravity: 'south',
+        gravity: {
+          compass: "south",
+          gravityType: "direction"
+        },
         x: 3,
         y: 4
       }

public/progress/cloudinary-base-progress-report.html

@@ -1,9 +1,8 @@
 import {ResizeSimpleAction} from "./ResizeSimpleAction.js";
-import {IGravity} from "../../qualifiers/gravity/GravityQualifier.js";
+import {IGravity, IShortenGravity} from "../../qualifiers/gravity/GravityQualifier.js";
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
 import {IActionModel} from "../../internal/models/IActionModel.js";
-
-export type IShortenGravity = 'auto' | 'north' | 'center' | 'east' | 'west' | 'south' | 'north_west' | 'south_east' | 'south_west' | 'north_east';
+import {createGravityModel} from "../../internal/models/createGravityModel.js";
 
 /**
  * @description Defines an advanced resize.
@@ -17,14 +16,10 @@ class ResizeAdvancedAction extends ResizeSimpleAction {
    * @param {Qualifiers.Gravity} gravity
    */
   gravity(gravity: IGravity | IShortenGravity): this {
-    if(typeof gravity === "string") {
-      this._actionModel.gravity = gravity;
-      return this.addQualifier(new Qualifier('g', gravity));
-    }
-
-    this._actionModel.gravity = gravity.qualifierValue;
+    this._actionModel.gravity = createGravityModel(gravity);
+    const gravityQualifier = typeof gravity === "string" ? new Qualifier('g', gravity) : gravity;
 
-    return this.addQualifier(gravity);
+    return this.addQualifier(gravityQualifier);
   }
 
   static fromJson(actionModel: IActionModel): ResizeAdvancedAction {

src/actions/resize/ResizeAdvancedAction.ts

@@ -0,0 +1,35 @@
+import {IGravity, IShortenGravity} from "../../qualifiers/gravity/GravityQualifier.js";
+import {ICompassGravity, isICompassGravity} from "../../qualifiers/gravity/compassGravity/CompassGravity.js";
+
+export interface IGravityModel{
+  gravityType: string;
+}
+
+export interface ICompassGravityModel extends IGravityModel{
+  compass: ICompassGravity
+}
+
+/**
+ * Creates a compassGravity model
+ * @param compass
+ */
+function createCompassGravityModel(compass: ICompassGravity): ICompassGravityModel{
+  return {
+    compass,
+    gravityType: 'direction'
+  };
+}
+
+/**
+ * Create a model of given gravity
+ * @param gravity
+ */
+export function createGravityModel(gravity: IGravity | IShortenGravity): ICompassGravityModel | string {
+  const gravityString = (typeof gravity === "string" ? gravity : (gravity).qualifierValue) as string;
+
+  if (isICompassGravity(gravityString)) {
+    return createCompassGravityModel(gravityString);
+  }
+
+  return gravityString;
+}

src/internal/models/createGravityModel.ts

@@ -1,6 +1,6 @@
 import {Qualifier} from "../../internal/qualifier/Qualifier.js";
 import {QualifierValue} from "../../internal/qualifier/QualifierValue.js";
-import {CompassGravity} from "./compassGravity/CompassGravity.js";
+import {CompassGravity, ICompassGravity} from "./compassGravity/CompassGravity.js";
 import {AutoGravity} from "./autoGravity/AutoGravity.js";
 import {FocusOnGravity} from "./focusOnGravity/FocusOnGravity.js";
 import {FocusOnValue} from "../focusOn.js";
@@ -10,7 +10,7 @@ import {XYCenterGravity} from "./xyCenterGravity/XYCenterGravity.js";
 
 export type IGravity = CompassGravity | AutoGravity | FocusOnGravity | XYCenterGravity;
 export type IGravityValue = CompassQualifier | FocusOnValue | AutoFocus;
-
+export type IShortenGravity = 'auto' | ICompassGravity;
 
 /**
  * @memberOf Gravity.GravityQualifier

src/qualifiers/gravity/GravityQualifier.ts

@@ -1,6 +1,16 @@
 import {GravityQualifier} from "../GravityQualifier.js";
 import {CompassQualifier} from "../qualifiers/compass/CompassQualifier.js";
 
+type ICompassGravity = 'north' | 'center' | 'east' | 'west' | 'south' | 'north_west' | 'south_east' | 'south_west' | 'north_east';
+
+/**
+ * Validate that given val is an ICompassGravity
+ * @param val
+ */
+function isICompassGravity(val: unknown): val is ICompassGravity{
+  return ['north', 'center', 'east', 'west', 'south', 'north_west', 'south_east', 'south_west', 'north_east'].includes(val as string);
+}
+
 /**
  * @description The class for the CompassGravity builder
  * @memberOf Qualifiers.Gravity
@@ -15,4 +25,4 @@ class CompassGravity extends GravityQualifier {
   }
 }
 
-export {CompassGravity};
+export {CompassGravity, ICompassGravity, isICompassGravity};