@apolitical/sdk 0.0.1-beta.3 → 0.0.1-beta.7

package/CHANGELOG.md

@@ -5,6 +5,11 @@ 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.2] - 2022-01-06
+### Added
+- First example function `ping`
+
+## [0.0.1] - 2022-01-05
 ### Added
 - Initial setup

package/build/index.js

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

package/package.json

@@ -1,10 +1,22 @@
 {
   "name": "@apolitical/sdk",
-  "version": "0.0.1-beta.3",
+  "version": "0.0.1-beta.7",
   "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",
@@ -22,11 +34,13 @@
   ],
   "dependencies": {
     "@apolitical/error-reporting": "0.0.1",
-    "axios": "0.24.0"
+    "axios": "0.24.0",
+    "http-status-codes": "2.2.0"
   },
   "peerDependencies": {
     "@apolitical/error-reporting": "0.0.1",
-    "axios": "0.24.0"
+    "axios": "0.24.0",
+    "http-status-codes": "2.2.0"
   },
   "devDependencies": {
     "@apolitical/eslint-config": "0.0.1",

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 '../errors';
-
-const {
-  APIS: {
-    BACKEND_TEMPLATE: {
-      BASE_URL,
-      ENDPOINTS: { DUMMY },
-    },
-  },
-} = config;
-
-/*
- * Returns a random number after calling the Backend Template
- * @return {Object} data - JSON object returned by the API
- */
-export const ping = async () => {
-  let data = null;
-  try {
-    ({ data } = await axios.get(`${BASE_URL}${DUMMY}`));
-  } catch (error) {
-    handleError(error);
-  }
-  return data;
-};

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,10 +0,0 @@
-import { setContext as setErrorContext } from '@apolitical/error-reporting';
-
-export const setContext = ({ origin, gcpErrorsApiKey, serviceName }) => {
-  // Setup error reporting context
-  setErrorContext({
-    origin,
-    accessToken: gcpErrorsApiKey,
-    serviceName,
-  });
-};

package/lib/errors.js

@@ -1,23 +0,0 @@
-import { reportError } from '@apolitical/error-reporting';
-
-export const handleError = async (error) => {
-  let errorMessage = 'Error at Apolitical SDK: ';
-  if (error.response) {
-    // The request was made and the server responded with a status code that falls out of the range of 2xx
-    errorMessage += JSON.stringify(error.response);
-  } else if (error.request) {
-    // The request was made but no response was received
-    errorMessage += JSON.stringify(error.request);
-  } else {
-    // Something happened in setting up the request that triggered an error
-    errorMessage += error.message;
-  }
-  // Log the error (on the client browser)
-  console.warn(errorMessage);
-  // Report the error (to GCP) but prevent exceptions
-  try {
-    await reportError(new Error(errorMessage));
-  } catch (error2) {
-    console.warn(`Cannot report error: ${error2.message}`);
-  }
-};

package/lib/index.js

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

package/test/__snapshots__/context.spec.js.snap

@@ -1,11 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`Apolitical SDK Context Set Context should set error reporting context 1`] = `
-Array [
-  Object {
-    "accessToken": "some-gcp-errors-api-key",
-    "origin": "some-origin",
-    "serviceName": "some-service-name",
-  },
-]
-`;

package/test/context.spec.js

@@ -1,27 +0,0 @@
-import { setContext as setErrorContext } from '@apolitical/error-reporting';
-
-import sdk from '../lib';
-
-describe('Apolitical SDK', () => {
-  describe('Context', () => {
-    const { setContext } = sdk;
-
-    describe('Set Context', () => {
-      const options = {
-        origin: 'some-origin',
-        gcpErrorsApiKey: 'some-gcp-errors-api-key',
-        serviceName: 'some-service-name',
-      };
-
-      beforeEach(() => {
-        setErrorContext.mockReturnValue();
-      });
-
-      test('should set error reporting context', () => {
-        setContext(options);
-        expect(setErrorContext).toHaveBeenCalledTimes(1);
-        expect(setErrorContext.mock.calls[0]).toMatchSnapshot();
-      });
-    });
-  });
-});

package/test/errors.spec.js

@@ -1,39 +0,0 @@
-import { reportError } from '@apolitical/error-reporting';
-
-import { handleError } from '../lib/errors';
-
-describe('Apolitical SDK', () => {
-  describe('Errors', () => {
-    describe('Handle Error', () => {
-      beforeEach(() => {
-        reportError.mockResolvedValue();
-      });
-
-      test('should log response error', async () => {
-        await handleError({ response: { data: 'some response' } });
-        expect(console.warn.mock.calls[0][0]).toEqual('Error at Apolitical SDK: {"data":"some response"}');
-      });
-
-      test('should log request error', async () => {
-        await handleError({ request: { data: 'some request' } });
-        expect(console.warn.mock.calls[0][0]).toEqual('Error at Apolitical SDK: {"data":"some request"}');
-      });
-
-      test('should log message error', async () => {
-        await handleError({ message: 'some message' });
-        expect(console.warn.mock.calls[0][0]).toEqual('Error at Apolitical SDK: some message');
-      });
-
-      test('should report error', async () => {
-        await handleError({ message: 'some message' });
-        expect(reportError).toHaveBeenCalledTimes(1);
-      });
-
-      test('should catch errors when reporting', async () => {
-        reportError.mockRejectedValueOnce(new Error('something went wrong'));
-        await handleError({ message: 'some message' });
-        expect(console.warn.mock.calls[1][0]).toEqual('Cannot report error: something went wrong');
-      });
-    });
-  });
-});

package/test/setupTests.js

@@ -1,13 +0,0 @@
-// Mock dependencies
-jest.mock('axios');
-jest.mock('@apolitical/error-reporting', () => {
-  return {
-    reportError: jest.fn(),
-    setContext: jest.fn(),
-  };
-});
-
-// Overrides console error & warn when testing
-// NB: Comment out this line to check errors when testing
-console.error = jest.fn();
-console.warn = jest.fn();

package/test/template.spec.js

@@ -1,33 +0,0 @@
-import axios from 'axios';
-import { reportError } from '@apolitical/error-reporting';
-
-import sdk from '../lib';
-
-describe('Apolitical SDK', () => {
-  describe('Backend Template', () => {
-    const {
-      template: { ping },
-    } = sdk;
-
-    describe('Ping (Dummy Endpoint)', () => {
-      const payload = { data: { result: 123 } };
-
-      beforeEach(() => {
-        reportError.mockResolvedValue();
-        axios.get.mockResolvedValue(payload);
-      });
-
-      test('should return a number', async () => {
-        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);
-        expect(reportError).toHaveBeenCalledTimes(1);
-      });
-    });
-  });
-});

package/webpack.config.js

@@ -1,29 +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',
-    '@apolitical/error-reporting': '@apolitical/error-reporting',
-  },
-  optimization: {
-    splitChunks: {
-      chunks: 'all',
-    },
-    minimize: true,
-  },
-};