@gofynd/fdk-client-javascript 1.0.3 → 1.1.0

package/README.md

@@ -13,6 +13,8 @@ Get started with the Javascript Development SDK for Fynd Platform
 
 ### Usage
 
+#### Node
+
 ```
 npm install @gofynd/fdk-client-javascript
 ```
@@ -26,6 +28,22 @@ const {
 } = require("fdk-client-javascript");
 ```
 
+#### Browser
+you can load fdk-client-javascript's application browser bundle from CDN; `ApplicationConfig`, `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>
+```
+Install Specific version
+```html
+<script src="https://cdn.jsdelivr.net/gh/gofynd/fdk-client-javascript@1.0.1/dist/application.js"></script>
+```
+
+```js
+const { ApplicationConfig, ApplicationClient } = window;
+```
+
+
 ### Logging
 
 For logging support user can pass `logLevel` in `ApplicationConfig` or `PlatformConfig` while declaration.
@@ -103,6 +121,33 @@ async function getData() {
 
 getData();
 ```
+---
+### Cookie
+
+Following code snippet will read and write cookies on behalf of you <br />
+Cookies will get appended in subsequent requests.
+
+```javascript
+const { FdkAxios } = require('@gofynd/fdk-client-javascript');
+const { wrapper } =  require("axios-cookiejar-support");
+const { CookieJar } = require("tough-cookie");
+
+
+wrapper(FdkAxios);
+const cookieJar = new CookieJar();
+FdkAxios.defaults.jar = cookieJar;
+
+
+module.exports = cookieJar
+```
+
+get the stored cookie from the CookieJar instance
+```javascript
+const cookieJar = require('path/to/cookieJar') // replace with actual path
+
+let cookies = await cookieJar.getCookies("https://api.fynd.com");
+```
+---
 
 ### Log Curl
 To print the curl command in the console for all network calls made using `applicationClient` or `platformClient`, set the logger level to debug.
@@ -127,7 +172,7 @@ The above code will log the curl command in the console
 curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 0.1.36' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
-
+---
 ### TypeScript
 
 fdk-client-javascript includes Typescript definitions.
@@ -135,8 +180,12 @@ fdk-client-javascript includes Typescript definitions.
 ```typescript
 import { ApplicationConfig, ApplicationClient } from "fdk-client-javascript";
 ```
-
+---
 ### Documentation
 
+- [Public Front](documentation/public/README.md)
 - [Application Front](documentation/application/README.md)
 - [Platform Front](documentation/platform/README.md)
+- [Admin Front](documentation/admin/README.md)
+- [Partner Front](documentation/partner/README.md)
+

package/index.d.ts

@@ -1,13 +1,16 @@
+import { PublicConfig } from "./sdk/public";
+import { PublicClient } from "./sdk/public";
+import { PublicModel } from "./sdk/public";
 import { ApplicationConfig } from "./sdk/application";
 import { ApplicationClient } from "./sdk/application";
 import { ApplicationModel } from "./sdk/application";
 import { PlatformConfig } from "./sdk/platform";
 import { PlatformClient } from "./sdk/platform";
 import { PlatformModel } from "./sdk/platform";
-import { PublicConfig } from "./sdk/public";
-import { PublicClient } from "./sdk/public";
-import { PublicModel } from "./sdk/public";
+import { PartnerConfig } from "./sdk/partner";
+import { PartnerClient } from "./sdk/partner";
+import { PartnerModel } from "./sdk/partner";
 import { fdkAxios } from "./sdk/common/AxiosHelper";
 import Utility = require("./sdk/common/Utility");
 import Constant = require("./sdk/common/Constant");
-export { ApplicationConfig, ApplicationClient, ApplicationModel, PlatformConfig, PlatformClient, PlatformModel, PublicConfig, PublicClient, PublicModel, fdkAxios as FdkAxios, Utility, Constant };
+export { PublicConfig, PublicClient, PublicModel, ApplicationConfig, ApplicationClient, ApplicationModel, PlatformConfig, PlatformClient, PlatformModel, PartnerConfig, PartnerClient, PartnerModel, fdkAxios as FdkAxios, Utility, Constant };

package/index.js

@@ -1,26 +1,41 @@
-const {ApplicationConfig, ApplicationClient, ApplicationModel } = require('./sdk/application');
-const {PlatformConfig, PlatformClient, PlatformModel } = require('./sdk/platform');
-const {PublicConfig, PublicClient, PublicModel } = require('./sdk/public');
-
 
+const { PublicConfig, PublicClient, PublicModel } = require('./sdk/public'); 
+const { ApplicationConfig, ApplicationClient, ApplicationModel } = require('./sdk/application'); 
+const { PlatformConfig, PlatformClient, PlatformModel } = require('./sdk/platform'); 
 
+const { PartnerConfig, PartnerClient, PartnerModel } = require('./sdk/partner'); 
 const {fdkAxios} = require('./sdk/common/AxiosHelper');
 const Utility = require('./sdk/common/Utility');
 const Constant = require('./sdk/common/Constant');
 
 module.exports = {
+    
+    
+    PublicConfig,
+    PublicClient,
+    PublicModel,
+    
+    
+    
     ApplicationConfig,
     ApplicationClient,
     ApplicationModel,
+    
+    
+    
     PlatformConfig,
     PlatformClient,
     PlatformModel,
-    PublicConfig,
-    PublicClient,
-    PublicModel,
     
     
     
+    
+    
+    PartnerConfig,
+    PartnerClient,
+    PartnerModel,
+    
+    
     FdkAxios: fdkAxios,
     Utility,
     Constant,

package/package.json

@@ -1,35 +1,44 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "",
   "main": "index.js",
   "scripts": {
     "test": "jest --coverage",
+    "test:standalone": "npm run build && npx cypress run",
+    "build": "webpack",
     "prettier": "npx prettier -w ./sdk ./tests && npx tsc"
   },
-  "jest": {
-    "coverageThreshold": {
-      "global": {
-        "branches": 0,
-        "functions": 0,
-        "lines": 0
-      }
-    }
-  },
   "author": "Jigar Dafda<jigar.dafda@gmail.com>",
   "license": "ISC",
   "dependencies": {
     "axios": "^0.27.2",
+    "camelcase": "^6.3.0",
     "crypto-js": "^4.1.1",
+    "isomorphic-base64": "^1.0.2",
     "joi": "^17.7.0",
-    "query-string": "^6.14.1",
     "loglevel": "^1.8.1",
-    "camelcase": "^6.3.0"
+    "query-string": "^7.1.3"
   },
   "devDependencies": {
+    "axios-cookiejar-support": "^4.0.6",
     "axios-mock-adapter": "^1.21.2",
+    "clean-webpack-plugin": "^4.0.0",
     "coveralls": "^3.1.1",
+    "cypress": "^9.2.0",
     "dotenv": "^16.0.3",
-    "jest": "^26.6.3"
-  }
+    "jest": "^29.5.0",
+    "tough-cookie": "^4.1.2",
+    "webpack": "^5.81.0",
+    "webpack-cli": "^5.0.2"
+  },
+  "files": [
+    "sdk/**/*.js",
+    "sdk/**/*.d.ts",
+    "./*.js",
+    "./*.d.ts",
+    "!**.config.*",
+    "!dist",
+    "!cypress"
+  ]
 }

package/partner.d.ts

@@ -0,0 +1,4 @@
+import { PartnerConfig } from "./sdk/partner";
+import { PartnerClient } from "./sdk/partner";
+import { PartnerModel } from "./sdk/partner";
+export { PartnerConfig, PartnerClient, PartnerModel };

package/partner.js

@@ -0,0 +1,7 @@
+const {PartnerConfig, PartnerClient, PartnerModel } = require('./sdk/partner');
+
+module.exports = {
+    PartnerConfig: PartnerConfig,
+    PartnerClient: PartnerClient,
+    PartnerModel: PartnerModel
+};

package/sdk/application/ApplicationAPIClient.js

@@ -1,4 +1,5 @@
 const { fdkAxios } = require("../common/AxiosHelper");
+const { btoa } = require("isomorphic-base64");
 
 class APIClient {
   /**
@@ -10,10 +11,7 @@ class APIClient {
    */
 
   static execute(conf, method, url, query, body, xHeaders) {
-    const token = Buffer.from(
-      `${conf.applicationID}:${conf.applicationToken}`,
-      "utf8"
-    ).toString("base64");
+    const token = btoa(`${conf.applicationID}:${conf.applicationToken}`);
 
     let headers = { Authorization: "Bearer " + token };
     if (conf.cookie) {

package/sdk/application/Cart/CartApplicationClient.js

@@ -1,10 +1,11 @@
-const APIClient = require("../ApplicationAPIClient");
+const ApplicationAPIClient = require("../ApplicationAPIClient");
+const { FDKClientValidationError } = require("../../common/FDKError");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
-const { FDKClientValidationError } = require("../../common/FDKError");
 const CartValidator = require("./CartApplicationValidator");
 const CartModel = require("./CartApplicationModel");
 const { Logger } = require("./../../common/Logger");
+const Joi = require("joi");
 
 class Cart {
   constructor(_conf) {
@@ -88,7 +89,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -159,7 +160,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -232,7 +233,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -303,7 +304,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -368,7 +369,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -451,7 +452,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -530,7 +531,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -602,7 +603,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -676,7 +677,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -740,7 +741,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "head",
       constructUrl({
@@ -800,7 +801,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -863,7 +864,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -929,7 +930,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -995,7 +996,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -1069,7 +1070,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -1139,7 +1140,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -1213,7 +1214,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({
@@ -1276,7 +1277,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "delete",
       constructUrl({
@@ -1342,7 +1343,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "delete",
       constructUrl({
@@ -1413,7 +1414,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -1480,7 +1481,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "put",
       constructUrl({
@@ -1544,7 +1545,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "put",
       constructUrl({
@@ -1617,7 +1618,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "put",
       constructUrl({
@@ -1684,7 +1685,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "put",
       constructUrl({
@@ -1749,7 +1750,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "post",
       constructUrl({
@@ -1851,7 +1852,7 @@ class Cart {
 
     const xHeaders = {};
 
-    const response = await APIClient.execute(
+    const response = await ApplicationAPIClient.execute(
       this._conf,
       "get",
       constructUrl({

package/sdk/application/Cart/CartApplicationModel.js

@@ -28,7 +28,9 @@ class CartModel {
       extra_meta: Joi.any(),
       item_id: Joi.number(),
       item_size: Joi.string().allow(""),
-      parent_item_identifiers: Joi.any(),
+      parent_item_identifiers: Joi.array().items(
+        Joi.object().pattern(/\S/, Joi.string().allow(""))
+      ),
       pos: Joi.boolean(),
       product_group_tags: Joi.array().items(Joi.string().allow("").allow(null)),
       quantity: Joi.number(),