@gofynd/fdk-client-javascript 1.0.4 → 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.
@@ -168,4 +186,6 @@ import { ApplicationConfig, ApplicationClient } from "fdk-client-javascript";
 - [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

@@ -7,7 +7,10 @@ import { ApplicationModel } from "./sdk/application";
 import { PlatformConfig } from "./sdk/platform";
 import { PlatformClient } from "./sdk/platform";
 import { PlatformModel } from "./sdk/platform";
+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 { PublicConfig, PublicClient, PublicModel, ApplicationConfig, ApplicationClient, ApplicationModel, PlatformConfig, PlatformClient, PlatformModel, 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,25 +1,41 @@
 
-const { PublicConfig, PublicClient, PublicModel } = require('./sdk/public');
-const { ApplicationConfig, ApplicationClient, ApplicationModel } = require('./sdk/application');
-const { PlatformConfig, PlatformClient, PlatformModel } = require('./sdk/platform');
+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,
     
+    
+    
+    
+    
+    PartnerConfig,
+    PartnerClient,
+    PartnerModel,
+    
+    
     FdkAxios: fdkAxios,
     Utility,
     Constant,

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "v1.0.4",
+  "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"
   },
   "author": "Jigar Dafda<jigar.dafda@gmail.com>",
@@ -13,23 +15,30 @@
     "axios": "^0.27.2",
     "camelcase": "^6.3.0",
     "crypto-js": "^4.1.1",
+    "isomorphic-base64": "^1.0.2",
     "joi": "^17.7.0",
     "loglevel": "^1.8.1",
-    "query-string": "^6.14.1"
+    "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": "^29.5.0",
-    "tough-cookie": "^4.1.2"
+    "tough-cookie": "^4.1.2",
+    "webpack": "^5.81.0",
+    "webpack-cli": "^5.0.2"
   },
   "files": [
     "sdk/**/*.js",
     "sdk/**/*.d.ts",
     "./*.js",
     "./*.d.ts",
-    "!jest.config.*"
+    "!**.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/Catalog/CatalogApplicationModel.js

@@ -16,7 +16,7 @@ class CatalogModel {
   }
   static ApplicationStoreListing() {
     return Joi.object({
-      filters: Joi.array().items(CatalogModel.StoreDepartments()),
+      filters: Joi.array().items(Joi.any()),
       items: Joi.array().items(CatalogModel.AppStore()),
       page: CatalogModel.Page(),
     });
@@ -29,6 +29,7 @@ class CatalogModel {
       departments: Joi.array().items(CatalogModel.StoreDepartments()),
       manager: CatalogModel.StoreManagerSerializer(),
       name: Joi.string().allow(""),
+      store_code: Joi.string().allow(""),
       uid: Joi.number(),
     });
   }
@@ -940,7 +941,7 @@ class CatalogModel {
   }
   static StoreDepartments() {
     return Joi.object({
-      logo: Joi.string().allow(""),
+      logo: Joi.any(),
       name: Joi.string().allow(""),
       priority_order: Joi.number(),
       slug: Joi.string().allow(""),
@@ -964,6 +965,7 @@ class CatalogModel {
       departments: Joi.array().items(CatalogModel.StoreDepartments()),
       manager: CatalogModel.StoreManagerSerializer(),
       name: Joi.string().allow(""),
+      store_code: Joi.string().allow(""),
       timing: Joi.array().items(CatalogModel.StoreTiming()),
       uid: Joi.number(),
     });

package/sdk/application/Content/ContentApplicationModel.js

@@ -347,7 +347,6 @@ class ContentModel {
   static Detail() {
     return Joi.object({
       description: Joi.string().allow(""),
-      image_url: Joi.string().allow(""),
       title: Joi.string().allow(""),
     });
   }

package/sdk/common/BaseOAuthClient.d.ts

@@ -0,0 +1,17 @@
+export = BaseOAuthClient;
+declare class BaseOAuthClient {
+    constructor(config: any);
+    config: any;
+    token: any;
+    refreshToken: any;
+    retryOAuthTokenTimer: NodeJS.Timeout;
+    raw_token: any;
+    token_expires_in: any;
+    token_expires_at: number;
+    useAutoRenewTimer: any;
+    getAccessToken(): Promise<any>;
+    isTokenExpired(ttl?: number): boolean;
+    setToken(token: any): void;
+    retryOAuthToken(expires_in: any): void;
+    renewAccessToken(): Promise<void>;
+}

package/sdk/common/BaseOAuthClient.js

@@ -0,0 +1,67 @@
+const { Logger } = require("./Logger");
+
+class BaseOAuthClient {
+  constructor(config) {
+    this.config = config;
+    this.token = null;
+    this.refreshToken = null;
+    this.retryOAuthTokenTimer = null;
+    this.raw_token = null;
+    this.token_expires_in = null;
+    this.token_expires_at = 0;
+    this.useAutoRenewTimer =
+      config.useAutoRenewTimer !== undefined ? config.useAutoRenewTimer : true;
+  }
+
+  async getAccessToken() {
+    if (
+      !this.useAutoRenewTimer &&
+      this.refreshToken &&
+      this.isTokenExpired(120)
+    ) {
+      // Check if token is about to expire in less than 2 mins.
+      // Renew if to be expired and auto renew timer is not enabled.
+      await this.renewAccessToken();
+    }
+    return this.token;
+  }
+
+  // default TTL checked 0 seconds
+  isTokenExpired(ttl = 0) {
+    const currentTimestamp = new Date().getTime();
+    // Check if token is about to expire in less than 2 mins
+    if ((this.token_expires_at - currentTimestamp) / 1000 < ttl) {
+      return true;
+    }
+    return false;
+  }
+
+  setToken(token) {
+    this.raw_token = token;
+    this.token_expires_in = token.expires_in;
+    this.token = token.access_token;
+    this.token_expires_at = token.expires_at || this.token_expires_at;
+    this.refreshToken = token.refresh_token ? token.refresh_token : null;
+    if (this.refreshToken && this.useAutoRenewTimer) {
+      this.retryOAuthToken(token.expires_in);
+    }
+  }
+
+  retryOAuthToken(expires_in) {
+    Logger({ type: "INFO", message: "Retrying OAuth Token" });
+    if (this.retryOAuthTokenTimer) {
+      clearTimeout(this.retryOAuthTokenTimer);
+    }
+    if (expires_in > 60) {
+      this.retryOAuthTokenTimer = setTimeout(() => {
+        this.renewAccessToken();
+      }, (expires_in - 60) * 1000);
+    }
+  }
+
+  async renewAccessToken() {
+    // Impementation to renew Access Token
+  }
+}
+
+module.exports = BaseOAuthClient;

package/sdk/common/RequestSigner.js

@@ -1,6 +1,5 @@
 "use strict";
 
-const url = require("url");
 const querystring = require("query-string");
 const sha256 = require("crypto-js/sha256");
 const hmacSHA256 = require("crypto-js/hmac-sha256");
@@ -39,10 +38,6 @@ const HEADERS_TO_INCLUDE = ["x-fp-.*", "host"];
 // request: { path | body, [host], [method], [headers], [service], [region] }
 class RequestSigner {
   constructor(request) {
-    if (typeof request === "string") {
-      request = url.parse(request);
-    }
-
     let headers = (request.headers = request.headers || {});
     this.request = request;
 

package/sdk/partner/OAuthClient.d.ts

@@ -0,0 +1,14 @@
+export = OAuthClient;
+declare class OAuthClient extends BaseOAuthClient {
+    startAuthorization(options: any): string;
+    verifyCallback(query: any): Promise<void>;
+    renewAccessToken(isOfflineToken?: boolean): Promise<any>;
+    getNewAccessToken(): Promise<any>;
+    getAccesstokenObj({ grant_type, client_id, client_secret, scope }: {
+        grant_type: any;
+        client_id: any;
+        client_secret: any;
+        scope: any;
+    }): Promise<any>;
+}
+import BaseOAuthClient = require("../common/BaseOAuthClient");

package/sdk/partner/OAuthClient.js

@@ -0,0 +1,112 @@
+const { fdkAxios } = require("../common/AxiosHelper");
+const { FDKTokenIssueError } = require("../common/FDKError");
+const { Logger } = require("../common/Logger");
+const BaseOAuthClient = require("../common/BaseOAuthClient");
+const querystring = require("querystring");
+const { sign } = require("../common/RequestSigner");
+
+class OAuthClient extends BaseOAuthClient {
+  constructor(config) {
+    super(config);
+  }
+
+  startAuthorization(options) {
+    Logger({ type: "DEBUG", message: "Starting Authorization" });
+    let query = {
+      client_id: this.config.apiKey,
+      scope: options.scope.join(","),
+      redirect_uri: options.redirectUri,
+      state: options.state,
+      access_mode: options.access_mode,
+      response_type: "code",
+      extension_id: this.config.extensionId,
+    };
+    const queryString = querystring.stringify(query);
+
+    let reqPath = `/service/panel/authentication/v1.0/organization/${this.config.organizationId}/oauth/authorize?${queryString}`;
+    let signingOptions = {
+      method: "GET",
+      host: new URL(this.config.domain).host,
+      path: reqPath,
+      body: null,
+      headers: {},
+      signQuery: true,
+    };
+    signingOptions = sign(signingOptions);
+    Logger({ type: "DEBUG", message: "Authorization successful" });
+
+    return `${this.config.domain}${signingOptions.path}`;
+  }
+
+  async verifyCallback(query) {
+    if (query.error) {
+      throw new FDKOAuthCodeError(query.error_description, {
+        error: query.error,
+      });
+    }
+
+    try {
+      let res = await this.getAccesstokenObj({
+        grant_type: "authorization_code",
+        code: query.code,
+      });
+      res.expires_at =
+        res.expires_at || new Date().getTime() + res.expires_in * 1000;
+      this.setToken(res);
+    } catch (error) {
+      if (error.isAxiosError) {
+        throw new FDKTokenIssueError(error.message);
+      }
+      throw error;
+    }
+  }
+
+  async renewAccessToken(isOfflineToken = true) {
+    if (isOfflineToken) {
+      await this.getNewAccessToken();
+    } else {
+      res = await this.getAccesstokenObj({
+        grant_type: "refresh_token",
+        refresh_token: this.refreshToken,
+      });
+      res.expires_at =
+        res.expires_at || new Date().getTime() + res.expires_in * 1000;
+      this.setToken(res);
+      return res;
+    }
+  }
+
+  async getNewAccessToken() {
+    try {
+      let res = await this.getAccesstokenObj({
+        grant_type: "client_credentials",
+        client_id: this.config.apiKey,
+        client_secret: this.config.apiSecret,
+        scope: this.config.scope,
+      });
+      res.expires_at =
+        res.expires_at || new Date().getTime() + res.expires_in * 1000;
+      this.setToken(res);
+      return this.token;
+    } catch (error) {
+      if (error.isAxiosError) {
+        throw new FDKTokenIssueError(error.message);
+      }
+      throw error;
+    }
+  }
+
+  async getAccesstokenObj({ grant_type, client_id, client_secret, scope }) {
+    Logger({ type: "DEBUG", message: "Processing Access token object..." });
+    let reqData = {
+      grant_type: grant_type,
+      client_id,
+      client_secret,
+      scope,
+    };
+    let url = `${this.config.domain}/service/panel/authentication/v1.0/organization/${this.config.organizationId}/oauth/token`;
+    return fdkAxios.post(url, reqData);
+  }
+}
+
+module.exports = OAuthClient;

package/sdk/{APIClient.d.ts → partner/PartnerAPIClient.d.ts}

@@ -7,5 +7,6 @@ declare class APIClient {
      * @param {object} query
      * @param {object} body
      */
-    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any): any;
+    static execute(conf: object, method: string, url: string, query: object, body: object): Promise<any>;
+    get(url: any, config: any): Promise<any>;
 }

package/sdk/{APIClient.js → partner/PartnerAPIClient.js}

@@ -8,9 +8,8 @@ class APIClient {
    * @param {object} query
    * @param {object} body
    */
-
-  static execute(conf, method, url, query, body, xHeaders) {
-    let headers = {};
+  static async execute(conf, method, url, query, body) {
+    const token = await conf.oauthClient.getNewAccessToken();
 
     const extraHeaders = conf.extraHeaders.reduce((acc, curr) => {
       acc = { ...acc, ...curr };
@@ -18,18 +17,26 @@ class APIClient {
     }, {});
 
     const rawRequest = {
+      baseURL: conf.domain,
       method: method,
       url: url,
       params: query,
       data: body,
       headers: {
-        ...headers,
+        Authorization: "Bearer " + token,
         ...extraHeaders,
-        ...xHeaders,
       },
     };
+
     return fdkAxios.request(rawRequest);
   }
-}
 
+  async get(url, config) {
+    let access_token = await this.configuration.getAccessToken();
+    config = config || {};
+    config.headers = config.headers || {};
+    config.headers.Authorization = "Bearer " + access_token;
+    return axios.get(url);
+  }
+}
 module.exports = APIClient;

package/sdk/{Client.d.ts → partner/PartnerClient.d.ts}

@@ -1,5 +1,5 @@
-export = Client;
-declare class Client {
+export = PartnerClient;
+declare class PartnerClient {
     constructor(config: any);
     config: any;
     setExtraHeaders(header: any): void;

package/sdk/{Client.js → partner/PartnerClient.js}

@@ -1,6 +1,6 @@
 const { FDKClientValidationError } = require("../common/FDKError");
 
-class Client {
+class PartnerClient {
   constructor(config) {
     this.config = config;
   }
@@ -14,4 +14,4 @@ class Client {
   }
 }
 
-module.exports = Client;
+module.exports = PartnerClient;

package/sdk/partner/PartnerConfig.d.ts

@@ -0,0 +1,30 @@
+export = PartnerConfig;
+declare class PartnerConfig {
+    /**
+     * @param {Object} config
+     * @param {string} config.companyId
+     * @param {string} config.domain
+     * @param {string} config.apiKey
+     * @param {string} config.apiSecret
+     * @param {boolean} config.useAutoRenewTimer
+     */
+    constructor(config: {
+        companyId: string;
+        domain: string;
+        apiKey: string;
+        apiSecret: string;
+        useAutoRenewTimer: boolean;
+    });
+    organizationId: any;
+    domain: string;
+    apiKey: string;
+    apiSecret: string;
+    scope: any;
+    useAutoRenewTimer: boolean;
+    oauthClient: OauthClient;
+    logLevel: any;
+    extraHeaders: any[];
+    setLogLevel(level: any): void;
+    getAccessToken(): Promise<any>;
+}
+import OauthClient = require("./OAuthClient");

package/sdk/partner/PartnerConfig.js

@@ -0,0 +1,39 @@
+const OauthClient = require("./OAuthClient");
+const { setLoggerLevel } = require("../common/Logger");
+
+class PartnerConfig {
+  /**
+   * @param {Object} config
+   * @param {string} config.companyId
+   * @param {string} config.domain
+   * @param {string} config.apiKey
+   * @param {string} config.apiSecret
+   * @param {boolean} config.useAutoRenewTimer
+   */
+  constructor(config) {
+    this.organizationId = config.organizationId;
+    this.domain = config.domain || "https://api.fynd.com";
+    this.apiKey = config.apiKey;
+    this.apiSecret = config.apiSecret;
+    (this.scope = config.scope),
+      (this.useAutoRenewTimer =
+        config.useAutoRenewTimer !== undefined
+          ? config.useAutoRenewTimer
+          : true);
+    this.oauthClient = new OauthClient(this);
+    this.logLevel = config.logLevel || "ERROR";
+    this.setLogLevel(this.logLevel);
+    this.extraHeaders = [];
+  }
+
+  setLogLevel(level) {
+    setLoggerLevel(level);
+  }
+
+  async getAccessToken() {
+    let token = await this.oauthClient.getAccessToken();
+    return token.access_token;
+  }
+}
+
+module.exports = PartnerConfig;

package/sdk/partner/index.d.ts

@@ -0,0 +1,3 @@
+export const PartnerConfig: typeof import("./PartnerConfig");
+export const PartnerClient: typeof import("./PartnerClient");
+export const PartnerModel: {};

package/sdk/partner/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+  PartnerConfig: require("./PartnerConfig"),
+  PartnerClient: require("./PartnerClient"),
+  PartnerModel: {},
+};

package/sdk/platform/Billing/BillingPlatformClient.d.ts

@@ -46,6 +46,18 @@ declare class Billing {
         plan: string;
         couponCode: string;
     }): Promise<CheckValidityResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {CreateOneTimeCharge} arg.body
+     * @returns {Promise<CreateOneTimeChargeResponse>} - Success response
+     * @summary: Create one time subscription charge
+     * @description: Register one time subscription charge for a seller of your extension.
+     */
+    createOneTimeCharge({ extensionId, body }?: {
+        extensionId: string;
+        body: CreateOneTimeCharge;
+    }): Promise<CreateOneTimeChargeResponse>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.extensionId - Extension _id
@@ -58,6 +70,18 @@ declare class Billing {
         extensionId: string;
         body: CreateSubscriptionCharge;
     }): Promise<CreateSubscriptionResponse>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.extensionId - Extension _id
+     * @param {string} arg.chargeId - Standalone charge _id
+     * @returns {Promise<OneTimeChargeEntity>} - Success response
+     * @summary: Get subscription charge details
+     * @description: Get created subscription charge details
+     */
+    getChargeDetails({ extensionId, chargeId }?: {
+        extensionId: string;
+        chargeId: string;
+    }): Promise<OneTimeChargeEntity>;
     /**
      * @param {Object} arg - Arg object.
      * @returns {Promise<SubscriptionCustomer>} - Success response