@availity/hooks 3.0.0 → 3.0.4

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.4](https://github.com/Availity/availity-react/compare/@availity/hooks@3.0.3...@availity/hooks@3.0.4) (2021-10-01)
+
+**Note:** Version bump only for package @availity/hooks
+
+
+
+
+
+## 3.0.3 (2021-09-28)
+
+**Note:** Version bump only for package @availity/hooks
+
+
+
+
+
+## 3.0.2 (2021-06-01)
+
+**Note:** Version bump only for package @availity/hooks
+
+
+
+
+
+## 3.0.1 (2021-01-06)
+
+
+### Bug Fixes
+
+* **hooks:** remove effect from dependency array in useMount ([a096fa4](https://github.com/Availity/availity-react/commit/a096fa45af7aaa40a09c87254aef0de864fa8ab6))
+
+
+
+
+
 # 3.0.0 (2020-12-23)
 
 

package/index.d.ts

@@ -1,9 +1,9 @@
-export { default as useEffectAsync } from './typings/useEffectAsync';
-export { default as useMount } from './typings/useMount';
-export { default as useTimeout } from './typings/useTimeout';
-export { default as useToggle } from './typings/useToggle';
-export { default as useCurrentRegion } from './typings/useCurrentRegion';
-export { default as useCurrentUser } from './typings/useCurrentUser';
-export { default as useProviders } from './typings/useProviders';
-export { default as usePermissions } from './typings/usePermissions';
-export { default as useOrganizations } from './typings/useOrganizations';
+export { default as useEffectAsync } from './types/useEffectAsync';
+export { default as useMount } from './types/useMount';
+export { default as useTimeout } from './types/useTimeout';
+export { default as useToggle } from './types/useToggle';
+export { default as useCurrentRegion } from './types/useCurrentRegion';
+export { default as useCurrentUser } from './types/useCurrentUser';
+export { default as useProviders } from './types/useProviders';
+export { default as usePermissions } from './types/usePermissions';
+export { default as useOrganizations } from './types/useOrganizations';

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@availity/hooks",
-  "version": "3.0.0",
+  "version": "3.0.4",
   "author": "Kyle Gray <kyle.gray@availity.com>",
   "description": "A group of pre-built hooks that are common in most apps",
   "main": "index.js",
+  "types": "index.d.ts",
   "keywords": [
     "react",
     "availity"
@@ -20,23 +21,19 @@
     "access": "public"
   },
   "dependencies": {
-    "prop-types": "^15.5.8",
+    "prop-types": "^15.7.2",
     "react-query": "^3.0.0"
   },
   "devDependencies": {
-    "@availity/api-axios": "^5.4.0",
-    "@availity/api-core": "^6.1.3",
-    "@availity/localstorage-core": "^3.0.0",
-    "axios": "^0.21.0",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "@availity/api-axios": "^6.0.0",
+    "axios": "^0.21.1",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
   },
   "peerDependencies": {
-    "@availity/api-axios": "^5.2.1",
-    "@availity/api-core": "^5.2.1",
-    "@availity/localstorage-core": "^2.6.1",
-    "axios": "^0.16.0 || ^0.17.0 || ^0.18.0 || ^0.19.0",
+    "@availity/api-axios": "^6.0.0",
+    "axios": "^0.21.1",
     "react": ">=16.8.0"
   },
-  "gitHead": "3a62c771a0799997a903da334971c31a4172072b"
+  "gitHead": "cf142eeb3780dfdc5a3b0130e09c4bb6ea0edf07"
 }

package/src/useMount.js

@@ -1,5 +1,6 @@
 import { useEffect } from 'react';
 
-export default (effect) => {
+export default function useMount(effect) {
+  // eslint-disable-next-line react-hooks/exhaustive-deps
   useEffect(effect, []);
-};
+}

package/src/useOrganizations.js

@@ -1,13 +1,8 @@
 import { useQuery } from 'react-query';
 import { avOrganizationsApi } from '@availity/api-axios';
 
-const fetchOrganization = async (config) =>
-  avOrganizationsApi.getOrganizations(config);
+const fetchOrganization = async (config) => avOrganizationsApi.getOrganizations(config);
 
 export default function useOrganization(config, options) {
-  return useQuery(
-    ['organizations', config],
-    () => fetchOrganization(config),
-    options
-  );
+  return useQuery(['organizations', config], () => fetchOrganization(config), options);
 }

package/src/usePermissions.js

@@ -1,13 +1,8 @@
 import { useQuery } from 'react-query';
 import { avPermissionsApi } from '@availity/api-axios';
 
-const fetchPermissions = async (config) =>
-  avPermissionsApi.getPermissions(config);
+const fetchPermissions = async (config) => avPermissionsApi.getPermissions(config);
 
 export default function usePermissions(config, options) {
-  return useQuery(
-    ['permissions', config],
-    () => fetchPermissions(config),
-    options
-  );
+  return useQuery(['permissions', config], () => fetchPermissions(config), options);
 }

package/src/useProviders.js

@@ -1,8 +1,7 @@
 import { useQuery } from 'react-query';
 import { avProvidersApi } from '@availity/api-axios';
 
-const fetchProviders = async (config) =>
-  avProvidersApi.getProviders(config.customerId, config);
+const fetchProviders = async (config) => avProvidersApi.getProviders(config.customerId, config);
 
 export default function useProviders(config, options) {
   return useQuery(['providers', config], () => fetchProviders(config), options);

package/src/useTimeout.js

@@ -1,6 +1,6 @@
 import { useEffect, useState } from 'react';
 
-export default (ms = 0) => {
+export default function useTimeout(ms = 0) {
   const [ready, setReady] = useState(false);
 
   useEffect(() => {
@@ -18,4 +18,4 @@ export default (ms = 0) => {
   }, [ms]);
 
   return ready;
-};
+}

package/src/useToggle.js

@@ -1,6 +1,6 @@
 import { useState } from 'react';
 
-export default function (initialState = false) {
+export default function useToggle(initialState = false) {
   const [state, setState] = useState(initialState);
   const toggle = (newState) => {
     if (newState !== undefined && newState !== state) {

package/tests/useCurrentRegion.test.js

@@ -1,102 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { waitFor, cleanup } from '@testing-library/react';
-import { avRegionsApi } from '@availity/api-axios';
-import { QueryClient } from 'react-query';
-import { useCurrentRegion } from '..';
-import renderWithClient from './util';
-
-jest.mock('@availity/api-axios');
-
-let queryStates = [];
-beforeEach(() => {
-  queryStates = [];
-});
-
-const queryClient = new QueryClient();
-
-afterEach(() => {
-  jest.clearAllMocks();
-  cleanup();
-  queryClient.clear();
-  queryStates = [];
-});
-
-const pushState = (state) => {
-  queryStates.push(state);
-};
-
-const Component = ({ log }) => {
-  // Mirror testing methods from react-query instead of relying on timing or booleans
-  // https://github.com/tannerlinsley/react-query/blob/master/src/react/tests/useQuery.test.tsx
-  const state = useCurrentRegion({ cacheTime: 0, retry: false });
-
-  // not directly used in assertions here, but useful for debugging purposes
-  if (log) log(state);
-
-  const { data, error, status } = state;
-
-  return (
-    <div>
-      <h1>Status: {status}</h1>
-      <h1>Data: {JSON.stringify(data)}</h1>
-      <h1>Error: {error}</h1>
-    </div>
-  );
-};
-
-Component.propTypes = {
-  log: PropTypes.func,
-};
-
-describe('useCurrentRegion', () => {
-  test('handle error', async () => {
-    avRegionsApi.getCurrentRegion.mockRejectedValueOnce('An error occurred');
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText('Status: error');
-      expect(el).toBeDefined();
-    });
-    await waitFor(() => {
-      const el = getByText('Error: An error occurred');
-      expect(el).toBeDefined();
-    });
-  });
-
-  test('handle success', async () => {
-    avRegionsApi.getCurrentRegion.mockResolvedValueOnce({
-      config: { polling: false },
-      data: {
-        regions: [
-          {
-            id: 'FL',
-            value: 'Florida',
-          },
-        ],
-      },
-      status: 200,
-      statusText: 'Ok',
-    });
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText(
-        `Data: ${JSON.stringify({
-          code: 'FL',
-          value: 'Florida',
-        })}`
-      );
-      expect(el).toBeDefined();
-    });
-  });
-});

package/tests/useCurrentUser.test.js

@@ -1,100 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { waitFor, cleanup } from '@testing-library/react';
-import { avUserApi } from '@availity/api-axios';
-import { QueryClient } from 'react-query';
-import { useCurrentUser } from '..';
-import renderWithClient from './util';
-
-jest.mock('@availity/api-axios');
-
-let queryStates = [];
-beforeEach(() => {
-  queryStates = [];
-});
-
-const queryClient = new QueryClient();
-
-afterEach(() => {
-  jest.clearAllMocks();
-  cleanup();
-  queryClient.clear();
-  queryStates = [];
-});
-
-const pushState = (state) => {
-  queryStates.push(state);
-};
-
-const Component = ({ log }) => {
-  // Mirror testing methods from react-query instead of relying on timing or booleans
-  // https://github.com/tannerlinsley/react-query/blob/master/src/react/tests/useQuery.test.tsx
-  const state = useCurrentUser({ cacheTime: 0, retry: false });
-
-  // not directly used in assertions here, but useful for debugging purposes
-  if (log) log(state);
-
-  const { data, error, status } = state;
-
-  return (
-    <div>
-      <h1>Status: {status}</h1>
-      <h1>Data: {JSON.stringify(data)}</h1>
-      <h1>Error: {error}</h1>
-    </div>
-  );
-};
-
-Component.propTypes = {
-  log: PropTypes.func,
-};
-
-describe('useCurrentUser', () => {
-  test('should set error on rejected promise', async () => {
-    avUserApi.me.mockRejectedValueOnce('An error occurred');
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText('Status: error');
-      expect(el).toBeDefined();
-    });
-    await waitFor(() => {
-      const el = getByText('Error: An error occurred');
-      expect(el).toBeDefined();
-    });
-  });
-
-  test('should return user', async () => {
-    avUserApi.me.mockResolvedValueOnce({
-      id: 'aka12345',
-      userId: 'testExample',
-      akaname: 'aka12345',
-      lastName: 'Last',
-      firstName: 'First',
-    });
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText(
-        `Data: ${JSON.stringify({
-          id: 'aka12345',
-          userId: 'testExample',
-          akaname: 'aka12345',
-          lastName: 'Last',
-          firstName: 'First',
-        })}`
-      );
-      expect(el).toBeDefined();
-    });
-  });
-});

package/tests/useEffectAsync.test.js

@@ -1,36 +0,0 @@
-import React, { useState } from 'react';
-import { render, waitFor, act, cleanup } from '@testing-library/react';
-import { useEffectAsync } from '..';
-
-afterEach(cleanup);
-
-// eslint-disable-next-line react/prop-types
-const Component = ({ asyncFunc }) => {
-  const [state, setState] = useState('Hello');
-
-  useEffectAsync(async () => {
-    const newState = await asyncFunc();
-
-    act(() => setState(newState));
-  }, []);
-
-  return <div data-testid="effect-test">{state}</div>;
-};
-const asyncFunc = () => Promise.resolve('World');
-
-describe('useEffectAsync', () => {
-  test('should render "Hello" then "World"', async () => {
-    // Create Async Method
-    // Render
-    const { getByTestId } = render(<Component asyncFunc={asyncFunc} />);
-
-    // Expect the component to render "Hello"
-    expect(getByTestId('effect-test').textContent).toEqual('Hello');
-
-    // Wait for the Async Function to be called after mounting
-    await waitFor(() => getByTestId('effect-test'));
-
-    // Expect the component to render "World"
-    expect(getByTestId('effect-test').textContent).toEqual('World');
-  });
-});

package/tests/useMount.test.js

@@ -1,24 +0,0 @@
-import React, { useState } from 'react';
-import { render, cleanup } from '@testing-library/react';
-import { useMount } from '..';
-
-afterEach(cleanup);
-
-// eslint-disable-next-line react/prop-types
-const Component = () => {
-  const [state, setState] = useState();
-
-  useMount(() => {
-    setState('test');
-  });
-
-  return <p data-testid="mount-test">{state}</p>;
-};
-
-describe('useMount', () => {
-  test('should render "test"', () => {
-    const { getByTestId } = render(<Component />);
-
-    expect(getByTestId('mount-test').textContent).toEqual('test');
-  });
-});

package/tests/useOrganizations.test.js

@@ -1,120 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { waitFor, cleanup } from '@testing-library/react';
-import { avOrganizationsApi } from '@availity/api-axios';
-import { QueryClient } from 'react-query';
-import renderWithClient from './util';
-import { useOrganizations } from '..';
-
-jest.mock('@availity/api-axios');
-
-let queryStates = [];
-beforeEach(() => {
-  queryStates = [];
-});
-
-const queryClient = new QueryClient();
-
-afterEach(() => {
-  jest.clearAllMocks();
-  cleanup();
-  queryClient.clear();
-  queryStates = [];
-});
-
-const pushState = (state) => {
-  queryStates.push(state);
-};
-
-const Component = ({ log }) => {
-  // Mirror testing methods from react-query instead of relying on timing or booleans
-  // https://github.com/tannerlinsley/react-query/blob/master/src/react/tests/useQuery.test.tsx
-  const state = useOrganizations({}, { cacheTime: 0, retry: false });
-
-  // not directly used in assertions here, but useful for debugging purposes
-  if (log) log(state);
-
-  const { data, error, status } = state;
-
-  return (
-    <div>
-      <h1>Status: {status}</h1>
-      <h1>Data: {JSON.stringify(data)}</h1>
-      <h1>Error: {error}</h1>
-    </div>
-  );
-};
-
-Component.propTypes = {
-  log: PropTypes.func,
-};
-
-describe('useOrganizations', () => {
-  test('should return an error', async () => {
-    avOrganizationsApi.getOrganizations.mockRejectedValueOnce(
-      'An error occurred'
-    );
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText('Status: error');
-      expect(el).toBeDefined();
-    });
-    await waitFor(() => {
-      const el = getByText('Error: An error occurred');
-      expect(el).toBeDefined();
-    });
-  });
-
-  test('should return organizations', async () => {
-    avOrganizationsApi.getOrganizations.mockResolvedValueOnce({
-      data: {
-        organizations: [
-          {
-            links: {
-              permissions: { href: 'test' },
-              patients: { href: 'test' },
-              self: { href: 'test' },
-              admin: { href: 'test' },
-              businessArrangements: { href: 'test' },
-              users: { href: 'test' },
-            },
-          },
-        ],
-      },
-    });
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText(
-        `Data: ${JSON.stringify({
-          data: {
-            organizations: [
-              {
-                links: {
-                  permissions: { href: 'test' },
-                  patients: { href: 'test' },
-                  self: { href: 'test' },
-                  admin: { href: 'test' },
-                  businessArrangements: { href: 'test' },
-                  users: { href: 'test' },
-                },
-              },
-            ],
-          },
-        })}`
-      );
-      expect(el).toBeDefined();
-    });
-  });
-});

package/tests/usePermissions.test.js

@@ -1,96 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { waitFor, cleanup } from '@testing-library/react';
-import { avPermissionsApi } from '@availity/api-axios';
-import { QueryClient } from 'react-query';
-import renderWithClient from './util';
-import { usePermissions } from '..';
-
-jest.mock('@availity/api-axios');
-
-let queryStates = [];
-beforeEach(() => {
-  queryStates = [];
-});
-
-const queryClient = new QueryClient();
-
-afterEach(() => {
-  jest.clearAllMocks();
-  cleanup();
-  queryClient.clear();
-  queryStates = [];
-});
-
-const pushState = (state) => {
-  queryStates.push(state);
-};
-
-const Component = ({ log }) => {
-  // Mirror testing methods from react-query instead of relying on timing or booleans
-  // https://github.com/tannerlinsley/react-query/blob/master/src/react/tests/useQuery.test.tsx
-  const state = usePermissions({}, { cacheTime: 0, retry: false });
-
-  // not directly used in assertions here, but useful for debugging purposes
-  if (log) log(state);
-
-  const { data, error, status } = state;
-
-  return (
-    <div>
-      <h1>Status: {status}</h1>
-      <h1>Data: {JSON.stringify(data)}</h1>
-      <h1>Error: {error}</h1>
-    </div>
-  );
-};
-
-Component.propTypes = {
-  log: PropTypes.func,
-};
-
-describe('usePermissions', () => {
-  test('should return an error', async () => {
-    avPermissionsApi.getPermissions.mockRejectedValueOnce('An error occurred');
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText('Status: error');
-      expect(el).toBeDefined();
-    });
-    await waitFor(() => {
-      const el = getByText('Error: An error occurred');
-      expect(el).toBeDefined();
-    });
-  });
-
-  test('should return permissions', async () => {
-    avPermissionsApi.getPermissions.mockResolvedValueOnce({
-      id: '44',
-      description: 'test',
-      links: { self: { href: 'test.com' } },
-    });
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText(
-        `Data: ${JSON.stringify({
-          id: '44',
-          description: 'test',
-          links: { self: { href: 'test.com' } },
-        })}`
-      );
-      expect(el).toBeDefined();
-    });
-  });
-});

package/tests/useProviders.test.js

@@ -1,112 +0,0 @@
-import React from 'react';
-import PropTypes from 'prop-types';
-import { waitFor, cleanup } from '@testing-library/react';
-import { avProvidersApi } from '@availity/api-axios';
-import { QueryClient } from 'react-query';
-import renderWithClient from './util';
-import { useProviders } from '..';
-
-jest.mock('@availity/api-axios');
-
-let queryStates = [];
-beforeEach(() => {
-  queryStates = [];
-});
-
-const queryClient = new QueryClient();
-
-afterEach(() => {
-  jest.clearAllMocks();
-  cleanup();
-  queryClient.clear();
-  queryStates = [];
-});
-
-const pushState = (state) => {
-  queryStates.push(state);
-};
-
-const Component = ({ log }) => {
-  // Mirror testing methods from react-query instead of relying on timing or booleans
-  // https://github.com/tannerlinsley/react-query/blob/master/src/react/tests/useQuery.test.tsx
-  const state = useProviders({}, { cacheTime: 0, retry: false });
-
-  // not directly used in assertions here, but useful for debugging purposes
-  if (log) log(state);
-
-  const { data, error, status } = state;
-
-  return (
-    <div>
-      <h1>Status: {status}</h1>
-      <h1>Data: {JSON.stringify(data)}</h1>
-      <h1>Error: {error}</h1>
-    </div>
-  );
-};
-
-Component.propTypes = {
-  log: PropTypes.func,
-};
-
-describe('useProviders', () => {
-  test('should return an error', async () => {
-    avProvidersApi.getProviders.mockRejectedValueOnce('An error occurred');
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText('Status: error');
-      expect(el).toBeDefined();
-    });
-    await waitFor(() => {
-      const el = getByText('Error: An error occurred');
-      expect(el).toBeDefined();
-    });
-  });
-
-  test('should return providers', async () => {
-    avProvidersApi.getProviders.mockResolvedValueOnce({
-      data: {
-        providers: [
-          {
-            id: 'test',
-            lastName: 'test',
-            firstName: 'test',
-            middleName: 'test',
-            uiDisplayName: 'test',
-          },
-        ],
-      },
-    });
-
-    const { getByText } = renderWithClient(
-      queryClient,
-      <Component log={pushState} />
-    );
-
-    getByText('Status: loading');
-    await waitFor(() => {
-      const el = getByText(
-        `Data: ${JSON.stringify({
-          data: {
-            providers: [
-              {
-                id: 'test',
-                lastName: 'test',
-                firstName: 'test',
-                middleName: 'test',
-                uiDisplayName: 'test',
-              },
-            ],
-          },
-        })}`
-      );
-      expect(el).toBeDefined();
-    });
-  });
-});

package/tests/useTimeout.test.js

@@ -1,28 +0,0 @@
-import React from 'react';
-import { render, cleanup, waitFor } from '@testing-library/react';
-import { useTimeout } from '..';
-
-afterEach(cleanup);
-
-// eslint-disable-next-line react/prop-types
-const Component = () => {
-  const timeout = useTimeout(1000);
-
-  return <p data-testid="timeout-test">{timeout ? 'True' : 'False'}</p>;
-};
-
-describe('useTimeout', () => {
-  test('should render "False"', () => {
-    const { getByTestId } = render(<Component />);
-
-    expect(getByTestId('timeout-test').textContent).toEqual('False');
-  });
-
-  test('should render "True"', async () => {
-    const { getByTestId } = render(<Component />);
-
-    await waitFor(() => {
-      expect(getByTestId('timeout-test').textContent).toEqual('True');
-    });
-  });
-});

package/tests/useToggle.test.js

@@ -1,42 +0,0 @@
-import React from 'react';
-import { render, fireEvent, cleanup } from '@testing-library/react';
-import { useToggle } from '..';
-
-afterEach(cleanup);
-
-// eslint-disable-next-line react/prop-types
-const Component = ({ initialToggle = false }) => {
-  const [isToggled, toggle] = useToggle(initialToggle);
-
-  return (
-    <button type="button" data-testid="toggle-test" onClick={toggle}>
-      {isToggled ? 'Hello' : 'World'}
-    </button>
-  );
-};
-
-describe('useToggle', () => {
-  test('should render "Hello"', () => {
-    const { getByTestId } = render(<Component />);
-
-    expect(getByTestId('toggle-test').textContent).toEqual('World');
-  });
-
-  test('should render "World"', () => {
-    const { getByTestId } = render(<Component initialToggle />);
-
-    expect(getByTestId('toggle-test').textContent).toEqual('Hello');
-  });
-
-  test('should toggle the state when clicked', () => {
-    const { getByTestId } = render(<Component />);
-
-    const button = getByTestId('toggle-test');
-
-    expect(button.textContent).toEqual('World');
-
-    fireEvent.click(button);
-
-    expect(getByTestId('toggle-test').textContent).toEqual('Hello');
-  });
-});