@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/README.md

@@ -147,6 +147,18 @@ const cookieJar = require('path/to/cookieJar') // replace with actual path
 
 let cookies = await cookieJar.getCookies("https://api.fynd.com");
 ```
+---
+### Get response headers
+To retrieve the response headers, simply set the `headers` option to `true` when calling the desired method. Below is an example demonstrating how to achieve this:
+```javascript
+const options = {
+  headers: 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

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.2.0",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/application/ApplicationAPIClient.d.ts

@@ -1,4 +1,8 @@
 export = APIClient;
+/**
+ * @typedef {Object} Options
+ * @property {boolean} headers - Whether 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 headers are returned or not.
+     */
+    headers: boolean;
+};

package/sdk/application/ApplicationAPIClient.js

@@ -1,6 +1,11 @@
 const { fdkAxios } = require("../common/AxiosHelper");
 const { btoa } = require("isomorphic-base64");
 
+/**
+ * @typedef {Object} Options
+ * @property {boolean} headers - Whether headers are returned or not.
+ */
+
 class APIClient {
   /**
    * @param {object} conf
@@ -8,9 +13,10 @@ class APIClient {
    * @param {string} url
    * @param {object} query
    * @param {object} body
+   * @param {object} xHeaders
    */
 
-  static execute(conf, method, url, query, body, xHeaders) {
+  static execute(conf, method, url, query, body, xHeaders, options) {
     const token = btoa(`${conf.applicationID}:${conf.applicationToken}`);
 
     let headers = { Authorization: "Bearer " + token };
@@ -37,6 +43,7 @@ class APIClient {
       params: query,
       data: body,
       headers: { ...headers, ...extraHeaders, ...xHeaders },
+      _returnHeaders: options.headers,
     };
     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,35 @@ 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("./ApplicationModels").LocationObject} locationDetails -
+     *   The location details to set.
+     * @throws {FDKClientValidationError} When the location details validation fails.
+     */
+    setLocationDetails(locationDetails: import("./ApplicationModels").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

@@ -34,7 +34,13 @@ 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;
 
@@ -71,10 +77,23 @@ class ApplicationClient {
     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("./ApplicationModels").LocationObject} locationDetails -
+   *   The location details to set.
+   * @throws {FDKClientValidationError} When the location details validation fails.
+   */
   setLocationDetails(locationDetails) {
     const {
       error,
@@ -91,6 +110,12 @@ class ApplicationClient {
     };
   }
 
+  /**
+   * 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 +123,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,60 @@
 export = ApplicationConfig;
+/**
+ * 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 {import("./ApplicationModels").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?: import("./ApplicationModels").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: import("./ApplicationModels").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 {FDKClientValidationError} When the locationDetails validation fails.
+     * @throws {FDKInvalidCredentialError} When the credentials are invalid or missing.
+     */
     validate(): void;
 }

package/sdk/application/ApplicationConfig.js

@@ -4,10 +4,28 @@ const {
 } = require("../common/FDKError");
 const { Logger, setLoggerLevel } = require("../common/Logger");
 const { LocationValidator } = require("./ApplicationModels");
+
+/**
+ * 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 {import("./ApplicationModels").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,15 +40,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 {FDKClientValidationError} When the locationDetails validation fails.
+   * @throws {FDKInvalidCredentialError} When the credentials are invalid or missing.
+   */
   validate() {
     const { error } = LocationValidator.validateLocationObj().validate(
       this.locationDetails,

package/sdk/application/ApplicationModels.d.ts

@@ -1,3 +1,48 @@
+/**
+ * Represents the location object for validation.
+ */
+export 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;
+    };
+};
+/**
+ * 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.
+ */
 export class LocationValidator {
-    static validateLocationObj(): any;
+    /**
+     * Validates the location object.
+     *
+     * @returns {LocationObject} - The location object schema for validation.
+     */
+    static validateLocationObj(): LocationObject;
 }

package/sdk/application/ApplicationModels.js

@@ -1,6 +1,24 @@
 const Joi = require("joi");
 
+/**
+ * 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.
+ */
+
 class LocationValidator {
+  /**
+   * Validates the location object.
+   *
+   * @returns {LocationObject} - The location object schema for validation.
+   */
   static validateLocationObj() {
     return Joi.object({
       pincode: Joi.string(),