Feature/add missing transformations parameters (#403)

* feat(filelink): add missing watermark

* feat(filelink): add missing transformations parameters

* fix(schema): duplicate values

Author: konradkrk

src/lib/api/transform.ts

@@ -124,6 +124,23 @@ export enum ECropfacesType {
   fill = 'fill',
 }
 
+/**
+ * SmartCrop mode options enum
+ */
+export enum ESmartCropMode {
+  fit = 'fit',
+  auto = 'auto',
+}
+
+export enum EImageWatermarkPosition {
+  top = 'top',
+  middle = 'middle',
+  bottom = 'bottom',
+  left = 'left',
+  center = 'center',
+  right = 'right',
+}
+
 /**
  * Convert to format
  */
@@ -181,13 +198,30 @@ export enum EVideoAccessMode {
   crop = 'crop',
 }
 
+
 /**
  * @see https://www.filestack.com/docs/image-transformations
  */
 export interface TransformOptions {
   flip?: boolean;
   compress?: boolean;
   flop?: boolean;
+  no_metadata?: boolean;
+  pjpg?: {
+    quality: number;
+    metadata: boolean;
+  };
+  smart_crop?: {
+    mode?: ESmartCropMode
+    width: number;
+    height: number;
+  };
+  watermark?: {
+    files: string;
+    size?: number;
+    position?: EImageWatermarkPosition | EImageWatermarkPosition[];
+  };
+  imagesize?: boolean;
   enchance?: boolean;
   redeye?: boolean;
   monochrome?: boolean;

src/lib/filelink.spec.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import { Filelink, ShapeType, VideoAccessMode, AnimationParams, FitOptions, Align } from './filelink';
+import { Filelink, ShapeType, VideoAccessMode, AnimationParams, FitOptions, Align, WatermarkParams, ImageWatermarkPosition, SmartCropParams, SmartCropMode, ProgressiveJpgParams } from './filelink';
 import { TransformSchema } from './../schema/transforms.schema';
 import * as validator from '../schema';
 
@@ -252,6 +252,50 @@ describe('Different tasks', () => {
     expect(filelink.toString()).toBe('https://cdn.filestackcontent.com/DEFAULT_API_KEY/flop/5aYkEQJSQCmYShsoCnZN');
   });
 
+  it('should be able to add imagesize', () => {
+    filelink.imagesize();
+    expect(filelink.toString()).toBe('https://cdn.filestackcontent.com/DEFAULT_API_KEY/imagesize/5aYkEQJSQCmYShsoCnZN');
+  });
+
+  it('should be able to add no_metadata', () => {
+    filelink.noMetadata();
+    expect(filelink.toString()).toBe('https://cdn.filestackcontent.com/DEFAULT_API_KEY/no_metadata/5aYkEQJSQCmYShsoCnZN');
+  });
+
+  it('should be able to add pjpg', () => {
+    const params: ProgressiveJpgParams = {
+      quality: 50,
+      metadata: false,
+    };
+
+    filelink.pjpg(params);
+    expect(filelink.toString()).toBe('https://cdn.filestackcontent.com/DEFAULT_API_KEY/pjpg=quality:50,metadata:false/5aYkEQJSQCmYShsoCnZN');
+  });
+
+  it('should be able to add smart_crop', () => {
+    const params: SmartCropParams = {
+      mode: SmartCropMode.auto,
+      width: 1000,
+      height: 1000,
+    };
+
+    filelink.smartCrop(params);
+    expect(filelink.toString()).toBe('https://cdn.filestackcontent.com/DEFAULT_API_KEY/smart_crop=mode:auto,width:1000,height:1000/5aYkEQJSQCmYShsoCnZN');
+  });
+
+  it('should be able to add watermark', () => {
+    const params: WatermarkParams = {
+      file: 'http://welcome-swiss.com/wp-content/uploads/2015/12/Swiss-landscape.jpg',
+      size: 20,
+      position: ImageWatermarkPosition.top,
+    };
+
+    filelink.watermark(params);
+    expect(filelink.toString()).toBe(
+      'https://cdn.filestackcontent.com/DEFAULT_API_KEY/watermark=file:http://welcome-swiss.com/wp-content/uploads/2015/12/Swiss-landscape.jpg,size:20,position:top/5aYkEQJSQCmYShsoCnZN'
+    );
+  });
+
   it('should be able to enhance', () => {
     filelink.enhance();
     expect(filelink.toString()).toBe('https://cdn.filestackcontent.com/DEFAULT_API_KEY/enhance/5aYkEQJSQCmYShsoCnZN');

src/lib/filelink.ts

@@ -101,6 +101,26 @@ export enum CropfacesType {
   fill = 'fill',
 }
 
+/**
+ * Watermark postion options enum
+ */
+export enum ImageWatermarkPosition {
+  top = 'top',
+  middle = 'middle',
+  bottom = 'bottom',
+  left = 'left',
+  center = 'center',
+  right = 'right',
+}
+
+/**
+ * SmartCrop options enum
+ */
+export enum SmartCropMode {
+  face = 'face',
+  auto = 'auto',
+}
+
 /**
  * Convert to format
  */
@@ -285,6 +305,23 @@ export interface CompressParams {
   metadata?: boolean;
 }
 
+export interface WatermarkParams {
+  file: string;
+  size?: number;
+  position?: ImageWatermarkPosition | ImageWatermarkPosition[];
+}
+
+export interface ProgressiveJpgParams {
+  quality: number;
+  metadata: boolean;
+}
+
+export interface SmartCropParams {
+  mode: SmartCropMode;
+  width: number;
+  height: number;
+}
+
 export interface SharpenParams {
   amount: number;
 }
@@ -628,7 +665,7 @@ export class Filelink {
       throw new FilestackError('External sources requires apikey to handle transforms');
     }
 
-    if (!isExternal && typeof this.source === 'string' && (!handleRegexp.test(this.source) && this.source.indexOf('filestackcontent') === -1)) {
+    if (!isExternal && typeof this.source === 'string' && !handleRegexp.test(this.source) && this.source.indexOf('filestackcontent') === -1) {
       throw new FilestackError('Invalid filestack source provided');
     }
   }
@@ -786,6 +823,61 @@ export class Filelink {
     return this.addTask('flop', true);
   }
 
+  /**
+   * Adds imagesize transformation
+   *
+   * @see https://www.filestack.com/docs/api/processing/#image-size
+   * @returns this
+   * @memberof Filelink
+   */
+  imagesize() {
+    return this.addTask('imagesize', true);
+  }
+
+  /**
+   * Adds noMetadata transformation
+   *
+   * @see https://www.filestack.com/docs/api/processing/#strip-metadata
+   * @returns this
+   * @memberof Filelink
+   */
+  noMetadata() {
+    return this.addTask('no_metadata', true);
+  }
+
+  /**
+   * Adds Progressive JPEG transformation
+   *
+   * @see https://www.filestack.com/docs/api/processing/#progressive-jpeg
+   * @returns this
+   * @memberof Filelink
+   */
+  pjpg(params: ProgressiveJpgParams) {
+    return this.addTask('pjpg', params);
+  }
+
+  /**
+   * Adds imagesize transformation
+   *
+   * @see https://www.filestack.com/docs/api/processing/#smart-crop
+   * @returns this
+   * @memberof Filelink
+   */
+  smartCrop(params: SmartCropParams) {
+    return this.addTask('smart_crop', params);
+  }
+
+  /**
+   * Adds watermart transformation
+   *
+   * @see https://www.filestack.com/docs/api/processing/#watermark
+   * @returns this
+   * @memberof Filelink
+   */
+  watermark(params: WatermarkParams) {
+    return this.addTask('watermark', params);
+  }
+
   /**
    * Adds enhance transformation
    *
@@ -1413,7 +1505,7 @@ export class Filelink {
   private generateTransformString(): string {
     let transforms = [];
 
-    this.transforms.forEach((el) => {
+    this.transforms.forEach(el => {
       transforms.push(this.optionToString(el.name, el.params));
     });
 
@@ -1443,7 +1535,7 @@ export class Filelink {
       return key;
     }
 
-    Object.keys(values).forEach((i) => {
+    Object.keys(values).forEach(i => {
       if (Array.isArray(values[i])) {
         optionsString.push(`${i}:${this.arrayToString(values[i])}`);
         return;
@@ -1483,7 +1575,7 @@ export class Filelink {
    * @param arr - any array
    */
   private arrayToString(arr: any[]): string {
-    const toReturn = arr.map((el) => {
+    const toReturn = arr.map(el => {
       if (Array.isArray(el)) {
         return this.arrayToString(el);
       }

src/schema/transforms.schema.ts

@@ -90,14 +90,31 @@ export const TransformSchema = {
       type: 'boolean',
       additionalProperties: false,
     },
+    smart_crop: {
+      width: {
+        type: 'integer',
+        minimum: 0,
+        maximum: 10000,
+      },
+      height: {
+        type: 'integer',
+        minimum: 0,
+        maximum: 10000,
+      },
+      mode: {
+        type: 'string',
+        default: 'auto',
+        enum: ['face', 'auto'],
+      },
+    },
     animate: {
       type: 'object',
       properties: {
         delay: {
           type: 'integer',
           minimum: 0,
           maximum: 10000,
-          default: 100,
+          default: 1000,
         },
         loop: {
           type: 'integer',