Merge pull request #414 from cloudinary/feature/add-shortened-ArtisticFilters

Author: strausr

__TESTS__/unit/actions/Effect.test.ts

@@ -152,6 +152,14 @@ describe('Tests for Transformation Action -- Effect', () => {
     expect(url).toBe('https://res.cloudinary.com/demo/image/upload/e_art:peacock/sample');
   });
 
+  it('Can use shortened artisticFilter notation', () => {
+    const url = createNewImage('sample')
+      .effect(Effect.artisticFilter("al_dente"))
+      .toURL();
+
+    expect(url).toBe('https://res.cloudinary.com/demo/image/upload/e_art:al_dente/sample');
+  });
+
   it('Creates a cloudinaryURL with effect cartoonify:50', () => {
     const url = createNewImage('sample')
       .effect(cartoonify().lineStrength(50).blackwhite())

src/actions/effect.ts

@@ -24,6 +24,7 @@ import {FadeInEffectAction} from "./effect/leveled/fadeIn";
 import {RemoveBackgroundAction} from "./effect/removeBackgroundAction";
 import {ThemeEffect} from "./effect/theme";
 import {SystemColors} from "../qualifiers/color";
+import {ArtisticFilterType} from "../types/types";
 
 
 /**
@@ -101,10 +102,10 @@ function oilPaint(oilPaintLevel?: number):EffectActionWithStrength {
  * @summary action
  * @description Applies an artistic filter to the asset.
  * @memberOf Actions.Effect
- * @param artisticFilterType
+ * @param {ArtisticFilterType | string} artisticFilterType
  * @return {Actions.Effect.SimpleEffectAction}
  */
-function artisticFilter(artisticFilterType: string):SimpleEffectAction {
+function artisticFilter(artisticFilterType: ArtisticFilterType | string):SimpleEffectAction {
   return new SimpleEffectAction('art', artisticFilterType);
 }
 

src/types/types.ts

@@ -284,6 +284,29 @@ export type VideoFormatType =
 
 export type AnimatedFormatType = "auto" | "gif" | "webp" | "png";
 
+export type ArtisticFilterType =
+  "al_dente"|
+  "athena"|
+  "audrey"|
+  "aurora"|
+  "daguerre"|
+  "eucalyptus"|
+  "hairspray"|
+  "hokusai"|
+  "peacock"|
+  "primavera"|
+  "quartz"|
+  "incognito"|
+  "red_rock"|
+  "sizzle"|
+  "fes"|
+  "linen"|
+  "refresh"|
+  "sonnet"|
+  "ukulele"|
+  "frost"|
+  "zorro";
+
 export interface LegacyITransforamtionOptions {
   transformation?: LegacyITransforamtionOptions | string;
   raw_transformation?: string;