@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

package/sdk/application/User/UserApplicationValidator.js

@@ -4,41 +4,41 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef AddEmailParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.EditEmailRequestSchema} body
  */
 
 /**
  * @typedef AddMobileNumberParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.EditMobileRequestSchema} body
  */
 
 /**
  * @typedef DeleteEmailParam
- * @property {string} [platform] - ID of the application
- * @property {boolean} active - This is a boolean value to check if email ID is
- *   active 1. True - Email ID is active 2.False - Email ID is inactive
- * @property {boolean} primary - This is a boolean value to check if email ID is
- *   primary (main email ID) 1. True - Email ID is primary 2.False - Email ID is
- *   not primary
- * @property {boolean} verified - This is a boolean value to check if email ID
- *   is verified 1. True - Email ID is verified 2.False - Email ID is not verified yet
- * @property {string} email - The email ID to delete
+ * @property {string} [platform] - ID of the application.
+ * @property {boolean} active - Boolean value to check if email id is active 1.
+ *   True - email id is active 2.False - email id is inactive.
+ * @property {boolean} primary - Boolean value to check if email id is primary
+ *   (main email id) 1. True - email id is primary 2.False - email id is not primary.
+ * @property {boolean} verified - Boolean value to check if email id is verified
+ *   1. True - email id is verified 2.False - email id is not verified yet.
+ * @property {string} email - The email id to delete.
  */
 
 /**
  * @typedef DeleteMobileNumberParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {boolean} active - This is a boolean value to check if mobile
- *   number is active 1.True - Number is active 2. False - Number is inactive
+ *   number is active 1.True - number is active 2. False - number is inactive.
  * @property {boolean} primary - This is a boolean value to check if mobile
- *   number is primary number (main number) 1. True - Number is primary 2. False
- *   - Number is not primary
+ *   number is primary number (main number) 1. True - number is primary 2. False
+ *   - number is not primary.
  * @property {boolean} verified - This is a boolean value to check if mobile
- *   number is verified 1. True - Number is verified 2.False - Number is not verified yet
- * @property {string} countryCode - Country code of the phone number, e.g. 91
- * @property {string} phone - Phone number
+ *   number is verified 1. True - number is verified 2.False - number is not
+ *   verified yet.
+ * @property {string} countryCode - Country code of the phone number, e.g. 91.
+ * @property {string} phone - Phone number.
  */
 
 /**
@@ -57,7 +57,7 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef GetPlatformConfigParam
- * @property {string} [name] - Name of the application, e.g. Fynd
+ * @property {string} [name] - Name of the application, e.g. Fynd.
  */
 
 /**
@@ -69,7 +69,7 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef LoginWithAppleIOSParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.OAuthRequestAppleSchema} body
  */
 
@@ -80,31 +80,31 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef LoginWithFacebookParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.OAuthRequestSchema} body
  */
 
 /**
  * @typedef LoginWithGoogleParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.OAuthRequestSchema} body
  */
 
 /**
  * @typedef LoginWithGoogleAndroidParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.OAuthRequestSchema} body
  */
 
 /**
  * @typedef LoginWithGoogleIOSParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.OAuthRequestSchema} body
  */
 
 /**
  * @typedef LoginWithOTPParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendOtpRequestSchema} body
  */
 
@@ -117,7 +117,7 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef RegisterWithFormParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.FormRegisterRequestSchema} body
  */
 
@@ -128,37 +128,37 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef SendForgotOTPOnEmailParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendEmailForgotOtpRequestSchema} body
  */
 
 /**
  * @typedef SendForgotOTPOnMobileParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendMobileForgotOtpRequestSchema} body
  */
 
 /**
  * @typedef SendOTPOnEmailParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendEmailOtpRequestSchema} body
  */
 
 /**
  * @typedef SendOTPOnMobileParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendMobileOtpRequestSchema} body
  */
 
 /**
  * @typedef SendResetPasswordEmailParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendResetPasswordEmailRequestSchema} body
  */
 
 /**
  * @typedef SendResetPasswordMobileParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendResetPasswordMobileRequestSchema} body
  */
 
@@ -169,13 +169,13 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef SendVerificationLinkToEmailParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.EditEmailRequestSchema} body
  */
 
 /**
  * @typedef SendVerificationLinkToMobileParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.SendVerificationLinkMobileRequestSchema} body
  */
 
@@ -196,7 +196,7 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef UpdateProfileParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.EditProfileRequestSchema} body
  */
 
@@ -207,7 +207,7 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef UserExistsParam
- * @property {string} q - Email id or phone number of user
+ * @property {string} q - Email id or phone number of user.
  */
 
 /**
@@ -217,13 +217,13 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef VerifyEmailForgotOTPParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.VerifyEmailForgotOtpRequestSchema} body
  */
 
 /**
  * @typedef VerifyEmailOTPParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.VerifyEmailOtpRequestSchema} body
  */
 
@@ -234,13 +234,13 @@ const UserApplicationModel = require("./UserApplicationModel");
 
 /**
  * @typedef VerifyMobileForgotOTPParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.VerifyMobileForgotOtpRequestSchema} body
  */
 
 /**
  * @typedef VerifyMobileOTPParam
- * @property {string} [platform] - ID of the application
+ * @property {string} [platform] - ID of the application.
  * @property {UserApplicationModel.VerifyOtpRequestSchema} body
  */
 

package/sdk/application/Webhook/WebhookApplicationClient.d.ts

@@ -14,7 +14,7 @@ declare class Webhook {
      * @returns {Promise<WebhookApplicationModel.ClickEventResponse>} - Success response
      * @name saveClickEvent
      * @summary: Endpoint to capture click events from sales channels and persist them in database.
-     * @description: Endpoint to capture click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
+     * @description: Send click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
      */
     saveClickEvent({ body, requestHeaders }?: WebhookApplicationValidator.SaveClickEventParam, { responseHeaders }?: object): Promise<WebhookApplicationModel.ClickEventResponse>;
 }

package/sdk/application/Webhook/WebhookApplicationClient.js

@@ -40,7 +40,7 @@ class Webhook {
    * @returns {Promise<WebhookApplicationModel.ClickEventResponse>} - Success response
    * @name saveClickEvent
    * @summary: Endpoint to capture click events from sales channels and persist them in database.
-   * @description: Endpoint to capture click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
+   * @description: Send click events from sales channels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/webhook/saveClickEvent/).
    */
   async saveClickEvent(
     { body, requestHeaders } = { requestHeaders: {} },

package/sdk/application/Webhook/WebhookApplicationModel.d.ts

@@ -1,17 +1,17 @@
 export = WebhookApplicationModel;
 /**
  * @typedef ClickEventBatch
- * @property {string} [event_name]
+ * @property {string} [event_name] - Name of click event.
  */
 /**
  * @typedef ClickEventRequest
- * @property {ClickEventBatch[]} [batch]
+ * @property {ClickEventBatch[]} [batch] - List of click events captured.
  */
 /**
  * @typedef ClickEventResponse
- * @property {number} [success_count]
- * @property {number} [failed_count]
- * @property {ClickEventBatch[]} [failed_events]
+ * @property {number} [success_count] - Count of valid events.
+ * @property {number} [failed_count] - Count of events failed in schema validation.
+ * @property {ClickEventBatch[]} [failed_events] - List of failed events with error.
  */
 declare class WebhookApplicationModel {
 }
@@ -21,17 +21,32 @@ declare namespace WebhookApplicationModel {
 /** @returns {ClickEventBatch} */
 declare function ClickEventBatch(): ClickEventBatch;
 type ClickEventBatch = {
+    /**
+     * - Name of click event.
+     */
     event_name?: string;
 };
 /** @returns {ClickEventRequest} */
 declare function ClickEventRequest(): ClickEventRequest;
 type ClickEventRequest = {
+    /**
+     * - List of click events captured.
+     */
     batch?: ClickEventBatch[];
 };
 /** @returns {ClickEventResponse} */
 declare function ClickEventResponse(): ClickEventResponse;
 type ClickEventResponse = {
+    /**
+     * - Count of valid events.
+     */
     success_count?: number;
+    /**
+     * - Count of events failed in schema validation.
+     */
     failed_count?: number;
+    /**
+     * - List of failed events with error.
+     */
     failed_events?: ClickEventBatch[];
 };

package/sdk/application/Webhook/WebhookApplicationModel.js

@@ -2,19 +2,19 @@ const Joi = require("joi");
 
 /**
  * @typedef ClickEventBatch
- * @property {string} [event_name]
+ * @property {string} [event_name] - Name of click event.
  */
 
 /**
  * @typedef ClickEventRequest
- * @property {ClickEventBatch[]} [batch]
+ * @property {ClickEventBatch[]} [batch] - List of click events captured.
  */
 
 /**
  * @typedef ClickEventResponse
- * @property {number} [success_count]
- * @property {number} [failed_count]
- * @property {ClickEventBatch[]} [failed_events]
+ * @property {number} [success_count] - Count of valid events.
+ * @property {number} [failed_count] - Count of events failed in schema validation.
+ * @property {ClickEventBatch[]} [failed_events] - List of failed events with error.
  */
 
 class WebhookApplicationModel {

package/sdk/common/Clickstream.js

@@ -16,7 +16,35 @@ const sg = function safeGet(fn, defaultValue = null) {
     return defaultValue;
   }
 };
-
+/**
+ * Safely extracts search query and click position
+ *
+ * @author Hitendra Singh
+ * @param {Object} [defaultValue] - Utm_params
+ * @returns {Object} - Query and position
+ */
+const fetchPositionAndQuery = function (utm_params) {
+  if (!utm_params || !Object.keys(utm_params).length) {
+    return {
+      query: null,
+      position: null,
+    };
+  }
+  const decodedUri = utm_params.utm_content
+    ? atob(utm_params.utm_content)
+    : null;
+  if (decodedUri && utm_params.utm_medium === "search") {
+    const parts = decodedUri.split(":::");
+    return {
+      query: parts[0] || null,
+      position: parts[1] || null,
+    };
+  }
+  return {
+    query: null,
+    position: null,
+  };
+};
 if (typeof window != "undefined") {
   window.FPI.event.on("user.login", (eventData) => {
     Logger({ level: "DEBUG", message: eventData });
@@ -57,7 +85,7 @@ if (typeof window != "undefined") {
 
   window.FPI.event.on("wishlist.add", (eventData) => {
     Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("product_wishlist_add", {
+    const payload = {
       wishlist_name: "TODO",
       wishlist_id: "TODO",
       event_type: "engagement",
@@ -70,6 +98,11 @@ if (typeof window != "undefined") {
       currency: sg(() => eventData.item.price.effective.currency_code),
       value: "TODO",
       source_url: "TODO",
+    };
+    const queryResult = fetchPositionAndQuery(eventData.utm_params);
+    Clickstream.sendEvent("product_wishlist_add", {
+      ...payload,
+      ...queryResult,
     })
       .then((resp) => {
         Logger({ level: "DEBUG", message: "Click event sent" });
@@ -105,7 +138,7 @@ if (typeof window != "undefined") {
 
   window.FPI.event.on("cart.newProduct", (eventData) => {
     Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("add_to_cart", {
+    const payload = {
       cart_id: eventData.cart_id,
       event_type: "engagement",
       product_id: sg(() => eventData.products[0]["uid"]),
@@ -117,9 +150,12 @@ if (typeof window != "undefined") {
       price: sg(() => eventData.products[0]["price"]["selling"]),
       quantity: sg(() => eventData.products[0]["quantity"]["current"]),
       source_url: "TODO",
-      position: "TODO",
+      position: null,
+      query: null,
       value: "TODO",
-    })
+    };
+    const queryResult = fetchPositionAndQuery(eventData.utm_params);
+    Clickstream.sendEvent("add_to_cart", { ...payload, ...queryResult })
       .then((resp) => {
         Logger({ level: "DEBUG", message: "Click event sent" });
       })
@@ -141,7 +177,7 @@ if (typeof window != "undefined") {
       price: sg(() => eventData.products[0]["price"]["selling"]),
       quantity: sg(() => eventData.products[0]["quantity"]["current"]),
       source_url: "TODO",
-      position: "TODO",
+      position: null,
       value: "TODO",
     })
       .then((resp) => {
@@ -212,9 +248,30 @@ if (typeof window != "undefined") {
       });
   });
 
+  window.FPI.event.on("product_list.view", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("product_listing", {
+      event_type: "impression",
+      query: sg(() => eventData.slug["q"]),
+      products: eventData.items.map((p) => {
+        return {
+          product_id: p.uid,
+          name: p.name,
+          currency: sg(() => p.price["effective"]["currency_code"]),
+          mrp: sg(() => p.price["effective"]["max"]),
+          esp: sg(() => p.price["effective"]["min"]),
+          source_url: p.url,
+          brand: sg(() => p.brand["name"]),
+        };
+      }),
+
+      item_total: sg(() => eventData["page"]["item_total"]),
+    });
+  });
+
   window.FPI.event.on("product.view", (eventData) => {
     Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("product_view", {
+    const payload = {
       event_type: "click",
       product_id: sg(() => eventData.product["uid"]),
       currency: sg(() => eventData.product.price["currency_code"]),
@@ -225,8 +282,11 @@ if (typeof window != "undefined") {
       l1_category: sg(() => eventData.product.l1_category),
       source_url: sg(() => eventData.product.source_url),
       quantity: sg(() => eventData.product.sizes[0]["quantity"]),
-      position: "TODO",
-    })
+      position: null,
+      query: null,
+    };
+    const queryResult = fetchPositionAndQuery(eventData.utm_params);
+    Clickstream.sendEvent("product_view", { ...payload, ...queryResult })
       .then((resp) => {
         Logger({ level: "DEBUG", message: "Click event sent" });
       })
@@ -237,16 +297,36 @@ if (typeof window != "undefined") {
 
   window.FPI.event.on("search.products", (eventData) => {
     Logger({ level: "DEBUG", message: eventData });
-    Clickstream.sendEvent("product_search", {
+    const payload = {
       event_type: "search",
       query: eventData.search_text,
-    })
-      .then((resp) => {
-        Logger({ level: "DEBUG", message: "Click event sent" });
+      products: [],
+      item_total: null,
+    };
+    //filter eventData.data to find the products array and item total
+    const products = eventData.data
+      .filter((item) => {
+        if ((item["type"] === "product" && item.categories) || item.product)
+          return true;
       })
-      .catch((err) => {
-        Logger({ level: "ERROR", message: err });
+      .map((product) => {
+        return product.display || product.name;
       });
+    const item_total = sg(() => eventData.page["item_total"]);
+    if (payload.query) {
+      //only if query is present
+      Clickstream.sendEvent("product_search", {
+        ...payload,
+        products,
+        item_total,
+      })
+        .then((resp) => {
+          Logger({ level: "DEBUG", message: "Click event sent" });
+        })
+        .catch((err) => {
+          Logger({ level: "ERROR", message: err });
+        });
+    }
   });
 
   window.FPI.event.on("product_list.filter", (eventData) => {

package/sdk/common/Constant.d.ts

@@ -12,6 +12,7 @@ export namespace AVAILABLE_PAGE_TYPE {
     const COLLECTIONS: string;
     const CONTACT_US: string;
     const EXTERNAL: string;
+    const CUSTOM: string;
     const FAQ: string;
     const FRESHCHAT: string;
     const HOME: string;
@@ -127,6 +128,14 @@ export const NAVIGATORS: {
             required: boolean;
         }[];
     };
+    custom: {
+        name: string;
+        link: string;
+        query: {
+            key: string;
+            required: boolean;
+        }[];
+    };
     faq: {
         name: string;
         link: string;

package/sdk/common/Constant.js

@@ -12,6 +12,7 @@ const AVAILABLE_PAGE_TYPE = {
   COLLECTIONS: "collections",
   CONTACT_US: "contact-us",
   EXTERNAL: "external",
+  CUSTOM: "custom",
   FAQ: "faq",
   FRESHCHAT: "freshchat",
   HOME: "home",
@@ -144,6 +145,16 @@ const NAVIGATORS = {
       },
     ],
   },
+  custom: {
+    name: "Custom theme link",
+    link: "/c/",
+    query: [
+      {
+        key: "url",
+        required: true,
+      },
+    ],
+  },
   faq: {
     name: "FAQ",
     link: "/faq",

package/sdk/common/Utility.js

@@ -31,6 +31,20 @@ function convertUrlToAction(url) {
       return utils.trimChar(pageType) === bestMatchingLink.value;
     });
     const closestMatchingNavKey = typeLink[closestMatchingNavLink] || "home";
+    // if it is custom theme link url should be in query object, also we will grab our main link from this url field in convertActionToUrl
+    if (closestMatchingNavLink === Constant.NAVIGATORS.custom.link) {
+      return {
+        type: "page",
+        page: {
+          type: closestMatchingNavKey,
+          query: {
+            url: [url.split("?")[0]],
+            ...query,
+          },
+          params: bestMatchingLink.params,
+        },
+      };
+    }
     return {
       type: "page",
       page: {
@@ -57,6 +71,11 @@ function convertActionToUrl(action) {
       case utils.NAV_TYPE.PAGE: {
         const item = Object.assign({}, Constant.NAVIGATORS[action.page.type]);
         if (item) {
+          // If it is custom action object then we need to get out link from query.url, in custom page action object url in query is original link, so get link from there and remove the url field
+          if (action.page.type === Constant.AVAILABLE_PAGE_TYPE.CUSTOM) {
+            item.link = action.page.query.url[0];
+            delete action.page.query.url;
+          }
           //get param
           item.link = utils.generateUrlWithParams(item, action.page.params);
           //get query

package/sdk/common/utils.js

@@ -112,7 +112,14 @@ const findBestMatchingLink = (allLinks = [], pathname = "/") => {
   pathname = trimChar(pathname); // -> product/test-product-tag/reviews
   for (let i = 0; i < allLinks.length; i++) {
     let link = trimChar(allLinks[i]); // -> product/:slug/add-reviews
-    if (new RegExp(`^${trimChar(link)}`).test(pathname)) {
+
+    const firstLinkMatch = trimChar(link).split("/")[0];
+    const firstPathMatch = trimChar(pathname).split("/")[0];
+    // atleast first string from path should match, if you don't add this condition then it will give link 'c' for 'collection' path name
+    if (
+      new RegExp(`^${trimChar(link)}`).test(pathname) &&
+      firstLinkMatch.length === firstPathMatch.length
+    ) {
       bestMatch.value = link;
       break;
     }

package/sdk/partner/Lead/LeadPartnerModel.d.ts

@@ -7,13 +7,13 @@ export = LeadPartnerModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef TicketHistoryList
@@ -194,12 +194,33 @@ type TicketList = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {TicketHistoryList} */