@gofynd/fdk-client-javascript 1.3.0 → 1.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -17,7 +17,8 @@
     "crypto-js": "^4.1.1",
     "joi": "^17.7.0",
     "loglevel": "^1.8.1",
-    "query-string": "^7.1.3"
+    "query-string": "^7.1.3",
+    "@gofynd/fp-signature": "^0.0.2-alpha.1"
   },
   "devDependencies": {
     "axios-cookiejar-support": "^4.0.6",

package/sdk/application/Cart/CartApplicationModel.d.ts

@@ -697,6 +697,7 @@ export = CartApplicationModel;
  * @property {number} [fynd_cash]
  * @property {number} [gift_card]
  * @property {number} [gst_charges]
+ * @property {number} [mop_total]
  * @property {number} [mrp_total]
  * @property {number} [subtotal]
  * @property {number} [total]
@@ -1888,6 +1889,7 @@ type RawBreakup = {
     fynd_cash?: number;
     gift_card?: number;
     gst_charges?: number;
+    mop_total?: number;
     mrp_total?: number;
     subtotal?: number;
     total?: number;

package/sdk/application/Cart/CartApplicationModel.js

@@ -775,6 +775,7 @@ const Joi = require("joi");
  * @property {number} [fynd_cash]
  * @property {number} [gift_card]
  * @property {number} [gst_charges]
+ * @property {number} [mop_total]
  * @property {number} [mrp_total]
  * @property {number} [subtotal]
  * @property {number} [total]
@@ -1862,6 +1863,7 @@ class CartApplicationModel {
       fynd_cash: Joi.number(),
       gift_card: Joi.number(),
       gst_charges: Joi.number(),
+      mop_total: Joi.number(),
       mrp_total: Joi.number(),
       subtotal: Joi.number(),
       total: Joi.number(),

package/sdk/common/AxiosHelper.js

@@ -2,7 +2,7 @@ const combineURLs = require("axios/lib/helpers/combineURLs");
 const isAbsoluteURL = require("axios/lib/helpers/isAbsoluteURL");
 const axios = require("axios");
 const querystring = require("query-string");
-const { sign } = require("./RequestSigner");
+const { sign } = require("@gofynd/fp-signature");
 const { FDKServerResponseError } = require("./FDKError");
 const { log, Logger, getLoggerLevel } = require("./Logger");
 const createCurl = require("./curlHelper");
@@ -73,7 +73,7 @@ function requestInterceptorFn() {
       body: transformedData,
       headers: headersToSign,
     };
-    sign(signingOptions);
+    sign(signingOptions, "1234567");
 
     config.headers["x-fp-date"] = signingOptions.headers["x-fp-date"];
     config.headers["x-fp-signature"] = signingOptions.headers["x-fp-signature"];

package/sdk/partner/OAuthClient.js

@@ -3,7 +3,7 @@ const { FDKTokenIssueError } = require("../common/FDKError");
 const { Logger } = require("../common/Logger");
 const BaseOAuthClient = require("../common/BaseOAuthClient");
 const querystring = require("query-string");
-const { sign } = require("../common/RequestSigner");
+const { sign } = require("@gofynd/fp-signature");
 
 class OAuthClient extends BaseOAuthClient {
   constructor(config) {
@@ -32,7 +32,7 @@ class OAuthClient extends BaseOAuthClient {
       headers: {},
       signQuery: true,
     };
-    signingOptions = sign(signingOptions);
+    signingOptions = sign(signingOptions, "1234567");
     Logger({ type: "DEBUG", message: "Authorization successful" });
 
     return `${this.config.domain}${signingOptions.path}`;

package/sdk/platform/OAuthClient.js

@@ -1,6 +1,6 @@
 const querystring = require("query-string");
 const { fdkAxios } = require("../common/AxiosHelper");
-const { sign } = require("../common/RequestSigner");
+const { sign } = require("@gofynd/fp-signature");
 const { FDKTokenIssueError, FDKOAuthCodeError } = require("../common/FDKError");
 const { Logger } = require("../common/Logger");
 const { convertStringToBase64 } = require("../common/utils");
@@ -86,7 +86,7 @@ class OAuthClient {
       headers: {},
       signQuery: true,
     };
-    signingOptions = sign(signingOptions);
+    signingOptions = sign(signingOptions, "1234567");
     Logger({ level: "INFO", message: "Authorization successful.!" });
 
     return `${this.config.domain}${signingOptions.path}`;

package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts

@@ -27,21 +27,19 @@ export = WebhookPlatformValidator;
  */
 /**
  * @typedef GetSubscriberByIdParam
- * @property {number} subscriberId - The ID of the company for which manual
- *   retry is to be initiated.
+ * @property {number} subscriberId - Subscriber id
  */
 /**
  * @typedef GetSubscribersByCompanyParam
  * @property {number} [pageNo] - Page Number
  * @property {number} [pageSize] - Page Size
- * @property {number} [extensionId] - Extension_id
+ * @property {string} [extensionId] - Extension_id
  */
 /**
  * @typedef GetSubscribersByExtensionIdParam
  * @property {number} [pageNo] - Page Number
  * @property {number} [pageSize] - Page Size
- * @property {number} extensionId - The ID of the company for which manual retry
- *   is to be initiated.
+ * @property {string} extensionId - Extension id
  */
 /** @typedef ManualRetryCancelParam */
 /**
@@ -120,8 +118,7 @@ type GetReportFiltersParam = {
 };
 type GetSubscriberByIdParam = {
     /**
-     * - The ID of the company for which manual
-     * retry is to be initiated.
+     * - Subscriber id
      */
     subscriberId: number;
 };
@@ -137,7 +134,7 @@ type GetSubscribersByCompanyParam = {
     /**
      * - Extension_id
      */
-    extensionId?: number;
+    extensionId?: string;
 };
 type GetSubscribersByExtensionIdParam = {
     /**
@@ -149,10 +146,9 @@ type GetSubscribersByExtensionIdParam = {
      */
     pageSize?: number;
     /**
-     * - The ID of the company for which manual retry
-     * is to be initiated.
+     * - Extension id
      */
-    extensionId: number;
+    extensionId: string;
 };
 type ManualRetryOfFailedEventParam = {
     body: WebhookPlatformModel.EventProcessRequest;

package/sdk/platform/Webhook/WebhookPlatformValidator.js

@@ -38,23 +38,21 @@ const WebhookPlatformModel = require("./WebhookPlatformModel");
 
 /**
  * @typedef GetSubscriberByIdParam
- * @property {number} subscriberId - The ID of the company for which manual
- *   retry is to be initiated.
+ * @property {number} subscriberId - Subscriber id
  */
 
 /**
  * @typedef GetSubscribersByCompanyParam
  * @property {number} [pageNo] - Page Number
  * @property {number} [pageSize] - Page Size
- * @property {number} [extensionId] - Extension_id
+ * @property {string} [extensionId] - Extension_id
  */
 
 /**
  * @typedef GetSubscribersByExtensionIdParam
  * @property {number} [pageNo] - Page Number
  * @property {number} [pageSize] - Page Size
- * @property {number} extensionId - The ID of the company for which manual retry
- *   is to be initiated.
+ * @property {string} extensionId - Extension id
  */
 
 /** @typedef ManualRetryCancelParam */
@@ -144,7 +142,7 @@ class WebhookPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      extensionId: Joi.number(),
+      extensionId: Joi.string().allow(""),
     }).required();
   }
 
@@ -153,7 +151,7 @@ class WebhookPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
-      extensionId: Joi.number().required(),
+      extensionId: Joi.string().allow("").required(),
     }).required();
   }
 

package/sdk/common/RequestSigner.d.ts

@@ -1 +0,0 @@
-export function sign(request: any): any;

package/sdk/common/RequestSigner.js

@@ -1,300 +0,0 @@
-"use strict";
-
-const querystring = require("query-string");
-const sha256 = require("crypto-js/sha256");
-const hmacSHA256 = require("crypto-js/hmac-sha256");
-
-function hmac(key, string, encoding) {
-  return hmacSHA256(string, key).toString();
-}
-function hash(string, encoding) {
-  return sha256(string).toString();
-}
-
-// This function assumes the string has already been percent encoded
-function encodeRfc3986(urlEncodedString) {
-  return urlEncodedString.replace(/[!'()*]/g, function (c) {
-    return "%" + c.charCodeAt(0).toString(16).toUpperCase();
-  });
-}
-
-function encodeRfc3986Full(str) {
-  return str;
-  // return encodeRfc3986(encodeURIComponent(str));
-}
-
-const HEADERS_TO_IGNORE = {
-  authorization: true,
-  connection: true,
-  "x-amzn-trace-id": true,
-  "user-agent": true,
-  expect: true,
-  "presigned-expires": true,
-  range: true,
-};
-
-const HEADERS_TO_INCLUDE = ["x-fp-.*", "host"];
-
-// request: { path | body, [host], [method], [headers], [service], [region] }
-class RequestSigner {
-  constructor(request) {
-    let headers = (request.headers = request.headers || {});
-    this.request = request;
-
-    if (!request.method && request.body) {
-      request.method = "POST";
-    }
-
-    if (!headers.Host && !headers.host) {
-      headers.Host = request.hostname || request.host;
-
-      // If a port is specified explicitly, use it as is
-      if (request.port) {
-        headers.Host += ":" + request.port;
-      }
-    }
-    if (!request.hostname && !request.host) {
-      request.hostname = headers.Host || headers.host;
-    }
-  }
-
-  prepareRequest() {
-    this.parsePath();
-
-    let request = this.request;
-    let headers = request.headers;
-    let query;
-
-    if (request.signQuery) {
-      this.parsedPath.query = query = this.parsedPath.query || {};
-
-      if (query["x-fp-date"]) {
-        this.datetime = query["x-fp-date"];
-      } else {
-        query["x-fp-date"] = this.getDateTime();
-      }
-    } else {
-      if (!request.doNotModifyHeaders) {
-        if (headers["x-fp-date"]) {
-          this.datetime = headers["x-fp-date"] || headers["x-fp-date"];
-        } else {
-          headers["x-fp-date"] = this.getDateTime();
-        }
-      }
-
-      delete headers["x-fp-signature"];
-      delete headers["X-Fp-Signature"];
-    }
-  }
-
-  sign() {
-    if (!this.parsedPath) {
-      this.prepareRequest();
-    }
-    if (this.request.signQuery) {
-      this.parsedPath.query["x-fp-signature"] = this.signature();
-    } else {
-      this.request.headers["x-fp-signature"] = this.signature();
-    }
-    this.request.path = this.formatPath();
-    return this.request;
-  }
-
-  getDateTime() {
-    if (!this.datetime) {
-      let headers = this.request.headers;
-      let date = new Date(headers.Date || headers.date || new Date());
-
-      this.datetime = date.toISOString().replace(/[:\-]|\.\d{3}/g, "");
-    }
-    return this.datetime;
-  }
-
-  getDate() {
-    return this.getDateTime().substr(0, 8);
-  }
-
-  signature() {
-    let kCredentials = "1234567";
-    let strTosign = this.stringToSign();
-    return `v1.1:${hmac(kCredentials, strTosign, "hex")}`;
-  }
-
-  stringToSign() {
-    return [this.getDateTime(), hash(this.canonicalString(), "hex")].join("\n");
-  }
-
-  canonicalString() {
-    if (!this.parsedPath) {
-      this.prepareRequest();
-    }
-
-    let pathStr = this.parsedPath.path;
-    let query = this.parsedPath.query;
-    let headers = this.request.headers;
-    let queryStr = "";
-    let normalizePath = true;
-    let decodePath = this.request.doNotEncodePath;
-    let decodeSlashesInPath = false;
-    let firstValOnly = false;
-    let bodyHash = hash(this.request.body || "", "hex");
-    if (query) {
-      let reducedQuery = Object.keys(query).reduce(function (obj, key) {
-        if (!key) {
-          return obj;
-        }
-        obj[encodeRfc3986Full(key)] = !Array.isArray(query[key])
-          ? query[key]
-          : firstValOnly
-          ? query[key][0]
-          : query[key];
-        return obj;
-      }, {});
-      let encodedQueryPieces = [];
-      Object.keys(reducedQuery)
-        .sort()
-        .forEach(function (key) {
-          if (!Array.isArray(reducedQuery[key])) {
-            encodedQueryPieces.push(
-              key + "=" + encodeRfc3986Full(reducedQuery[key])
-            );
-          } else {
-            reducedQuery[key]
-              .map(encodeRfc3986Full)
-              .sort()
-              .forEach(function (val) {
-                encodedQueryPieces.push(key + "=" + val);
-              });
-          }
-        });
-      queryStr = encodedQueryPieces.join("&");
-    }
-    if (pathStr !== "/") {
-      if (normalizePath) {
-        pathStr = pathStr.replace(/\/{2,}/g, "/");
-      }
-      pathStr = pathStr
-        .split("/")
-        .reduce(function (path, piece) {
-          if (normalizePath && piece === "..") {
-            path.pop();
-          } else if (!normalizePath || piece !== ".") {
-            if (decodePath)
-              piece = decodeURIComponent(piece.replace(/\+/g, " "));
-            path.push(encodeRfc3986Full(piece));
-          }
-          return path;
-        }, [])
-        .join("/");
-      if (pathStr[0] !== "/") pathStr = "/" + pathStr;
-      if (decodeSlashesInPath) pathStr = pathStr.replace(/%2F/g, "/");
-    }
-
-    let canonicalReq = [
-      this.request.method || "GET",
-      pathStr,
-      queryStr,
-      this.canonicalHeaders() + "\n",
-      this.signedHeaders(),
-      bodyHash,
-    ].join("\n");
-    return canonicalReq;
-  }
-
-  canonicalHeaders() {
-    let headers = this.request.headers;
-
-    function trimAll(header) {
-      return header.toString().trim().replace(/\s+/g, " ");
-    }
-    return Object.keys(headers)
-      .filter(function (key) {
-        let notInIgnoreHeader = HEADERS_TO_IGNORE[key.toLowerCase()] == null;
-        if (notInIgnoreHeader) {
-          let foundMatch = false;
-          for (let t in HEADERS_TO_INCLUDE) {
-            foundMatch =
-              foundMatch || new RegExp(HEADERS_TO_INCLUDE[t], "ig").test(key);
-          }
-          return foundMatch;
-        } else {
-          return false;
-        }
-      })
-      .sort(function (a, b) {
-        return a.toLowerCase() < b.toLowerCase() ? -1 : 1;
-      })
-      .map(function (key) {
-        return key.toLowerCase() + ":" + trimAll(headers[key]);
-      })
-      .join("\n");
-  }
-
-  signedHeaders() {
-    return Object.keys(this.request.headers)
-      .map(function (key) {
-        return key.toLowerCase();
-      })
-      .filter(function (key) {
-        let notInIgnoreHeader = HEADERS_TO_IGNORE[key.toLowerCase()] == null;
-        if (notInIgnoreHeader) {
-          let foundMatch = false;
-          for (let t in HEADERS_TO_INCLUDE) {
-            foundMatch =
-              foundMatch || new RegExp(HEADERS_TO_INCLUDE[t], "ig").test(key);
-          }
-          return foundMatch;
-        } else {
-          return false;
-        }
-      })
-      .sort()
-      .join(";");
-  }
-
-  parsePath() {
-    let path = this.request.path || "/";
-    let queryIx = path.indexOf("?");
-    let query = null;
-
-    if (queryIx >= 0) {
-      query = querystring.parse(path.slice(queryIx + 1));
-      path = path.slice(0, queryIx);
-    }
-    path = path
-      .split("/")
-      .map((t) => {
-        return encodeURIComponent(decodeURIComponent(t));
-      })
-      .join("/");
-
-    this.parsedPath = {
-      path: path,
-      query: query,
-    };
-  }
-
-  formatPath() {
-    let path = this.parsedPath.path;
-    let query = this.parsedPath.query;
-
-    if (!query) {
-      return path;
-    }
-
-    // Services don't support empty query string keys
-    if (query[""] != null) {
-      delete query[""];
-    }
-
-    return path + "?" + encodeRfc3986(querystring.stringify(query));
-  }
-}
-
-function sign(request) {
-  return new RequestSigner(request).sign();
-}
-
-module.exports = {
-  sign: sign,
-};