@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/User/UserApplicationValidator.js

@@ -1,21 +1,223 @@
 const Joi = require("joi");
 
-const UserModel = require("./UserApplicationModel");
-class UserValidator {
+const UserApplicationModel = require("./UserApplicationModel");
+
+/**
+ * @typedef AddEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.EditEmailRequestSchema} body
+ */
+
+/**
+ * @typedef AddMobileNumberParam
+ * @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
+ */
+
+/**
+ * @typedef DeleteMobileNumberParam
+ * @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
+ * @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
+ * @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
+ */
+
+/**
+ * @typedef DeleteUserParam
+ * @property {UserApplicationModel.DeleteApplicationUserRequestSchema} body
+ */
+
+/**
+ * @typedef ForgotPasswordParam
+ * @property {UserApplicationModel.ForgotPasswordRequestSchema} body
+ */
+
+/** @typedef GetListOfActiveSessionsParam */
+
+/** @typedef GetLoggedInUserParam */
+
+/**
+ * @typedef GetPlatformConfigParam
+ * @property {string} [name] - Name of the application, e.g. Fynd
+ */
+
+/** @typedef HasPasswordParam */
+
+/**
+ * @typedef LoginWithAppleIOSParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestAppleSchema} body
+ */
+
+/**
+ * @typedef LoginWithEmailAndPasswordParam
+ * @property {UserApplicationModel.PasswordLoginRequestSchema} body
+ */
+
+/**
+ * @typedef LoginWithFacebookParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+
+/**
+ * @typedef LoginWithGoogleParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+
+/**
+ * @typedef LoginWithGoogleAndroidParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+
+/**
+ * @typedef LoginWithGoogleIOSParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.OAuthRequestSchema} body
+ */
+
+/**
+ * @typedef LoginWithOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendOtpRequestSchema} body
+ */
+
+/**
+ * @typedef LoginWithTokenParam
+ * @property {UserApplicationModel.TokenRequestBodySchema} body
+ */
+
+/** @typedef LogoutParam */
+
+/**
+ * @typedef RegisterWithFormParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.FormRegisterRequestSchema} body
+ */
+
+/**
+ * @typedef SendOTPOnEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendEmailOtpRequestSchema} body
+ */
+
+/**
+ * @typedef SendOTPOnMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendMobileOtpRequestSchema} body
+ */
+
+/**
+ * @typedef SendResetPasswordEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendResetPasswordEmailRequestSchema} body
+ */
+
+/**
+ * @typedef SendResetPasswordMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendResetPasswordMobileRequestSchema} body
+ */
+
+/**
+ * @typedef SendResetTokenParam
+ * @property {UserApplicationModel.CodeRequestBodySchema} body
+ */
+
+/**
+ * @typedef SendVerificationLinkToEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.EditEmailRequestSchema} body
+ */
+
+/**
+ * @typedef SendVerificationLinkToMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendVerificationLinkMobileRequestSchema} body
+ */
+
+/**
+ * @typedef SetEmailAsPrimaryParam
+ * @property {UserApplicationModel.EditEmailRequestSchema} body
+ */
+
+/**
+ * @typedef SetMobileNumberAsPrimaryParam
+ * @property {UserApplicationModel.SendVerificationLinkMobileRequestSchema} body
+ */
+
+/**
+ * @typedef UpdatePasswordParam
+ * @property {UserApplicationModel.UpdatePasswordRequestSchema} body
+ */
+
+/**
+ * @typedef UpdateProfileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.EditProfileRequestSchema} body
+ */
+
+/**
+ * @typedef VerifyEmailParam
+ * @property {UserApplicationModel.CodeRequestBodySchema} body
+ */
+
+/**
+ * @typedef VerifyEmailOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyEmailOtpRequestSchema} body
+ */
+
+/**
+ * @typedef VerifyMobileParam
+ * @property {UserApplicationModel.CodeRequestBodySchema} body
+ */
+
+/**
+ * @typedef VerifyMobileOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyOtpRequestSchema} body
+ */
+
+class UserApplicationValidator {
+  /** @returns {AddEmailParam} */
   static addEmail() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.EditEmailRequestSchema().required(),
+      body: UserApplicationModel.EditEmailRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {AddMobileNumberParam} */
   static addMobileNumber() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.EditMobileRequestSchema().required(),
+      body: UserApplicationModel.EditMobileRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {DeleteEmailParam} */
   static deleteEmail() {
     return Joi.object({
       platform: Joi.string().allow(""),
@@ -26,6 +228,7 @@ class UserValidator {
     }).required();
   }
 
+  /** @returns {DeleteMobileNumberParam} */
   static deleteMobileNumber() {
     return Joi.object({
       platform: Joi.string().allow(""),
@@ -37,199 +240,230 @@ class UserValidator {
     }).required();
   }
 
+  /** @returns {DeleteUserParam} */
   static deleteUser() {
     return Joi.object({
-      body: UserModel.DeleteApplicationUserRequestSchema().required(),
+      body: UserApplicationModel.DeleteApplicationUserRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {ForgotPasswordParam} */
   static forgotPassword() {
     return Joi.object({
-      body: UserModel.ForgotPasswordRequestSchema().required(),
+      body: UserApplicationModel.ForgotPasswordRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {GetListOfActiveSessionsParam} */
   static getListOfActiveSessions() {
     return Joi.object({});
   }
 
+  /** @returns {GetLoggedInUserParam} */
   static getLoggedInUser() {
     return Joi.object({});
   }
 
+  /** @returns {GetPlatformConfigParam} */
   static getPlatformConfig() {
     return Joi.object({
       name: Joi.string().allow(""),
     });
   }
 
+  /** @returns {HasPasswordParam} */
   static hasPassword() {
     return Joi.object({});
   }
 
+  /** @returns {LoginWithAppleIOSParam} */
   static loginWithAppleIOS() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.OAuthRequestAppleSchema().required(),
+      body: UserApplicationModel.OAuthRequestAppleSchema().required(),
     }).required();
   }
 
+  /** @returns {LoginWithEmailAndPasswordParam} */
   static loginWithEmailAndPassword() {
     return Joi.object({
-      body: UserModel.PasswordLoginRequestSchema().required(),
+      body: UserApplicationModel.PasswordLoginRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {LoginWithFacebookParam} */
   static loginWithFacebook() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.OAuthRequestSchema().required(),
+      body: UserApplicationModel.OAuthRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {LoginWithGoogleParam} */
   static loginWithGoogle() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.OAuthRequestSchema().required(),
+      body: UserApplicationModel.OAuthRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {LoginWithGoogleAndroidParam} */
   static loginWithGoogleAndroid() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.OAuthRequestSchema().required(),
+      body: UserApplicationModel.OAuthRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {LoginWithGoogleIOSParam} */
   static loginWithGoogleIOS() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.OAuthRequestSchema().required(),
+      body: UserApplicationModel.OAuthRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {LoginWithOTPParam} */
   static loginWithOTP() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.SendOtpRequestSchema().required(),
+      body: UserApplicationModel.SendOtpRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {LoginWithTokenParam} */
   static loginWithToken() {
     return Joi.object({
-      body: UserModel.TokenRequestBodySchema().required(),
+      body: UserApplicationModel.TokenRequestBodySchema().required(),
     }).required();
   }
 
+  /** @returns {LogoutParam} */
   static logout() {
     return Joi.object({});
   }
 
+  /** @returns {RegisterWithFormParam} */
   static registerWithForm() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.FormRegisterRequestSchema().required(),
+      body: UserApplicationModel.FormRegisterRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SendOTPOnEmailParam} */
   static sendOTPOnEmail() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.SendEmailOtpRequestSchema().required(),
+      body: UserApplicationModel.SendEmailOtpRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SendOTPOnMobileParam} */
   static sendOTPOnMobile() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.SendMobileOtpRequestSchema().required(),
+      body: UserApplicationModel.SendMobileOtpRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SendResetPasswordEmailParam} */
   static sendResetPasswordEmail() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.SendResetPasswordEmailRequestSchema().required(),
+      body: UserApplicationModel.SendResetPasswordEmailRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SendResetPasswordMobileParam} */
   static sendResetPasswordMobile() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.SendResetPasswordMobileRequestSchema().required(),
+      body: UserApplicationModel.SendResetPasswordMobileRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SendResetTokenParam} */
   static sendResetToken() {
     return Joi.object({
-      body: UserModel.CodeRequestBodySchema().required(),
+      body: UserApplicationModel.CodeRequestBodySchema().required(),
     }).required();
   }
 
+  /** @returns {SendVerificationLinkToEmailParam} */
   static sendVerificationLinkToEmail() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.EditEmailRequestSchema().required(),
+      body: UserApplicationModel.EditEmailRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SendVerificationLinkToMobileParam} */
   static sendVerificationLinkToMobile() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.SendVerificationLinkMobileRequestSchema().required(),
+      body: UserApplicationModel.SendVerificationLinkMobileRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SetEmailAsPrimaryParam} */
   static setEmailAsPrimary() {
     return Joi.object({
-      body: UserModel.EditEmailRequestSchema().required(),
+      body: UserApplicationModel.EditEmailRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {SetMobileNumberAsPrimaryParam} */
   static setMobileNumberAsPrimary() {
     return Joi.object({
-      body: UserModel.SendVerificationLinkMobileRequestSchema().required(),
+      body: UserApplicationModel.SendVerificationLinkMobileRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {UpdatePasswordParam} */
   static updatePassword() {
     return Joi.object({
-      body: UserModel.UpdatePasswordRequestSchema().required(),
+      body: UserApplicationModel.UpdatePasswordRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {UpdateProfileParam} */
   static updateProfile() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.EditProfileRequestSchema().required(),
+      body: UserApplicationModel.EditProfileRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {VerifyEmailParam} */
   static verifyEmail() {
     return Joi.object({
-      body: UserModel.CodeRequestBodySchema().required(),
+      body: UserApplicationModel.CodeRequestBodySchema().required(),
     }).required();
   }
 
+  /** @returns {VerifyEmailOTPParam} */
   static verifyEmailOTP() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.VerifyEmailOtpRequestSchema().required(),
+      body: UserApplicationModel.VerifyEmailOtpRequestSchema().required(),
     }).required();
   }
 
+  /** @returns {VerifyMobileParam} */
   static verifyMobile() {
     return Joi.object({
-      body: UserModel.CodeRequestBodySchema().required(),
+      body: UserApplicationModel.CodeRequestBodySchema().required(),
     }).required();
   }
 
+  /** @returns {VerifyMobileOTPParam} */
   static verifyMobileOTP() {
     return Joi.object({
       platform: Joi.string().allow(""),
-      body: UserModel.VerifyOtpRequestSchema().required(),
+      body: UserApplicationModel.VerifyOtpRequestSchema().required(),
     }).required();
   }
 }
 
-module.exports = UserValidator;
+module.exports = UserApplicationValidator;

package/sdk/common/AxiosHelper.js

@@ -6,6 +6,7 @@ const { sign } = require("./RequestSigner");
 const { FDKServerResponseError } = require("./FDKError");
 const { log, Logger, getLoggerLevel } = require("./Logger");
 const createCurl = require("./curlHelper");
+const packageJson = require("../../package.json");
 axios.defaults.withCredentials = true;
 
 function getTransformer(config) {
@@ -38,7 +39,7 @@ function requestInterceptorFn() {
     }
     const { host, pathname, search } = new URL(url);
     const { data, headers, method, params } = config;
-    headers["x-fp-sdk-version"] = "1.1.2";
+    headers["x-fp-sdk-version"] = packageJson.version;
     let querySearchObj = querystring.parse(search);
     querySearchObj = { ...querySearchObj, ...params };
     let queryParam = "";
@@ -114,6 +115,7 @@ fdkAxios.interceptors.request.use(requestInterceptorFn());
 fdkAxios.interceptors.response.use(
   function (response) {
     if (response.config.method == "head") {
+      // TODO: what to do for `head` method
       return response.headers;
     }
     Logger({
@@ -122,7 +124,11 @@ fdkAxios.interceptors.response.use(
       message: response.data,
       url: response.config.url,
     });
-    return response.data; // IF 2XX then return response.data only
+
+    if (response.config._returnHeaders) {
+      return [response.data, response.headers];
+    }
+    return response.data;
   },
   function (error) {
     if (error.response) {

package/sdk/common/Paginator.d.ts

@@ -1,16 +1,31 @@
 export = Paginator;
-declare class Paginator {
-    constructor(pageNo: any);
-    pageNo: any;
-    callback: any;
-    setCallback(callback: any): void;
-    hasNext(): any;
+/** @template {Object} T */
+declare class Paginator<T extends unknown> {
+    /** @param {number} pageNo */
+    constructor(pageNo: number);
+    pageNo: number;
+    callback: () => Promise<T>;
+    /**
+     * @param {() => Promise<T>} callback
+     * @returns {void}
+     */
+    setCallback(callback: () => Promise<T>): void;
+    /** @returns {boolean} */
+    hasNext(): boolean;
+    /**
+     * @param {Object} arg
+     * @param {boolean} arg.hasNext
+     * @param {string} arg.nextId
+     * @param {number} arg.pageNo
+     * @returns {void}
+     */
     setPaginator({ hasNext, nextId, pageNo }: {
-        hasNext: any;
-        nextId?: any;
-        pageNo?: number;
+        hasNext: boolean;
+        nextId: string;
+        pageNo: number;
     }): void;
-    isNext: any;
-    nextId: any;
-    next(): any;
+    isNext: boolean;
+    nextId: string;
+    /** @returns {Promise<T>} */
+    next(): Promise<T>;
 }

package/sdk/common/Paginator.js

@@ -1,23 +1,38 @@
+/** @template {Object} T */
 class Paginator {
+  /** @param {number} pageNo */
   constructor(pageNo) {
     this.pageNo = pageNo;
     this.callback = undefined;
   }
 
+  /**
+   * @param {() => Promise<T>} callback
+   * @returns {void}
+   */
   setCallback(callback) {
     this.callback = callback;
   }
 
+  /** @returns {boolean} */
   hasNext() {
     return this.isNext;
   }
 
+  /**
+   * @param {Object} arg
+   * @param {boolean} arg.hasNext
+   * @param {string} arg.nextId
+   * @param {number} arg.pageNo
+   * @returns {void}
+   */
   setPaginator({ hasNext, nextId = undefined, pageNo = 1 }) {
     this.isNext = hasNext;
     this.nextId = nextId;
     this.pageNo = pageNo;
   }
 
+  /** @returns {Promise<T>} */
   next() {
     return this.callback();
   }

package/sdk/common/RequestSigner.js

@@ -117,7 +117,6 @@ class RequestSigner {
   signature() {
     let kCredentials = "1234567";
     let strTosign = this.stringToSign();
-    // console.log(strTosign);
     return `v1.1:${hmac(kCredentials, strTosign, "hex")}`;
   }
 

package/sdk/partner/PartnerAPIClient.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,7 +10,17 @@ declare class APIClient {
      * @param {string} url
      * @param {object} query
      * @param {object} body
+     * @param {Options} options
      */
-    static execute(conf: object, method: string, url: string, query: object, body: object): Promise<any>;
+    static execute(conf: object, method: string, url: string, query: object, body: object, options: Options): Promise<any>;
     get(url: any, config: any): Promise<any>;
 }
+declare namespace APIClient {
+    export { Options };
+}
+type Options = {
+    /**
+     * - Whether headers are returned or not.
+     */
+    headers: boolean;
+};

package/sdk/partner/PartnerAPIClient.js

@@ -1,5 +1,10 @@
 const { fdkAxios } = require("../common/AxiosHelper");
 
+/**
+ * @typedef {Object} Options
+ * @property {boolean} headers - Whether headers are returned or not.
+ */
+
 class APIClient {
   /**
    * @param {object} conf
@@ -7,8 +12,9 @@ class APIClient {
    * @param {string} url
    * @param {object} query
    * @param {object} body
+   * @param {Options} options
    */
-  static async execute(conf, method, url, query, body) {
+  static async execute(conf, method, url, query, body, options) {
     const token = await conf.oauthClient.getNewAccessToken();
 
     const extraHeaders = conf.extraHeaders.reduce((acc, curr) => {
@@ -26,6 +32,7 @@ class APIClient {
         Authorization: "Bearer " + token,
         ...extraHeaders,
       },
+      _returnHeaders: options.headers,
     };
 
     return fdkAxios.request(rawRequest);