@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js

@@ -2,6 +2,8 @@ const Paginator = require("../../common/Paginator");
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const FileStorageValidator = require("./FileStoragePlatformApplicationValidator");
+const FileStorageModel = require("./FileStoragePlatformModel");
+const { Logger } = require("./../../common/Logger");
 
 class FileStorage {
   constructor(config, applicationId) {
@@ -12,8 +14,9 @@ class FileStorage {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
-   * @param {StartRequest} arg.body
-   * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
+   * @param {StartResponse} arg.body
+   * @returns {Promise<CompleteResponse>} - Success response
+   * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
    * @description: Uploads an arbitrarily sized buffer or blob.
    *
    * It has three Major Steps:
@@ -33,8 +36,8 @@ class FileStorage {
    * After successfully upload, call `appCompleteUpload` api to complete the upload process.
    * This operation will return the url for the uploaded file.
    */
-  appStartUpload({ namespace, body } = {}) {
-    const { error } = FileStorageValidator.appStartUpload().validate(
+  async appCompleteUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.appCompleteUpload().validate(
       {
         namespace,
         body,
@@ -46,7 +49,9 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.appStartUpload().validate(
+    const {
+      error: warrning,
+    } = FileStorageValidator.appCompleteUpload().validate(
       {
         namespace,
         body,
@@ -54,50 +59,54 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for appStartUpload");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for appCompleteUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/start/`,
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/complete/`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.CompleteResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for appCompleteUpload",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Bucket name
-   * @param {StartResponse} arg.body
-   * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
-   * @description: Uploads an arbitrarily sized buffer or blob.
-   *
-   * It has three Major Steps:
-   * Start
-   * Upload
-   * Complete
-   *
-   * ### Start
-   * Initiates the assets upload using `appStartUpload`.
-   * It returns the storage link in response.
-   *
-   * ### Upload
-   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
-   * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
-   *
-   * ### Complete
-   * After successfully upload, call `appCompleteUpload` api to complete the upload process.
-   * This operation will return the url for the uploaded file.
+   * @param {boolean} [arg.sync] - Sync
+   * @param {BulkRequest} arg.body
+   * @returns {Promise<BulkUploadResponse>} - Success response
+   * @summary: Copy Files
+   * @description: Copy Files
    */
-  appCompleteUpload({ namespace, body } = {}) {
-    const { error } = FileStorageValidator.appCompleteUpload().validate(
+  async appCopyFiles({ body, sync } = {}) {
+    const { error } = FileStorageValidator.appCopyFiles().validate(
       {
-        namespace,
         body,
+        sync,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -106,43 +115,80 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = FileStorageValidator.appCompleteUpload().validate(
+    const { error: warrning } = FileStorageValidator.appCopyFiles().validate(
       {
-        namespace,
         body,
+        sync,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for appCompleteUpload");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for appCopyFiles",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["sync"] = sync;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/complete/`,
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/uploads/copy/`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.BulkUploadResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for appCopyFiles",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {boolean} [arg.sync] - Sync
-   * @param {BulkRequest} arg.body
-   * @summary: Copy Files
-   * @description: Copy Files
+   * @param {string} arg.namespace - Bucket name
+   * @param {StartRequest} arg.body
+   * @returns {Promise<StartResponse>} - Success response
+   * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `appStartUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `appStartUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `appCompleteUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
    */
-  appCopyFiles({ body, sync } = {}) {
-    const { error } = FileStorageValidator.appCopyFiles().validate(
+  async appStartUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.appStartUpload().validate(
       {
+        namespace,
         body,
-        sync,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -151,38 +197,58 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.appCopyFiles().validate(
+    const { error: warrning } = FileStorageValidator.appStartUpload().validate(
       {
+        namespace,
         body,
-        sync,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for appCopyFiles");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for appStartUpload",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["sync"] = sync;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/uploads/copy/`,
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/upload/start/`,
       query_params,
       body
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.StartResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for appStartUpload",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
    * @param {number} [arg.pageNo] - Page no
+   * @returns {Promise<BrowseResponse>} - Success response
    * @summary: Browse Files
    * @description: Browse Files
    */
-  browse({ namespace, pageNo } = {}) {
+  async browse({ namespace, pageNo } = {}) {
     const { error } = FileStorageValidator.browse().validate(
       {
         namespace,
@@ -203,20 +269,40 @@ class FileStorage {
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
-      console.log("Parameter Validation warrnings for browse");
-      console.log(warrning);
+      Logger({
+        level: "WARN",
+        message: "Parameter Validation warrnings for browse",
+      });
+      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
     query_params["page_no"] = pageNo;
 
-    return PlatformAPIClient.execute(
+    const response = await PlatformAPIClient.execute(
       this.config,
       "get",
       `/service/platform/assets/v1.0/company/${this.config.companyId}/application/${this.applicationId}/namespaces/${namespace}/browse/`,
       query_params,
       undefined
     );
+
+    const {
+      error: res_error,
+    } = FileStorageModel.BrowseResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: "Response Validation Warnnings for browse",
+      });
+      Logger({ level: "WARN", message: res_error });
+    }
+
+    return response;
   }
 
   /**

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts

@@ -1,7 +1,7 @@
 export = FileStorageValidator;
 declare class FileStorageValidator {
-    static appStartUpload(): any;
     static appCompleteUpload(): any;
     static appCopyFiles(): any;
+    static appStartUpload(): any;
     static browse(): any;
 }

package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js

@@ -2,14 +2,6 @@ const Joi = require("joi");
 const FileStorageModel = require("./FileStoragePlatformModel");
 
 class FileStorageValidator {
-  static appStartUpload() {
-    return Joi.object({
-      namespace: Joi.string().allow("").required(),
-
-      body: FileStorageModel.StartRequest().required(),
-    }).required();
-  }
-
   static appCompleteUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
@@ -26,6 +18,14 @@ class FileStorageValidator {
     }).required();
   }
 
+  static appStartUpload() {
+    return Joi.object({
+      namespace: Joi.string().allow("").required(),
+
+      body: FileStorageModel.StartRequest().required(),
+    }).required();
+  }
+
   static browse() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),

package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts

@@ -5,35 +5,29 @@ declare class FileStorage {
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
-     * @param {StartRequest} arg.body
-     * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
-     * @description: Uploads an arbitrarily sized buffer or blob.
-     *
-     * It has three Major Steps:
-     * Start
-     * Upload
-     * Complete
-     *
-     * ### Start
-     * Initiates the assets upload using `startUpload`.
-     * It returns the storage link in response.
-     *
-     * ### Upload
-     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
-     * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
-     *
-     * ### Complete
-     * After successfully upload, call `completeUpload` api to complete the upload process.
-     * This operation will return the url for the uploaded file.
+     * @param {number} [arg.pageNo] - Page no
+     * @returns {Promise<BrowseResponse>} - Success response
+     * @summary: Browse Files
+     * @description: Browse Files
      */
-    startUpload({ namespace, body }?: {
+    browse({ namespace, pageNo }?: {
         namespace: string;
-        body: StartRequest;
-    }): Promise<any>;
+        pageNo?: number;
+    }): Promise<BrowseResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Bucket name
+     * @summary: Browse Files
+     * @description: Browse Files
+     */
+    browsePaginator({ namespace }?: {
+        namespace: string;
+    }): Paginator;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.namespace - Bucket name
      * @param {StartResponse} arg.body
+     * @returns {Promise<CompleteResponse>} - Success response
      * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
      * @description: Uploads an arbitrarily sized buffer or blob.
      *
@@ -57,56 +51,68 @@ declare class FileStorage {
     completeUpload({ namespace, body }?: {
         namespace: string;
         body: StartResponse;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {SignUrlRequest} arg.body
-     * @summary: Gives signed urls to access private files
-     * @description: Describe here
-     */
-    getSignUrls({ body }?: {
-        body: SignUrlRequest;
-    }): Promise<any>;
+    }): Promise<CompleteResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {boolean} [arg.sync] - Sync
      * @param {BulkRequest} arg.body
+     * @returns {Promise<BulkUploadResponse>} - Success response
      * @summary: Copy Files
      * @description: Copy Files
      */
     copyFiles({ body, sync }?: {
         sync?: boolean;
         body: BulkRequest;
-    }): Promise<any>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
-     * @param {number} [arg.pageNo] - Page no
-     * @summary: Browse Files
-     * @description: Browse Files
-     */
-    browse({ namespace, pageNo }?: {
-        namespace: string;
-        pageNo?: number;
-    }): Promise<any>;
+    }): Promise<BulkUploadResponse>;
     /**
      * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Bucket name
-     * @summary: Browse Files
-     * @description: Browse Files
+     * @param {SignUrlRequest} arg.body
+     * @returns {Promise<SignUrlResponse>} - Success response
+     * @summary: Gives signed urls to access private files
+     * @description: Describe here
      */
-    browsePaginator({ namespace }?: {
-        namespace: string;
-    }): Paginator;
+    getSignUrls({ body }?: {
+        body: SignUrlRequest;
+    }): Promise<SignUrlResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.url - Url
+     * @returns {Promise<string>} - Success response
      * @summary: Proxy
      * @description: Proxy
      */
     proxy({ url }?: {
         url: string;
-    }): Promise<any>;
+    }): Promise<string>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Bucket name
+     * @param {StartRequest} arg.body
+     * @returns {Promise<StartResponse>} - Success response
+     * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
+     * @description: Uploads an arbitrarily sized buffer or blob.
+     *
+     * It has three Major Steps:
+     * Start
+     * Upload
+     * Complete
+     *
+     * ### Start
+     * Initiates the assets upload using `startUpload`.
+     * It returns the storage link in response.
+     *
+     * ### Upload
+     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+     * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
+     *
+     * ### Complete
+     * After successfully upload, call `completeUpload` api to complete the upload process.
+     * This operation will return the url for the uploaded file.
+     */
+    startUpload({ namespace, body }?: {
+        namespace: string;
+        body: StartRequest;
+    }): Promise<StartResponse>;
     /**
      * @param data
      * @param {string} file_name