@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/README.md

@@ -15,7 +15,7 @@ Get started with the Javascript Development SDK for Fynd Platform
 
 #### Node
 
-```
+```bash
 npm install @gofynd/fdk-client-javascript
 ```
 
@@ -29,21 +29,23 @@ const {
 ```
 
 #### Browser
+
 you can load fdk-client-javascript's application browser bundle from CDN; `ApplicationConfig`, `ApplicationClient` and `ApplicationModels` will be attached to browser's `window` object.
 
 ```html
 <script src="https://cdn.jsdelivr.net/gh/gofynd/fdk-client-javascript@<version>/dist/application.js"></script>
 ```
+
 Install Specific version
+
 ```html
-<script src="https://cdn.jsdelivr.net/gh/gofynd/fdk-client-javascript@1.0.1/dist/application.js"></script>
+<script src="https://cdn.jsdelivr.net/gh/gofynd/fdk-client-javascript@1.1.0/dist/application.js"></script>
 ```
 
 ```js
 const { ApplicationConfig, ApplicationClient } = window;
 ```
 
-
 ### Logging
 
 For logging support user can pass `logLevel` in `ApplicationConfig` or `PlatformConfig` while declaration.
@@ -53,6 +55,7 @@ Available logging levels: TRACE, DEBUG, INFO, WARN, ERROR.
 
 Default log level: ERROR
 ```
+
 ### Sample Usage - ApplicationClient
 
 ```javascript
@@ -121,7 +124,9 @@ async function getData() {
 
 getData();
 ```
+
 ---
+
 ### Cookie
 
 Following code snippet will read and write cookies on behalf of you <br />
@@ -142,15 +147,53 @@ module.exports = cookieJar
 ```
 
 get the stored cookie from the CookieJar instance
+
 ```javascript
 const cookieJar = require('path/to/cookieJar') // replace with actual path
 
 let cookies = await cookieJar.getCookies("https://api.fynd.com");
 ```
+
+---
+
+### Headers
+
+#### Adding Request Headers
+
+To include request headers when calling a method, add `requestHeaders` object in the first argument.
+
+```javascript
+const requestHeaders = {
+  "x-api-version": "1.0"
+}
+
+const options = {
+  responseHeaders: true
+}
+
+const [response, headers] = await platformClient.application("<APPLICATION_ID>").theme.getAllPages({theme_id: "<THEME_ID>", requestHeaders: requestHeaders}, options);
+```
+
+#### get Response Headers
+
+To retrieve the response headers, simply set the `responseHeaders` option to `true` when calling the desired method. Below is an example demonstrating how to achieve this:
+
+```javascript
+const options = {
+  responseHeaders: true
+}
+const [response, headers] = await platformClient.application("<APPLICATION_ID>").theme.getAllPages({theme_id: "<THEME_ID>"}, options);
+
+console.log("[API RESPONSE]: ", response);
+console.log("[RESPONSE HEADERS]: ", headers);
+```
+
 ---
 
 ### Log Curl
+
 To print the curl command in the console for all network calls made using `applicationClient` or `platformClient`, set the logger level to debug.
+
 ```javascript
 const {
   ApplicationClient, ApplicationConfig,
@@ -167,12 +210,16 @@ let applicationClient = new ApplicationClient(applicationConfig);
 let response = await applicationClient.theme.getAppliedTheme(); 
 console.log("Active Theme: ", response.information.name);
 ```
+
 The above code will log the curl command in the console
+
 ```bash
 curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 0.1.36' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
+
 ---
+
 ### TypeScript
 
 fdk-client-javascript includes Typescript definitions.
@@ -180,7 +227,9 @@ fdk-client-javascript includes Typescript definitions.
 ```typescript
 import { ApplicationConfig, ApplicationClient } from "fdk-client-javascript";
 ```
+
 ---
+
 ### Documentation
 
 - [Application Front](documentation/application/README.md)

package/index.js

@@ -1,5 +1,4 @@
 
-
 const { ApplicationConfig, ApplicationClient, ApplicationModel } = require('./sdk/application'); 
 const { PartnerConfig, PartnerClient, PartnerModel } = require('./sdk/partner'); 
 const { PlatformConfig, PlatformClient, PlatformModel } = require('./sdk/platform'); 
@@ -11,8 +10,6 @@ const Constant = require('./sdk/common/Constant');
 module.exports = {
     
     
-    
-    
     ApplicationConfig,
     ApplicationClient,
     ApplicationModel,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.1.6",
+  "version": "1.3.0",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -15,7 +15,6 @@
     "axios": "^0.27.2",
     "camelcase": "^6.3.0",
     "crypto-js": "^4.1.1",
-    "isomorphic-base64": "^1.0.2",
     "joi": "^17.7.0",
     "loglevel": "^1.8.1",
     "query-string": "^7.1.3"

package/sdk/application/ApplicationAPIClient.d.ts

@@ -1,4 +1,8 @@
 export = APIClient;
+/**
+ * @typedef {Object} Options
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
+ */
 declare class APIClient {
     /**
      * @param {object} conf
@@ -6,6 +10,16 @@ declare class APIClient {
      * @param {string} url
      * @param {object} query
      * @param {object} body
+     * @param {object} xHeaders
      */
-    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any): any;
+    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: any): any;
 }
+declare namespace APIClient {
+    export { Options };
+}
+type Options = {
+    /**
+     * - Whether response headers are returned or not.
+     */
+    responseHeaders: boolean;
+};

package/sdk/application/ApplicationAPIClient.js

@@ -1,5 +1,10 @@
 const { fdkAxios } = require("../common/AxiosHelper");
-const { btoa } = require("isomorphic-base64");
+const { convertStringToBase64 } = require("../common/utils");
+
+/**
+ * @typedef {Object} Options
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
+ */
 
 class APIClient {
   /**
@@ -8,10 +13,13 @@ class APIClient {
    * @param {string} url
    * @param {object} query
    * @param {object} body
+   * @param {object} xHeaders
    */
 
-  static execute(conf, method, url, query, body, xHeaders) {
-    const token = btoa(`${conf.applicationID}:${conf.applicationToken}`);
+  static execute(conf, method, url, query, body, xHeaders, options) {
+    const token = convertStringToBase64(
+      `${conf.applicationID}:${conf.applicationToken}`
+    );
 
     let headers = { Authorization: "Bearer " + token };
     if (conf.cookie) {
@@ -37,6 +45,7 @@ class APIClient {
       params: query,
       data: body,
       headers: { ...headers, ...extraHeaders, ...xHeaders },
+      responseHeaders: options.responseHeaders,
     };
     rawRequest = JSON.parse(JSON.stringify(rawRequest));
 

package/sdk/application/ApplicationClient.d.ts

@@ -1,7 +1,13 @@
 export = ApplicationClient;
+/**
+ * Represents the client for the application.
+ *
+ * @class
+ */
 declare class ApplicationClient {
-    constructor(config: any);
-    config: any;
+    /** @param {import("./ApplicationConfig")} config - The application configuration. */
+    constructor(config: import("./ApplicationConfig"));
+    config: import("./ApplicationConfig");
     cart: Cart;
     catalog: Catalog;
     common: Common;
@@ -18,10 +24,34 @@ declare class ApplicationClient {
     share: Share;
     theme: Theme;
     user: User;
-    setCookie(cookie: any): void;
-    setLocationDetails(locationDetails: any): void;
-    setCurrencyCode(currencyCode: any): void;
-    setExtraHeaders(header: any): void;
+    /**
+     * Sets the cookie for the application.
+     *
+     * @param {string} cookie - The cookie to set, This cookie will be included
+     *   in the headers of every subsequent request.
+     */
+    setCookie(cookie: string): void;
+    /**
+     * Sets the location details for the application.
+     *
+     * @param {import("./ApplicationConfig").LocationObject} locationDetails -
+     *   The location details to set.
+     */
+    setLocationDetails(locationDetails: import("./ApplicationConfig").LocationObject): void;
+    /**
+     * Sets the currency code in ApplicationConfig.
+     *
+     * @param {string} currencyCode - The currency code to set.
+     * @throws {FDKClientValidationError} When the provided currency code is not a string.
+     */
+    setCurrencyCode(currencyCode: string): void;
+    /**
+     * Sets the extra headers for the application.
+     *
+     * @param {object} header - The header object to set.
+     * @throws {FDKClientValidationError} When the provided header is not an object.
+     */
+    setExtraHeaders(header: object): void;
 }
 import Cart = require("./Cart/CartApplicationClient");
 import Catalog = require("./Catalog/CatalogApplicationClient");

package/sdk/application/ApplicationClient.js

@@ -1,96 +1,77 @@
-const { LocationValidator } = require("./ApplicationModels");
-
 const Cart = require("./Cart/CartApplicationClient");
-
 const Catalog = require("./Catalog/CatalogApplicationClient");
-
 const Common = require("./Common/CommonApplicationClient");
-
 const Communication = require("./Communication/CommunicationApplicationClient");
-
 const Configuration = require("./Configuration/ConfigurationApplicationClient");
-
 const Content = require("./Content/ContentApplicationClient");
-
 const FileStorage = require("./FileStorage/FileStorageApplicationClient");
-
 const Lead = require("./Lead/LeadApplicationClient");
-
 const Logistic = require("./Logistic/LogisticApplicationClient");
-
 const Order = require("./Order/OrderApplicationClient");
-
 const Payment = require("./Payment/PaymentApplicationClient");
-
 const PosCart = require("./PosCart/PosCartApplicationClient");
-
 const Rewards = require("./Rewards/RewardsApplicationClient");
-
 const Share = require("./Share/ShareApplicationClient");
-
 const Theme = require("./Theme/ThemeApplicationClient");
-
 const User = require("./User/UserApplicationClient");
-
 const { FDKClientValidationError } = require("../common/FDKError");
 
+/**
+ * Represents the client for the application.
+ *
+ * @class
+ */
 class ApplicationClient {
+  /** @param {import("./ApplicationConfig")} config - The application configuration. */
   constructor(config) {
     this.config = config;
-
     this.cart = new Cart(config);
-
     this.catalog = new Catalog(config);
-
     this.common = new Common(config);
-
     this.communication = new Communication(config);
-
     this.configuration = new Configuration(config);
-
     this.content = new Content(config);
-
     this.fileStorage = new FileStorage(config);
-
     this.lead = new Lead(config);
-
     this.logistic = new Logistic(config);
-
     this.order = new Order(config);
-
     this.payment = new Payment(config);
-
     this.posCart = new PosCart(config);
-
     this.rewards = new Rewards(config);
-
     this.share = new Share(config);
-
     this.theme = new Theme(config);
-
     this.user = new User(config);
   }
 
+  /**
+   * Sets the cookie for the application.
+   *
+   * @param {string} cookie - The cookie to set, This cookie will be included
+   *   in the headers of every subsequent request.
+   */
   setCookie(cookie) {
     this.config.cookie = cookie;
   }
 
+  /**
+   * Sets the location details for the application.
+   *
+   * @param {import("./ApplicationConfig").LocationObject} locationDetails -
+   *   The location details to set.
+   */
   setLocationDetails(locationDetails) {
-    const {
-      error,
-    } = LocationValidator.validateLocationObj().validate(locationDetails, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-    if (error) {
-      throw new FDKClientValidationError(error);
-    }
     this.config.locationDetails = {
       ...this.config.locationDetails,
       ...locationDetails,
     };
   }
 
+  /**
+   * Sets the currency code in ApplicationConfig.
+   *
+   * @param {string} currencyCode - The currency code to set.
+   * @throws {FDKClientValidationError} When the provided currency code is not a string.
+   */
   setCurrencyCode(currencyCode) {
     if (typeof currencyCode !== "string") {
       throw new FDKClientValidationError("Currency code should be string only");
@@ -98,6 +79,12 @@ class ApplicationClient {
     this.config.currencyCode = currencyCode;
   }
 
+  /**
+   * Sets the extra headers for the application.
+   *
+   * @param {object} header - The header object to set.
+   * @throws {FDKClientValidationError} When the provided header is not an object.
+   */
   setExtraHeaders(header) {
     if (typeof header === "object") {
       this.config.extraHeaders.push(header);

package/sdk/application/ApplicationConfig.d.ts

@@ -1,20 +1,100 @@
 export = ApplicationConfig;
+/**
+ * Represents the location object for validation.
+ *
+ * @typedef {Object} LocationObject
+ * @property {string} pincode - The pincode of the location.
+ * @property {string} country - The country of the location.
+ * @property {string} country_iso_code - The ISO code of the country.
+ * @property {string} city - The city of the location.
+ * @property {Object} location - The geographical coordinates of the location.
+ * @property {string} location.longitude - The longitude of the location.
+ * @property {string} location.latitude - The latitude of the location.
+ */
+/**
+ * Represents the configuration for an application.
+ *
+ * @class
+ */
 declare class ApplicationConfig {
+    /** @typedef {"TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"} logLevelEnum */
     /**
-     * @param {object} _conf
-     * @param {object} [_opts]
+     * @param {object} _conf - The application configuration.
+     * @param {string} _conf.applicationID - The ID of the application.
+     * @param {string} [_conf.applicationToken] - The token for the application.
+     * @param {string} [_conf.domain='https://api.fynd.com'] - The domain for
+     *   API. \n Write full domain. Default is `'https://api.fynd.com'`
+     * @param {logLevelEnum} [_conf.logLevel='ERROR'] - The log level. Available
+     *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
+     * @param {LocationObject} [_conf.locationDetails] - The location details.
+     * @param {string} [_conf.currencyCode='INR'] - The currency code. Default is `'INR'`
+     * @param {object} [_opts] - Additional options.
      */
-    constructor(_conf: object, _opts?: object);
-    applicationID: any;
-    applicationToken: any;
+    constructor(_conf: {
+        applicationID: string;
+        applicationToken?: string;
+        domain?: string;
+        logLevel?: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
+        locationDetails?: LocationObject;
+        currencyCode?: string;
+    }, _opts?: object);
+    applicationID: string;
+    applicationToken: string;
     opts: any;
-    domain: any;
-    logLevel: any;
+    domain: string;
+    logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
     extraHeaders: any[];
-    locationDetails: any;
-    currencyCode: any;
-    setLogLevel(level: any): void;
-    setCookie(cookie: any): void;
-    cookie: any;
+    locationDetails: LocationObject;
+    currencyCode: string;
+    /**
+     * Sets the log level for the application.
+     *
+     * @param {logLevelEnum} level - The log level to set.
+     */
+    setLogLevel(level: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"): void;
+    /**
+     * Sets the cookie for the application.
+     *
+     * @param {string} cookie - The cookie to set, This cookie will be included
+     *   in the headers of every subsequent request.
+     */
+    setCookie(cookie: string): void;
+    cookie: string;
+    /**
+     * Validates the application configuration.
+     *
+     * @throws {FDKInvalidCredentialError} When the credentials are invalid or missing.
+     */
     validate(): void;
 }
+declare namespace ApplicationConfig {
+    export { LocationObject };
+}
+/**
+ * Represents the location object for validation.
+ */
+type LocationObject = {
+    /**
+     * - The pincode of the location.
+     */
+    pincode: string;
+    /**
+     * - The country of the location.
+     */
+    country: string;
+    /**
+     * - The ISO code of the country.
+     */
+    country_iso_code: string;
+    /**
+     * - The city of the location.
+     */
+    city: string;
+    /**
+     * - The geographical coordinates of the location.
+     */
+    location: {
+        longitude: string;
+        latitude: string;
+    };
+};

package/sdk/application/ApplicationConfig.js

@@ -1,13 +1,38 @@
-const {
-  FDKInvalidCredentialError,
-  FDKClientValidationError,
-} = require("../common/FDKError");
+const { FDKInvalidCredentialError } = require("../common/FDKError");
 const { Logger, setLoggerLevel } = require("../common/Logger");
-const { LocationValidator } = require("./ApplicationModels");
+
+/**
+ * Represents the location object for validation.
+ *
+ * @typedef {Object} LocationObject
+ * @property {string} pincode - The pincode of the location.
+ * @property {string} country - The country of the location.
+ * @property {string} country_iso_code - The ISO code of the country.
+ * @property {string} city - The city of the location.
+ * @property {Object} location - The geographical coordinates of the location.
+ * @property {string} location.longitude - The longitude of the location.
+ * @property {string} location.latitude - The latitude of the location.
+ */
+
+/**
+ * Represents the configuration for an application.
+ *
+ * @class
+ */
 class ApplicationConfig {
+  /** @typedef {"TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"} logLevelEnum */
+
   /**
-   * @param {object} _conf
-   * @param {object} [_opts]
+   * @param {object} _conf - The application configuration.
+   * @param {string} _conf.applicationID - The ID of the application.
+   * @param {string} [_conf.applicationToken] - The token for the application.
+   * @param {string} [_conf.domain='https://api.fynd.com'] - The domain for
+   *   API. \n Write full domain. Default is `'https://api.fynd.com'`
+   * @param {logLevelEnum} [_conf.logLevel='ERROR'] - The log level. Available
+   *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
+   * @param {LocationObject} [_conf.locationDetails] - The location details.
+   * @param {string} [_conf.currencyCode='INR'] - The currency code. Default is `'INR'`
+   * @param {object} [_opts] - Additional options.
    */
   constructor(_conf, _opts) {
     this.applicationID = _conf.applicationID || "";
@@ -22,23 +47,32 @@ class ApplicationConfig {
     this.validate();
   }
 
+  /**
+   * Sets the log level for the application.
+   *
+   * @param {logLevelEnum} level - The log level to set.
+   */
   setLogLevel(level) {
     setLoggerLevel(level.toUpperCase());
     this.logLevel = level.toUpperCase();
   }
 
+  /**
+   * Sets the cookie for the application.
+   *
+   * @param {string} cookie - The cookie to set, This cookie will be included
+   *   in the headers of every subsequent request.
+   */
   setCookie(cookie) {
     this.cookie = cookie;
   }
 
+  /**
+   * Validates the application configuration.
+   *
+   * @throws {FDKInvalidCredentialError} When the credentials are invalid or missing.
+   */
   validate() {
-    const { error } = LocationValidator.validateLocationObj().validate(
-      this.locationDetails,
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      throw new FDKClientValidationError(error);
-    }
     if (!this.applicationID) {
       Logger({ level: "ERROR", message: "No Application ID Present" });
       throw new FDKInvalidCredentialError("No Application ID Present");