@gofynd/fdk-client-javascript 3.4.1 → 3.4.2

package/README.md

@@ -23,14 +23,13 @@ Using this method, you can `require` fdk-client-javascript like so:
 
 ```js
 const {
-  ApplicationConfig,
   ApplicationClient,
 } = require("fdk-client-javascript");
 ```
 
 #### Browser
 
-you can load fdk-client-javascript's application browser bundle from CDN; `ApplicationConfig` and `ApplicationClient` will be attached to browser's `window` object.
+you can load fdk-client-javascript's application browser bundle from CDN; `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>
@@ -43,12 +42,12 @@ Install Specific version
 ```
 
 ```js
-const { ApplicationConfig, ApplicationClient } = window;
+const { ApplicationClient } = window;
 ```
 
 ### Logging
 
-For logging support user can pass `logLevel` in `ApplicationConfig` or `PlatformConfig` while declaration.
+For logging support user can pass `logLevel` in `ApplicationClient` or `PlatformClient` while declaration.
 
 ```
 Available logging levels: TRACE, DEBUG, INFO, WARN, ERROR.
@@ -59,14 +58,12 @@ Default log level: ERROR
 ### Sample Usage - ApplicationClient
 
 ```javascript
-const config = new ApplicationConfig({
+const applicationClient = new ApplicationClient({
   applicationID: "YOUR_APPLICATION_ID",
   applicationToken: "YOUR_APPLICATION_TOKEN",
   locationDetails: "LOCATION_DETAILS_OBJECT"
 });
 
-const applicationClient = new ApplicationClient(config);
-
 applicationClient.setLocationDetails({ 
   pincode:"385001",
   country: "India",
@@ -92,21 +89,23 @@ getProductDetails();
 ### Sample Usage - PlatformClient
 
 ```javascript
-const { PlatformConfig, PlatformClient } = require("fdk-client-javascript");
-
-let platformConfig = new PlatformConfig({
-  companyId: "COMPANY_ID",
-  apiKey: "API_KEY", 
-  apiSecret: "API_SECRET", 
-  domain: "DOMAIN",
-  useAutoRenewTimer: true // Setting `true` will use timer based logic to refresh the access token. With `false` will issue refresh token just before any api call when it is expired. 
-});
+const { PlatformClient } = require("fdk-client-javascript");
 
 async function getData() {
   try {
-    // TODO: get token using OAuth
-    platformConfig.oauthClient.setToken(token.access_token);
-    const client = new PlatformClient(platformConfig);
+    const client = new PlatformClient({
+      companyId: "COMPANY_ID",
+      apiKey: "API_KEY", 
+      apiSecret: "API_SECRET", 
+      domain: "DOMAIN",
+      useAutoRenewTimer: true // Setting `true` will use timer based logic to refresh the access token. With `false` will issue refresh token just before any api call when it is expired. 
+    });
+
+    const token = await platformClient.getAccesstokenObj({
+      grant_type: 'client_credentials'    
+    })
+    
+    platformClient.setToken(token);
 
     // API's without application_id
     const tickets = await client.lead.getTickets();
@@ -219,17 +218,15 @@ To print the curl command in the console for all network calls made using `appli
 
 ```javascript
 const {
-  ApplicationClient, ApplicationConfig,
+  ApplicationClient,
 } = require("fdk-client-javascript");
 
-let applicationConfig = new ApplicationConfig({
+let applicationClient = new ApplicationClient({
   applicationID: "YOUR_APPLICATION_ID",
   applicationToken: "YOUR_APPLICATION_TOKEN",
+  logLevel: "debug"
 });
 
-applicationConfig.setLogLevel("debug");
-let applicationClient = new ApplicationClient(applicationConfig);
-
 let response = await applicationClient.theme.getAppliedTheme(); 
 console.log("Active Theme: ", response.information.name);
 ```
@@ -237,7 +234,7 @@ 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: 3.4.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.4.2' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 
@@ -248,7 +245,7 @@ Active Theme: Emerge
 fdk-client-javascript includes Typescript definitions.
 
 ```typescript
-import { ApplicationConfig, ApplicationClient } from "fdk-client-javascript";
+import { ApplicationClient } from "fdk-client-javascript";
 ```
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "3.4.1",
+  "version": "3.4.2",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/application/ApplicationClient.d.ts

@@ -6,8 +6,8 @@ export = ApplicationClient;
  */
 declare class ApplicationClient {
     /** @param {import("./ApplicationConfig")} config - The application configuration. */
-    constructor(config: import("./ApplicationConfig"));
-    config: import("./ApplicationConfig");
+    constructor(config: import("./ApplicationConfig"), options: any);
+    config: ApplicationConfig;
     cart: Cart;
     catalog: Catalog;
     common: Common;
@@ -65,6 +65,7 @@ declare class ApplicationClient {
         responseHeaders?: boolean;
     }): Promise<import("axios").AxiosResponse<any, any>>;
 }
+import ApplicationConfig = require("./ApplicationConfig");
 import Cart = require("./Cart/CartApplicationClient");
 import Catalog = require("./Catalog/CatalogApplicationClient");
 import Common = require("./Common/CommonApplicationClient");

package/sdk/application/ApplicationClient.js

@@ -19,6 +19,7 @@ const { FDKClientValidationError } = require("../common/FDKError");
 const { Logger } = require("../common/Logger");
 const { convertStringToBase64 } = require("../common/utils");
 const { execute } = require("./ApplicationAPIClient");
+const ApplicationConfig = require("./ApplicationConfig");
 
 /**
  * Represents the client for the application.
@@ -27,25 +28,30 @@ const { execute } = require("./ApplicationAPIClient");
  */
 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.finance = new Finance(config);
-    this.lead = new Lead(config);
-    this.logistic = new Logistic(config);
-    this.order = new Order(config);
-    this.payment = new Payment(config);
-    this.rewards = new Rewards(config);
-    this.share = new Share(config);
-    this.theme = new Theme(config);
-    this.user = new User(config);
-    this.webhook = new Webhook(config);
+  constructor(config, options) {
+    if (config instanceof ApplicationConfig) {
+      this.config = config;
+    } else {
+      let applicationConfig = new ApplicationConfig(config, options);
+      this.config = applicationConfig;
+    }
+    this.cart = new Cart(this.config);
+    this.catalog = new Catalog(this.config);
+    this.common = new Common(this.config);
+    this.communication = new Communication(this.config);
+    this.configuration = new Configuration(this.config);
+    this.content = new Content(this.config);
+    this.fileStorage = new FileStorage(this.config);
+    this.finance = new Finance(this.config);
+    this.lead = new Lead(this.config);
+    this.logistic = new Logistic(this.config);
+    this.order = new Order(this.config);
+    this.payment = new Payment(this.config);
+    this.rewards = new Rewards(this.config);
+    this.share = new Share(this.config);
+    this.theme = new Theme(this.config);
+    this.user = new User(this.config);
+    this.webhook = new Webhook(this.config);
   }
 
   /**

package/sdk/common/utils.js

@@ -57,9 +57,12 @@ const generateUrlWithParams = (item = {}, params) => {
   let url = "";
   for (let linkSubString of linkArr) {
     if (linkSubString.startsWith(":")) {
-      linkSubString = linkSubString.slice(1);
-      url += `${joinedParamsObj[linkSubString]}`;
-    } else url += `${linkSubString}`;
+      const paramKey = linkSubString.slice(1);
+      const paramVal = joinedParamsObj[paramKey];
+      url += paramVal || ""; // Prevent undefined
+    } else {
+      url += linkSubString;
+    }
     url += "/";
   }
   url = trimChar(url);

package/sdk/partner/PartnerClient.d.ts

@@ -11,8 +11,8 @@ declare class PartnerClient {
      * @param {import("./PartnerConfig")} config - The configuration for the
      *   partner client.
      */
-    constructor(config: import("./PartnerConfig"));
-    config: import("./PartnerConfig");
+    constructor(config: import("./PartnerConfig"), options: any);
+    config: PartnerConfig;
     fileStorage: FileStorage;
     lead: Lead;
     logistics: Logistics;
@@ -33,7 +33,10 @@ declare class PartnerClient {
         headers: any;
         responseHeaders?: boolean;
     }): Promise<import("axios").AxiosResponse<any, any>>;
+    getAccesstokenObj(options: any): Promise<import("axios").AxiosResponse<any, any>>;
+    setToken(token: any): void;
 }
+import PartnerConfig = require("./PartnerConfig");
 import FileStorage = require("./FileStorage/FileStoragePartnerClient");
 import Lead = require("./Lead/LeadPartnerClient");
 import Logistics = require("./Logistics/LogisticsPartnerClient");

package/sdk/partner/PartnerClient.js

@@ -10,6 +10,7 @@ const Webhook = require("./Webhook/WebhookPartnerClient");
 
 const { FDKClientValidationError } = require("../common/FDKError");
 const { execute } = require("./PartnerAPIClient");
+const PartnerConfig = require("./PartnerConfig");
 
 /**
  * Represents the client for the partner APIs.
@@ -23,13 +24,18 @@ class PartnerClient {
    * @param {import("./PartnerConfig")} config - The configuration for the
    *   partner client.
    */
-  constructor(config) {
-    this.config = config;
-    this.fileStorage = new FileStorage(config);
-    this.lead = new Lead(config);
-    this.logistics = new Logistics(config);
-    this.theme = new Theme(config);
-    this.webhook = new Webhook(config);
+  constructor(config, options) {
+    if (config instanceof PartnerConfig) {
+      this.config = config;
+    } else {
+      let partnerConfig = new PartnerConfig(config, options);
+      this.config = partnerConfig;
+    }
+    this.fileStorage = new FileStorage(this.config);
+    this.lead = new Lead(this.config);
+    this.logistics = new Logistics(this.config);
+    this.theme = new Theme(this.config);
+    this.webhook = new Webhook(this.config);
   }
 
   /**
@@ -58,6 +64,14 @@ class PartnerClient {
       responseHeaders,
     });
   }
+
+  getAccesstokenObj(options) {
+    return this.config.oauthClient.getAccesstokenObj(options);
+  }
+
+  setToken(token) {
+    this.config.oauthClient.setToken(token);
+  }
 }
 
 module.exports = PartnerClient;

package/sdk/platform/Cart/CartPlatformModel.d.ts

@@ -2453,88 +2453,9 @@ export = CartPlatformModel;
  *   | "kiosk"
  *   | "scan_go"
  *   | "smart_trolley"
- *   | "gofynd"
- *   | "uniket"
  *   | "marketplace"
  *   | "social_commerce"
- *   | "ondc"
- *   | "nexus"
- *   | "nykaa_fashion"
- *   | "etsy"
- *   | "vuivui"
- *   | "zilingo"
- *   | "firstcry"
- *   | "bukalapak"
- *   | "myntra_ppmp"
- *   | "lazada"
- *   | "tiktok"
- *   | "sfcc"
- *   | "debenhams"
- *   | "prestomall"
- *   | "meesho"
- *   | "amazon_vdf"
- *   | "bigcommerce"
- *   | "sendo"
- *   | "storehippo"
- *   | "cdiscount"
- *   | "nykaa"
- *   | "trendyol"
- *   | "weloveshopping"
- *   | "jollee"
- *   | "wish"
- *   | "tiki"
- *   | "central_online"
- *   | "q10"
- *   | "cred"
- *   | "walmart"
- *   | "snapdeal"
- *   | "flipkart"
- *   | "blibli"
- *   | "ajio_jit"
- *   | "pharmeasy"
- *   | "ezmall"
- *   | "adobe_commerce"
- *   | "kartmax"
- *   | "shopee"
- *   | "zalora"
- *   | "prestashop"
- *   | "smytten"
- *   | "amazon_sc"
- *   | "urbanpiper"
- *   | "flipkart_quick"
- *   | "woocommerce"
- *   | "zivame"
- *   | "lelong"
- *   | "facebook"
- *   | "jiomart"
- *   | "gmc"
- *   | "robins"
- *   | "akulaku"
- *   | "noon"
- *   | "tatacliq"
- *   | "kartrocket"
- *   | "inorbit"
- *   | "ajio_business"
- *   | "swiggy"
- *   | "asos"
- *   | "tokopedia"
- *   | "limeroad"
- *   | "myntra_omni"
- *   | "spoyl"
- *   | "amazon_mlf"
- *   | "fulfilled_by_lazada"
- *   | "ebay"
- *   | "jd"
- *   | "amazon_pharmacy"
- *   | "ajio_vms"
- *   | "daraz"
- *   | "oker"
- *   | "flipkart_b2b"
- *   | "amazon_mlf_ss"
- *   | "woovly"
- *   | "tata1mg"
- *   | "zomato"
- *   | "shopify"} OrderingSource
+ *   | "ondc"} OrderingSource
  */
 declare class CartPlatformModel {
 }
@@ -8687,4 +8608,4 @@ type ValidationError = {
  * @returns {OrderingSource}
  */
 declare function OrderingSource(): OrderingSource;
-type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "gofynd" | "uniket" | "marketplace" | "social_commerce" | "ondc" | "nexus" | "nykaa_fashion" | "etsy" | "vuivui" | "zilingo" | "firstcry" | "bukalapak" | "myntra_ppmp" | "lazada" | "tiktok" | "sfcc" | "debenhams" | "prestomall" | "meesho" | "amazon_vdf" | "bigcommerce" | "sendo" | "storehippo" | "cdiscount" | "nykaa" | "trendyol" | "weloveshopping" | "jollee" | "wish" | "tiki" | "central_online" | "q10" | "cred" | "walmart" | "snapdeal" | "flipkart" | "blibli" | "ajio_jit" | "pharmeasy" | "ezmall" | "adobe_commerce" | "kartmax" | "shopee" | "zalora" | "prestashop" | "smytten" | "amazon_sc" | "urbanpiper" | "flipkart_quick" | "woocommerce" | "zivame" | "lelong" | "facebook" | "jiomart" | "gmc" | "robins" | "akulaku" | "noon" | "tatacliq" | "kartrocket" | "inorbit" | "ajio_business" | "swiggy" | "asos" | "tokopedia" | "limeroad" | "myntra_omni" | "spoyl" | "amazon_mlf" | "fulfilled_by_lazada" | "ebay" | "jd" | "amazon_pharmacy" | "ajio_vms" | "daraz" | "oker" | "flipkart_b2b" | "amazon_mlf_ss" | "woovly" | "tata1mg" | "zomato" | "shopify";
+type OrderingSource = "storefront" | "store_os_pos" | "kiosk" | "scan_go" | "smart_trolley" | "marketplace" | "social_commerce" | "ondc";

package/sdk/platform/Cart/CartPlatformModel.js

@@ -2666,88 +2666,9 @@ const Joi = require("joi");
  *   | "kiosk"
  *   | "scan_go"
  *   | "smart_trolley"
- *   | "gofynd"
- *   | "uniket"
  *   | "marketplace"
  *   | "social_commerce"
- *   | "ondc"
- *   | "nexus"
- *   | "nykaa_fashion"
- *   | "etsy"
- *   | "vuivui"
- *   | "zilingo"
- *   | "firstcry"
- *   | "bukalapak"
- *   | "myntra_ppmp"
- *   | "lazada"
- *   | "tiktok"
- *   | "sfcc"
- *   | "debenhams"
- *   | "prestomall"
- *   | "meesho"
- *   | "amazon_vdf"
- *   | "bigcommerce"
- *   | "sendo"
- *   | "storehippo"
- *   | "cdiscount"
- *   | "nykaa"
- *   | "trendyol"
- *   | "weloveshopping"
- *   | "jollee"
- *   | "wish"
- *   | "tiki"
- *   | "central_online"
- *   | "q10"
- *   | "cred"
- *   | "walmart"
- *   | "snapdeal"
- *   | "flipkart"
- *   | "blibli"
- *   | "ajio_jit"
- *   | "pharmeasy"
- *   | "ezmall"
- *   | "adobe_commerce"
- *   | "kartmax"
- *   | "shopee"
- *   | "zalora"
- *   | "prestashop"
- *   | "smytten"
- *   | "amazon_sc"
- *   | "urbanpiper"
- *   | "flipkart_quick"
- *   | "woocommerce"
- *   | "zivame"
- *   | "lelong"
- *   | "facebook"
- *   | "jiomart"
- *   | "gmc"
- *   | "robins"
- *   | "akulaku"
- *   | "noon"
- *   | "tatacliq"
- *   | "kartrocket"
- *   | "inorbit"
- *   | "ajio_business"
- *   | "swiggy"
- *   | "asos"
- *   | "tokopedia"
- *   | "limeroad"
- *   | "myntra_omni"
- *   | "spoyl"
- *   | "amazon_mlf"
- *   | "fulfilled_by_lazada"
- *   | "ebay"
- *   | "jd"
- *   | "amazon_pharmacy"
- *   | "ajio_vms"
- *   | "daraz"
- *   | "oker"
- *   | "flipkart_b2b"
- *   | "amazon_mlf_ss"
- *   | "woovly"
- *   | "tata1mg"
- *   | "zomato"
- *   | "shopify"} OrderingSource
+ *   | "ondc"} OrderingSource
  */
 
 class CartPlatformModel {
@@ -5489,169 +5410,11 @@ class CartPlatformModel {
 
       "smart_trolley",
 
-      "gofynd",
-
-      "uniket",
-
       "marketplace",
 
       "social_commerce",
 
-      "ondc",
-
-      "nexus",
-
-      "nykaa_fashion",
-
-      "etsy",
-
-      "vuivui",
-
-      "zilingo",
-
-      "firstcry",
-
-      "bukalapak",
-
-      "myntra_ppmp",
-
-      "lazada",
-
-      "tiktok",
-
-      "sfcc",
-
-      "debenhams",
-
-      "prestomall",
-
-      "meesho",
-
-      "amazon_vdf",
-
-      "bigcommerce",
-
-      "sendo",
-
-      "storehippo",
-
-      "cdiscount",
-
-      "nykaa",
-
-      "trendyol",
-
-      "weloveshopping",
-
-      "jollee",
-
-      "wish",
-
-      "tiki",
-
-      "central_online",
-
-      "q10",
-
-      "cred",
-
-      "walmart",
-
-      "snapdeal",
-
-      "flipkart",
-
-      "blibli",
-
-      "ajio_jit",
-
-      "pharmeasy",
-
-      "ezmall",
-
-      "adobe_commerce",
-
-      "kartmax",
-
-      "shopee",
-
-      "zalora",
-
-      "prestashop",
-
-      "smytten",
-
-      "amazon_sc",
-
-      "urbanpiper",
-
-      "flipkart_quick",
-
-      "woocommerce",
-
-      "zivame",
-
-      "lelong",
-
-      "facebook",
-
-      "jiomart",
-
-      "gmc",
-
-      "robins",
-
-      "akulaku",
-
-      "noon",
-
-      "tatacliq",
-
-      "kartrocket",
-
-      "inorbit",
-
-      "ajio_business",
-
-      "swiggy",
-
-      "asos",
-
-      "tokopedia",
-
-      "limeroad",
-
-      "myntra_omni",
-
-      "spoyl",
-
-      "amazon_mlf",
-
-      "fulfilled_by_lazada",
-
-      "ebay",
-
-      "jd",
-
-      "amazon_pharmacy",
-
-      "ajio_vms",
-
-      "daraz",
-
-      "oker",
-
-      "flipkart_b2b",
-
-      "amazon_mlf_ss",
-
-      "woovly",
-
-      "tata1mg",
-
-      "zomato",
-
-      "shopify"
+      "ondc"
     );
   }
 }