@gofynd/fdk-client-javascript 1.0.3 → 1.1.0

package/documentation/public/WEBHOOK.md

@@ -1,246 +0,0 @@
-
-
-
-
-
-##### [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
-
-
-#### [Association](#Association)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || application_id | [string] |  no  |  || company_id | number |  no  |  || criteria | string |  no  |  || extension_id | string |  no  |  |
-
----
-
-#### [AuthMeta](#AuthMeta)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || secret | string |  no  |  || type | string |  no  |  |
-
----
-
-#### [EventConfig](#EventConfig)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || created_on | string |  no  |  || description | string |  no  |  || display_name | string |  no  |  || event_category | string |  no  |  || event_name | string |  no  |  || event_type | string |  no  |  || id | number |  no  |  || version | string |  no  |  |
-
----
-
-#### [EventConfigBase](#EventConfigBase)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || event_category | string |  no  |  || event_name | string |  no  |  || event_type | string |  no  |  || version | 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  |  |
-
----
-
-#### [EventPayload](#EventPayload)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || event_name | string |  no  |  || event_trace_id | string |  no  |  || event_type | string |  no  |  || id | number |  no  |  || message_id | string |  no  |  || status | boolean |  no  |  || version | string |  no  |  |
-
----
-
-#### [EventProcessedStatus](#EventProcessedStatus)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || attempt | number |  no  |  || created_on | string |  no  |  || id | number |  no  |  || processed_on | string |  no  |  || response_code | string |  no  |  || response_message | string |  no  |  || status | boolean |  no  |  || subscriber_id | string |  no  |  |
-
----
-
-#### [Page](#Page)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || current | number |  no  |  || has_next | boolean |  no  |  || has_previous | boolean |  no  |  || item_total | number |  no  |  || next_id | string |  no  |  || size | number |  no  |  || type | string |  yes  |  |
-
----
-
-#### [SubscriberConfig](#SubscriberConfig)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || association | [Association](#Association) |  no  |  || auth_meta | [AuthMeta](#AuthMeta) |  no  |  || custom_headers | string |  no  |  || email_id | string |  no  |  || event_id | [number] |  no  |  || id | number |  no  |  || name | string |  no  |  || status | [SubscriberStatus](#SubscriberStatus) |  no  |  || webhook_url | string |  no  |  |
-
----
-
-#### [SubscriberConfigList](#SubscriberConfigList)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || items | [[SubscriberResponse](#SubscriberResponse)] |  no  |  || page | [Page](#Page) |  no  |  |
-
----
-
-#### [SubscriberEvent](#SubscriberEvent)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || created_date | string |  no  |  || event_id | number |  no  |  || id | number |  no  |  || subscriber_id | number |  no  |  |
-
----
-
-#### [SubscriberResponse](#SubscriberResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || association | [Association](#Association) |  no  |  || auth_meta | [AuthMeta](#AuthMeta) |  no  |  || created_on | string |  no  |  || custom_headers | string |  no  |  || email_id | string |  no  |  || event_configs | [[EventConfig](#EventConfig)] |  no  |  || id | number |  no  |  || name | string |  no  |  || status | [SubscriberStatus](#SubscriberStatus) |  no  |  || updated_on | string |  no  |  || webhook_url | 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/jest.config.d.ts

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

package/jest.config.js

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

package/tests/application/catalog.spec.js

@@ -1,54 +0,0 @@
-const { ApplicationConfig, ApplicationClient } = require("../../index.js");
-const setupCookieInterceptor = require("../helpers/cookie.helper");
-require("dotenv").config();
-let applicationClient;
-
-beforeAll(() => {
-  setupCookieInterceptor();
-  const config = new ApplicationConfig({
-    domain: "https://api.fynd.com",
-    applicationID: "000000000000000000000001",
-    applicationToken: "9502d710-5a22-11e9-a001-57d85417c280",
-    locationDetails: {
-      pincode: "385001",
-      country: "India",
-      city: "Ahmedabad",
-      location: { longitude: "72.585022", latitude: "23.033863" },
-    },
-  });
-  applicationClient = new ApplicationClient(config);
-  applicationClient.setLocationDetails({
-    pincode: "385002",
-    country: "India",
-    city: "Ahmedabad",
-    location: { longitude: "72.585022", latitude: "23.033863" },
-  });
-});
-
-afterAll(() => {
-  applicationClient = null;
-});
-
-describe("Application Catalog Test Cases", () => {
-  it("getProducts testing", async () => {
-    let products = await applicationClient.catalog.getProducts();
-    expect(products.items.length).toBeGreaterThan(0);
-  });
-});
-
-describe("Application Common Test Cases ", () => {
-  it("search application by name", async () => {
-    let locations = await applicationClient.common.searchApplication({
-      authorization: `Basic ${process.env.AUTH_HEADER}`,
-      query: "pc.fyndstore.co",
-    });
-    expect(locations && typeof locations === "object").toBe(true);
-  });
-});
-
-describe("Application Content Test Cases ", () => {
-  it("getNavigations test", async () => {
-    let res = await applicationClient.content.getNavigations();
-    expect(res).not.toBeNull();
-  });
-});

package/tests/common/action-url.spec.js

@@ -1,35 +0,0 @@
-const { convertActionToUrl } = require("../../sdk/common/Utility");
-const actionToUrlConvert = require("./schema/action-url.json");
-
-describe("Convert to URl  from ActionObject", () => {
-  //loop over test cases json
-  actionToUrlConvert.tests.forEach((test) => {
-    it(test.name, () => {
-      let path = convertActionToUrl(test.action);
-      expect(path).toEqual(test.result.path);
-    });
-  });
-
-  it("empty object as actionObj", () => {
-    let path = convertActionToUrl({});
-    expect(path).toEqual("");
-  });
-
-  it("null as actionObj", () => {
-    let path = convertActionToUrl(null);
-    expect(path).toEqual("");
-  });
-
-  it("wrong actionObj format", () => {
-    let testObj = {
-      type: "page",
-      page: {
-        params: {
-          slug: ["test-product", "test-product-2"],
-        },
-      },
-    };
-    let path = convertActionToUrl(testObj);
-    expect(path).toEqual("");
-  });
-});

package/tests/common/schema/action-url.json

@@ -1,178 +0,0 @@
-{
-  "tests": [
-    {
-      "name": "brand listing query param  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "brand",
-          "params": {
-            "slug": ["test"]
-          },
-          "query": {
-            "department": ["men", "women"]
-          }
-        }
-      },
-      "result": {
-        "path": "/brand/test/?department=men&department=women"
-      }
-    },
-    {
-      "name": "profile order shipments",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "profile-order-shipment",
-          "params": {
-            "shipmentid": [16720482187091110000]
-          }
-        }
-      },
-      "result": {
-        "path": "/profile/orders/shipment/16720482187091110000"
-      }
-    },
-    {
-      "name": "category listing query param  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "category",
-          "params": {
-            "slug": ["test"]
-          },
-          "query": {
-            "department": ["men", "women"]
-          }
-        }
-      },
-      "result": {
-        "path": "/category/test/?department=men&department=women"
-      }
-    },
-    {
-      "name": "products listing query param  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "products",
-          "query": {
-            "department": ["men", "women"]
-          }
-        }
-      },
-      "result": {
-        "path": "/products/?department=men&department=women"
-      }
-    },
-    {
-      "name": "external url action to link",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "external",
-          "query": {
-            "url": ["https://abhay.dev"]
-          }
-        }
-      },
-      "result": {
-        "path": "/external/?url=https%3A%2F%2Fabhay.dev"
-      }
-    },
-    {
-      "name": "Sections with group  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "sections",
-          "params": {
-            "group": ["home"]
-          }
-        }
-      },
-      "result": {
-        "path": "/sections/home"
-      }
-    },
-    {
-      "name": "Review page",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "product-reviews",
-          "params": {
-            "slug": ["test-product"]
-          }
-        }
-      },
-      "result": {
-        "path": "/product/test-product/reviews"
-      }
-    },
-    {
-      "name": "Multiple slugs",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "product-reviews",
-          "params": {
-            "slug": ["test-product", "test-product-2"]
-          }
-        }
-      },
-      "result": {
-        "path": "/product/test-product:::test-product-2/reviews"
-      }
-    },
-    {
-      "name": "login page  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "login"
-        }
-      },
-      "result": {
-        "path": "/auth/login"
-      }
-    },
-    {
-      "name": "register page  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "register"
-        }
-      },
-      "result": {
-        "path": "/auth/register"
-      }
-    },
-    {
-      "name": "Shipping policy  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "shipping-policy"
-        }
-      },
-      "result": {
-        "path": "/shipping-policy"
-      }
-    },
-    {
-      "name": "Return policy  ",
-      "action": {
-        "type": "page",
-        "page": {
-          "type": "return-policy"
-        }
-      },
-      "result": {
-        "path": "/return-policy"
-      }
-    }
-  ]
-}