export transformationStringFromObject function (#595)

Author: lbendavid-cloudinary

__TESTS__/unit/url/url.test.ts

@@ -2,6 +2,13 @@ import {createNewImage} from "../../TestUtils/createCloudinaryImage";
 import {Resize} from "../../../src/actions/resize";
 import {Rotate} from "../../../src/actions/rotate";
 import {SEO_TYPES} from "../../../src/assets/CloudinaryFile";
+import {
+  generateTransformationString
+} from "@cloudinary/transformation-builder-sdk/backwards/generateTransformationString";
+import {Effect} from "@cloudinary/transformation-builder-sdk/actions/effect";
+import {Border} from "@cloudinary/transformation-builder-sdk/actions";
+import {RoundCorners} from "../../../src/actions/roundCorners";
+import {transformationStringFromObject} from "../../../src";
 
 
 describe('Tests for URL configuration', () => {
@@ -129,4 +136,31 @@ describe('Tests for URL configuration', () => {
     expect(url).toEqual(`https://res.cloudinary.com/demo/image/upload/sample?_i=abcde&_z=1234&_t=false&_a=DATAABAQZAA0`);
   });
 
+  it('Should include transformation string', function () {
+    const image = createNewImage('sample', {cloudName: 'demo'}, {analytics: false});
+    const transformation = transformationStringFromObject({width: 100});
+    const url = image.addTransformation(transformation).toURL();
+    expect(url).toEqual("https://res.cloudinary.com/demo/image/upload/w_100/sample");
+  });
+
+  it('Should include transformation string created from an array of nested transformations', function () {
+    const image = createNewImage('sample', {cloudName: 'demo'}, {analytics: false});
+    const transformation = transformationStringFromObject({transformation: [{width: 100}, {height: 100}]});
+    const url = image.addTransformation(transformation).toURL();
+    expect(url).toEqual("https://res.cloudinary.com/demo/image/upload/w_100/h_100/sample");
+  });
+
+  it('Should include transformation string created from an array of transformations', function () {
+    const image = createNewImage('sample', {cloudName: 'demo'}, {analytics: false});
+    const transformation = transformationStringFromObject([{width: 100}, {height: 100}]);
+    const url = image.addTransformation(transformation).toURL();
+    expect(url).toEqual("https://res.cloudinary.com/demo/image/upload/w_100/h_100/sample");
+  });
+
+  it('Should include both transformation string and transformation action', function () {
+    const image = createNewImage('sample', {cloudName: 'demo'}, {analytics: false});
+    const transformation = transformationStringFromObject({transformation: [{width: 100}, {height: 100}]});
+    const url = image.effect(Effect.sepia(10)).addTransformation(transformation).border(Border.roundCorners(RoundCorners.byRadius(50))).toURL();
+    expect(url).toEqual("https://res.cloudinary.com/demo/image/upload/e_sepia:10/w_100/h_100/bo_0px_solid_transparent,r_50/sample");
+  });
 });

src/backwards/generateTransformationString.ts

@@ -1,5 +1,5 @@
 // eslint-disable @typescript-eslint/ban-ts-comment
-import {LegacyITransforamtionOptions} from "../types/types.js";
+import {LegacyITransforamtionOptions, LegacyTransformation as TransformationObject} from "../types/types.js";
 import {processLayer} from "./transformationProcessing/processLayer.js";
 import {process_if} from "./transformationProcessing/processIf.js";
 import {toArray} from "./utils/toArray.js";
@@ -227,4 +227,4 @@ export function generateTransformationString(transformationOptions: LegacyITrans
   // console.log(childTransformations);
   return childTransformations.join("/");
 }
-
+export const transformationStringFromObject: (transformationObject: TransformationObject) => string = generateTransformationString;

src/index.ts

@@ -11,6 +11,7 @@ export {CloudinaryFile} from "./assets/CloudinaryFile.js";
 export {CloudinaryMedia} from "./assets/CloudinaryMedia.js";
 export {Cloudinary} from "./instance/Cloudinary.js";
 export {createCloudinaryLegacyURL} from "./backwards/createCloudinaryLegacyURL.js";
+export {transformationStringFromObject} from "./backwards/generateTransformationString.js";
 export * as Actions from './actions.js';
 export * as Qualifiers from './qualifiers.js';
 

src/types/types.ts

@@ -401,6 +401,33 @@ export type SimulateColorBlindType =
   "tritanomaly"|
   "tritanopia";
 
+type ExcludedFromTransformation =
+  'cloud_name'
+  | 'api_key'
+  | 'api_secret'
+  | 'auth_token'
+  | 'cname'
+  | 'secure_distribution'
+  | 'private_cdn'
+  | 'secure'
+  | 'sign_url'
+  | 'long_url_signature'
+  | 'shorten'
+  | 'use_root_path'
+  | 'force_version'
+  | 'ssl_detected'
+  | 'cdn_subdomain'
+  | 'secure_cdn_subdomain'
+  | 'account_id'
+  | 'provisioning_api_key'
+  | 'provisioning_api_secret'
+  | 'version'
+  | 'url_suffix'
+  | 'transformation';
+export type LegacyTransformation = ({
+  transformation?: LegacyTransformation | Array<LegacyTransformation> | string | Transformation;
+} & Omit<LegacyITransforamtionOptions, ExcludedFromTransformation>) | Array<LegacyTransformation>
+
 export interface LegacyITransforamtionOptions {
   transformation?: LegacyITransforamtionOptions | string | Transformation;
   raw_transformation?: string;