@apolitical/sdk 0.0.1 → 0.0.4-beta.2

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [0.0.1] - 2021-01-18
+## [0.0.4] - 2022-01-31
+### Fixed
+- Buffer dependency
+- Node.js version
+
+## [0.0.3] - 2022-01-12
+### Added
+- Exposed `reportError` function
+### Fixed
+- Resources naming (must be plural)
+
+## [0.0.2] - 2022-01-06
+### Added
+- First example function `ping`
+
+## [0.0.1] - 2022-01-05
 ### Added
 - Initial setup

package/README.md

@@ -6,7 +6,7 @@ Browser library to interact with Apolitical's APIs
 
 Requires the following to run:
 
-- [node.js][node] 12.20.1+
+- [node.js][node] 16.13.0+
 - [yarn][yarn]
 
 [node]: https://nodejs.org/en/download/
@@ -38,11 +38,22 @@ Publishes the library to NPM.
 
 ## Usage
 
-The recommended way to use `@apolitical/sdk` is to use the provided functionality:
+The recommended way to use `@apolitical/sdk` is to load the SDK first:
 
 ```js
-const { ping } = require('@apolitical/sdk');
+const loadSdk = require('@apolitical/sdk');
 
-const result = ping();
-console.log(result);
+const sdk = loadSdk({
+  origin: window.origin || window.location.origin,
+  gcpErrorsApiKey: process.env.REACT_APP_GCP_ERRORS_API_KEY,
+  serviceName: 'some-service',
+});
+```
+
+And then, you can use all the functionality provided by the SDK. For example:
+
+```js
+sdk.template.dummy.read().then((result) => {
+  console.info('SDK ping:', result);
+});
 ```

package/build/index.js

@@ -1 +1 @@
-!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t(require("axios")):"function"==typeof define&&define.amd?define(["axios"],t):"object"==typeof exports?exports.ApoliticalSDK=t(require("axios")):e.ApoliticalSDK=t(e.axios)}(this,(function(e){return function(){"use strict";var t={300:function(t){t.exports=e}},o={};function n(e){var r=o[e];if(void 0!==r)return r.exports;var u=o[e]={exports:{}};return t[e](u,u.exports,n),u.exports}n.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return n.d(t,{a:t}),t},n.d=function(e,t){for(var o in t)n.o(t,o)&&!n.o(e,o)&&Object.defineProperty(e,o,{enumerable:!0,get:t[o]})},n.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},n.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var r={};return function(){n.r(r),n.d(r,{default:function(){return a}});var e=n(300),t=n.n(e);const{APIS:{BACKEND_TEMPLATE:{BASE_URL:o,ENDPOINTS:{DUMMY:u}}}}={APIS:{BACKEND_TEMPLATE:{BASE_URL:"/api/backend-template",ENDPOINTS:{DUMMY:"/dummy"}}}};var a={template:{ping:async()=>{let e=null;try{e=await t().get(`${o}${u}`)}catch(e){(e=>{e.response?console.warn(e.response.data,e.response.status,e.response.headers):e.request?console.warn(e.request):console.warn(e.message)})(e)}return e}}}}(),r}()}));
+!function(e,r){"object"==typeof exports&&"object"==typeof module?module.exports=r(require("@apolitical/error-reporting"),require("axios"),require("http-status-codes")):"function"==typeof define&&define.amd?define(["@apolitical/error-reporting","axios","http-status-codes"],r):"object"==typeof exports?exports.ApoliticalSDK=r(require("@apolitical/error-reporting"),require("axios"),require("http-status-codes")):e.ApoliticalSDK=r(e["@apolitical/error-reporting"],e.axios,e["http-status-codes"])}(this,(function(e,r,t){return function(){"use strict";var o={30:function(r){r.exports=e},300:function(e){e.exports=r},25:function(e){e.exports=t}},n={};function a(e){var r=n[e];if(void 0!==r)return r.exports;var t=n[e]={exports:{}};return o[e](t,t.exports,a),t.exports}a.n=function(e){var r=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(r,{a:r}),r},a.d=function(e,r){for(var t in r)a.o(r,t)&&!a.o(e,t)&&Object.defineProperty(e,t,{enumerable:!0,get:r[t]})},a.o=function(e,r){return Object.prototype.hasOwnProperty.call(e,r)},a.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})};var i={};return function(){a.r(i),a.d(i,{default:function(){return E},reportError:function(){return e.reportError}});var e=a(30),r=a(300),t=a.n(r),o={APIS:{BACKEND_TEMPLATE:{BASE_URL:"/api/backend-template",ENDPOINTS:{DUMMY:"/dummy"}},PEOPLE_API:{BASE_URL:"/api/people-api",ENDPOINTS:{USERS:"/users"}}}},n=a(25);const s=async r=>{try{let t=!1,o="Error at Apolitical SDK: ";if(r.response){switch(r.response.status){case n.StatusCodes.NOT_FOUND:case n.StatusCodes.FORBIDDEN:t=!0}o+=JSON.stringify(r.response)}else r.request?o+=JSON.stringify(r.request):o+=r.message;if(console.warn(o),t)return;await(0,e.reportError)(new Error(o))}catch(e){console.warn(`Cannot handle error: ${e.message}`)}},{APIS:{PEOPLE_API:{BASE_URL:u,ENDPOINTS:{USERS:c}}}}=o;var p={users:{read:async e=>{let r=null;try{({data:r}=await t().get(`${u}${c}/${e}`))}catch(e){await s(e)}return r}}};const{APIS:{BACKEND_TEMPLATE:{BASE_URL:l,ENDPOINTS:{DUMMY:f}}}}=o;var d={people:p,template:{dummy:{read:async()=>{let e=null;try{({data:e}=await t().get(`${l}${f}`))}catch(e){await s(e)}return e}}}};function E({origin:r,gcpErrorsApiKey:t,serviceName:o}){return(0,e.setContext)({origin:r,accessToken:t,serviceName:o}),{...d,reportError:e.reportError}}}(),i}()}));

package/package.json

@@ -1,19 +1,13 @@
 {
   "name": "@apolitical/sdk",
-  "version": "0.0.1",
+  "version": "0.0.4-beta.2",
   "description": "Browser library to interact with Apolitical's APIs",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
-  "contributors": [
-    "Anouska Hopkins <anouska.hopkins@apolitical.co>",
-    "Antonio Cordasco <antonio.cordasco@apolitical.co>",
-    "Dorothy Yau <dorothy.yau@apolitical.co>",
-    "Laura Hanna-White <laura.hanna-white@apolitical.co>",
-    "Fatimat Gbajabiamila <fatimat.gbajabiamila@apolitical.co>",
-    "Renzo Rozza <renzo.rozza@apolitical.co>",
-    "Rihards Jukna <rihards.jukna@apolitical.co>"
-  ],
   "license": "MIT",
   "main": "build/index.js",
+  "files": [
+    "build/**"
+  ],
   "scripts": {
     "test": "jest --runInBand",
     "unit-test": "jest test/unit/* --bail --runInBand --passWithNoTests",
@@ -30,40 +24,36 @@
     "SDK"
   ],
   "dependencies": {
-    "axios": "0.24.0"
+    "@apolitical/error-reporting": "0.0.3-beta.2",
+    "axios": "0.25.0",
+    "http-status-codes": "2.2.0"
   },
   "peerDependencies": {
-    "axios": "0.24.0"
+    "@apolitical/error-reporting": "0.0.3-beta.2",
+    "axios": "0.25.0",
+    "http-status-codes": "2.2.0"
   },
   "devDependencies": {
-    "@apolitical/eslint-config": "0.0.1",
-    "@babel/core": "7.16.7",
-    "babel-eslint": "10.1.0",
-    "babel-loader": "8.2.3",
-    "babel-preset-react-app": "10.0.1",
+    "@apolitical/eslint-config": "1.0.2-beta.1",
+    "@babel/core": "7.16.12",
+    "@babel/eslint-parser": "7.16.5",
+    "@babel/plugin-transform-runtime": "7.16.10",
+    "@babel/preset-env": "7.16.11",
     "husky": "7.0.4",
     "jest": "27.4.7",
     "jest-junit": "13.0.0",
-    "lint-staged": "12.1.5",
-    "webpack": "5.65.0",
-    "webpack-cli": "4.9.1"
+    "lint-staged": "12.3.2",
+    "webpack": "5.67.0",
+    "webpack-cli": "4.9.2"
   },
   "eslintConfig": {
     "extends": [
-      "eslint:recommended",
-      "plugin:prettier/recommended",
-      "plugin:jest/recommended"
+      "@apolitical/eslint-config/base.config"
     ],
     "env": {
-      "browser": true,
-      "node": true,
-      "es6": true,
-      "jest": true
+      "browser": true
     },
-    "plugins": [
-      "jest"
-    ],
-    "parser": "babel-eslint"
+    "parser": "@babel/eslint-parser"
   },
   "prettier": "@apolitical/eslint-config/prettier.config",
   "browserslist": {
@@ -95,11 +85,18 @@
   },
   "babel": {
     "presets": [
-      "react-app"
-    ]
+      "@babel/preset-env"
+    ],
+    "env": {
+      "test": {
+        "plugins": [
+          "@babel/plugin-transform-runtime"
+        ]
+      }
+    }
   },
   "engines": {
-    "node": ">=12.20.1"
+    "node": ">=16.13.0"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix --ignore-path .gitignore",

package/.gitlab-ci.yml

@@ -1,25 +0,0 @@
-# External jobs
-include:
-  - project: 'apolitical/templates/gitlab-pipelines'
-    ref: master
-    file: 'Node-Testing.gitlab-ci.yml'
-
-stages:
-  - cache
-  - test
-  - publish
-
-# Publish jobs
-
-publish-module:
-  stage: publish
-  image: node:12.20.1-alpine3.11
-  extends: .yarn-install
-  only:
-    - tags
-    - /^v\d+\.\d+\.\d+$/
-  before_script:
-    - yarn build
-  script:
-    - echo '//registry.npmjs.org/:_authToken=${NPM_TOKEN}' > ~/.npmrc
-    - yarn publish --access=public

package/.husky/pre-commit

@@ -1,8 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-yarn lint-format 
-
-yarn build
-
-yarn test

package/lib/apis/template.js

@@ -1,27 +0,0 @@
-import axios from 'axios';
-
-import config from '../config';
-import { handleError } from '../helpers/errors';
-
-const {
-  APIS: {
-    BACKEND_TEMPLATE: {
-      BASE_URL,
-      ENDPOINTS: { DUMMY },
-    },
-  },
-} = config;
-
-/*
- * Returns a random number after calling the Backend Template
- * @return {Object} payload - random number generated by the API
- */
-export const ping = async () => {
-  let payload = null;
-  try {
-    payload = await axios.get(`${BASE_URL}${DUMMY}`);
-  } catch (error) {
-    handleError(error);
-  }
-  return payload;
-};

package/lib/config.js

@@ -1,12 +0,0 @@
-const config = {
-  APIS: {
-    BACKEND_TEMPLATE: {
-      BASE_URL: '/api/backend-template',
-      ENDPOINTS: {
-        DUMMY: '/dummy',
-      },
-    },
-  },
-};
-
-export default config;

package/lib/context.js

@@ -1,13 +0,0 @@
-// TODO: Define context when external configurations are required for the SDK to work
-
-// let context = {
-//   token: null,
-// };
-
-// export const setContext = ({ token }) => {
-//   context.token = token;
-// };
-
-// export const getContext = () => {
-//   return context;
-// };

package/lib/helpers/errors.js

@@ -1,12 +0,0 @@
-export const handleError = (error) => {
-  if (error.response) {
-    // The request was made and the server responded with a status code that falls out of the range of 2xx
-    console.warn(error.response.data, error.response.status, error.response.headers);
-  } else if (error.request) {
-    // The request was made but no response was received
-    console.warn(error.request);
-  } else {
-    // Something happened in setting up the request that triggered an error
-    console.warn(error.message);
-  }
-};

package/lib/index.js

@@ -1,9 +0,0 @@
-import { ping } from './apis/template';
-
-const sdk = {
-  template: {
-    ping,
-  },
-};
-
-export default sdk;

package/test/setupTests.js

@@ -1,4 +0,0 @@
-// Overrides console error & warn when testing
-// Importnat: Comment out this line to check errors when testing
-console.error = jest.fn();
-console.warn = jest.fn();

package/test/template.spec.js

@@ -1,27 +0,0 @@
-import axios from 'axios';
-
-import sdk from '../lib';
-
-const {
-  template: { ping },
-} = sdk;
-
-jest.mock('axios');
-
-describe('Apolitical SDK', () => {
-  describe('Backend Template', () => {
-    describe('Ping (Dummy)', () => {
-      test('should return a number', async () => {
-        axios.get.mockResolvedValueOnce({ result: 123 });
-        const { result } = await ping();
-        expect(result).toEqual(expect.any(Number));
-      });
-
-      test('should catch unexpected errors', async () => {
-        axios.get.mockRejectedValueOnce(new Error('Something went wrong'));
-        const result = await ping();
-        expect(result).toStrictEqual(null);
-      });
-    });
-  });
-});

package/webpack.config.js

@@ -1,28 +0,0 @@
-'use strict';
-
-const path = require('path');
-
-module.exports = {
-  mode: 'production',
-  entry: {
-    index: path.resolve(__dirname, 'lib', 'index.js'),
-  },
-  output: {
-    path: path.resolve(__dirname, 'build'),
-    filename: 'index.js',
-    library: {
-      name: 'ApoliticalSDK',
-      type: 'umd',
-    },
-    globalObject: 'this',
-  },
-  externals: {
-    axios: 'axios',
-  },
-  optimization: {
-    splitChunks: {
-      chunks: 'all',
-    },
-    minimize: true,
-  },
-};