Skip to content

export transformationStringFromObject function #595

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions __TESTS__/unit/url/url.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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', () => {
Expand Down Expand Up @@ -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");
});
});
4 changes: 2 additions & 2 deletions src/backwards/generateTransformationString.ts
Original file line number Diff line number Diff line change
@@ -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";
Expand Down Expand Up @@ -227,4 +227,4 @@ export function generateTransformationString(transformationOptions: LegacyITrans
// console.log(childTransformations);
return childTransformations.join("/");
}

export const transformationStringFromObject: (transformationObject: TransformationObject) => string = generateTransformationString;
1 change: 1 addition & 0 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down
27 changes: 27 additions & 0 deletions src/types/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down