Merge pull request #415 from cloudinary/feature/add-shortened-AspectRatio

Author: strausr

__TESTS__/unit/actions/Resize/AspectRatio.test.ts

@@ -32,4 +32,13 @@ describe('Tests for AspectRatio values Action -- Resize.crop', () => {
 
     expect(url).toContain('ar_1:1,c_crop/ar_16:9,c_crop/ar_4:3,c_crop/ar_3:2,c_crop/ar_3:1,c_crop/ar_5:4,c_crop/c_crop,fl_ignore_aspect_ratio');
   });
+  it('Can use shortened aspectRatio notation', () => {
+    const url = createNewImage('sample')
+      .resize(
+        crop().aspectRatio("3:2"))
+      .setPublicID('sample')
+      .toURL();
+
+    expect(url).toContain('ar_3:2,c_crop');
+  });
 });

src/actions/resize/ResizeSimpleAction.ts

@@ -5,6 +5,7 @@ import {AspectRatioQualifierValue} from "../../qualifiers/aspectRatio/AspectRati
 import {regionRelative, relative} from "../../qualifiers/flag";
 import {FlagQualifier} from "../../qualifiers/flag/FlagQualifier";
 import {ExpressionQualifier} from "../../qualifiers/expression/ExpressionQualifier";
+import {AspectRatioType} from "../../types/types";
 
 /**
  * @description Defines a resize using width and height.
@@ -49,10 +50,10 @@ class ResizeSimpleAction extends Action {
    * @description Sets the aspect ratio of the asset.
    * For a list of supported types see {@link Qualifiers.AspectRatio |
     * AspectRatio values}
-   * @param {number|string} ratio The new aspect ratio, specified as a percentage or ratio.
+   * @param {AspectRatioType|number|string} ratio The new aspect ratio, specified as a percentage or ratio.
    * @return {this}
    */
-  aspectRatio(ratio: AspectRatioQualifierValue | FlagQualifier | number | string): this {
+  aspectRatio(ratio: AspectRatioType | AspectRatioQualifierValue | FlagQualifier | number | string): this {
     // toFloatAsString is used to ensure 1 turns into 1.0
     if (ratio instanceof AspectRatioQualifierValue) {
       return this.addQualifier(new Qualifier('ar', ratio));

src/types/types.ts

@@ -307,6 +307,14 @@ export type ArtisticFilterType =
   "frost"|
   "zorro";
 
+export type AspectRatioType =
+  "1:1"|
+  "5:4"|
+  "3:1"|
+  "3:2"|
+  "4:3"|
+  "16:9";
+
 export interface LegacyITransforamtionOptions {
   transformation?: LegacyITransforamtionOptions | string;
   raw_transformation?: string;