@gofynd/fdk-client-javascript 1.4.1 → 1.4.2-beta.10

package/sdk/application/User/UserApplicationValidator.d.ts

@@ -48,10 +48,6 @@ export = UserApplicationValidator;
  * @typedef GetPlatformConfigParam
  * @property {string} [name] - Name of the application, e.g. Fynd
  */
-/**
- * @typedef GetUserAttributesParam
- * @property {string} [slug] - Filter by attribute slug.
- */
 /** @typedef HasPasswordParam */
 /**
  * @typedef LoginWithAppleIOSParam
@@ -162,14 +158,6 @@ export = UserApplicationValidator;
  * @property {string} [platform] - ID of the application
  * @property {UserApplicationModel.EditProfileRequestSchema} body
  */
-/**
- * @typedef UpdateUserAttributesParam
- * @property {UserApplicationModel.UpdateUserAttributesRequest} body
- */
-/**
- * @typedef UserExistsParam
- * @property {string} q - Email id or phone number of user
- */
 /**
  * @typedef VerifyEmailParam
  * @property {UserApplicationModel.CodeRequestBodySchema} body
@@ -217,8 +205,6 @@ declare class UserApplicationValidator {
     static getLoggedInUser(): any;
     /** @returns {GetPlatformConfigParam} */
     static getPlatformConfig(): GetPlatformConfigParam;
-    /** @returns {GetUserAttributesParam} */
-    static getUserAttributes(): GetUserAttributesParam;
     /** @returns {HasPasswordParam} */
     static hasPassword(): any;
     /** @returns {LoginWithAppleIOSParam} */
@@ -269,10 +255,6 @@ declare class UserApplicationValidator {
     static updatePassword(): UpdatePasswordParam;
     /** @returns {UpdateProfileParam} */
     static updateProfile(): UpdateProfileParam;
-    /** @returns {UpdateUserAttributesParam} */
-    static updateUserAttributes(): UpdateUserAttributesParam;
-    /** @returns {UserExistsParam} */
-    static userExists(): UserExistsParam;
     /** @returns {VerifyEmailParam} */
     static verifyEmail(): VerifyEmailParam;
     /** @returns {VerifyEmailForgotOTPParam} */
@@ -287,7 +269,7 @@ declare class UserApplicationValidator {
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace UserApplicationValidator {
-    export { AddEmailParam, AddMobileNumberParam, DeleteEmailParam, DeleteMobileNumberParam, DeleteUserParam, ForgotPasswordParam, GetListOfActiveSessionsParam, GetLoggedInUserParam, GetPlatformConfigParam, GetUserAttributesParam, HasPasswordParam, LoginWithAppleIOSParam, LoginWithEmailAndPasswordParam, LoginWithFacebookParam, LoginWithGoogleParam, LoginWithGoogleAndroidParam, LoginWithGoogleIOSParam, LoginWithOTPParam, LoginWithTokenParam, LogoutParam, RegisterWithFormParam, ResetForgotPasswordParam, SendForgotOTPOnEmailParam, SendForgotOTPOnMobileParam, SendOTPOnEmailParam, SendOTPOnMobileParam, SendResetPasswordEmailParam, SendResetPasswordMobileParam, SendResetTokenParam, SendVerificationLinkToEmailParam, SendVerificationLinkToMobileParam, SetEmailAsPrimaryParam, SetMobileNumberAsPrimaryParam, UpdatePasswordParam, UpdateProfileParam, UpdateUserAttributesParam, UserExistsParam, VerifyEmailParam, VerifyEmailForgotOTPParam, VerifyEmailOTPParam, VerifyMobileParam, VerifyMobileForgotOTPParam, VerifyMobileOTPParam };
+    export { AddEmailParam, AddMobileNumberParam, DeleteEmailParam, DeleteMobileNumberParam, DeleteUserParam, ForgotPasswordParam, GetListOfActiveSessionsParam, GetLoggedInUserParam, GetPlatformConfigParam, HasPasswordParam, LoginWithAppleIOSParam, LoginWithEmailAndPasswordParam, LoginWithFacebookParam, LoginWithGoogleParam, LoginWithGoogleAndroidParam, LoginWithGoogleIOSParam, LoginWithOTPParam, LoginWithTokenParam, LogoutParam, RegisterWithFormParam, ResetForgotPasswordParam, SendForgotOTPOnEmailParam, SendForgotOTPOnMobileParam, SendOTPOnEmailParam, SendOTPOnMobileParam, SendResetPasswordEmailParam, SendResetPasswordMobileParam, SendResetTokenParam, SendVerificationLinkToEmailParam, SendVerificationLinkToMobileParam, SetEmailAsPrimaryParam, SetMobileNumberAsPrimaryParam, UpdatePasswordParam, UpdateProfileParam, VerifyEmailParam, VerifyEmailForgotOTPParam, VerifyEmailOTPParam, VerifyMobileParam, VerifyMobileForgotOTPParam, VerifyMobileOTPParam };
 }
 type AddEmailParam = {
     /**
@@ -371,12 +353,6 @@ type GetPlatformConfigParam = {
      */
     name?: string;
 };
-type GetUserAttributesParam = {
-    /**
-     * - Filter by attribute slug.
-     */
-    slug?: string;
-};
 type LoginWithAppleIOSParam = {
     /**
      * - ID of the application
@@ -510,15 +486,6 @@ type UpdateProfileParam = {
     platform?: string;
     body: UserApplicationModel.EditProfileRequestSchema;
 };
-type UpdateUserAttributesParam = {
-    body: UserApplicationModel.UpdateUserAttributesRequest;
-};
-type UserExistsParam = {
-    /**
-     * - Email id or phone number of user
-     */
-    q: string;
-};
 type VerifyEmailParam = {
     body: UserApplicationModel.CodeRequestBodySchema;
 };

package/sdk/application/User/UserApplicationValidator.js

@@ -60,11 +60,6 @@ const UserApplicationModel = require("./UserApplicationModel");
  * @property {string} [name] - Name of the application, e.g. Fynd
  */
 
-/**
- * @typedef GetUserAttributesParam
- * @property {string} [slug] - Filter by attribute slug.
- */
-
 /** @typedef HasPasswordParam */
 
 /**
@@ -200,16 +195,6 @@ const UserApplicationModel = require("./UserApplicationModel");
  * @property {UserApplicationModel.EditProfileRequestSchema} body
  */
 
-/**
- * @typedef UpdateUserAttributesParam
- * @property {UserApplicationModel.UpdateUserAttributesRequest} body
- */
-
-/**
- * @typedef UserExistsParam
- * @property {string} q - Email id or phone number of user
- */
-
 /**
  * @typedef VerifyEmailParam
  * @property {UserApplicationModel.CodeRequestBodySchema} body
@@ -315,13 +300,6 @@ class UserApplicationValidator {
     });
   }
 
-  /** @returns {GetUserAttributesParam} */
-  static getUserAttributes() {
-    return Joi.object({
-      slug: Joi.string().allow(""),
-    });
-  }
-
   /** @returns {HasPasswordParam} */
   static hasPassword() {
     return Joi.object({});
@@ -509,20 +487,6 @@ class UserApplicationValidator {
     }).required();
   }
 
-  /** @returns {UpdateUserAttributesParam} */
-  static updateUserAttributes() {
-    return Joi.object({
-      body: UserApplicationModel.UpdateUserAttributesRequest().required(),
-    }).required();
-  }
-
-  /** @returns {UserExistsParam} */
-  static userExists() {
-    return Joi.object({
-      q: Joi.string().allow("").required(),
-    }).required();
-  }
-
   /** @returns {VerifyEmailParam} */
   static verifyEmail() {
     return Joi.object({

package/sdk/common/Clickstream.d.ts

@@ -0,0 +1 @@
+export {};

package/sdk/common/Clickstream.js

@@ -0,0 +1,254 @@
+const Clickstream = require("@gofynd/flick");
+const { Logger } = require("../common/Logger");
+
+/**
+ * Safely extracts a value from an Object of n-depth
+ *
+ * @author Nikhil Kakade
+ * @param {function} fn
+ * @param {any} [defaultValue] - Null
+ * @returns {any}
+ */
+const sg = function safeGet(fn, defaultValue = null) {
+  try {
+    return fn();
+  } catch (err) {
+    return defaultValue;
+  }
+};
+
+if (typeof window != "undefined") {
+  window.FPI.event.on("user.login", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.identify(eventData["user_id"], {
+      event_type: "identity",
+      ...eventData,
+    }).catch((err) => {
+      Logger({ level: "ERROR", message: err });
+    });
+  });
+
+  window.FPI.event.on("user.update", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.identify(eventData["used_id"], {
+      event_type: "identity",
+      ...eventData,
+    }).catch((err) => {
+      Logger({ level: "ERROR", message: err });
+    });
+  });
+
+  window.FPI.event.on("user.logout", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("user_logout", {
+      event_type: "identity",
+      ...eventData,
+    }).catch((err) => {
+      Logger({ level: "ERROR", message: err });
+    });
+    Clickstream.reset().catch((err) => {
+      Logger({ level: "ERROR", message: err });
+    });
+  });
+
+  window.FPI.event.on("wishlist.add", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("product_wishlist_add", {
+      wishlist_name: "TODO",
+      wishlist_id: "TODO",
+      event_type: "click",
+      product_id: sg(() => eventData.item["uid"]),
+      brand: sg(() => eventData.item.brand["name"]),
+      l3_category: sg(() => eventData.item.categories[0]["name"]),
+      mrp: sg(() => eventData.item.price.marked.max),
+      quantity: "TODO",
+      esp: sg(() => eventData.item.price.effective.min),
+      currency: sg(() => eventData.item.price.effective.currency_code),
+      value: "TODO",
+      source_url: "TODO",
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("wishlist.remove", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("product_wishlist_remove", {
+      wishlist_name: "TODO",
+      wishlist_id: "TODO",
+      event_type: "click",
+      product_id: sg(() => eventData.item["uid"]),
+      brand: sg(() => eventData.item.brand["name"]),
+      l3_category: sg(() => eventData.item.categories[0]["name"]),
+      mrp: sg(() => eventData.item.price.marked.max),
+      quantity: "TODO",
+      esp: sg(() => eventData.item.price.effective.min),
+      currency: sg(() => eventData.item.price.effective.currency_code),
+      value: "TODO",
+      source_url: "TODO",
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("cart.newProduct", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("add_to_cart", {
+      cart_id: eventData.cart_id,
+      event_type: "click",
+      product_id: sg(() => eventData.products[0]["uid"]),
+      brand: sg(() => eventData.products[0]["brand"]["name"]),
+      l3_category: sg(() => eventData.products[0]["category"]["name"]),
+      l1_category: "TODO",
+      currency: sg(() => eventData.products[0]["price"]["currency_code"]),
+      price: sg(() => eventData.products[0]["price"]["selling"]),
+      quantity: sg(() => eventData.products[0]["quantity"]["current"]),
+      source_url: "TODO",
+      position: "TODO",
+      value: "TODO",
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("cart.remove", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("remove_from_cart", {
+      cart_id: eventData.cart_id,
+      event_type: "click",
+      product_id: sg(() => eventData.products[0]["uid"]),
+      brand: sg(() => eventData.products[0]["brand"]["name"]),
+      l3_category: sg(() => eventData.products[0]["category"]["name"]),
+      l1_category: "TODO",
+      currency: sg(() => eventData.products[0]["price"]["currency_code"]),
+      price: sg(() => eventData.products[0]["price"]["selling"]),
+      quantity: sg(() => eventData.products[0]["quantity"]["current"]),
+      source_url: "TODO",
+      position: "TODO",
+      value: "TODO",
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("order.processed", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("order_complete", {
+      event_type: "click",
+      ...eventData,
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("refund.success", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("order_refunded", {
+      event_type: "click",
+      ...eventData,
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("order.checkout", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("order_checkout", {
+      event_type: "click",
+      cart_id: eventData.cart_id,
+      cart_total: sg(() => eventData.breakup_values_raw["mrp_total"]),
+      items: sg(() => eventData.products.lenght),
+      shipping: sg(() => eventData.breakup_values_raw["delivery_charge"]),
+      tax: sg(() => eventData.breakup_values_raw["gst_charges"]),
+      order_total: sg(() => eventData.breakup_values_raw["total"]),
+      currency: sg(() => eventData.products[0]["price"]["currency_code"]),
+      products: eventData.products.map((p) => {
+        return {
+          product_id: p.uid,
+          l3_category: sg(() => p.category["name"]),
+          l1_category: "TODO",
+          quantity: sg(() => p.quantity["current"]),
+          price: sg(() => p.price["marked"]),
+          value: sg(() => p.price["effective"]),
+          currency: sg(() => p.price["currency_code"]),
+        };
+      }),
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("product.view", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("product_view", {
+      event_type: "click",
+      product_id: sg(() => eventData.product["uid"]),
+      currency: sg(() => eventData.product.price["currency"]),
+      brand: sg(() => eventData.product.brand["name"]),
+      l3_category: sg(() => eventData.product.l3_category),
+      mrp: sg(() => eventData.product.price.max),
+      esp: sg(() => eventData.product.price.min),
+      l1_category: sg(() => eventData.product.l1_category),
+      source_url: sg(() => eventData.product.source_url),
+      quantity: sg(() => eventData.product.sizes[0]["quantity"]),
+      position: "TODO",
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("search.products", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    Clickstream.sendEvent("product_search", {
+      event_type: "search",
+      query: eventData.search_text,
+    })
+      .then((resp) => {
+        Logger({ level: "DEBUG", message: "Click event sent" });
+      })
+      .catch((err) => {
+        Logger({ level: "ERROR", message: err });
+      });
+  });
+
+  window.FPI.event.on("product_list.filter", (eventData) => {
+    Logger({ level: "DEBUG", message: eventData });
+    // Clickstream.sendEvent("add_to_cart", { event_type: "conversion", product_uid: eventData.products[0]['uid'], user_id: eventData.user['user_id'], brand: eventData.products[0]['brand']['name'], category: eventData.products[0]['category']['name'], currency: eventData.products[0]['price']['currency_code'], price: eventData.products[0]['price']['selling'], quantity: eventData.products[0]['quantity']['current'], cart: [] }).then((resp) => {
+    //   console.log("Event sent succesfully")
+    // }).catch(err => {
+    //   console.error(err)
+    // })
+  });
+}

package/sdk/common/Utility.js

@@ -30,10 +30,7 @@ function convertUrlToAction(url) {
     const closestMatchingNavLink = Object.keys(typeLink).find((pageType) => {
       return utils.trimChar(pageType) === bestMatchingLink.value;
     });
-    const closestMatchingNavKey = typeLink[closestMatchingNavLink];
-    if (!closestMatchingNavKey) {
-      closestMatchingNavKey = "home";
-    }
+    const closestMatchingNavKey = typeLink[closestMatchingNavLink] || "home";
     return {
       type: "page",
       page: {

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

@@ -1,127 +1,139 @@
 export = FileStoragePartnerModel;
 /**
  * @typedef CDN
+ * @property {string} url
  * @property {string} absolute_url
  * @property {string} relative_url
+ */
+/**
+ * @typedef Upload
+ * @property {number} expiry
  * @property {string} url
  */
 /**
- * @typedef CompleteResponse
- * @property {string} _id
- * @property {CDN} cdn
- * @property {string} content_type
- * @property {CreatedBy} [created_by]
- * @property {string} created_on
+ * @typedef StartResponse
  * @property {string} file_name
  * @property {string} file_path
- * @property {string} modified_on
+ * @property {string} content_type
+ * @property {string} [method]
  * @property {string} namespace
  * @property {string} operation
  * @property {number} size
- * @property {boolean} success
- * @property {string[]} [tags]
  * @property {Upload} upload
+ * @property {CDN} cdn
+ * @property {string[]} [tags]
  */
 /**
- * @typedef CreatedBy
- * @property {string} [username]
- */
-/**
- * @typedef FailedResponse
- * @property {string} message
+ * @typedef Params
+ * @property {string} [subpath] - The subpath for the file.
  */
 /**
  * @typedef StartRequest
- * @property {string} content_type
  * @property {string} file_name
- * @property {Object} [params]
+ * @property {string} content_type
  * @property {number} size
  * @property {string[]} [tags]
+ * @property {Params} [params]
  */
 /**
- * @typedef StartResponse
- * @property {CDN} cdn
- * @property {string} content_type
+ * @typedef CreatedBy
+ * @property {string} [username]
+ */
+/**
+ * @typedef CompleteResponse
+ * @property {string} _id
  * @property {string} file_name
  * @property {string} file_path
- * @property {string} [method]
+ * @property {string} content_type
  * @property {string} namespace
  * @property {string} operation
  * @property {number} size
- * @property {string[]} [tags]
  * @property {Upload} upload
+ * @property {CDN} cdn
+ * @property {boolean} success
+ * @property {string[]} [tags]
+ * @property {string} created_on
+ * @property {string} modified_on
+ * @property {CreatedBy} [created_by]
  */
 /**
- * @typedef Upload
- * @property {number} expiry
- * @property {string} url
+ * @typedef FailedResponse
+ * @property {string} message
  */
 declare class FileStoragePartnerModel {
 }
 declare namespace FileStoragePartnerModel {
-    export { CDN, CompleteResponse, CreatedBy, FailedResponse, StartRequest, StartResponse, Upload };
+    export { CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, FailedResponse };
 }
 /** @returns {CDN} */
 declare function CDN(): CDN;
 type CDN = {
+    url: string;
     absolute_url: string;
     relative_url: string;
+};
+/** @returns {Upload} */
+declare function Upload(): Upload;
+type Upload = {
+    expiry: number;
     url: string;
 };
-/** @returns {CompleteResponse} */
-declare function CompleteResponse(): CompleteResponse;
-type CompleteResponse = {
-    _id: string;
-    cdn: CDN;
-    content_type: string;
-    created_by?: CreatedBy;
-    created_on: string;
+/** @returns {StartResponse} */
+declare function StartResponse(): StartResponse;
+type StartResponse = {
     file_name: string;
     file_path: string;
-    modified_on: string;
+    content_type: string;
+    method?: string;
     namespace: string;
     operation: string;
     size: number;
-    success: boolean;
-    tags?: string[];
     upload: Upload;
+    cdn: CDN;
+    tags?: string[];
 };
-/** @returns {CreatedBy} */
-declare function CreatedBy(): CreatedBy;
-type CreatedBy = {
-    username?: string;
-};
-/** @returns {FailedResponse} */
-declare function FailedResponse(): FailedResponse;
-type FailedResponse = {
-    message: string;
+/** @returns {Params} */
+declare function Params(): Params;
+type Params = {
+    /**
+     * - The subpath for the file.
+     */
+    subpath?: string;
 };
 /** @returns {StartRequest} */
 declare function StartRequest(): StartRequest;
 type StartRequest = {
-    content_type: string;
     file_name: string;
-    params?: any;
+    content_type: string;
     size: number;
     tags?: string[];
+    params?: Params;
 };
-/** @returns {StartResponse} */
-declare function StartResponse(): StartResponse;
-type StartResponse = {
-    cdn: CDN;
-    content_type: string;
+/** @returns {CreatedBy} */
+declare function CreatedBy(): CreatedBy;
+type CreatedBy = {
+    username?: string;
+};
+/** @returns {CompleteResponse} */
+declare function CompleteResponse(): CompleteResponse;
+type CompleteResponse = {
+    _id: string;
     file_name: string;
     file_path: string;
-    method?: string;
+    content_type: string;
     namespace: string;
     operation: string;
     size: number;
-    tags?: string[];
     upload: Upload;
+    cdn: CDN;
+    success: boolean;
+    tags?: string[];
+    created_on: string;
+    modified_on: string;
+    created_by?: CreatedBy;
 };
-/** @returns {Upload} */
-declare function Upload(): Upload;
-type Upload = {
-    expiry: number;
-    url: string;
+/** @returns {FailedResponse} */
+declare function FailedResponse(): FailedResponse;
+type FailedResponse = {
+    message: string;
 };