fix(shared): Return api errors from organization hooks (#2743)

* fix(shared): Return api errors from organization hooks * fix(shared): Update changeset to minor
clerk · Feb 8, 2024 · 8daf845 · 8daf845
1 parent 37b4159
commit 8daf845
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 1 deletion.
diff --git a/.changeset/sixty-lions-obey.md b/.changeset/sixty-lions-obey.md
@@ -0,0 +1,5 @@
+---
+'@clerk/shared': minor
+---
+
+Add `error` for each paginated property return by `useOrganization` and `useOrganizationList` hooks.
diff --git a/packages/shared/src/react/hooks/useOrganization.tsx b/packages/shared/src/react/hooks/useOrganization.tsx
@@ -73,6 +73,7 @@ type UseOrganization = <T extends UseOrganizationParams>(
 const undefinedPaginatedResource = {
   data: undefined,
   count: undefined,
+  error: undefined,
   isLoading: false,
   isFetching: false,
   isError: false,

diff --git a/packages/shared/src/react/hooks/useOrganizationList.tsx b/packages/shared/src/react/hooks/useOrganizationList.tsx
@@ -24,6 +24,7 @@ type UseOrganizationListParams = {
 const undefinedPaginatedResource = {
   data: undefined,
   count: undefined,
+  error: undefined,
   isLoading: false,
   isFetching: false,
   isError: false,

diff --git a/packages/shared/src/react/hooks/usePagesOrInfinite.ts b/packages/shared/src/react/hooks/usePagesOrInfinite.ts
@@ -174,7 +174,8 @@ export const usePagesOrInfinite: UsePagesOrInfinite = (params, fetcher, config,
 
   const isLoading = triggerInfinite ? swrInfiniteIsLoading : swrIsLoading;
   const isFetching = triggerInfinite ? swrInfiniteIsValidating : swrIsValidating;
-  const isError = !!(triggerInfinite ? swrInfiniteError : swrError);
+  const error = (triggerInfinite ? swrInfiniteError : swrError) ?? null;
+  const isError = !!error;
   /**
    * Helpers
    */
@@ -207,6 +208,7 @@ export const usePagesOrInfinite: UsePagesOrInfinite = (params, fetcher, config,
   return {
     data,
     count,
+    error,
     isLoading,
     isFetching,
     isError,

diff --git a/packages/shared/src/react/types.ts b/packages/shared/src/react/types.ts
@@ -1,5 +1,7 @@
 import type { ClerkPaginatedResponse } from '@clerk/types';
 
+import type { ClerkAPIResponseError } from '../error';
+
 export type ValueOrSetter<T = unknown> = (size: T | ((_size: T) => T)) => void;
 
 export type CacheSetter<CData = any> = (
@@ -9,6 +11,7 @@ export type CacheSetter<CData = any> = (
 export type PaginatedResources<T = unknown, Infinite = false> = {
   data: T[];
   count: number;
+  error: ClerkAPIResponseError | null;
   isLoading: boolean;
   isFetching: boolean;
   isError: boolean;