@availity/hooks 6.0.0 → 6.0.1

package/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [6.0.1](https://github.com/Availity/availity-react/compare/@availity/hooks@6.0.0...@availity/hooks@6.0.1) (2026-06-16)
+
+
+
 # [6.0.0](https://github.com/Availity/availity-react/compare/@availity/hooks@5.2.0...@availity/hooks@6.0.0) (2026-06-12)
 
 

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { DependencyList, EffectCallback } from 'react';
 import { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
+import { User, ProvidersResponse as ProvidersResponse$1, PermissionsResponse as PermissionsResponse$1, Organization as Organization$1, OrganizationsResponse as OrganizationsResponse$1, AriesPaginatedResponse } from '@availity/api-axios';
 
 /**
  * @deprecated useEffectAsync is an anti-pattern. Use useEffect with an IIFE or extract async logic into a separate function instead.
@@ -18,180 +19,26 @@ interface CurrentRegion {
 }
 declare function useCurrentRegion(options?: Omit<UseQueryOptions<CurrentRegion, unknown>, 'queryKey' | 'queryFn'>): UseQueryResult<CurrentRegion, unknown>;
 
-interface CurrentUser {
-    akaname: string;
-    createDate: string;
-    currentRegion: string;
-    email: string;
-    firstName: string;
-    lastName: string;
-    id: string;
-    jobTitle: string;
-    userHasSecurityException: boolean;
-    userId: string;
-    userValidated: boolean;
-}
-declare function useCurrentUser(options?: Omit<UseQueryOptions<CurrentUser, unknown>, 'queryKey' | 'queryFn'>): UseQueryResult<CurrentUser, unknown>;
-
-interface AriesHookBase {
-    data: {
-        totalCount: number;
-        count: number;
-        offSet: number;
-        links: {
-            next: {
-                href: string;
-            };
-            last: {
-                href: string;
-            };
-            self: {
-                href: string;
-            };
-        };
-    };
-}
+/** @deprecated Use `User` from `@availity/api-axios` instead */
+type CurrentUser = User;
+declare function useCurrentUser(options?: Omit<UseQueryOptions<User, unknown>, 'queryKey' | 'queryFn'>): UseQueryResult<User, unknown>;
 
-interface ProvidersResponse extends AriesHookBase {
-    data: AriesHookBase['data'] & {
-        providers: {
-            id: string;
-            lastName: string;
-            firstName: string;
-            middleName: string;
-            uiDisplayName: string;
-            atypical: boolean;
-            npi: string;
-            customerIds: string[];
-            roles: {
-                code: string;
-                value: string;
-            }[];
-            primarySpecialty: {
-                code: string;
-                value: string;
-            };
-            primaryFax: {
-                internationalCellularCode: string;
-                areaCode: string;
-                phoneNumber: string;
-            };
-            primaryAddress: {
-                line1: string;
-                line2: string;
-                city: string;
-                state: string;
-                stateCode: string;
-                zip: {
-                    code: string;
-                    addon: string;
-                };
-            };
-        }[];
-    };
-}
+/** @deprecated Use `ProvidersResponse` from `@availity/api-axios` instead */
+type ProvidersResponse = ProvidersResponse$1;
 interface AvProvidersConfig {
     customerId: string;
     [key: string]: unknown;
 }
 declare function useProviders(config: AvProvidersConfig, options?: Omit<UseQueryOptions<ProvidersResponse, unknown>, 'queryKey' | 'queryFn'>): UseQueryResult<ProvidersResponse, unknown>;
 
-interface PermissionsResponse extends AriesHookBase {
-    data: AriesHookBase['data'] & {
-        permissions: {
-            id: string;
-            description: string;
-            links: {
-                self: {
-                    href: string;
-                };
-            };
-        }[];
-    };
-}
+/** @deprecated Use `PermissionsResponse` from `@availity/api-axios` instead */
+type PermissionsResponse = PermissionsResponse$1;
 declare function usePermissions(config: string | string[], options?: Omit<UseQueryOptions<PermissionsResponse, unknown>, 'queryKey' | 'queryFn'>): UseQueryResult<PermissionsResponse, unknown>;
 
-interface Organization {
-    links: {
-        permissions: {
-            href: string;
-        };
-        patients: {
-            href: string;
-        };
-        self: {
-            href: string;
-        };
-        admin: {
-            href: string;
-        };
-        businessArrangements: {
-            href: string;
-        };
-        users: {
-            href: string;
-        };
-    };
-    id: string;
-    customerId: string;
-    name: string;
-    status: string;
-    statusCode: string;
-    types: {
-        code: string;
-        value: string;
-    }[];
-    primaryControllingAuthority: {
-        lastName: string;
-        firstName: string;
-        primaryPhone: string;
-        email: string;
-    };
-    physicalAddress: {
-        line1: string;
-        city: string;
-        state: string;
-        stateCode: string;
-        zipCode: string;
-    };
-    mailingAddress: {
-        line1: string;
-        city: string;
-        state: string;
-        stateCode: string;
-        zipCode: string;
-    };
-    billingAddress: {
-        line1: string;
-        city: string;
-        state: string;
-        stateCode: string;
-        zipCode: string;
-    };
-    regions: {
-        code: string;
-        value: string;
-    }[];
-    npis: {
-        number: string;
-    }[];
-    taxIds: {
-        number: string;
-        type: string;
-    }[];
-    phoneNumber: {
-        areaCode: string;
-        exchange: string;
-        phoneNumber: string;
-    };
-    numberOfLicensedPhysicians: string;
-    numberOfLicensedClinicians: string;
-}
-interface OrganizationsResponse extends AriesHookBase {
-    data: AriesHookBase['data'] & {
-        organizations: Organization[];
-    };
-}
+/** @deprecated Use `Organization` from `@availity/api-axios` instead */
+type Organization = Organization$1;
+/** @deprecated Use `OrganizationsResponse` from `@availity/api-axios` instead */
+type OrganizationsResponse = OrganizationsResponse$1;
 declare function useOrganizations(config: Record<string, unknown>, options?: Omit<UseQueryOptions<OrganizationsResponse, unknown>, 'queryKey' | 'queryFn'>): UseQueryResult<OrganizationsResponse, unknown>;
 
 declare const useUpdateNav: () => void;
@@ -205,4 +52,7 @@ declare function useWindowDimensions(): Dimensions;
 type StashData = Record<string, unknown>;
 declare function useStash(sessionId: string, options?: Omit<UseQueryOptions<StashData, unknown>, 'queryKey' | 'queryFn'>): UseQueryResult<StashData, unknown>;
 
+/** @deprecated Use `AriesPaginatedResponse` from `@availity/api-axios` instead */
+type AriesHookBase = AriesPaginatedResponse;
+
 export { type AriesHookBase, type AvProvidersConfig, type CurrentRegion, type CurrentUser, type Dimensions, type Organization, type OrganizationsResponse, type PermissionsResponse, type ProvidersResponse, useCurrentRegion, useCurrentUser, useEffectAsync, useMount, useOrganizations, usePermissions, useProviders, useStash, useTimeout, useToggle, useUpdateNav, useWindowDimensions };

package/dist/index.js

@@ -86,7 +86,9 @@ function usePermissions(config, options) {
 
 // src/useOrganizations.ts
 import { useQuery as useQuery5 } from "@tanstack/react-query";
-import { avOrganizationsApi } from "@availity/api-axios";
+import {
+  avOrganizationsApi
+} from "@availity/api-axios";
 var fetchOrganization = async (config) => avOrganizationsApi.getOrganizations(config);
 function useOrganizations(config, options) {
   return useQuery5({ queryKey: ["organizations", config], queryFn: () => fetchOrganization(config), ...options });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@availity/hooks",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "A group of pre-built hooks that are common in most apps",
   "keywords": [
     "react",
@@ -27,8 +27,8 @@
     "clean": "rm -rf dist"
   },
   "devDependencies": {
-    "@availity/api-axios": "^13.0.2",
-    "@availity/message-core": "^9.0.2",
+    "@availity/api-axios": "^13.2.0",
+    "@availity/message-core": "^9.2.0",
     "@tanstack/react-query": "^5.75.5",
     "axios": "^1.17.0",
     "react": "^18.3.1",
@@ -47,13 +47,13 @@
   "publishConfig": {
     "access": "public"
   },
+  "main": "./dist/index.js",
   "exports": {
     ".": {
       "source": "./src/index.ts",
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
-    }
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
   }
 }

package/project.json

@@ -27,15 +27,12 @@
     "lint": {
       "executor": "@nx/eslint:lint",
       "options": {
-        "eslintConfig": ".eslintrc.yaml",
         "silent": false,
         "fix": false,
         "cache": true,
         "cacheLocation": "./node_modules/.cache/hooks/.eslintcache",
         "maxWarnings": -1,
         "quiet": false,
-        "noEslintrc": false,
-        "hasTypeAwareRules": true,
         "cacheStrategy": "metadata"
       }
     },

package/src/types.ts

@@ -1,12 +1,4 @@
-export interface AriesHookBase {
-  data: {
-    totalCount: number;
-    count: number;
-    offSet: number;
-    links: {
-      next: { href: string };
-      last: { href: string };
-      self: { href: string };
-    };
-  };
-}
+import { AriesPaginatedResponse } from '@availity/api-axios';
+
+/** @deprecated Use `AriesPaginatedResponse` from `@availity/api-axios` instead */
+export type AriesHookBase = AriesPaginatedResponse;

package/src/useCurrentRegion.ts

@@ -1,5 +1,5 @@
 import { useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
-import { avRegionsApi } from '@availity/api-axios';
+import { avRegionsApi, Region } from '@availity/api-axios';
 
 export interface CurrentRegion {
   code: string;
@@ -8,7 +8,7 @@ export interface CurrentRegion {
 
 async function fetchRegion(): Promise<CurrentRegion> {
   const response = await avRegionsApi.getCurrentRegion();
-  const data = response?.data as { regions?: { id?: string; value?: string }[] };
+  const data = response?.data as { regions?: Region[] };
 
   return {
     code: data?.regions?.[0]?.id || '',

package/src/useCurrentUser.ts

@@ -1,24 +1,13 @@
-import { avUserApi } from '@availity/api-axios';
+import { avUserApi, User } from '@availity/api-axios';
 import { useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 
-export interface CurrentUser {
-  akaname: string;
-  createDate: string;
-  currentRegion: string;
-  email: string;
-  firstName: string;
-  lastName: string;
-  id: string;
-  jobTitle: string;
-  userHasSecurityException: boolean;
-  userId: string;
-  userValidated: boolean;
-}
+/** @deprecated Use `User` from `@availity/api-axios` instead */
+export type CurrentUser = User;
 
-const fetchUser = async () => avUserApi.me() as unknown as CurrentUser;
+const fetchUser = async () => avUserApi.me() as unknown as User;
 
 export default function useCurrentUser(
-  options?: Omit<UseQueryOptions<CurrentUser, unknown>, 'queryKey' | 'queryFn'>
-): UseQueryResult<CurrentUser, unknown> {
+  options?: Omit<UseQueryOptions<User, unknown>, 'queryKey' | 'queryFn'>
+): UseQueryResult<User, unknown> {
   return useQuery({ queryKey: ['user'], queryFn: fetchUser, ...options });
 }

package/src/useOrganizations.ts

@@ -1,66 +1,15 @@
 import { useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
-import { avOrganizationsApi } from '@availity/api-axios';
-import { AriesHookBase } from './types';
+import {
+  avOrganizationsApi,
+  Organization as ApiOrganization,
+  OrganizationsResponse as ApiOrganizationsResponse,
+} from '@availity/api-axios';
 
-export interface Organization {
-  links: {
-    permissions: { href: string };
-    patients: { href: string };
-    self: { href: string };
-    admin: { href: string };
-    businessArrangements: { href: string };
-    users: { href: string };
-  };
-  id: string;
-  customerId: string;
-  name: string;
-  status: string;
-  statusCode: string;
-  types: { code: string; value: string }[];
-  primaryControllingAuthority: {
-    lastName: string;
-    firstName: string;
-    primaryPhone: string;
-    email: string;
-  };
-  physicalAddress: {
-    line1: string;
-    city: string;
-    state: string;
-    stateCode: string;
-    zipCode: string;
-  };
-  mailingAddress: {
-    line1: string;
-    city: string;
-    state: string;
-    stateCode: string;
-    zipCode: string;
-  };
-  billingAddress: {
-    line1: string;
-    city: string;
-    state: string;
-    stateCode: string;
-    zipCode: string;
-  };
-  regions: { code: string; value: string }[];
-  npis: { number: string }[];
-  taxIds: { number: string; type: string }[];
-  phoneNumber: {
-    areaCode: string;
-    exchange: string;
-    phoneNumber: string;
-  };
-  numberOfLicensedPhysicians: string;
-  numberOfLicensedClinicians: string;
-}
+/** @deprecated Use `Organization` from `@availity/api-axios` instead */
+export type Organization = ApiOrganization;
 
-export interface OrganizationsResponse extends AriesHookBase {
-  data: AriesHookBase['data'] & {
-    organizations: Organization[];
-  };
-}
+/** @deprecated Use `OrganizationsResponse` from `@availity/api-axios` instead */
+export type OrganizationsResponse = ApiOrganizationsResponse;
 
 const fetchOrganization = async (config: Record<string, unknown>) =>
   avOrganizationsApi.getOrganizations(config) as unknown as OrganizationsResponse;

package/src/usePermissions.ts

@@ -1,16 +1,8 @@
 import { useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
-import { avPermissionsApi } from '@availity/api-axios';
-import { AriesHookBase } from './types';
+import { avPermissionsApi, PermissionsResponse as ApiPermissionsResponse } from '@availity/api-axios';
 
-export interface PermissionsResponse extends AriesHookBase {
-  data: AriesHookBase['data'] & {
-    permissions: {
-      id: string;
-      description: string;
-      links: { self: { href: string } };
-    }[];
-  };
-}
+/** @deprecated Use `PermissionsResponse` from `@availity/api-axios` instead */
+export type PermissionsResponse = ApiPermissionsResponse;
 
 const fetchPermissions = async (config: string | string[]) =>
   avPermissionsApi.getPermissions(config) as unknown as PermissionsResponse;

package/src/useProviders.ts

@@ -1,36 +1,8 @@
 import { useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
-import { avProvidersApi } from '@availity/api-axios';
-import { AriesHookBase } from './types';
+import { avProvidersApi, ProvidersResponse as ApiProvidersResponse } from '@availity/api-axios';
 
-export interface ProvidersResponse extends AriesHookBase {
-  data: AriesHookBase['data'] & {
-    providers: {
-      id: string;
-      lastName: string;
-      firstName: string;
-      middleName: string;
-      uiDisplayName: string;
-      atypical: boolean;
-      npi: string;
-      customerIds: string[];
-      roles: { code: string; value: string }[];
-      primarySpecialty: { code: string; value: string };
-      primaryFax: {
-        internationalCellularCode: string;
-        areaCode: string;
-        phoneNumber: string;
-      };
-      primaryAddress: {
-        line1: string;
-        line2: string;
-        city: string;
-        state: string;
-        stateCode: string;
-        zip: { code: string; addon: string };
-      };
-    }[];
-  };
-}
+/** @deprecated Use `ProvidersResponse` from `@availity/api-axios` instead */
+export type ProvidersResponse = ApiProvidersResponse;
 
 export interface AvProvidersConfig {
   customerId: string;

package/tests/useCurrentRegion.test.tsx

@@ -0,0 +1,49 @@
+import React from 'react';
+import { waitFor, cleanup } from '@testing-library/react';
+import { QueryClient } from '@tanstack/react-query';
+import { http, HttpResponse } from 'msw';
+import { server } from '@availity/mock/src/server';
+import { REGIONS } from '@availity/mock/src/routes';
+import { useCurrentRegion } from '../src/index';
+import renderWithClient from './util';
+
+const queryClient = new QueryClient();
+
+afterEach(() => {
+  cleanup();
+  queryClient.clear();
+});
+
+const Component = () => {
+  const { data, error, status } = useCurrentRegion({ gcTime: 0, retry: false });
+
+  return (
+    <div>
+      <h1>Status: {status}</h1>
+      <h1>Data: {JSON.stringify(data)}</h1>
+      <h1>Error: {error?.message}</h1>
+    </div>
+  );
+};
+
+describe('useCurrentRegion', () => {
+  test('handle error', async () => {
+    server.use(http.get(REGIONS, () => HttpResponse.error()));
+
+    const { getByText } = renderWithClient(queryClient, <Component />);
+
+    getByText('Status: pending');
+    await waitFor(() => {
+      expect(getByText('Status: error')).toBeDefined();
+    });
+  });
+
+  test('handle success', async () => {
+    const { getByText } = renderWithClient(queryClient, <Component />);
+
+    getByText('Status: pending');
+    await waitFor(() => {
+      expect(getByText(`Data: ${JSON.stringify({ code: 'FL', value: 'Florida' })}`)).toBeDefined();
+    });
+  });
+});

package/tests/useCurrentUser.test.tsx

@@ -0,0 +1,52 @@
+import React from 'react';
+import { waitFor, cleanup } from '@testing-library/react';
+import { QueryClient } from '@tanstack/react-query';
+import { http, HttpResponse } from 'msw';
+import { server } from '@availity/mock/src/server';
+import { USER_A2 } from '@availity/mock/src/routes';
+import { useCurrentUser } from '../src/index';
+import renderWithClient from './util';
+
+const queryClient = new QueryClient();
+
+afterEach(() => {
+  cleanup();
+  queryClient.clear();
+});
+
+const Component = () => {
+  const { data, error, status } = useCurrentUser({ gcTime: 0, retry: false });
+
+  return (
+    <div>
+      <h1>Status: {status}</h1>
+      <h1>Data: {JSON.stringify(data)}</h1>
+      <h1>Error: {error?.message}</h1>
+    </div>
+  );
+};
+
+describe('useCurrentUser', () => {
+  test('should set error on rejected promise', async () => {
+    server.use(http.get(USER_A2, () => HttpResponse.error()));
+
+    const { getByText } = renderWithClient(queryClient, <Component />);
+
+    getByText('Status: pending');
+    await waitFor(() => {
+      expect(getByText('Status: error')).toBeDefined();
+    });
+  });
+
+  test('should return user', async () => {
+    const { getByText } = renderWithClient(queryClient, <Component />);
+
+    getByText('Status: pending');
+    await waitFor(() => {
+      expect(getByText(/aka123456789/)).toBeDefined();
+    });
+    await waitFor(() => {
+      expect(getByText(/Sanchez/)).toBeDefined();
+    });
+  });
+});

package/tests/{useEffectAsync.test.jsx → useEffectAsync.test.tsx}

@@ -4,8 +4,7 @@ import { useEffectAsync } from '../src/index';
 
 afterEach(cleanup);
 
-// eslint-disable-next-line react/prop-types
-const Component = ({ asyncFunc }) => {
+const Component = ({ asyncFunc }: { asyncFunc: () => Promise<string> }) => {
   const [state, setState] = useState('Hello');
 
   useEffectAsync(async () => {
@@ -20,17 +19,12 @@ 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.jsx → useMount.test.tsx}

@@ -4,9 +4,8 @@ import { useMount } from '../src/index';
 
 afterEach(cleanup);
 
-// eslint-disable-next-line react/prop-types
 const Component = () => {
-  const [state, setState] = useState();
+  const [state, setState] = useState<string | undefined>();
 
   useMount(() => {
     setState('test');

package/tests/useOrganizations.test.tsx

@@ -0,0 +1,49 @@
+import React from 'react';
+import { waitFor, cleanup } from '@testing-library/react';
+import { QueryClient } from '@tanstack/react-query';
+import { http, HttpResponse } from 'msw';
+import { server } from '@availity/mock/src/server';
+import { USER_A2 } from '@availity/mock/src/routes';
+import renderWithClient from './util';
+import { useOrganizations } from '../src/index';
+
+const queryClient = new QueryClient();
+
+afterEach(() => {
+  cleanup();
+  queryClient.clear();
+});
+
+const Component = () => {
+  const { data, error, status } = useOrganizations({}, { gcTime: 0, retry: false });
+
+  return (
+    <div>
+      <h1>Status: {status}</h1>
+      <h1>Data: {JSON.stringify(data?.data)}</h1>
+      <h1>Error: {error?.message}</h1>
+    </div>
+  );
+};
+
+describe('useOrganizations', () => {
+  test('should return an error', async () => {
+    server.use(http.get(USER_A2, () => HttpResponse.error()));
+
+    const { getByText } = renderWithClient(queryClient, <Component />);
+
+    getByText('Status: pending');
+    await waitFor(() => {
+      expect(getByText('Status: error')).toBeDefined();
+    });
+  });
+
+  test('should return organizations', async () => {
+    const { getByText } = renderWithClient(queryClient, <Component />);
+
+    getByText('Status: pending');
+    await waitFor(() => {
+      expect(getByText(/Techmania/)).toBeDefined();
+    });
+  });
+});