Function useOrgs

apps/hash-frontend/src/components/hooks/use-orgs.ts:23–113

()

 * Retrieves a list of organizations
 */
export const useOrgs = (): {
  loading: boolean;
  orgs?: MinimalOrg[];
  refetch: () => Promise<ApolloQueryResult<QueryEntitiesQuery>>;
} => {
  const { data, loading, refetch } = useQuery<
    QueryEntitiesQuery,
    QueryEntitiesQueryVariables
  >(queryEntitiesQuery, {
    variables: {
      request: {
        filter: convertBpFilterToGraphFilter({
          filters: [
            entityHasEntityTypeByVersionedUrlFilter(
              systemEntityTypes.organization.entityTypeId,
            ),
          ],
          operator: "AND",
        }),
        temporalAxes: currentTimeInstantTemporalAxes,
        includeDrafts: false,
        includePermissions: false,
      },
    },
    fetchPolicy: "cache-and-network",
  });

  const { queryEntities } = data ?? {};

  const orgs = useMemoCompare(
    () => {
      if (!queryEntities) {
        return undefined;
      }

      return deserializeQueryEntitiesResponse(queryEntities).entities.map(
        (orgEntity) => {
          if (!isEntityOrgEntity(orgEntity)) {
            throw new Error(
              `Entity with type(s) ${orgEntity.metadata.entityTypeIds.join(", ")} is not an org entity`,
            );
          }
          return constructMinimalOrg({ orgEntity });
        },
      );
    },
    [queryEntities],
    /**
     * Check if the previous and new orgs are the same.
     * If they are, the return value from the hook won't change, avoiding unnecessary re-renders.
     *
     * This assumes that the UX/performance benefit of avoiding re-renders outweighs the cost of the comparison.
     *
     * An alternative approach would be to not use a 'cache-and-network' fetch policy, which also makes a network request
     * for all the orgs every time the hook is run, but instead use polling (or a subscription) to get updates.
     *
     * An identical approach is taken in {@link useUsers}. Update that too if this is changed.
     */ (a, b) => {