@gofynd/fdk-client-javascript 1.3.6-beta.1 → 1.3.6

package/sdk/common/AxiosHelper.js

@@ -73,10 +73,10 @@ function requestInterceptorFn() {
       body: transformedData,
       headers: headersToSign,
     };
-    sign(signingOptions, "1234567");
+    const signature = sign(signingOptions);
 
-    config.headers["x-fp-date"] = signingOptions.headers["x-fp-date"];
-    config.headers["x-fp-signature"] = signingOptions.headers["x-fp-signature"];
+    config.headers["x-fp-date"] = signature["x-fp-date"];
+    config.headers["x-fp-signature"] = signature["x-fp-signature"];
     // config.headers["fp-sdk-version"] = version;
     return config;
   };

package/sdk/common/FDKError.d.ts

@@ -15,6 +15,10 @@ export class FDKClientValidationError extends Error {
     constructor(errObj: any);
     details: any;
 }
+export class FDKResponseValidationError extends Error {
+    constructor(errObj: any);
+    details: any;
+}
 export class FDKInvalidCredentialError extends Error {
     constructor(message: any);
 }

package/sdk/common/FDKError.js

@@ -23,6 +23,14 @@ class FDKClientValidationError extends Error {
   }
 }
 
+class FDKResponseValidationError extends Error {
+  constructor(errObj) {
+    super(errObj.message);
+    this.name = "FDKResponseValidationError";
+    this.details = JSON.parse(JSON.stringify(errObj.details));
+  }
+}
+
 class FDKInvalidCredentialError extends Error {
   constructor(message) {
     super(message);
@@ -52,6 +60,7 @@ class FDKException extends Error {
 module.exports = {
   FDKServerResponseError,
   FDKClientValidationError,
+  FDKResponseValidationError,
   FDKInvalidCredentialError,
   FDKTokenIssueError,
   FDKOAuthCodeError,

package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts

@@ -3,14 +3,11 @@ declare class FileStorage {
     constructor(config: any);
     config: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Segregation of different types of
-     *   files(products, orders, logistics etc), Required for validating the
-     *   data of the file being uploaded, decides where exactly the file will be
-     *   stored inside the storage bucket.
-     * @param {StartRequest} arg.body
+     * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePartnerModel.StartResponse>} - Success response
+     * @name startUpload
      * @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.
      *
@@ -30,21 +27,15 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `completeUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/startUpload/).
      */
-    startUpload({ namespace, body, requestHeaders }?: {
-        namespace: string;
-        body: StartRequest;
-        requestHeaders?: object;
-    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.StartResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Segregation of different types of
-     *   files(products, orders, logistics etc), Required for validating the
-     *   data of the file being uploaded, decides where exactly the file will be
-     *   stored inside the storage bucket.
-     * @param {StartResponse} arg.body
+     * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<FileStoragePartnerModel.CompleteResponse>} - Success response
+     * @name completeUpload
      * @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.
      *
@@ -64,33 +55,18 @@ declare class FileStorage {
      * ### Complete
      * After successfully upload, call `completeUpload` api to complete the upload process.
      * This operation will return the url for the uploaded file.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body, requestHeaders }?: {
-        namespace: string;
-        body: StartResponse;
-        requestHeaders?: object;
-    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.CompleteResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.namespace - Segregation of different types of
-     *   files(products, orders, logistics etc), Required for validating the
-     *   data of the file being uploaded, decides where exactly the file will be
-     *   stored inside the storage bucket.
-     * @param {string} arg.applicationId -
-     * @param {number} arg.companyId -
-     * @param {number} [arg.page] - Page no
-     * @param {number} [arg.limit] - Limit
+     * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name browse
      * @summary: Browse Files
-     * @description: Browse Files
+     * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/browse/).
      */
-    browse({ namespace, applicationId, companyId, page, limit, requestHeaders }?: {
-        namespace: string;
-        applicationId: string;
-        companyId: number;
-        page?: number;
-        limit?: number;
-        requestHeaders?: object;
-    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    browse({ namespace, applicationId, companyId, page, limit, requestHeaders }?: FileStoragePartnerValidator.BrowseParam, { responseHeaders }?: object): Promise<any>;
 }
+import FileStoragePartnerModel = require("./FileStoragePartnerModel");

package/sdk/partner/FileStorage/FileStoragePartnerClient.js

@@ -1,9 +1,13 @@
-const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const PartnerAPIClient = require("../PartnerAPIClient");
-const FileStorageValidator = require("./FileStoragePartnerValidator");
-const FileStorageModel = require("./FileStoragePartnerModel");
+const {
+  FDKClientValidationError,
+  FDKResponseValidationError,
+} = require("../../common/FDKError");
+const Paginator = require("../../common/Paginator");
+const FileStoragePartnerValidator = require("./FileStoragePartnerValidator");
+const FileStoragePartnerModel = require("./FileStoragePartnerModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class FileStorage {
   constructor(config) {
@@ -11,14 +15,11 @@ class FileStorage {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Segregation of different types of
-   *   files(products, orders, logistics etc), Required for validating the
-   *   data of the file being uploaded, decides where exactly the file will be
-   *   stored inside the storage bucket.
-   * @param {StartRequest} arg.body
+   * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
+   * @returns {Promise<FileStoragePartnerModel.StartResponse>} - Success response
+   * @name startUpload
    * @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.
    *
@@ -38,25 +39,44 @@ class FileStorage {
    * ### Complete
    * After successfully upload, call `completeUpload` api to complete the upload process.
    * This operation will return the url for the uploaded file.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/startUpload/).
    */
-  startUpload(
+  async startUpload(
     { namespace, body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = FileStorageValidator.startUpload().validate(
+    const { error } = FileStoragePartnerValidator.startUpload().validate(
       {
         namespace,
         body,
       },
-      { abortEarly: false }
+      { abortEarly: false, allowUnknown: true }
     );
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = FileStoragePartnerValidator.startUpload().validate(
+      {
+        namespace,
+
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for partner > FileStorage > startUpload \n ${warrning}`,
+      });
+    }
+
     const query_params = {};
 
-    return PartnerAPIClient.execute(
+    const response = await PartnerAPIClient.execute(
       this.config,
       "post",
       `/service/partner/assets/v1.0/organization/${this.config.organizationId}/namespaces/${namespace}/upload/start`,
@@ -65,17 +85,39 @@ class FileStorage {
       requestHeaders,
       { responseHeaders }
     );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FileStoragePartnerModel.StartResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for partner > FileStorage > startUpload \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Segregation of different types of
-   *   files(products, orders, logistics etc), Required for validating the
-   *   data of the file being uploaded, decides where exactly the file will be
-   *   stored inside the storage bucket.
-   * @param {StartResponse} arg.body
+   * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
+   * @returns {Promise<FileStoragePartnerModel.CompleteResponse>} - Success response
+   * @name completeUpload
    * @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.
    *
@@ -95,25 +137,44 @@ class FileStorage {
    * ### Complete
    * After successfully upload, call `completeUpload` api to complete the upload process.
    * This operation will return the url for the uploaded file.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/completeUpload/).
    */
-  completeUpload(
+  async completeUpload(
     { namespace, body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = FileStorageValidator.completeUpload().validate(
+    const { error } = FileStoragePartnerValidator.completeUpload().validate(
       {
         namespace,
         body,
       },
-      { abortEarly: false }
+      { abortEarly: false, allowUnknown: true }
     );
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = FileStoragePartnerValidator.completeUpload().validate(
+      {
+        namespace,
+
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for partner > FileStorage > completeUpload \n ${warrning}`,
+      });
+    }
+
     const query_params = {};
 
-    return PartnerAPIClient.execute(
+    const response = await PartnerAPIClient.execute(
       this.config,
       "post",
       `/service/partner/assets/v1.0/organization/${this.config.organizationId}/namespaces/${namespace}/upload/complete`,
@@ -122,30 +183,49 @@ class FileStorage {
       requestHeaders,
       { responseHeaders }
     );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = FileStoragePartnerModel.CompleteResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for partner > FileStorage > completeUpload \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Segregation of different types of
-   *   files(products, orders, logistics etc), Required for validating the
-   *   data of the file being uploaded, decides where exactly the file will be
-   *   stored inside the storage bucket.
-   * @param {string} arg.applicationId -
-   * @param {number} arg.companyId -
-   * @param {number} [arg.page] - Page no
-   * @param {number} [arg.limit] - Limit
+   * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
+   * @returns {Promise<Object>} - Success response
+   * @name browse
    * @summary: Browse Files
-   * @description: Browse Files
+   * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/browse/).
    */
-  browse(
+  async browse(
     { namespace, applicationId, companyId, page, limit, requestHeaders } = {
       requestHeaders: {},
     },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = FileStorageValidator.browse().validate(
+    const { error } = FileStoragePartnerValidator.browse().validate(
       {
         namespace,
         applicationId,
@@ -153,17 +233,36 @@ class FileStorage {
         page,
         limit,
       },
-      { abortEarly: false }
+      { abortEarly: false, allowUnknown: true }
     );
     if (error) {
       return Promise.reject(new FDKClientValidationError(error));
     }
 
+    // Showing warrnings if extra unknown parameters are found
+    const { error: warrning } = FileStoragePartnerValidator.browse().validate(
+      {
+        namespace,
+
+        applicationId,
+        companyId,
+        page,
+        limit,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for partner > FileStorage > browse \n ${warrning}`,
+      });
+    }
+
     const query_params = {};
     query_params["page"] = page;
     query_params["limit"] = limit;
 
-    return PartnerAPIClient.execute(
+    const response = await PartnerAPIClient.execute(
       this.config,
       "get",
       `/service/partner/assets/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/namespaces/${namespace}/browse`,
@@ -172,6 +271,29 @@ class FileStorage {
       requestHeaders,
       { responseHeaders }
     );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const { error: res_error } = Joi.any().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for partner > FileStorage > browse \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
   }
 }
 module.exports = FileStorage;

package/sdk/partner/PartnerConfig.d.ts

@@ -20,6 +20,11 @@ declare class PartnerConfig {
      *   to use the auto-renew timer. Default is `true`
      * @param {logLevelEnum} [config.logLevel='ERROR'] - The log level. Available
      *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
+     * @param {object} [options] - Additional options.
+     * @param {boolean} [options.strictResponseCheck=false] - Strict check for
+     *   response schema validation. Passing this `true` will check response
+     *   against response schema and throw FDKResponseValidationError if it
+     *   doesn't match. Default is `false`
      */
     constructor(config: {
         organizationId: string;
@@ -29,6 +34,8 @@ declare class PartnerConfig {
         scope?: string;
         useAutoRenewTimer?: boolean;
         logLevel?: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
+    }, options?: {
+        strictResponseCheck?: boolean;
     });
     organizationId: string;
     domain: string;
@@ -39,6 +46,9 @@ declare class PartnerConfig {
     oauthClient: OauthClient;
     logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
     extraHeaders: any[];
+    options: {
+        strictResponseCheck: boolean;
+    };
     /**
      * Sets the log level for the partner.
      *

package/sdk/partner/PartnerConfig.js

@@ -23,8 +23,13 @@ class PartnerConfig {
    *   to use the auto-renew timer. Default is `true`
    * @param {logLevelEnum} [config.logLevel='ERROR'] - The log level. Available
    *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
+   * @param {object} [options] - Additional options.
+   * @param {boolean} [options.strictResponseCheck=false] - Strict check for
+   *   response schema validation. Passing this `true` will check response
+   *   against response schema and throw FDKResponseValidationError if it
+   *   doesn't match. Default is `false`
    */
-  constructor(config) {
+  constructor(config, options) {
     this.organizationId = config.organizationId;
     this.domain = config.domain || "https://api.fynd.com";
     this.apiKey = config.apiKey;
@@ -36,6 +41,10 @@ class PartnerConfig {
     this.logLevel = config.logLevel || "ERROR";
     this.setLogLevel(this.logLevel);
     this.extraHeaders = [];
+    this.options = {
+      ...{ strictResponseCheck: false },
+      ...options,
+    };
   }
 
   /**