@clerk/shared - npm Package Compare versions

Comparing version 0.22.0-snapshot.0b0cc93 to 0.22.0-snapshot.12da27f

dist/cjs/hooks/useOrganization.js

@@ -34,6 +34,19 @@ "use strict";
 module.exports = __toCommonJS(useOrganization_exports);
-var import_react = require("react");
 var import_swr = __toESM(require("swr"));
-var import_infinite = __toESM(require("swr/infinite"));
 var import_contexts = require("./contexts");
+var import_usePagesOrInfinite = require("./usePagesOrInfinite");
+const undefinedPaginatedResource = {
+  data: void 0,
+  count: void 0,
+  isLoading: false,
+  isFetching: false,
+  isError: false,
+  page: void 0,
+  pageCount: void 0,
+  fetchPage: void 0,
+  fetchNext: void 0,
+  fetchPrevious: void 0,
+  hasNextPage: false,
+  hasPreviousPage: false
+};
 const useOrganization = (params) => {
@@ -43,95 +56,63 @@ const {
     membershipList: membershipListParams,
-    domains: domainListParams
+    domains: domainListParams,
+    membershipRequests: membershipRequestsListParams
   } = params || {};
   const { organization, lastOrganizationMember, lastOrganizationInvitation } = (0, import_contexts.useOrganizationContext)();
   const session = (0, import_contexts.useSessionContext)();
-  const shouldUseDefaults = typeof domainListParams === "boolean" && domainListParams;
-  const [paginatedPage, setPaginatedPage] = (0, import_react.useState)(shouldUseDefaults ? 1 : domainListParams?.initialPage ?? 1);
-  const initialPageRef = (0, import_react.useRef)(shouldUseDefaults ? 1 : domainListParams?.initialPage ?? 1);
-  const initialPageSizeRef = (0, import_react.useRef)(shouldUseDefaults ? 10 : domainListParams?.initialPageSize ?? 10);
-  const triggerInfinite = shouldUseDefaults ? false : !!domainListParams?.infinite;
-  const internalKeepPreviousData = shouldUseDefaults ? false : !!domainListParams?.keepPreviousData;
+  const domainSafeValues = (0, import_usePagesOrInfinite.useWithSafeValues)(domainListParams, {
+    initialPage: 1,
+    pageSize: 10,
+    keepPreviousData: false,
+    infinite: false,
+    enrollmentMode: void 0
+  });
+  const membershipRequestSafeValues = (0, import_usePagesOrInfinite.useWithSafeValues)(membershipRequestsListParams, {
+    initialPage: 1,
+    pageSize: 10,
+    status: "pending",
+    keepPreviousData: false,
+    infinite: false
+  });
   const clerk = (0, import_contexts.useClerkInstanceContext)();
   const shouldFetch = !!(clerk.loaded && session && organization);
-  const paginatedParams = typeof domainListParams === "undefined" ? void 0 : {
-    initialPage: paginatedPage,
-    initialPageSize: initialPageSizeRef.current
+  const domainParams = typeof domainListParams === "undefined" ? void 0 : {
+    initialPage: domainSafeValues.initialPage,
+    pageSize: domainSafeValues.pageSize,
+    enrollmentMode: domainSafeValues.enrollmentMode
   };
-  const fetchInvitations = !clerk.loaded ? () => ({ data: [], total_count: 0 }) : () => organization?.getDomains(paginatedParams);
-  const {
-    data: userInvitationsData,
-    isValidating: userInvitationsValidating,
-    isLoading: userInvitationsLoading,
-    error: userInvitationsError,
-    mutate: userInvitationsMutate
-  } = (0, import_swr.default)(
-    !triggerInfinite && shouldFetch && paginatedParams ? cacheKeyDomains("domains", organization, paginatedParams) : null,
-    fetchInvitations,
-    { keepPreviousData: internalKeepPreviousData }
-  );
-  const getInfiniteKey = (pageIndex, previousPageData) => {
-    if (!shouldFetch || !paginatedParams || !triggerInfinite) {
-      return null;
-    }
-    return cacheKeyDomains("domains", organization, {
-      initialPage: initialPageRef.current + pageIndex,
-      initialPageSize: initialPageSizeRef.current
-    });
+  const membershipRequestParams = typeof membershipRequestsListParams === "undefined" ? void 0 : {
+    initialPage: membershipRequestSafeValues.initialPage,
+    pageSize: membershipRequestSafeValues.pageSize,
+    status: membershipRequestSafeValues.status
   };
-  const {
-    data: userInvitationsDataInfinite,
-    isLoading: userInvitationsLoadingInfinite,
-    isValidating: userInvitationsInfiniteValidating,
-    error: userInvitationsInfiniteError,
-    size,
-    setSize,
-    mutate: userInvitationsInfiniteMutate
-  } = (0, import_infinite.default)(getInfiniteKey, ({ initialPage, initialPageSize }) => {
-    return !clerk.loaded || !organization ? { data: [], total_count: 0 } : organization.getDomains({
-      initialPage,
-      initialPageSize
-    });
-  });
-  const isomorphicPage = (0, import_react.useMemo)(() => {
-    if (triggerInfinite) {
-      return size;
+  const domains = (0, import_usePagesOrInfinite.usePagesOrInfinite)(
+    {
+      ...domainParams
+    },
+    organization?.getDomains,
+    {
+      keepPreviousData: domainSafeValues.keepPreviousData,
+      infinite: domainSafeValues.infinite,
+      enabled: !!domainParams
+    },
+    {
+      type: "domains",
+      organizationId: organization?.id
     }
-    return paginatedPage;
-  }, [triggerInfinite, size, paginatedPage]);
-  const isomorphicSetPage = (0, import_react.useCallback)(
-    (numberOrgFn) => {
-      if (triggerInfinite) {
-        void setSize(numberOrgFn);
-        return;
-      }
-      return setPaginatedPage(numberOrgFn);
+  );
+  const membershipRequests = (0, import_usePagesOrInfinite.usePagesOrInfinite)(
+    {
+      ...membershipRequestParams
     },
-    [setSize]
+    organization?.getMembershipRequests,
+    {
+      keepPreviousData: membershipRequestSafeValues.keepPreviousData,
+      infinite: membershipRequestSafeValues.infinite,
+      enabled: !!membershipRequestParams
+    },
+    {
+      type: "membershipRequests",
+      organizationId: organization?.id
+    }
   );
-  const isomorphicData = (0, import_react.useMemo)(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.map((a) => a?.data).flat() ?? [];
-    }
-    return userInvitationsData?.data ?? [];
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicCount = (0, import_react.useMemo)(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.[userInvitationsDataInfinite?.length - 1]?.total_count || 0;
-    }
-    return userInvitationsData?.total_count ?? 0;
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicIsLoading = triggerInfinite ? userInvitationsLoadingInfinite : userInvitationsLoading;
-  const isomorphicIsFetching = triggerInfinite ? userInvitationsInfiniteValidating : userInvitationsValidating;
-  const isomorphicIsError = !!(triggerInfinite ? userInvitationsInfiniteError : userInvitationsError);
-  const fetchNext = (0, import_react.useCallback)(() => {
-    isomorphicSetPage((n) => n + 1);
-  }, [isomorphicSetPage]);
-  const fetchPrevious = (0, import_react.useCallback)(() => {
-    isomorphicSetPage((n) => n - 1);
-  }, [isomorphicSetPage]);
-  const offsetCount = (initialPageRef.current - 1) * initialPageSizeRef.current;
-  const pageCount = Math.ceil((isomorphicCount - offsetCount) / initialPageSizeRef.current);
-  const hasNextPage = isomorphicCount - offsetCount * initialPageSizeRef.current > isomorphicPage * initialPageSizeRef.current;
-  const hasPreviousPage = (isomorphicPage - 1) * initialPageSizeRef.current > offsetCount * initialPageSizeRef.current;
-  const unstable__mutate = triggerInfinite ? userInvitationsInfiniteMutate : userInvitationsMutate;
   const pendingInvitations = !clerk.loaded ? () => [] : () => clerk.organization?.getPendingInvitations(invitationListParams);
@@ -162,16 +143,4 @@ const currentOrganizationMemberships = !clerk.loaded ? () => [] : () => clerk.organization?.getMemberships(membershipListParams);
       membership: void 0,
-      domains: {
-        data: void 0,
-        count: void 0,
-        isLoading: false,
-        isFetching: false,
-        isError: false,
-        page: void 0,
-        pageCount: void 0,
-        fetchPage: void 0,
-        fetchNext: void 0,
-        fetchPrevious: void 0,
-        hasNextPage: false,
-        hasPreviousPage: false
-      }
+      domains: undefinedPaginatedResource,
+      membershipRequests: undefinedPaginatedResource
     };
@@ -186,3 +155,4 @@ }
       membership: null,
-      domains: null
+      domains: null,
+      membershipRequests: null
     };
@@ -197,16 +167,4 @@ }
       membership: void 0,
-      domains: {
-        data: void 0,
-        count: void 0,
-        isLoading: false,
-        isFetching: false,
-        isError: false,
-        page: void 0,
-        pageCount: void 0,
-        fetchPage: void 0,
-        fetchNext: void 0,
-        fetchPrevious: void 0,
-        hasNextPage: false,
-        hasPreviousPage: false
-      }
+      domains: undefinedPaginatedResource,
+      membershipRequests: undefinedPaginatedResource
     };
@@ -225,17 +183,4 @@ }
     },
-    domains: {
-      data: isomorphicData,
-      count: isomorphicCount,
-      isLoading: isomorphicIsLoading,
-      isFetching: isomorphicIsFetching,
-      isError: isomorphicIsError,
-      page: isomorphicPage,
-      pageCount,
-      fetchPage: isomorphicSetPage,
-      fetchNext,
-      fetchPrevious,
-      hasNextPage,
-      hasPreviousPage,
-      unstable__mutate
-    }
+    domains,
+    membershipRequests
   };
@@ -251,10 +196,2 @@ };
 }
-function cacheKeyDomains(type, organization, pagination) {
-  return {
-    type,
-    organizationId: organization.id,
-    initialPage: pagination.initialPage,
-    initialPageSize: pagination.initialPageSize
-  };
-}
 // Annotate the CommonJS export names for ESM import in node:
@@ -261,0 +198,0 @@ 0 && (module.exports = {

dist/cjs/hooks/useOrganizationList.js

 "use strict";
-var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
@@ -20,10 +18,2 @@ var __export = (target, all) => {
 };
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
@@ -35,103 +25,90 @@ var useOrganizationList_exports = {};
 module.exports = __toCommonJS(useOrganizationList_exports);
-var import_react = require("react");
-var import_swr = __toESM(require("swr"));
-var import_infinite = __toESM(require("swr/infinite"));
 var import_contexts = require("./contexts");
+var import_usePagesOrInfinite = require("./usePagesOrInfinite");
 const useOrganizationList = (params) => {
-  const { userInvitations } = params || {};
-  const shouldUseDefaults = typeof userInvitations === "boolean" && userInvitations;
-  const [paginatedPage, setPaginatedPage] = (0, import_react.useState)(shouldUseDefaults ? 1 : userInvitations?.initialPage ?? 1);
-  const initialPageRef = (0, import_react.useRef)(shouldUseDefaults ? 1 : userInvitations?.initialPage ?? 1);
-  const initialPageSizeRef = (0, import_react.useRef)(shouldUseDefaults ? 10 : userInvitations?.initialPageSize ?? 10);
-  const triggerInfinite = shouldUseDefaults ? false : !!userInvitations?.infinite;
-  const internalKeepPreviousData = shouldUseDefaults ? false : !!userInvitations?.keepPreviousData;
-  const internalStatus = shouldUseDefaults ? "pending" : userInvitations?.status ?? "pending";
+  const { userMemberships, userInvitations, userSuggestions } = params || {};
+  const userMembershipsSafeValues = (0, import_usePagesOrInfinite.useWithSafeValues)(userMemberships, {
+    initialPage: 1,
+    pageSize: 10,
+    keepPreviousData: false,
+    infinite: false
+  });
+  const userInvitationsSafeValues = (0, import_usePagesOrInfinite.useWithSafeValues)(userInvitations, {
+    initialPage: 1,
+    pageSize: 10,
+    status: "pending",
+    keepPreviousData: false,
+    infinite: false
+  });
+  const userSuggestionsSafeValues = (0, import_usePagesOrInfinite.useWithSafeValues)(userSuggestions, {
+    initialPage: 1,
+    pageSize: 10,
+    status: "pending",
+    keepPreviousData: false,
+    infinite: false
+  });
   const clerk = (0, import_contexts.useClerkInstanceContext)();
   const user = (0, import_contexts.useUserContext)();
-  const paginatedParams = typeof userInvitations === "undefined" ? void 0 : {
-    initialPage: paginatedPage,
-    initialPageSize: initialPageSizeRef.current,
-    status: internalStatus
+  const userMembershipsParams = typeof userMemberships === "undefined" ? void 0 : {
+    initialPage: userMembershipsSafeValues.initialPage,
+    pageSize: userMembershipsSafeValues.pageSize
   };
-  const canFetch = !!(clerk.loaded && user);
-  const fetchInvitations = !clerk.loaded ? () => ({ data: [], total_count: 0 }) : () => user?.getOrganizationInvitations(paginatedParams);
-  const {
-    data: userInvitationsData,
-    isValidating: userInvitationsValidating,
-    isLoading: userInvitationsLoading,
-    error: userInvitationsError,
-    mutate: userInvitationsMutate
-  } = (0, import_swr.default)(
-    !triggerInfinite && canFetch && paginatedParams ? cacheKey("userInvitations", user, paginatedParams) : null,
-    fetchInvitations,
-    { keepPreviousData: internalKeepPreviousData }
-  );
-  const getInfiniteKey = (pageIndex, previousPageData) => {
-    if (!canFetch || !paginatedParams || !triggerInfinite) {
-      return null;
-    }
-    return cacheKey("userInvitations", user, {
-      initialPage: initialPageRef.current + pageIndex,
-      initialPageSize: initialPageSizeRef.current,
-      status: internalStatus
-    });
+  const userInvitationsParams = typeof userInvitations === "undefined" ? void 0 : {
+    initialPage: userInvitationsSafeValues.initialPage,
+    pageSize: userInvitationsSafeValues.pageSize,
+    status: userInvitationsSafeValues.status
   };
-  const {
-    data: userInvitationsDataInfinite,
-    isLoading: userInvitationsLoadingInfinite,
-    isValidating: userInvitationsInfiniteValidating,
-    error: userInvitationsInfiniteError,
-    size,
-    setSize,
-    mutate: userInvitationsInfiniteMutate
-  } = (0, import_infinite.default)(getInfiniteKey, ({ initialPage, initialPageSize, status }) => {
-    return !clerk.loaded || !user ? { data: [], total_count: 0 } : user.getOrganizationInvitations({
-      initialPage,
-      initialPageSize,
-      status
-    });
-  });
-  const isomorphicPage = (0, import_react.useMemo)(() => {
-    if (triggerInfinite) {
-      return size;
+  const userSuggestionsParams = typeof userSuggestions === "undefined" ? void 0 : {
+    initialPage: userSuggestionsSafeValues.initialPage,
+    pageSize: userSuggestionsSafeValues.pageSize,
+    status: userSuggestionsSafeValues.status
+  };
+  const isClerkLoaded = !!(clerk.loaded && user);
+  const memberships = (0, import_usePagesOrInfinite.usePagesOrInfinite)(
+    {
+      ...userMembershipsParams,
+      paginated: true
+    },
+    user?.getOrganizationMemberships,
+    {
+      keepPreviousData: userMembershipsSafeValues.keepPreviousData,
+      infinite: userMembershipsSafeValues.infinite,
+      enabled: !!userMembershipsParams
+    },
+    {
+      type: "userMemberships",
+      userId: user?.id
     }
-    return paginatedPage;
-  }, [triggerInfinite, size, paginatedPage]);
-  const isomorphicSetPage = (0, import_react.useCallback)(
-    (numberOrgFn) => {
-      if (triggerInfinite) {
-        void setSize(numberOrgFn);
-        return;
-      }
-      return setPaginatedPage(numberOrgFn);
+  );
+  const invitations = (0, import_usePagesOrInfinite.usePagesOrInfinite)(
+    {
+      ...userInvitationsParams
     },
-    [setSize]
+    user?.getOrganizationInvitations,
+    {
+      keepPreviousData: userInvitationsSafeValues.keepPreviousData,
+      infinite: userInvitationsSafeValues.infinite,
+      enabled: !!userInvitationsParams
+    },
+    {
+      type: "userInvitations",
+      userId: user?.id
+    }
   );
-  const isomorphicData = (0, import_react.useMemo)(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.map((a) => a?.data).flat() ?? [];
+  const suggestions = (0, import_usePagesOrInfinite.usePagesOrInfinite)(
+    {
+      ...userSuggestionsParams
+    },
+    user?.getOrganizationSuggestions,
+    {
+      keepPreviousData: userSuggestionsSafeValues.keepPreviousData,
+      infinite: userSuggestionsSafeValues.infinite,
+      enabled: !!userSuggestionsParams
+    },
+    {
+      type: "userSuggestions",
+      userId: user?.id
     }
-    return userInvitationsData?.data ?? [];
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicCount = (0, import_react.useMemo)(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.[userInvitationsDataInfinite?.length - 1]?.total_count || 0;
-    }
-    return userInvitationsData?.total_count ?? 0;
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicIsLoading = triggerInfinite ? userInvitationsLoadingInfinite : userInvitationsLoading;
-  const isomorphicIsFetching = triggerInfinite ? userInvitationsInfiniteValidating : userInvitationsValidating;
-  const isomorphicIsError = !!(triggerInfinite ? userInvitationsInfiniteError : userInvitationsError);
-  const fetchNext = (0, import_react.useCallback)(() => {
-    isomorphicSetPage((n) => n + 1);
-  }, [isomorphicSetPage]);
-  const fetchPrevious = (0, import_react.useCallback)(() => {
-    isomorphicSetPage((n) => n - 1);
-  }, [isomorphicSetPage]);
-  const offsetCount = (initialPageRef.current - 1) * initialPageSizeRef.current;
-  const pageCount = Math.ceil((isomorphicCount - offsetCount) / initialPageSizeRef.current);
-  const hasNextPage = isomorphicCount - offsetCount * initialPageSizeRef.current > isomorphicPage * initialPageSizeRef.current;
-  const hasPreviousPage = (isomorphicPage - 1) * initialPageSizeRef.current > offsetCount * initialPageSizeRef.current;
-  const unstable__mutate = triggerInfinite ? userInvitationsInfiniteMutate : userInvitationsMutate;
-  if (!clerk.loaded || !user) {
+  );
+  if (!isClerkLoaded) {
     return {
@@ -142,2 +119,17 @@ isLoaded: false,
       setActive: void 0,
+      userMemberships: {
+        data: void 0,
+        count: void 0,
+        isLoading: false,
+        isFetching: false,
+        isError: false,
+        page: void 0,
+        pageCount: void 0,
+        fetchPage: void 0,
+        fetchNext: void 0,
+        fetchPrevious: void 0,
+        hasNextPage: false,
+        hasPreviousPage: false,
+        unstable__mutate: void 0
+      },
       userInvitations: {
@@ -157,2 +149,17 @@ data: void 0,
         unstable__mutate: void 0
+      },
+      userSuggestions: {
+        data: void 0,
+        count: void 0,
+        isLoading: false,
+        isFetching: false,
+        isError: false,
+        page: void 0,
+        pageCount: void 0,
+        fetchPage: void 0,
+        fetchNext: void 0,
+        fetchPrevious: void 0,
+        hasNextPage: false,
+        hasPreviousPage: false,
+        unstable__mutate: void 0
       }
@@ -162,21 +169,9 @@ };
   return {
-    isLoaded: canFetch,
+    isLoaded: isClerkLoaded,
     organizationList: createOrganizationList(user.organizationMemberships),
     setActive: clerk.setActive,
     createOrganization: clerk.createOrganization,
-    userInvitations: {
-      data: isomorphicData,
-      count: isomorphicCount,
-      isLoading: isomorphicIsLoading,
-      isFetching: isomorphicIsFetching,
-      isError: isomorphicIsError,
-      page: isomorphicPage,
-      pageCount,
-      fetchPage: isomorphicSetPage,
-      fetchNext,
-      fetchPrevious,
-      hasNextPage,
-      hasPreviousPage,
-      unstable__mutate
-    }
+    userMemberships: memberships,
+    userInvitations: invitations,
+    userSuggestions: suggestions
   };
@@ -190,11 +185,2 @@ };
 }
-function cacheKey(type, user, pagination) {
-  return {
-    type,
-    userId: user.id,
-    initialPage: pagination.initialPage,
-    initialPageSize: pagination.initialPageSize,
-    status: pagination.status
-  };
-}
 // Annotate the CommonJS export names for ESM import in node:
@@ -201,0 +187,0 @@ 0 && (module.exports = {

dist/esm/hooks/useOrganization.js

@@ -1,5 +0,18 @@
-import { useCallback, useMemo, useRef, useState } from "react";
 import useSWR from "swr";
-import useSWRInfinite from "swr/infinite";
 import { useClerkInstanceContext, useOrganizationContext, useSessionContext } from "./contexts";
+import { usePagesOrInfinite, useWithSafeValues } from "./usePagesOrInfinite";
+const undefinedPaginatedResource = {
+  data: void 0,
+  count: void 0,
+  isLoading: false,
+  isFetching: false,
+  isError: false,
+  page: void 0,
+  pageCount: void 0,
+  fetchPage: void 0,
+  fetchNext: void 0,
+  fetchPrevious: void 0,
+  hasNextPage: false,
+  hasPreviousPage: false
+};
 const useOrganization = (params) => {
@@ -9,95 +22,63 @@ const {
     membershipList: membershipListParams,
-    domains: domainListParams
+    domains: domainListParams,
+    membershipRequests: membershipRequestsListParams
   } = params || {};
   const { organization, lastOrganizationMember, lastOrganizationInvitation } = useOrganizationContext();
   const session = useSessionContext();
-  const shouldUseDefaults = typeof domainListParams === "boolean" && domainListParams;
-  const [paginatedPage, setPaginatedPage] = useState(shouldUseDefaults ? 1 : domainListParams?.initialPage ?? 1);
-  const initialPageRef = useRef(shouldUseDefaults ? 1 : domainListParams?.initialPage ?? 1);
-  const initialPageSizeRef = useRef(shouldUseDefaults ? 10 : domainListParams?.initialPageSize ?? 10);
-  const triggerInfinite = shouldUseDefaults ? false : !!domainListParams?.infinite;
-  const internalKeepPreviousData = shouldUseDefaults ? false : !!domainListParams?.keepPreviousData;
+  const domainSafeValues = useWithSafeValues(domainListParams, {
+    initialPage: 1,
+    pageSize: 10,
+    keepPreviousData: false,
+    infinite: false,
+    enrollmentMode: void 0
+  });
+  const membershipRequestSafeValues = useWithSafeValues(membershipRequestsListParams, {
+    initialPage: 1,
+    pageSize: 10,
+    status: "pending",
+    keepPreviousData: false,
+    infinite: false
+  });
   const clerk = useClerkInstanceContext();
   const shouldFetch = !!(clerk.loaded && session && organization);
-  const paginatedParams = typeof domainListParams === "undefined" ? void 0 : {
-    initialPage: paginatedPage,
-    initialPageSize: initialPageSizeRef.current
+  const domainParams = typeof domainListParams === "undefined" ? void 0 : {
+    initialPage: domainSafeValues.initialPage,
+    pageSize: domainSafeValues.pageSize,
+    enrollmentMode: domainSafeValues.enrollmentMode
   };
-  const fetchInvitations = !clerk.loaded ? () => ({ data: [], total_count: 0 }) : () => organization?.getDomains(paginatedParams);
-  const {
-    data: userInvitationsData,
-    isValidating: userInvitationsValidating,
-    isLoading: userInvitationsLoading,
-    error: userInvitationsError,
-    mutate: userInvitationsMutate
-  } = useSWR(
-    !triggerInfinite && shouldFetch && paginatedParams ? cacheKeyDomains("domains", organization, paginatedParams) : null,
-    fetchInvitations,
-    { keepPreviousData: internalKeepPreviousData }
-  );
-  const getInfiniteKey = (pageIndex, previousPageData) => {
-    if (!shouldFetch || !paginatedParams || !triggerInfinite) {
-      return null;
-    }
-    return cacheKeyDomains("domains", organization, {
-      initialPage: initialPageRef.current + pageIndex,
-      initialPageSize: initialPageSizeRef.current
-    });
+  const membershipRequestParams = typeof membershipRequestsListParams === "undefined" ? void 0 : {
+    initialPage: membershipRequestSafeValues.initialPage,
+    pageSize: membershipRequestSafeValues.pageSize,
+    status: membershipRequestSafeValues.status
   };
-  const {
-    data: userInvitationsDataInfinite,
-    isLoading: userInvitationsLoadingInfinite,
-    isValidating: userInvitationsInfiniteValidating,
-    error: userInvitationsInfiniteError,
-    size,
-    setSize,
-    mutate: userInvitationsInfiniteMutate
-  } = useSWRInfinite(getInfiniteKey, ({ initialPage, initialPageSize }) => {
-    return !clerk.loaded || !organization ? { data: [], total_count: 0 } : organization.getDomains({
-      initialPage,
-      initialPageSize
-    });
-  });
-  const isomorphicPage = useMemo(() => {
-    if (triggerInfinite) {
-      return size;
+  const domains = usePagesOrInfinite(
+    {
+      ...domainParams
+    },
+    organization?.getDomains,
+    {
+      keepPreviousData: domainSafeValues.keepPreviousData,
+      infinite: domainSafeValues.infinite,
+      enabled: !!domainParams
+    },
+    {
+      type: "domains",
+      organizationId: organization?.id
     }
-    return paginatedPage;
-  }, [triggerInfinite, size, paginatedPage]);
-  const isomorphicSetPage = useCallback(
-    (numberOrgFn) => {
-      if (triggerInfinite) {
-        void setSize(numberOrgFn);
-        return;
-      }
-      return setPaginatedPage(numberOrgFn);
+  );
+  const membershipRequests = usePagesOrInfinite(
+    {
+      ...membershipRequestParams
     },
-    [setSize]
+    organization?.getMembershipRequests,
+    {
+      keepPreviousData: membershipRequestSafeValues.keepPreviousData,
+      infinite: membershipRequestSafeValues.infinite,
+      enabled: !!membershipRequestParams
+    },
+    {
+      type: "membershipRequests",
+      organizationId: organization?.id
+    }
   );
-  const isomorphicData = useMemo(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.map((a) => a?.data).flat() ?? [];
-    }
-    return userInvitationsData?.data ?? [];
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicCount = useMemo(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.[userInvitationsDataInfinite?.length - 1]?.total_count || 0;
-    }
-    return userInvitationsData?.total_count ?? 0;
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicIsLoading = triggerInfinite ? userInvitationsLoadingInfinite : userInvitationsLoading;
-  const isomorphicIsFetching = triggerInfinite ? userInvitationsInfiniteValidating : userInvitationsValidating;
-  const isomorphicIsError = !!(triggerInfinite ? userInvitationsInfiniteError : userInvitationsError);
-  const fetchNext = useCallback(() => {
-    isomorphicSetPage((n) => n + 1);
-  }, [isomorphicSetPage]);
-  const fetchPrevious = useCallback(() => {
-    isomorphicSetPage((n) => n - 1);
-  }, [isomorphicSetPage]);
-  const offsetCount = (initialPageRef.current - 1) * initialPageSizeRef.current;
-  const pageCount = Math.ceil((isomorphicCount - offsetCount) / initialPageSizeRef.current);
-  const hasNextPage = isomorphicCount - offsetCount * initialPageSizeRef.current > isomorphicPage * initialPageSizeRef.current;
-  const hasPreviousPage = (isomorphicPage - 1) * initialPageSizeRef.current > offsetCount * initialPageSizeRef.current;
-  const unstable__mutate = triggerInfinite ? userInvitationsInfiniteMutate : userInvitationsMutate;
   const pendingInvitations = !clerk.loaded ? () => [] : () => clerk.organization?.getPendingInvitations(invitationListParams);
@@ -128,16 +109,4 @@ const currentOrganizationMemberships = !clerk.loaded ? () => [] : () => clerk.organization?.getMemberships(membershipListParams);
       membership: void 0,
-      domains: {
-        data: void 0,
-        count: void 0,
-        isLoading: false,
-        isFetching: false,
-        isError: false,
-        page: void 0,
-        pageCount: void 0,
-        fetchPage: void 0,
-        fetchNext: void 0,
-        fetchPrevious: void 0,
-        hasNextPage: false,
-        hasPreviousPage: false
-      }
+      domains: undefinedPaginatedResource,
+      membershipRequests: undefinedPaginatedResource
     };
@@ -152,3 +121,4 @@ }
       membership: null,
-      domains: null
+      domains: null,
+      membershipRequests: null
     };
@@ -163,16 +133,4 @@ }
       membership: void 0,
-      domains: {
-        data: void 0,
-        count: void 0,
-        isLoading: false,
-        isFetching: false,
-        isError: false,
-        page: void 0,
-        pageCount: void 0,
-        fetchPage: void 0,
-        fetchNext: void 0,
-        fetchPrevious: void 0,
-        hasNextPage: false,
-        hasPreviousPage: false
-      }
+      domains: undefinedPaginatedResource,
+      membershipRequests: undefinedPaginatedResource
     };
@@ -191,17 +149,4 @@ }
     },
-    domains: {
-      data: isomorphicData,
-      count: isomorphicCount,
-      isLoading: isomorphicIsLoading,
-      isFetching: isomorphicIsFetching,
-      isError: isomorphicIsError,
-      page: isomorphicPage,
-      pageCount,
-      fetchPage: isomorphicSetPage,
-      fetchNext,
-      fetchPrevious,
-      hasNextPage,
-      hasPreviousPage,
-      unstable__mutate
-    }
+    domains,
+    membershipRequests
   };
@@ -217,10 +162,2 @@ };
 }
-function cacheKeyDomains(type, organization, pagination) {
-  return {
-    type,
-    organizationId: organization.id,
-    initialPage: pagination.initialPage,
-    initialPageSize: pagination.initialPageSize
-  };
-}
 export {
@@ -227,0 +164,0 @@ useOrganization

dist/esm/hooks/useOrganizationList.js

@@ -1,102 +0,89 @@
-import { useCallback, useMemo, useRef, useState } from "react";
-import useSWR from "swr";
-import useSWRInfinite from "swr/infinite";
 import { useClerkInstanceContext, useUserContext } from "./contexts";
+import { usePagesOrInfinite, useWithSafeValues } from "./usePagesOrInfinite";
 const useOrganizationList = (params) => {
-  const { userInvitations } = params || {};
-  const shouldUseDefaults = typeof userInvitations === "boolean" && userInvitations;
-  const [paginatedPage, setPaginatedPage] = useState(shouldUseDefaults ? 1 : userInvitations?.initialPage ?? 1);
-  const initialPageRef = useRef(shouldUseDefaults ? 1 : userInvitations?.initialPage ?? 1);
-  const initialPageSizeRef = useRef(shouldUseDefaults ? 10 : userInvitations?.initialPageSize ?? 10);
-  const triggerInfinite = shouldUseDefaults ? false : !!userInvitations?.infinite;
-  const internalKeepPreviousData = shouldUseDefaults ? false : !!userInvitations?.keepPreviousData;
-  const internalStatus = shouldUseDefaults ? "pending" : userInvitations?.status ?? "pending";
+  const { userMemberships, userInvitations, userSuggestions } = params || {};
+  const userMembershipsSafeValues = useWithSafeValues(userMemberships, {
+    initialPage: 1,
+    pageSize: 10,
+    keepPreviousData: false,
+    infinite: false
+  });
+  const userInvitationsSafeValues = useWithSafeValues(userInvitations, {
+    initialPage: 1,
+    pageSize: 10,
+    status: "pending",
+    keepPreviousData: false,
+    infinite: false
+  });
+  const userSuggestionsSafeValues = useWithSafeValues(userSuggestions, {
+    initialPage: 1,
+    pageSize: 10,
+    status: "pending",
+    keepPreviousData: false,
+    infinite: false
+  });
   const clerk = useClerkInstanceContext();
   const user = useUserContext();
-  const paginatedParams = typeof userInvitations === "undefined" ? void 0 : {
-    initialPage: paginatedPage,
-    initialPageSize: initialPageSizeRef.current,
-    status: internalStatus
+  const userMembershipsParams = typeof userMemberships === "undefined" ? void 0 : {
+    initialPage: userMembershipsSafeValues.initialPage,
+    pageSize: userMembershipsSafeValues.pageSize
   };
-  const canFetch = !!(clerk.loaded && user);
-  const fetchInvitations = !clerk.loaded ? () => ({ data: [], total_count: 0 }) : () => user?.getOrganizationInvitations(paginatedParams);
-  const {
-    data: userInvitationsData,
-    isValidating: userInvitationsValidating,
-    isLoading: userInvitationsLoading,
-    error: userInvitationsError,
-    mutate: userInvitationsMutate
-  } = useSWR(
-    !triggerInfinite && canFetch && paginatedParams ? cacheKey("userInvitations", user, paginatedParams) : null,
-    fetchInvitations,
-    { keepPreviousData: internalKeepPreviousData }
-  );
-  const getInfiniteKey = (pageIndex, previousPageData) => {
-    if (!canFetch || !paginatedParams || !triggerInfinite) {
-      return null;
-    }
-    return cacheKey("userInvitations", user, {
-      initialPage: initialPageRef.current + pageIndex,
-      initialPageSize: initialPageSizeRef.current,
-      status: internalStatus
-    });
+  const userInvitationsParams = typeof userInvitations === "undefined" ? void 0 : {
+    initialPage: userInvitationsSafeValues.initialPage,
+    pageSize: userInvitationsSafeValues.pageSize,
+    status: userInvitationsSafeValues.status
   };
-  const {
-    data: userInvitationsDataInfinite,
-    isLoading: userInvitationsLoadingInfinite,
-    isValidating: userInvitationsInfiniteValidating,
-    error: userInvitationsInfiniteError,
-    size,
-    setSize,
-    mutate: userInvitationsInfiniteMutate
-  } = useSWRInfinite(getInfiniteKey, ({ initialPage, initialPageSize, status }) => {
-    return !clerk.loaded || !user ? { data: [], total_count: 0 } : user.getOrganizationInvitations({
-      initialPage,
-      initialPageSize,
-      status
-    });
-  });
-  const isomorphicPage = useMemo(() => {
-    if (triggerInfinite) {
-      return size;
+  const userSuggestionsParams = typeof userSuggestions === "undefined" ? void 0 : {
+    initialPage: userSuggestionsSafeValues.initialPage,
+    pageSize: userSuggestionsSafeValues.pageSize,
+    status: userSuggestionsSafeValues.status
+  };
+  const isClerkLoaded = !!(clerk.loaded && user);
+  const memberships = usePagesOrInfinite(
+    {
+      ...userMembershipsParams,
+      paginated: true
+    },
+    user?.getOrganizationMemberships,
+    {
+      keepPreviousData: userMembershipsSafeValues.keepPreviousData,
+      infinite: userMembershipsSafeValues.infinite,
+      enabled: !!userMembershipsParams
+    },
+    {
+      type: "userMemberships",
+      userId: user?.id
     }
-    return paginatedPage;
-  }, [triggerInfinite, size, paginatedPage]);
-  const isomorphicSetPage = useCallback(
-    (numberOrgFn) => {
-      if (triggerInfinite) {
-        void setSize(numberOrgFn);
-        return;
-      }
-      return setPaginatedPage(numberOrgFn);
+  );
+  const invitations = usePagesOrInfinite(
+    {
+      ...userInvitationsParams
     },
-    [setSize]
+    user?.getOrganizationInvitations,
+    {
+      keepPreviousData: userInvitationsSafeValues.keepPreviousData,
+      infinite: userInvitationsSafeValues.infinite,
+      enabled: !!userInvitationsParams
+    },
+    {
+      type: "userInvitations",
+      userId: user?.id
+    }
   );
-  const isomorphicData = useMemo(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.map((a) => a?.data).flat() ?? [];
+  const suggestions = usePagesOrInfinite(
+    {
+      ...userSuggestionsParams
+    },
+    user?.getOrganizationSuggestions,
+    {
+      keepPreviousData: userSuggestionsSafeValues.keepPreviousData,
+      infinite: userSuggestionsSafeValues.infinite,
+      enabled: !!userSuggestionsParams
+    },
+    {
+      type: "userSuggestions",
+      userId: user?.id
     }
-    return userInvitationsData?.data ?? [];
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicCount = useMemo(() => {
-    if (triggerInfinite) {
-      return userInvitationsDataInfinite?.[userInvitationsDataInfinite?.length - 1]?.total_count || 0;
-    }
-    return userInvitationsData?.total_count ?? 0;
-  }, [triggerInfinite, userInvitationsDataInfinite, userInvitationsData]);
-  const isomorphicIsLoading = triggerInfinite ? userInvitationsLoadingInfinite : userInvitationsLoading;
-  const isomorphicIsFetching = triggerInfinite ? userInvitationsInfiniteValidating : userInvitationsValidating;
-  const isomorphicIsError = !!(triggerInfinite ? userInvitationsInfiniteError : userInvitationsError);
-  const fetchNext = useCallback(() => {
-    isomorphicSetPage((n) => n + 1);
-  }, [isomorphicSetPage]);
-  const fetchPrevious = useCallback(() => {
-    isomorphicSetPage((n) => n - 1);
-  }, [isomorphicSetPage]);
-  const offsetCount = (initialPageRef.current - 1) * initialPageSizeRef.current;
-  const pageCount = Math.ceil((isomorphicCount - offsetCount) / initialPageSizeRef.current);
-  const hasNextPage = isomorphicCount - offsetCount * initialPageSizeRef.current > isomorphicPage * initialPageSizeRef.current;
-  const hasPreviousPage = (isomorphicPage - 1) * initialPageSizeRef.current > offsetCount * initialPageSizeRef.current;
-  const unstable__mutate = triggerInfinite ? userInvitationsInfiniteMutate : userInvitationsMutate;
-  if (!clerk.loaded || !user) {
+  );
+  if (!isClerkLoaded) {
     return {
@@ -107,2 +94,17 @@ isLoaded: false,
       setActive: void 0,
+      userMemberships: {
+        data: void 0,
+        count: void 0,
+        isLoading: false,
+        isFetching: false,
+        isError: false,
+        page: void 0,
+        pageCount: void 0,
+        fetchPage: void 0,
+        fetchNext: void 0,
+        fetchPrevious: void 0,
+        hasNextPage: false,
+        hasPreviousPage: false,
+        unstable__mutate: void 0
+      },
       userInvitations: {
@@ -122,2 +124,17 @@ data: void 0,
         unstable__mutate: void 0
+      },
+      userSuggestions: {
+        data: void 0,
+        count: void 0,
+        isLoading: false,
+        isFetching: false,
+        isError: false,
+        page: void 0,
+        pageCount: void 0,
+        fetchPage: void 0,
+        fetchNext: void 0,
+        fetchPrevious: void 0,
+        hasNextPage: false,
+        hasPreviousPage: false,
+        unstable__mutate: void 0
       }
@@ -127,21 +144,9 @@ };
   return {
-    isLoaded: canFetch,
+    isLoaded: isClerkLoaded,
     organizationList: createOrganizationList(user.organizationMemberships),
     setActive: clerk.setActive,
     createOrganization: clerk.createOrganization,
-    userInvitations: {
-      data: isomorphicData,
-      count: isomorphicCount,
-      isLoading: isomorphicIsLoading,
-      isFetching: isomorphicIsFetching,
-      isError: isomorphicIsError,
-      page: isomorphicPage,
-      pageCount,
-      fetchPage: isomorphicSetPage,
-      fetchNext,
-      fetchPrevious,
-      hasNextPage,
-      hasPreviousPage,
-      unstable__mutate
-    }
+    userMemberships: memberships,
+    userInvitations: invitations,
+    userSuggestions: suggestions
   };
@@ -155,11 +160,2 @@ };
 }
-function cacheKey(type, user, pagination) {
-  return {
-    type,
-    userId: user.id,
-    initialPage: pagination.initialPage,
-    initialPageSize: pagination.initialPageSize,
-    status: pagination.status
-  };
-}
 export {
@@ -166,0 +162,0 @@ useOrganizationList

dist/types/hooks/useOrganization.d.ts

@@ -1,3 +0,3 @@
-import type { GetDomainsParams, GetMembershipsParams, GetPendingInvitationsParams, OrganizationDomainResource, OrganizationInvitationResource, OrganizationMembershipResource, OrganizationResource } from '@clerk/types';
-import type { PaginatedDataAPI, PaginatedDataAPIWithDefaults } from './useOrganizationList';
+import type { GetDomainsParams, GetMembershipRequestParams, GetMembershipsParams, GetPendingInvitationsParams, OrganizationDomainResource, OrganizationInvitationResource, OrganizationMembershipRequestResource, OrganizationMembershipResource, OrganizationResource } from '@clerk/types';
+import type { PaginatedResources, PaginatedResourcesWithDefault } from './types';
 type UseOrganizationParams = {
@@ -10,2 +10,6 @@ invitationList?: GetPendingInvitationsParams;
     });
+    membershipRequests?: true | (GetMembershipRequestParams & {
+        infinite?: boolean;
+        keepPreviousData?: boolean;
+    });
 };
@@ -18,3 +22,4 @@ type UseOrganizationReturn = {
     membership: undefined;
-    domains: PaginatedDataAPIWithDefaults<OrganizationDomainResource>;
+    domains: PaginatedResourcesWithDefault<OrganizationDomainResource>;
+    membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
 } | {
@@ -26,3 +31,4 @@ isLoaded: true;
     membership: undefined;
-    domains: PaginatedDataAPIWithDefaults<OrganizationDomainResource>;
+    domains: PaginatedResourcesWithDefault<OrganizationDomainResource>;
+    membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
 } | {
@@ -34,3 +40,4 @@ isLoaded: boolean;
     membership: OrganizationMembershipResource | null | undefined;
-    domains: PaginatedDataAPI<OrganizationDomainResource> | null;
+    domains: PaginatedResources<OrganizationDomainResource> | null;
+    membershipRequests: PaginatedResources<OrganizationMembershipRequestResource> | null;
 };
@@ -37,0 +44,0 @@ type UseOrganization = (params?: UseOrganizationParams) => UseOrganizationReturn;

dist/types/hooks/useOrganizationList.d.ts

@@ -1,3 +0,8 @@
-import type { CreateOrganizationParams, GetUserOrganizationInvitationsParams, OrganizationMembershipResource, OrganizationResource, SetActive, UserOrganizationInvitationResource } from '@clerk/types';
+import type { CreateOrganizationParams, GetUserOrganizationInvitationsParams, GetUserOrganizationMembershipParams, GetUserOrganizationSuggestionsParams, OrganizationMembershipResource, OrganizationResource, OrganizationSuggestionResource, SetActive, UserOrganizationInvitationResource } from '@clerk/types';
+import type { PaginatedResources, PaginatedResourcesWithDefault } from './types';
 type UseOrganizationListParams = {
+    userMemberships?: true | (GetUserOrganizationMembershipParams & {
+        infinite?: boolean;
+        keepPreviousData?: boolean;
+    });
     userInvitations?: true | (GetUserOrganizationInvitationsParams & {
@@ -7,34 +12,30 @@ infinite?: boolean;
     });
+    userSuggestions?: true | (GetUserOrganizationSuggestionsParams & {
+        infinite?: boolean;
+        keepPreviousData?: boolean;
+    });
 };
 type OrganizationList = ReturnType<typeof createOrganizationList>;
-type CustomSetAction<T = unknown> = (size: T | ((_size: T) => T)) => void;
-export type PaginatedDataAPI<T = unknown> = {
-    data: T[];
-    count: number;
-    isLoading: boolean;
-    isFetching: boolean;
-    isError: boolean;
-    page: number;
-    pageCount: number;
-    fetchPage: CustomSetAction<number>;
-    fetchPrevious: () => void;
-    fetchNext: () => void;
-    hasNextPage: boolean;
-    hasPreviousPage: boolean;
-};
-export type PaginatedDataAPIWithDefaults<T> = {
-    [K in keyof PaginatedDataAPI<T>]: PaginatedDataAPI<T>[K] extends boolean ? false : PaginatedDataAPI<T>[K] | undefined;
-};
 type UseOrganizationListReturn = {
     isLoaded: false;
+    /**
+     * @deprecated Use userMemberships instead
+     */
     organizationList: undefined;
     createOrganization: undefined;
     setActive: undefined;
-    userInvitations: PaginatedDataAPIWithDefaults<UserOrganizationInvitationResource>;
+    userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
+    userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
+    userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 } | {
     isLoaded: boolean;
+    /**
+     * @deprecated Use userMemberships instead
+     */
     organizationList: OrganizationList;
     createOrganization: (params: CreateOrganizationParams) => Promise<OrganizationResource>;
     setActive: SetActive;
-    userInvitations: PaginatedDataAPI<UserOrganizationInvitationResource>;
+    userMemberships: PaginatedResources<OrganizationMembershipResource>;
+    userInvitations: PaginatedResources<UserOrganizationInvitationResource>;
+    userSuggestions: PaginatedResources<OrganizationSuggestionResource>;
 };
@@ -41,0 +42,0 @@ type UseOrganizationList = (params?: UseOrganizationListParams) => UseOrganizationListReturn;

package.json

 {
   "name": "@clerk/shared",
-  "version": "0.22.0-snapshot.0b0cc93",
+  "version": "0.22.0-snapshot.12da27f",
   "description": "Internal package utils used by the Clerk SDKs",
@@ -38,3 +38,3 @@ "types": "./dist/types/index.d.ts",
   "devDependencies": {
-    "@clerk/types": "3.50.0-snapshot.0b0cc93",
+    "@clerk/types": "3.50.0-snapshot.12da27f",
     "@types/glob-to-regexp": "0.4.1",
@@ -41,0 +41,0 @@ "@types/js-cookie": "3.0.2",

No alert changes

Improved metrics

Total package byte prevSize

550149

increased by2.38%

Number of package files

310

increased by4.03%

Lines of code

6258

increased by4.46%

No dependency changes