Merge pull request #403 from cloudinary/fix/cloudinary-file-class

Fix/cloudinary file class

Author: strausr

__TESTS__/unit/asset/CloudinaryFile.test.ts

@@ -27,7 +27,7 @@ describe('Tests for CloudinaryFile', () => {
       .setPublicID('sample')
       .setSuffix('foo')
       .setAssetType('image')
-      .setStorageType('private')
+      .setDeliveryType('private')
       .setVersion('12345');
 
     expect(cloudinaryFile.toURL()).toContain('private_images/v12345/sample/foo');

__TESTS__/unit/config/cloudinaryConfig.test.ts

@@ -185,7 +185,7 @@ describe('Tests for CloudinaryConfiguration', () => {
 
   it('should support url_suffix for private uploads', () => {
     const img = createNewImage('sample');
-    img.setStorageType('private');
+    img.setDeliveryType('private');
     img.setSuffix('SOME_SUFFIX');
 
     expect(img.toURL()).toBe("https://res.cloudinary.com/demo/private_images/sample/SOME_SUFFIX");
@@ -214,7 +214,7 @@ describe('Tests for CloudinaryConfiguration', () => {
       const img = createNewImage('sample', {}, {
         useRootPath: true,
         privateCdn: true
-      }).setStorageType('private');
+      }).setDeliveryType('private');
       img.toURL();
     }).toThrow();
 

__TESTS__/unit/url/encoding.test.ts

@@ -64,15 +64,15 @@ describe('Tests for Encoding the URL', () => {
 
   it('Fetch: should not encode ("$:/") signs', () => {
     const img = createNewImage('https://res.cloudinary.com/demo/image/upload/sample?a=b');
-    img.setStorageType('fetch');
+    img.setDeliveryType('fetch');
 
     expect(img.toURL())
       .toBe('https://res.cloudinary.com/demo/image/fetch/https://res.cloudinary.com/demo/image/upload/sample%3Fa%3Db');
   });
 
   it('Should correctly encode youtube URLs', () => {
     const img = createNewImage('https://www.youtube.com/watch?v=d9NF2edxy-M');
-    img.setStorageType('youtube');
+    img.setDeliveryType('youtube');
 
     expect(img.toURL())
       .toBe('https://res.cloudinary.com/demo/image/youtube/https://www.youtube.com/watch%3Fv%3Dd9NF2edxy-M');

__TESTS__/unit/url/url.test.ts

@@ -40,14 +40,14 @@ describe('Tests for URL configuration', () => {
     // Suffix only works with predefined SEO_TYPES
     Object.keys(SEO_TYPES).forEach((resourceType) => {
       const [assetType, storageType] = resourceType.split('/');
-      image.setStorageType(assetType)
-        .setStorageType(storageType);
+      image.setDeliveryType(assetType)
+        .setDeliveryType(storageType);
 
       expect(image.toURL.bind(image)).not.toThrow();
     });
 
     // Any other storage type should throw
-    image.setStorageType('fff');
+    image.setDeliveryType('fff');
     expect(image.toURL.bind(image)).toThrow();
   });
 

src/assets/CloudinaryFile.ts

@@ -24,9 +24,32 @@ export const SEO_TYPES: Record<string, string> = {
   "video/upload": "videos"
 };
 
+/**
+ * Supported delivery type options.
+ */
+type DELIVERY_TYPE =
+  'key'|
+  'upload'|
+  'private_delivery'|
+  'public_delivery'|
+  'authenticated'|
+  'fetch'|
+  'sprite'|
+  'text'|
+  'multi'|
+  'facebook'|
+  'twitter'|
+  'twitter_name'|
+  'gravatar'|
+  'youtube'|
+  'hulu'|
+  'vimeo'|
+  'animoto'|
+  'worldstarhiphop'|
+  'dailymotion';
 
 /**
- * @desc Cloudinary file without a transformation
+ * @description Cloudinary file without a transformation
  * @summary SDK
  * @memberOf SDK
  */
@@ -54,35 +77,65 @@ class CloudinaryFile {
     this.urlConfig = new URLConfig(urlConfig);
   }
 
+  /**
+   * @description Sets the public ID of the asset.
+   * @param {string} publicID The public ID of the asset.
+   * @return {this}
+   */
   setPublicID(publicID: string): this {
     // PublicID must be a string!
     this.publicID = publicID ? publicID.toString() : '';
     return this;
   }
 
-  setStorageType(newType: string): this {
+  /**
+   * @description Sets the delivery type of the asset.
+   * @param {DELIVERY_TYPE | string} newType The type of the asset.
+   * @return {this}
+   */
+  setDeliveryType(newType: DELIVERY_TYPE|string): this {
     this.storageType = newType;
     return this;
   }
 
+  /**
+   * @description Sets the URL SEO suffix of the asset.
+   * @param {string} newSuffix The SEO suffix.
+   * @return {this}
+   */
   setSuffix(newSuffix: string): this {
     this.suffix = newSuffix;
     return this;
   }
 
+  /**
+   * @description Sets the signature of the asset.
+   * @param {string} signature The signature.
+   * @return {this}
+   */
   setSignature(signature: string): this {
     this.signature = signature;
     return this;
   }
 
+  /**
+   * @description Sets the version of the asset.
+   * @param {string} newVersion The version of the asset.
+   * @return {this}
+   */
   setVersion(newVersion: number | string): this {
     if (newVersion) {
       this.version = newVersion;
     }
     return this;
   }
 
-  setAssetType(newType: string): this {
+  /**
+   * @description Sets the asset type.
+   * @param {string} newType The type of the asset.
+   * @return {this}
+   */
+  setAssetType(newType: 'key'|'image'|'video'|'raw'|'auto'|'all'|string): this {
     if (newType) {
       this.assetType = newType;
     }
@@ -93,6 +146,10 @@ class CloudinaryFile {
     return this;
   }
 
+  /**
+   * @description Serializes to URL string
+   * @param overwriteOptions
+   */
   toURL(overwriteOptions: {trackedAnalytics?: Partial<ITrackedPropertiesThroughAnalytics>} = {}): string {
     return this.createCloudinaryURL(null, overwriteOptions.trackedAnalytics);
   }