@gofynd/fdk-client-javascript 0.1.35

package/.github/workflows/on_create_release.yml

@@ -0,0 +1,23 @@
+on:
+  release:
+    types: [created]
+
+jobs:
+
+  publish-npm:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - uses: jaywcjlove/github-action-package@main
+        with:
+          version: ${{ github.ref_name }}
+          rename: "@gofynd/fdk-client-javascript"
+      - run: npm ci
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_AUTH_TOKEN}}

package/.github/workflows/on_merge_main.yml

@@ -0,0 +1,38 @@
+name: Merge CI
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 15.x]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: npm install, npm test
+      run: |
+        npm install
+        npm test
+      env:
+        API_KEY: ${{ secrets.API_KEY }}
+        API_SECRET: ${{ secrets.API_SECRET }}
+        APP_USERNAME: ${{ secrets.APP_USERNAME }}
+        PASSWORD: ${{ secrets.PASSWORD }}
+        AUTH_HEADER: ${{ secrets.AUTH_HEADER}}
+    
+    - name: Coveralls (Uploading test report)
+      uses: coverallsapp/github-action@master
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/on_pull_request.yml

@@ -0,0 +1,35 @@
+name: Pull Request CI
+
+on:
+  push:
+    branches: [ fyndx0 ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.x, 14.x, 15.x]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: npm install, npm test
+      run: |
+        npm install
+        npm test
+      env:
+        API_KEY: ${{ secrets.API_KEY }}
+        API_SECRET: ${{ secrets.API_SECRET }}
+        APP_USERNAME: ${{ secrets.APP_USERNAME }}
+        PASSWORD: ${{ secrets.PASSWORD }}
+        AUTH_HEADER: ${{ secrets.AUTH_HEADER}}

package/.prettierrc

@@ -0,0 +1,5 @@
+{
+    "plugins": [
+        "prettier-plugin-jsdoc"
+    ]
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Fynd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,118 @@
+# FDK Javascript
+
+![GitHub package.json version](https://img.shields.io/github/package-json/v/gofynd/fdk-client-javascript?style=plastic)
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/gofynd/fdk-client-javascript/Node.js%20CI?style=plastic)
+![GitHub](https://img.shields.io/github/license/gofynd/fdk-client-javascript?style=plastic)
+[![Coverage Status](https://coveralls.io/repos/github/gofynd/fdk-client-javascript/badge.svg)](https://coveralls.io/github/gofynd/fdk-client-javascript)
+
+FDK client for Javascript
+
+## Getting Started
+
+Get started with the Javascript Development SDK for Fynd Platform
+
+### Usage
+
+```
+npm install fdk-client-javascript --save
+```
+
+Using this method, you can `require` fdk-client-javascript like so:
+
+```js
+const {
+  ApplicationConfig,
+  ApplicationClient,
+} = require("fdk-client-javascript");
+```
+
+### Logging
+
+For logging support user can pass `logLevel` in `ApplicationConfig` or `PlatformConfig` while declaration.
+
+```
+Available logging levels: TRACE, DEBUG, INFO, WARN, ERROR.
+
+Default log level: ERROR
+```
+### Sample Usage - ApplicationClient
+
+```javascript
+const config = new ApplicationConfig({
+  applicationID: "YOUR_APPLICATION_ID",
+  applicationToken: "YOUR_APPLICATION_TOKEN",
+  locationDetails: "LOCATION_DETAILS_OBJECT"
+});
+
+const applicationClient = new ApplicationClient(config);
+
+applicationClient.setLocationDetails({ 
+  pincode:"385001",
+  country: "India",
+  city:  "Ahmedabad",
+  location: {longitude: "72.585022", latitude: "23.033863"}
+  });
+
+
+async function getProductDetails() {
+  try {
+    const product = await applicationClient.catalog.getProductDetailBySlug({
+        slug: "product-slug"
+      });
+    console.log(product.name);
+  } catch (err) {
+    console.log(err);
+  }
+}
+
+getProductDetails();
+```
+
+### Sample Usage - PlatformClient
+
+```javascript
+const { PlatformConfig, PlatformClient } = require("fdk-client-javascript");
+
+let platformConfig = new PlatformConfig({
+  companyId: "COMPANY_ID",
+  apiKey: "API_KEY", 
+  apiSecret: "API_SECRET", 
+  domain: "DOMAIN",
+  useAutoRenewTimer: true // Setting `true` will use timer based logic to refresh the access token. With `false` will issue refresh token just before any api call when it is expired. 
+});
+
+async function getData() {
+  try {
+    // TODO: get token using OAuth
+    platformConfig.oauthClient.setToken(token.access_token);
+    const client = new PlatformClient(platformConfig);
+
+    // API's without application_id
+    const tickets = await client.lead.getTickets();
+    console.log("tickets", tickets);
+
+    // API's with application_id
+    const customers = await client
+      .application("APPLICATION_ID")
+      .user.getCustomers();
+    console.log("customers", customers);
+  } catch (err) {
+    console.log(err);
+  }
+}
+
+getData();
+```
+
+### TypeScript
+
+fdk-client-javascript includes Typescript definitions.
+
+```typescript
+import { ApplicationConfig, ApplicationClient } from "fdk-client-javascript";
+```
+
+### Documentation
+
+- [Application Front](documentation/application/README.md)
+- [Platform Front](documentation/platform/README.md)

package/application.d.ts

@@ -0,0 +1,3 @@
+import { ApplicationConfig } from "./sdk/application";
+import { ApplicationClient } from "./sdk/application";
+export { ApplicationConfig, ApplicationClient };

package/application.js

@@ -0,0 +1,6 @@
+const {ApplicationConfig, ApplicationClient} = require('./sdk/application');
+
+module.exports = {
+    ApplicationConfig: ApplicationConfig,
+    ApplicationClient: ApplicationClient,
+};

package/common.d.ts

@@ -0,0 +1,4 @@
+import { fdkAxios } from "./sdk/common/AxiosHelper";
+import Utility = require("./sdk/common/Utility");
+import Constant = require("./sdk/common/Constant");
+export { fdkAxios as FdkAxios, Utility, Constant };

package/common.js

@@ -0,0 +1,9 @@
+const {fdkAxios} = require('./sdk/common/AxiosHelper');
+const Utility = require('./sdk/common/Utility');
+const Constant = require('./sdk/common/Constant');
+
+module.exports = {
+    FdkAxios: fdkAxios,
+    Utility,
+    Constant,
+};