@gofynd/fdk-client-javascript 0.1.35

package/documentation/public/WEBHOOK.md

@@ -0,0 +1,348 @@
+
+
+
+
+##### [Back to Public docs](./README.md)
+
+## Webhook Methods
+Webhook dispatcher with retry and one event to many subscriber vice versa
+* [fetchAllWebhookEvents](#fetchallwebhookevents)
+* [queryWebhookEventDetails](#querywebhookeventdetails)
+
+
+
+## Methods with example and description
+
+
+### fetchAllWebhookEvents
+Get All Webhook Events
+
+
+
+```javascript
+// Promise
+const promise = webhook.fetchAllWebhookEvents();
+
+// Async/Await
+const data = await webhook.fetchAllWebhookEvents();
+```
+
+
+
+
+
+
+Get All Webhook Events
+
+*Returned Response:*
+
+
+
+
+[EventConfigResponse](#EventConfigResponse)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### queryWebhookEventDetails
+Send webhook event name, type, version, category in request body to get complete details of event from server
+
+
+
+```javascript
+// Promise
+const promise = webhook.queryWebhookEventDetails({  body : value });
+
+// Async/Await
+const data = await webhook.queryWebhookEventDetails({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [Array<EventConfigBase>](#Array<EventConfigBase>) | yes | Request body |
+
+
+Get Webhook Event Details for provided events
+
+*Returned Response:*
+
+
+
+
+[EventConfigResponse](#EventConfigResponse)
+
+Success
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+
+### Schemas
+
+ 
+ 
+ #### [EventConfig](#EventConfig)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | id | number |  no  |  |
+ | event_name | string |  no  |  |
+ | event_type | string |  no  |  |
+ | event_category | string |  no  |  |
+ | version | string |  no  |  |
+ | display_name | string |  no  |  |
+ | description | string |  no  |  |
+ | created_on | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EventConfigList](#EventConfigList)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | items | [[EventConfig](#EventConfig)] |  no  |  |
+ | page | [Page](#Page) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EventConfigResponse](#EventConfigResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | event_configs | [[EventConfig](#EventConfig)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [SubscriberConfigList](#SubscriberConfigList)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | items | [[SubscriberResponse](#SubscriberResponse)] |  no  |  |
+ | page | [Page](#Page) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Page](#Page)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | item_total | number |  no  |  |
+ | next_id | string |  no  |  |
+ | has_previous | boolean |  no  |  |
+ | has_next | boolean |  no  |  |
+ | current | number |  no  |  |
+ | type | string |  yes  |  |
+ | size | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EventProcessedStatus](#EventProcessedStatus)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | id | number |  no  |  |
+ | subscriber_id | string |  no  |  |
+ | attempt | number |  no  |  |
+ | response_code | string |  no  |  |
+ | response_message | string |  no  |  |
+ | created_on | string |  no  |  |
+ | processed_on | string |  no  |  |
+ | status | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EventPayload](#EventPayload)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | id | number |  no  |  |
+ | event_trace_id | string |  no  |  |
+ | message_id | string |  no  |  |
+ | event_name | string |  no  |  |
+ | event_type | string |  no  |  |
+ | version | string |  no  |  |
+ | status | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [SubscriberConfig](#SubscriberConfig)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | id | number |  no  |  |
+ | name | string |  no  |  |
+ | webhook_url | string |  no  |  |
+ | association | [Association](#Association) |  no  |  |
+ | custom_headers | string |  no  |  |
+ | status | [SubscriberStatus](#SubscriberStatus) |  no  |  |
+ | email_id | string |  no  |  |
+ | auth_meta | [AuthMeta](#AuthMeta) |  no  |  |
+ | event_id | [number] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [SubscriberResponse](#SubscriberResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | id | number |  no  |  |
+ | name | string |  no  |  |
+ | webhook_url | string |  no  |  |
+ | association | [Association](#Association) |  no  |  |
+ | custom_headers | string |  no  |  |
+ | email_id | string |  no  |  |
+ | status | [SubscriberStatus](#SubscriberStatus) |  no  |  |
+ | auth_meta | [AuthMeta](#AuthMeta) |  no  |  |
+ | created_on | string |  no  |  |
+ | updated_on | string |  no  |  |
+ | event_configs | [[EventConfig](#EventConfig)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [SubscriberEvent](#SubscriberEvent)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | id | number |  no  |  |
+ | subscriber_id | number |  no  |  |
+ | event_id | number |  no  |  |
+ | created_date | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [AuthMeta](#AuthMeta)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | type | string |  no  |  |
+ | secret | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Association](#Association)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | company_id | number |  no  |  |
+ | application_id | [string] |  no  |  |
+ | extension_id | string |  no  |  |
+ | criteria | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EventConfigBase](#EventConfigBase)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | event_name | string |  no  |  |
+ | event_type | string |  no  |  |
+ | event_category | string |  no  |  |
+ | version | string |  no  |  |
+
+---
+
+
+
+
+### Enums
+
+
+
+
+
+ #### [SubscriberStatus](#SubscriberStatus)
+ Type : string
+
+ | Name | Value | Description |
+ | ---- | ----- | ----------- |
+ | active | active | Status is active |
+ | inactive | inactive | Status is inactive |
+ | blocked | blocked | Subscriber is blocked by system due to multiple failed delivery attempts. |
+
+---
+
+
+
+
+
+

package/index.d.ts

@@ -0,0 +1,10 @@
+import { ApplicationConfig } from "./sdk/application";
+import { ApplicationClient } from "./sdk/application";
+import { PlatformConfig } from "./sdk/platform";
+import { PlatformClient } from "./sdk/platform";
+import { PublicConfig } from "./sdk/public";
+import { PublicClient } from "./sdk/public";
+import { fdkAxios } from "./sdk/common/AxiosHelper";
+import Utility = require("./sdk/common/Utility");
+import Constant = require("./sdk/common/Constant");
+export { ApplicationConfig, ApplicationClient, PlatformConfig, PlatformClient, PublicConfig, PublicClient, fdkAxios as FdkAxios, Utility, Constant };

package/index.js

@@ -0,0 +1,18 @@
+const {ApplicationConfig, ApplicationClient} = require('./sdk/application');
+const {PlatformConfig, PlatformClient} = require('./sdk/platform');
+const {PublicConfig, PublicClient} = require('./sdk/public');
+const {fdkAxios} = require('./sdk/common/AxiosHelper');
+const Utility = require('./sdk/common/Utility');
+const Constant = require('./sdk/common/Constant');
+
+module.exports = {
+    ApplicationConfig,
+    ApplicationClient,
+    PlatformConfig,
+    PlatformClient,
+    PublicConfig,
+    PublicClient,
+    FdkAxios: fdkAxios,
+    Utility,
+    Constant,
+};

package/jest.config.d.ts

@@ -0,0 +1,4 @@
+export const verbose: boolean;
+export const testEnvironment: string;
+export const bail: boolean;
+export const testTimeout: number;

package/jest.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+    verbose: true,
+    testEnvironment: 'node',
+    bail: true,
+    testTimeout: 30000
+};

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@gofynd/fdk-client-javascript",
+  "version": "0.1.35",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "jest --coverage",
+    "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.21.1",
+    "crypto-js": "^4.0.0",
+    "joi": "^17.4.0",
+    "query-string": "^6.14.1",
+    "loglevel": "^1.8.0",
+    "camelcase": "^6.2.0"
+  },
+  "devDependencies": {
+    "axios-mock-adapter": "^1.19.0",
+    "coveralls": "^3.1.0",
+    "dotenv": "^10.0.0",
+    "jest": "^26.6.3"
+  }
+}

package/platform.d.ts

@@ -0,0 +1,3 @@
+import { PlatformConfig } from "./sdk/platform";
+import { PlatformClient } from "./sdk/platform";
+export { PlatformConfig, PlatformClient };

package/platform.js

@@ -0,0 +1,6 @@
+const {PlatformConfig, PlatformClient} = require('./sdk/platform');
+
+module.exports = {
+    PlatformConfig: PlatformConfig,
+    PlatformClient: PlatformClient
+};

package/public.d.ts

@@ -0,0 +1,3 @@
+import { PublicConfig } from "./sdk/public";
+import { PublicClient } from "./sdk/public";
+export { PublicConfig, PublicClient };

package/public.js

@@ -0,0 +1,6 @@
+const { PublicConfig, PublicClient } = require('./sdk/public');
+
+module.exports = {
+    PublicConfig,
+    PublicClient
+};

package/sdk/application/ApplicationAPIClient.d.ts

@@ -0,0 +1,11 @@
+export = APIClient;
+declare class APIClient {
+    /**
+     * @param {object} conf
+     * @param {string} method
+     * @param {string} url
+     * @param {object} query
+     * @param {object} body
+     */
+    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any): any;
+}

package/sdk/application/ApplicationAPIClient.js

@@ -0,0 +1,44 @@
+const { fdkAxios } = require("../common/AxiosHelper");
+
+class APIClient {
+  /**
+   * @param {object} conf
+   * @param {string} method
+   * @param {string} url
+   * @param {object} query
+   * @param {object} body
+   */
+
+  static execute(conf, method, url, query, body, xHeaders) {
+    const token = Buffer.from(
+      `${conf.applicationID}:${conf.applicationToken}`,
+      "utf8"
+    ).toString("base64");
+
+    let headers = { Authorization: "Bearer " + token };
+    if (conf.cookie) {
+      headers = { ...headers, cookie: conf.cookie };
+    }
+    if (conf.locationDetails) {
+      headers = {
+        ...headers,
+        "x-location-detail": JSON.stringify(conf.locationDetails),
+      };
+    }
+    const extraHeaders = conf.extraHeaders.reduce((acc, curr) => {
+      acc = { ...acc, ...curr };
+      return acc;
+    }, {});
+
+    const rawRequest = {
+      method: method,
+      url: url,
+      params: query,
+      data: body,
+      headers: { ...headers, ...extraHeaders, ...xHeaders },
+    };
+    return fdkAxios.request(rawRequest);
+  }
+}
+
+module.exports = APIClient;

package/sdk/application/ApplicationClient.d.ts

@@ -0,0 +1,40 @@
+export = ApplicationClient;
+declare class ApplicationClient {
+    constructor(config: any);
+    config: any;
+    catalog: Catalog;
+    cart: Cart;
+    common: Common;
+    lead: Lead;
+    theme: Theme;
+    user: User;
+    content: Content;
+    communication: Communication;
+    share: Share;
+    fileStorage: FileStorage;
+    configuration: Configuration;
+    payment: Payment;
+    order: Order;
+    rewards: Rewards;
+    posCart: PosCart;
+    logistic: Logistic;
+    setCookie(cookie: any): void;
+    setLocationDetails(locationDetails: any): void;
+    setExtraHeaders(header: any): void;
+}
+import Catalog = require("./client/CatalogApplicationClient");
+import Cart = require("./client/CartApplicationClient");
+import Common = require("./client/CommonApplicationClient");
+import Lead = require("./client/LeadApplicationClient");
+import Theme = require("./client/ThemeApplicationClient");
+import User = require("./client/UserApplicationClient");
+import Content = require("./client/ContentApplicationClient");
+import Communication = require("./client/CommunicationApplicationClient");
+import Share = require("./client/ShareApplicationClient");
+import FileStorage = require("./client/FileStorageApplicationClient");
+import Configuration = require("./client/ConfigurationApplicationClient");
+import Payment = require("./client/PaymentApplicationClient");
+import Order = require("./client/OrderApplicationClient");
+import Rewards = require("./client/RewardsApplicationClient");
+import PosCart = require("./client/PosCartApplicationClient");
+import Logistic = require("./client/LogisticApplicationClient");

package/sdk/application/ApplicationClient.js

@@ -0,0 +1,84 @@
+const { LocationValidator } = require("./ApplicationModels");
+
+const Catalog = require("./client/CatalogApplicationClient");
+
+const Cart = require("./client/CartApplicationClient");
+
+const Common = require("./client/CommonApplicationClient");
+
+const Lead = require("./client/LeadApplicationClient");
+
+const Theme = require("./client/ThemeApplicationClient");
+
+const User = require("./client/UserApplicationClient");
+
+const Content = require("./client/ContentApplicationClient");
+
+const Communication = require("./client/CommunicationApplicationClient");
+
+const Share = require("./client/ShareApplicationClient");
+
+const FileStorage = require("./client/FileStorageApplicationClient");
+
+const Configuration = require("./client/ConfigurationApplicationClient");
+
+const Payment = require("./client/PaymentApplicationClient");
+
+const Order = require("./client/OrderApplicationClient");
+
+const Rewards = require("./client/RewardsApplicationClient");
+
+const PosCart = require("./client/PosCartApplicationClient");
+
+const Logistic = require("./client/LogisticApplicationClient");
+
+const { FDKClientValidationError } = require("../common/FDKError");
+
+class ApplicationClient {
+  constructor(config) {
+    this.config = config;
+    this.catalog = new Catalog(config);
+    this.cart = new Cart(config);
+    this.common = new Common(config);
+    this.lead = new Lead(config);
+    this.theme = new Theme(config);
+    this.user = new User(config);
+    this.content = new Content(config);
+    this.communication = new Communication(config);
+    this.share = new Share(config);
+    this.fileStorage = new FileStorage(config);
+    this.configuration = new Configuration(config);
+    this.payment = new Payment(config);
+    this.order = new Order(config);
+    this.rewards = new Rewards(config);
+    this.posCart = new PosCart(config);
+    this.logistic = new Logistic(config);
+  }
+
+  setCookie(cookie) {
+    this.config.cookie = cookie;
+  }
+
+  setLocationDetails(locationDetails) {
+    const {
+      error,
+    } = LocationValidator.validateLocationObj().validate(locationDetails, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+    if (error) {
+      throw new FDKClientValidationError(error);
+    }
+    this.config.locationDetails = locationDetails;
+  }
+
+  setExtraHeaders(header) {
+    if (typeof header === "object") {
+      this.config.extraHeaders.push(header);
+    } else {
+      throw new FDKClientValidationError("Context value should be an object");
+    }
+  }
+}
+
+module.exports = ApplicationClient;

package/sdk/application/ApplicationConfig.d.ts

@@ -0,0 +1,19 @@
+export = ApplicationConfig;
+declare class ApplicationConfig {
+    /**
+     * @param {object} _conf
+     * @param {object} [_opts]
+     */
+    constructor(_conf: object, _opts?: object);
+    applicationID: any;
+    applicationToken: any;
+    opts: any;
+    domain: any;
+    logLevel: any;
+    extraHeaders: any[];
+    locationDetails: any;
+    setLogLevel(level: any): void;
+    setCookie(cookie: any): void;
+    cookie: any;
+    validate(): void;
+}