@availity/api-core - npm Package Compare versions

Comparing version 1.0.0-alpha.17 to 1.0.0

package.json

 {
   "name": "@availity/api-core",
-  "version": "1.0.0-alpha.17",
+  "version": "1.0.0",
   "description": "Base API definitions for the Availity REST API",
@@ -20,3 +20,3 @@ "keywords": [
   "devDependencies": {
-    "@availity/localstorage-core": "^1.0.0-alpha.17"
+    "@availity/localstorage-core": "^1.0.0"
   },
@@ -23,0 +23,0 @@ "publishConfig": {

README.md

@@ -133,1 +133,5 @@ # api-core
 ```
+
+## AvMicroservice
+
+`AvMicroservice` extends `AvApi` and thus can call the same methods. It has slightly different `config` options used for some child apis.

src/api.js

@@ -15,3 +15,3 @@ import AvLocalStorage from '@availity/localstorage-core';
     this.merge = merge;
-    this.defaultConfig = this.merge({}, API_OPTIONS, config);
+    this.defaultConfig = this.merge({}, API_OPTIONS.API, config);
     this.localStorage = new AvLocalStorage();
@@ -18,0 +18,0 @@ }

src/index.js

 import AvApi from './api';
+import AvMicroservice from './ms';
 import AvLogMessages from './resources/logs';
@@ -14,2 +15,4 @@ import AvNavigation from './resources/navigation';
 import AvUserPermissions from './resources/userPermissions';
+import AvFiles from './resources/files';
+import AvSettings from './resources/settings';
 
@@ -19,2 +22,3 @@ export default AvApi;
 export {
+  AvMicroservice,
   AvLogMessages,
@@ -32,2 +36,4 @@ AvNavigation,
   AvUserPermissions,
+  AvFiles,
+  AvSettings,
 };

src/ms.js

@@ -1,9 +0,26 @@
-class AvMicroservice {
-  constructor(http, promise, config) {
-    if (!http || !config || !promise) {
-      throw new Error('[http], [promise] and [config] and must be defined');
+import AvApi from './api';
+import API_OPTIONS from './options';
+
+export default class AvMicroservice extends AvApi {
+  constructor({ http, promise, merge, config }) {
+    super({
+      http,
+      promise,
+      merge,
+      config,
+    });
+    this.defaultConfig = this.merge({}, API_OPTIONS.MS, config);
+  }
+
+  getUrl(config) {
+    const { path, name, id } = this.config(config);
+    let parts = [path, name];
+    if (id) {
+      parts = [path, name, id];
     }
+    return parts
+      .join('/')
+      .replace(/[/]+/g, '/')
+      .replace(/\/$/, '');
   }
 }
-
-export default AvMicroservice;

src/options.js

 const API_OPTIONS = {
-  // default base segment for Availity API endpoints
-  path: '/api',
+  API: {
+    // default base segment for Availity API endpoints
+    path: '/api',
 
-  // full url to api resource
-  url: null,
+    // full url to api resource
+    url: null,
 
-  // name of resource
-  name: null,
+    // name of resource
+    name: null,
 
-  // defaults version for api
-  version: '/v1',
+    // defaults version for api
+    version: '/v1',
 
-  // cache all request by default
-  cache: true,
+    // cache all request by default
+    cache: true,
 
-  // flag used to enable behaviors around the Availity Rest API
-  api: true,
+    // flag used to enable behaviors around the Availity Rest API
+    api: true,
 
-  polling: true, //  1s,  2s,  5s,  10s
+    polling: true, //  1s,  2s,  5s,  10s
 
-  pollingIntervals: [1e3, 2e3, 5e3, 1e4], // in ms
+    pollingIntervals: [1e3, 2e3, 5e3, 1e4], // in ms
 
-  // default headers
-  headers: {
-    // Turn off content encoding for angular apis
-    'X-Response-Encoding-Context': 'NONE',
+    // default headers
+    headers: {
+      // Turn off content encoding for angular apis
+      'X-Response-Encoding-Context': 'NONE',
+    },
+
+    sessionBust: true,
   },
+  MS: {
+    // default base segment for Availity API endpoints
+    path: '/ms/api/availity/internal',
 
-  sessionBust: true,
+    // full url to api resource
+    url: null,
+
+    // name of resource
+    name: null,
+
+    // defaults version for api
+    version: null,
+
+    // cache all request by default
+    cache: false,
+
+    // flag used to enable behaviors around the Availity Rest API
+    api: true,
+
+    polling: false, //  1s,  2s,  5s,  10s
+
+    pollingIntervals: [1e3, 2e3, 5e3, 1e4], // in ms
+
+    // default headers
+    headers: {
+      // Turn off content encoding for angular apis
+      'X-Response-Encoding-Context': 'NONE',
+    },
+
+    sessionBust: false,
+  },
 };
 
 export default API_OPTIONS;

src/resources/logs.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/navigation.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/notifications.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/organizations.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/pdfs.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/permissions.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/providers.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/proxy.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/README.md

@@ -16,2 +16,4 @@ # Availity API's
 * [AvProxy](#avproxy)
+* [AvFiles](#avfiles)
+* [AvSettings](#avsettings)
 
@@ -93,2 +95,15 @@ ## Intro
 
+### AvFiles
+Upload a file to a bucket in the vault
 
+#### Methods
+
+#### `uploadFile(data, config)`
+Method to upload a file. `data` contains FormData elements with a key of either `reference` (if pointed to an existing file) or `filedata` (if uploading a new file)
+`config` should contain `customerId` and `id` (the bucketId)
+
+
+### AvSettings
+Store and retrieve settings to be reused.
+Use `query(params)` with at least an `applicationId` and `userId` in the `params` object
+Use `update(data)` with at least an `applicationId` and `userId` in the `scope` object, and key/value pairs of data

src/resources/regions.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/spaces.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/tests/logs.test.js

@@ -0,0 +0,0 @@ import AvLogMessages from '../logs';

src/resources/tests/navigation.test.js

@@ -0,0 +0,0 @@ import AvNavigation from '../navigation';

src/resources/tests/notifications.test.js

@@ -0,0 +0,0 @@ import AvNotification from '../notifications';

src/resources/tests/organizations.test.js

@@ -0,0 +0,0 @@ import AvOrganizations from '../organizations';

src/resources/tests/pdfs.test.js

@@ -0,0 +0,0 @@ import AvPdfs from '../pdfs';

src/resources/tests/permissions.test.js

@@ -0,0 +0,0 @@ import AvPermissions from '../permissions';

src/resources/tests/providers.test.js

@@ -0,0 +0,0 @@ import AvProviders from '../providers';

src/resources/tests/proxy.test.js

@@ -0,0 +0,0 @@ import AvProxy from '../proxy';

src/resources/tests/regions.test.js

@@ -58,3 +58,3 @@ import AvRegions from '../regions';
 
-  test('getRegions should call avUsers.me() and then query with result', () => {
+  test('getRegions should call avUsers.me() and then query with result', async () => {
     api = new AvRegions({
@@ -75,8 +75,7 @@ http: mockHttp,
     Object.assign(expectedConfig.params, { userId: mockUser.id });
-    return api.getRegions(testConfig).then(() => {
-      expect(api.query).toHaveBeenLastCalledWith(expectedConfig);
-    });
+    await api.getRegions(testConfig);
+    expect(api.query).toHaveBeenLastCalledWith(expectedConfig);
   });
 
-  test('getRegions should handle undefined config param', () => {
+  test('getRegions should handle undefined config param', async () => {
     api = new AvRegions({
@@ -92,5 +91,4 @@ http: mockHttp,
     const expectedConfig = { params: { userId: mockUser.id } };
-    return api.getRegions().then(() => {
-      expect(api.query).toHaveBeenLastCalledWith(expectedConfig);
-    });
+    await api.getRegions();
+    expect(api.query).toHaveBeenLastCalledWith(expectedConfig);
   });
@@ -97,0 +95,0 @@

src/resources/tests/spaces.test.js

@@ -0,0 +0,0 @@ import AvSpaces from '../spaces';

src/resources/tests/user.test.js

@@ -0,0 +0,0 @@ import AvUsers from '../user';

src/resources/tests/userPermissions.test.js

@@ -0,0 +0,0 @@ import AvUserPermissions from '../userPermissions';

src/resources/user.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/resources/userPermissions.js

@@ -0,0 +0,0 @@ import AvApi from '../api';

src/tests/api.test.js

@@ -572,3 +572,5 @@ import AvApi from '../api';
           );
+          return true;
         });
+
       jest.runAllTimers();
@@ -592,20 +594,18 @@ return output;
 
-    test('should call http', () => {
+    test('should call http', async () => {
       const mockConfig = {
         testVal: 'test',
       };
-      return api.request(mockConfig).then(response => {
-        expect(response).toEqual(mockFinalResponse);
-        expect(mockHttp).toHaveBeenCalledWith(mockConfig);
-      });
+      const response = await api.request(mockConfig);
+      expect(response).toEqual(mockFinalResponse);
+      expect(mockHttp).toHaveBeenCalledWith(mockConfig);
     });
 
-    test('should catch error in http, returning undefined if no error.response', () => {
+    test('should catch error in http, returning undefined if no error.response', async () => {
       mockHttp.mockImplementationOnce(() => Promise.reject(new Error('err')));
-      return api.request({}).then(response => {
-        expect(response).toBeUndefined();
-      });
+      const response = await api.request({});
+      expect(response).toBeUndefined();
     });
 
-    test('should default attempt in polling is true', () => {
+    test('should default attempt in polling is true', async () => {
       const mockConfig = {
@@ -618,6 +618,6 @@ polling: true,
       };
-      return api.request(mockConfig).then(response => {
-        expect(mockHttp).toHaveBeenCalledWith(expectedConfig);
-        expect(response).toEqual(mockFinalResponse);
-      });
+
+      const response = await api.request(mockConfig);
+      expect(mockHttp).toHaveBeenCalledWith(expectedConfig);
+      expect(response).toEqual(mockFinalResponse);
     });
@@ -624,0 +624,0 @@ });

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

79740

increased by19.1%

Number of package files

37

increased by12.12%

Lines of code

2410

increased by16.03%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

137

increased by3.01%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes