Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

2.4 KB
Raw Blame
import { useMemo, useState } from "react";

import { useSdkBreadcrumbs } from "embedding-sdk-bundle/hooks/private/use-sdk-breadcrumb";
import { useSdkSelector } from "embedding-sdk-bundle/store";
import { getCollectionIdSlugFromReference } from "embedding-sdk-bundle/store/collections";
import type { SdkBrowserCollectionId } from "embedding-sdk-bundle/types/collection";
import { skipToken, useGetCollectionQuery } from "metabase/api";
import type { CollectionId } from "metabase-types/api";

export const useCollectionData = (
  collectionId: SdkBrowserCollectionId = "personal",
  { skipCollectionFetching = false }: { skipCollectionFetching?: boolean } = {},
) => {
  const baseCollectionId = useSdkSelector((state) =>
    getCollectionIdSlugFromReference(state, collectionId),
  );

  // Internal collection state. Nullish when there is no current collection, and
  // when "personal" cannot be resolved — see [[getCollectionIdSlugFromReference]].
  const [internalCollectionId, setInternalCollectionId] = useState<
    CollectionId | null | undefined
  >(baseCollectionId);

  const { isBreadcrumbEnabled: isGlobalBreadcrumbEnabled, currentLocation } =
    useSdkBreadcrumbs();

  const effectiveCollectionId = useMemo(() => {
    if (isGlobalBreadcrumbEnabled) {
      if (currentLocation?.type === "collection") {
        return currentLocation.id;
      }

      if (currentLocation?.type === "all-collections") {
        return undefined;
      }
    }

    return internalCollectionId;
  }, [isGlobalBreadcrumbEnabled, currentLocation, internalCollectionId]);

  // `currentData`, not `data`: `data` keeps serving the previous collection
  // while a new one loads, so the caller would read the `can_write` of the
  // collection the user just left and offer to create things in this one.
  const {
    currentData: collection,
    error: collectionLoadingError,
    isFetching: isFetchingCollection,
  } = useGetCollectionQuery(
    // To avoid `/api/collection/undefined` and 404.
    effectiveCollectionId === null ||
      effectiveCollectionId === undefined ||
      skipCollectionFetching
      ? skipToken
      : { id: effectiveCollectionId },
  );

  return {
    baseCollectionId,
    internalCollectionId,
    effectiveCollectionId,
    collection,
    canWrite: collection?.can_write ?? false,
    setInternalCollectionId,
    isFetchingCollection,
    collectionLoadingError,
  };
};