@databiosphere/findable-ui 12.0.0 → 13.0.1

package/.github/workflows/release-please.yml

@@ -0,0 +1,48 @@
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  pull-requests: write
+
+name: release-please
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          # this assumes that you have created a personal access token
+          # (PAT) and configured it as a GitHub action secret named
+          # `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          # This is a built-in strategy in release-please, see "Action Inputs" for more options
+          release-type: node
+
+      # The logic below handles the npm publication:
+      - uses: actions/checkout@v4
+
+      # These if statements ensure that a publication only occurs when a new release is created:
+      - uses: actions/setup-node@v4
+        if: ${{ steps.release.outputs.release_created }}
+        with:
+          node-version: 20
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Install dependencies
+        if: ${{ steps.release.outputs.release_created }}
+        run: npm ci
+
+      - name: Compile
+        if: ${{ steps.release.outputs.release_created }}
+        run: npx tsc
+
+      - name: Publish to NPM
+        if: ${{ steps.release.outputs.release_created }}
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.DATABIOSPHERE_FINDABLE_UI_NPM_PUBLISH_TOKEN }} # Ensure this token is scoped to only the permissions required for npm publication to limit security risks.

package/.github/workflows/run-checks.yml

@@ -1,31 +1,57 @@
 name: Run checks
-on: [pull_request]
+on:
+  pull_request:
+    branches:
+      - "**"
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: "20.10.0"
+          cache: "npm"
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Check code format
+        run: npm run check-format
+
+      - name: Run linter
+        run: npm run lint
+
+      - name: Run tests
+        run: npm run test
 
-      - run: |
-          npm ci
-          npm run check-format
-          npm run lint
-          npm run test
-          npm run test-compile
+      - name: Test compilation
+        run: npm run test-compile
 
   install-without-lock:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
         with:
           node-version: "20.10.0"
+          cache: "npm"
+
+      - name: Remove package lock
+        run: rm package-lock.json
+
+      - name: Install dependencies without lock
+        run: npm install
+
+      - name: Run tests
+        run: npm run test
 
-      - run: |
-          rm package-lock.json
-          npm install
-          npm run test-compile
+      - name: Test compilation
+        run: npm run test-compile

package/.prettierignore

@@ -1,5 +1,6 @@
 # general
 README.md
+CHANGELOG.md
 
 # testing
 coverage

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+## [13.0.1](https://github.com/DataBiosphere/findable-ui/compare/v13.0.0...v13.0.1) (2024-10-18)
+
+
+### Bug Fixes
+
+* give release-please workflow step an id ([#235](https://github.com/DataBiosphere/findable-ui/issues/235)) ([#236](https://github.com/DataBiosphere/findable-ui/issues/236)) ([420733f](https://github.com/DataBiosphere/findable-ui/commit/420733f3d6dc51f44301b06476550f499b4ffbd3))
+
+## [13.0.0](https://github.com/DataBiosphere/findable-ui/compare/v12.0.0...v13.0.0) (2024-10-18)
+
+
+### ⚠ BREAKING CHANGES
+
+* use ky with limited retries instead of axios ([#203](https://github.com/DataBiosphere/findable-ui/issues/203)) (#216)
+
+### Features
+
+* remove dry run from npm publish ([#231](https://github.com/DataBiosphere/findable-ui/issues/231)) ([#234](https://github.com/DataBiosphere/findable-ui/issues/234)) ([f44d0c3](https://github.com/DataBiosphere/findable-ui/commit/f44d0c3cb2859af6b87d33f5f6e16673db77ec52))
+* use ky with limited retries instead of axios ([#203](https://github.com/DataBiosphere/findable-ui/issues/203)) ([#216](https://github.com/DataBiosphere/findable-ui/issues/216)) ([ec18080](https://github.com/DataBiosphere/findable-ui/commit/ec18080e3191f99a88e9ddec174c9f953d9e3a41))
+
+
+### Bug Fixes
+
+* add changelog to gitignore ([#232](https://github.com/DataBiosphere/findable-ui/issues/232)) ([#233](https://github.com/DataBiosphere/findable-ui/issues/233)) ([b99ba34](https://github.com/DataBiosphere/findable-ui/commit/b99ba34088199b561b38493888206ed475a209e4))

package/jest.config.js

@@ -1,5 +1,5 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
-  preset: "ts-jest",
+  preset: "ts-jest/presets/js-with-ts-esm",
   testEnvironment: "jest-environment-jsdom",
 };

package/lib/common/analytics/entities.d.ts

@@ -17,7 +17,6 @@ export declare enum EVENT_PARAM {
     COLUMN_NAME = "column_name",
     CURRENT_QUERY = "current_query",
     ENTITY_NAME = "entity_name",
-    ENTITY_TYPE = "entity_type",
     FILTER_NAME = "filter_name",
     FILTER_VALUE = "filter_value",
     INDEX = "index",
@@ -46,7 +45,6 @@ export type EventParams = {
     [EVENT_NAME.BULK_DOWNLOAD_REQUESTED]: {
         [EVENT_PARAM.CATALOG]: string;
         [EVENT_PARAM.CURRENT_QUERY]: string;
-        [EVENT_PARAM.ENTITY_TYPE]: string;
         [EVENT_PARAM.INDEX]: string;
         [EVENT_PARAM.TOOL_NAME]: string;
     };

package/lib/common/analytics/entities.js

@@ -18,7 +18,6 @@ export var EVENT_PARAM;
     EVENT_PARAM["COLUMN_NAME"] = "column_name";
     EVENT_PARAM["CURRENT_QUERY"] = "current_query";
     EVENT_PARAM["ENTITY_NAME"] = "entity_name";
-    EVENT_PARAM["ENTITY_TYPE"] = "entity_type";
     EVENT_PARAM["FILTER_NAME"] = "filter_name";
     EVENT_PARAM["FILTER_VALUE"] = "filter_value";
     EVENT_PARAM["INDEX"] = "index";

package/lib/components/Export/common/tracking.js

@@ -17,7 +17,6 @@ export function bulkDownloadTracking(index, toolName, requestParams) {
     track(EVENT_NAME.BULK_DOWNLOAD_REQUESTED, {
         [EVENT_PARAM.CATALOG]: catalog,
         [EVENT_PARAM.CURRENT_QUERY]: currentQuery,
-        [EVENT_PARAM.ENTITY_TYPE]: "Bulk Download",
         [EVENT_PARAM.INDEX]: index,
         [EVENT_PARAM.TOOL_NAME]: toolName,
     });

package/lib/components/Export/components/ExportMethod/exportMethod.d.ts

@@ -6,5 +6,6 @@ export interface ExportMethodProps {
     isAccessible?: boolean;
     route: string;
     title: string;
+    trackingId?: string;
 }
-export declare const ExportMethod: ({ buttonLabel, description, footnote, isAccessible, route, title, }: ExportMethodProps) => JSX.Element;
+export declare const ExportMethod: ({ buttonLabel, description, footnote, isAccessible, route, title, trackingId, }: ExportMethodProps) => JSX.Element;

package/lib/components/Export/components/ExportMethod/exportMethod.js

@@ -6,7 +6,7 @@ import { FluidPaper } from "../../../common/Paper/paper.styles";
 import { SectionTitle } from "../../../common/Section/components/SectionTitle/sectionTitle";
 import { Section, SectionActions, SectionContent, } from "../../../common/Section/section.styles";
 import { ExportButton, SectionFootnote } from "./exportMethod.styles";
-export const ExportMethod = ({ buttonLabel, description, footnote, isAccessible = true, route, title, }) => {
+export const ExportMethod = ({ buttonLabel, description, footnote, isAccessible = true, route, title, trackingId, }) => {
     const { disabled, message } = useDownloadStatus();
     return (React.createElement(FluidPaper, null,
         React.createElement(Section, null,
@@ -16,7 +16,6 @@ export const ExportMethod = ({ buttonLabel, description, footnote, isAccessible
             React.createElement(SectionActions, null,
                 React.createElement(Tooltip, { arrow: true, title: message },
                     React.createElement("span", null,
-                        React.createElement(Link, { href: route, legacyBehavior: true, passHref: true },
-                            React.createElement(ExportButton, { disabled: disabled || !isAccessible }, buttonLabel))))),
+                        React.createElement(Link, { href: route, legacyBehavior: true, passHref: true }, trackingId ? (React.createElement(ExportButton, { disabled: disabled || !isAccessible, id: trackingId }, buttonLabel)) : (React.createElement(ExportButton, { disabled: disabled || !isAccessible }, buttonLabel)))))),
             footnote && React.createElement(SectionFootnote, null, footnote))));
 };

package/lib/components/Index/components/Hero/components/ExportButton/exportButton.js

@@ -8,5 +8,5 @@ export const ExportButton = () => {
     return (React.createElement(Tooltip, { arrow: true, title: message },
         React.createElement("span", null,
             React.createElement(Link, { href: "/export", legacyBehavior: true, passHref: true },
-                React.createElement(Button, { disabled: disabled || isLoading, href: "passHref" }, "Export")))));
+                React.createElement(Button, { disabled: disabled || isLoading, href: "passHref", id: "button-cohort-export" }, "Export")))));
 };

package/lib/components/Support/components/SupportRequest/components/SupportRequestForm/supportRequestForm.js

@@ -105,8 +105,6 @@ export const SupportRequestForm = ({ setFormSubmitted, supportRequest, }) => {
                 submitting: false,
             }));
             setFormSubmitted(true); // Shows form submitted message.
-            // Execute GTM tracking.
-            // TODO(cc) add GTM tracking.
         }
         catch (error) {
             setFormState((formState) => ({
@@ -131,7 +129,7 @@ export const SupportRequestForm = ({ setFormSubmitted, supportRequest, }) => {
             React.createElement(UploadFile, { isDragActive: isDragActive, label: FORM_CONTROL_LABEL.ATTACHMENT_TOKEN, onAttachmentDeleted: onAttachmentDeleted, open: open, ...formState })),
         React.createElement(Section, null,
             React.createElement(SectionActions, null,
-                React.createElement(ButtonPrimary, { disabled: Boolean(errors) || formState.submitting, fullWidth: true, onClick: onSupportRequestSubmitted }, "Send")))))));
+                React.createElement(ButtonPrimary, { disabled: Boolean(errors) || formState.submitting, fullWidth: true, onClick: onSupportRequestSubmitted, id: "button-support-request" }, "Send")))))));
 };
 /**
  * Build support request model from form values.

package/lib/components/TempError/tempError.d.ts

@@ -1,6 +1,6 @@
-import { AxiosError } from "axios";
+import { HTTPError } from "ky";
 interface TempErrorProps {
-    error: Error | AxiosError;
+    error: Error | HTTPError;
 }
 export declare const TempError: ({ error }: TempErrorProps) => JSX.Element;
 export {};

package/lib/components/TempError/tempError.js

@@ -1,12 +1,12 @@
-import { isAxiosError } from "axios";
+import { HTTPError } from "ky";
 import React from "react";
 import { ErrorBox } from "./components/errorBox";
 export const TempError = ({ error }) => {
-    const { code, request } = isAxiosError(error)
+    const { code, request } = error instanceof HTTPError
         ? {
             ...error,
-            code: error.response?.status,
-            request: error.request.responseURL,
+            code: error.response.status,
+            request: error.response.url,
         }
         : { ...error, code: null, request: null };
     return (React.createElement("div", null,

package/lib/config/entities.d.ts

@@ -111,7 +111,6 @@ export interface DataSourceConfig {
     defaultParams?: {
         catalog: string;
     };
-    entityURL?: string;
     url: string;
 }
 /**

package/lib/entity/api/service.js

@@ -5,11 +5,11 @@
 import { APIEndpoints, AZUL_PARAM, } from "../../apis/azul/common/entities";
 import { transformFilters } from "../../apis/azul/common/filterTransformer";
 import { getConfig } from "../../config/config";
-import { getDefaultDetailParams, getDefaultListParams, getEntityURL, } from "../../shared/utils";
+import { getDefaultDetailParams, getDefaultListParams, } from "../../shared/utils";
 import { convertUrlParams } from "../../utils/url";
-import { api } from "../common/client";
+import { fetchApi } from "../common/client";
 import { fetchEntitiesFromURL } from "../common/service";
-import { getAxiosRequestOptions } from "../common/utils";
+import { getKyRequestOptions } from "../common/utils";
 /**
  * Make a GET or POST request for a list of entities
  * @param apiPath - Path that will be used to compose the API url
@@ -38,7 +38,7 @@ export const fetchAllEntities = async (apiPath, accessToken, catalog, listParams
     let hits = result.hits;
     let nextPage = result.pagination.next;
     while (nextPage) {
-        const { data: nextPageJson } = await api().get(nextPage);
+        const nextPageJson = await (await fetchApi(nextPage)).json();
         nextPage = nextPageJson.pagination.next;
         hits = [...hits, ...nextPageJson.hits];
     }
@@ -49,8 +49,8 @@ export const fetchAllEntities = async (apiPath, accessToken, catalog, listParams
  * @returns name of the default catalog and all available catalogs.
  */
 export const fetchCatalog = async () => {
-    const res = await api().get(APIEndpoints.CATALOGS);
-    return res.data;
+    const res = await fetchApi(APIEndpoints.CATALOGS);
+    return await res.json();
 };
 /**
  *  Request to get a single project.
@@ -66,15 +66,13 @@ export const fetchEntityDetail = async (id, apiPath, catalog, accessToken, defau
 // eslint-disable-next-line @typescript-eslint/no-explicit-any -- this response type can't be determined beforehand
 ) => {
     const catalogParam = catalog ? { [AZUL_PARAM.CATALOG]: catalog } : undefined;
-    const options = getAxiosRequestOptions(accessToken);
-    const baseURL = getEntityURL();
-    return await api(baseURL)
-        .get(`${apiPath}/${id}?${convertUrlParams({
+    const options = getKyRequestOptions(accessToken);
+    return await fetchApi(`${apiPath}/${id}?${convertUrlParams({
         ...defaultParams,
         ...catalogParam,
     })}`, options)
         .then((res) => {
-        return res.data;
+        return res.json();
     })
         .catch((error) => {
         if (swallow404) {
@@ -109,9 +107,9 @@ export const fetchSummary = async (filterState, catalog, accessToken) => {
             [AZUL_PARAM.FILTERS]: filtersParam,
         };
     }
-    const options = getAxiosRequestOptions(accessToken);
-    const res = await api().get(`${apiPath}?${convertUrlParams({ ...summaryParams })}`, options);
-    return res.data;
+    const options = getKyRequestOptions(accessToken);
+    const res = await fetchApi(`${apiPath}?${convertUrlParams({ ...summaryParams })}`, options);
+    return await res.json();
 };
 /**
  * Fetch summary from given URL.
@@ -120,8 +118,8 @@ export const fetchSummary = async (filterState, catalog, accessToken) => {
  * @returns summary response.
  */
 export const fetchSummaryFromURL = async (path, accessToken) => {
-    const res = await api().get(path, getAxiosRequestOptions(accessToken));
-    return res.data;
+    const res = await fetchApi(path, getKyRequestOptions(accessToken));
+    return await res.json();
 };
 /**
  * Fetch system status from given URL.
@@ -129,6 +127,6 @@ export const fetchSummaryFromURL = async (path, accessToken) => {
  * @returns system status.
  */
 export const fetchSystemStatusFromURL = async (URL) => {
-    const res = await api().get(URL);
-    return res.data;
+    const res = await fetchApi(URL);
+    return await res.json();
 };

package/lib/entity/common/client.d.ts

@@ -1,12 +1,8 @@
-import { AxiosInstance } from "axios";
+import { Options, ResponsePromise } from "ky";
 /**
- * Adding response interceptors to axios instances.
- * @param api - AxiosInstance.
+ * Makes an HTTP request with the API URL as a base.
+ * @param url - URL to fetch.
+ * @param options - Ky options.
+ * @returns Ky response.
  */
-export declare const configureInterceptors: (api: AxiosInstance) => void;
-/**
- * Returns a singleton Axios instance configured for making HTTP requests to a specified base URL.
- * @param baseURL - The base URL to use for the AxiosInstance.
- * @returns axios instance.
- */
-export declare const api: (baseURL?: string) => AxiosInstance;
+export declare function fetchApi<T>(url: string, options?: Options): ResponsePromise<T>;

package/lib/entity/common/client.js

@@ -1,37 +1,27 @@
-import axios, { HttpStatusCode, } from "axios";
+import ky from "ky";
 import { getURL } from "../../shared/utils";
-let axiosInstance = null;
+let kyInstance = null;
 /**
- * Adding response interceptors to axios instances.
- * @param api - AxiosInstance.
+ * Makes an HTTP request with the API URL as a base.
+ * @param url - URL to fetch.
+ * @param options - Ky options.
+ * @returns Ky response.
  */
-export const configureInterceptors = (api) => {
-    api.interceptors.response.use((response) => response, (error) => {
-        const { config, response } = error;
-        if (response?.status === HttpStatusCode.ServiceUnavailable && config) {
-            const retryAfterValue = response.headers["Retry-After"];
-            const waitingTime = retryAfterValue ? +retryAfterValue : 0;
-            return new Promise((resolve) => {
-                setTimeout(() => resolve(api(config)), waitingTime);
-            });
-        }
-        else {
-            return Promise.reject(error);
-        }
-    });
-};
-/**
- * Returns a singleton Axios instance configured for making HTTP requests to a specified base URL.
- * @param baseURL - The base URL to use for the AxiosInstance.
- * @returns axios instance.
- */
-export const api = (baseURL = getURL()) => {
-    if (!axiosInstance) {
-        axiosInstance = axios.create({
-            baseURL,
+export function fetchApi(url, options = {}) {
+    if (!kyInstance) {
+        kyInstance = ky.create({
+            prefixUrl: getURL(),
+            retry: {
+                delay: (attemptCount) => 1000 * 3 ** (attemptCount - 1),
+                limit: 3,
+            },
             timeout: 20 * 1000,
         });
-        configureInterceptors(axiosInstance);
     }
-    return axiosInstance;
-};
+    // If a full URL is provided, there shouldn't be a prefix URL. Otherwise, Ky requires that the URL not start with a slash.
+    if (/^https?:\/\//.test(url))
+        options = { prefixUrl: "", ...options };
+    else
+        url = url.replace(/^\//, "");
+    return kyInstance.get(url, options);
+}

package/lib/entity/common/service.js

@@ -1,6 +1,5 @@
-import { getEntityURL } from "../../shared/utils";
-import { api } from "./client";
-import { getAxiosRequestOptions } from "./utils";
+import { fetchApi } from "./client";
+import { getKyRequestOptions } from "./utils";
 /**
  * Fetch entities from the given URL.
  * @param URL - URL.
@@ -8,8 +7,8 @@ import { getAxiosRequestOptions } from "./utils";
  * @returns entities.
  */
 export const fetchEntitiesFromURL = async (URL, accessToken) => {
-    const res = await api().get(URL, getAxiosRequestOptions(accessToken));
-    return res.data;
+    const res = await fetchApi(URL, getKyRequestOptions(accessToken));
+    return await res.json();
 };
 /**
  * Fetch entity from the given URL.
@@ -18,7 +17,6 @@ export const fetchEntitiesFromURL = async (URL, accessToken) => {
  * @returns entity.
  */
 export const fetchEntityFromURL = async (URL, accessToken) => {
-    const baseURL = getEntityURL();
-    const res = await api(baseURL).get(URL, getAxiosRequestOptions(accessToken));
-    return res.data;
+    const res = await fetchApi(URL, getKyRequestOptions(accessToken));
+    return await res.json();
 };

package/lib/entity/common/utils.d.ts

@@ -1,7 +1,7 @@
-import { AxiosRequestConfig } from "axios";
+import { Options } from "ky";
 /**
- * Returns Axios request configuration.
+ * Returns Ky request configuration.
  * @param accessToken - Access token.
- * @returns Axios request configuration.
+ * @returns Ky request configuration.
  */
-export declare function getAxiosRequestOptions(accessToken: string | undefined): AxiosRequestConfig;
+export declare function getKyRequestOptions(accessToken: string | undefined): Options;

package/lib/entity/common/utils.js

@@ -1,9 +1,9 @@
 /**
- * Returns Axios request configuration.
+ * Returns Ky request configuration.
  * @param accessToken - Access token.
- * @returns Axios request configuration.
+ * @returns Ky request configuration.
  */
-export function getAxiosRequestOptions(accessToken) {
+export function getKyRequestOptions(accessToken) {
     return {
         headers: accessToken ? { Authorization: "Bearer " + accessToken } : {},
     };

package/lib/shared/utils.d.ts

@@ -9,11 +9,6 @@ export declare function getDefaultDetailParams(): DataSourceConfig["defaultDetai
  * @returns application DEFAULT_LIST_PARAMS.
  */
 export declare function getDefaultListParams(): DataSourceConfig["defaultListParams"] | DataSourceConfig["defaultParams"];
-/**
- * Returns entity source URL.
- * @returns entity source URL.
- */
-export declare function getEntityURL(): string;
 /**
  * Returns application URL.
  * @returns application url.

package/lib/shared/utils.js

@@ -17,14 +17,6 @@ export function getDefaultListParams() {
     const { defaultListParams, defaultParams } = dataSource;
     return { ...defaultListParams, ...defaultParams };
 }
-/**
- * Returns entity source URL.
- * @returns entity source URL.
- */
-export function getEntityURL() {
-    const dataSource = getConfig().dataSource;
-    return dataSource.entityURL || dataSource.url;
-}
 /**
  * Returns application URL.
  * @returns application url.

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@databiosphere/findable-ui",
-  "version": "12.0.0",
+  "version": "13.0.1",
   "description": "",
   "scripts": {
-    "test": "jest",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
     "lint": "eslint .",
     "check-format": "prettier --check .",
     "storybook": "storybook dev -p 6006",
@@ -57,6 +57,7 @@
     "husky": "^8.0.3",
     "jest": "^29.4.1",
     "jest-environment-jsdom": "^29.4.1",
+    "jest-fetch-mock": "^3.0.3",
     "prettier": "^2.8.3",
     "prettier-plugin-organize-imports": "^3.2.2",
     "storybook": "^7.6.17",
@@ -70,9 +71,9 @@
     "@mui/material": "^6.0.2",
     "@tanstack/react-table": "^8.19.2",
     "@tanstack/react-virtual": "^3.0.0-beta.59",
-    "axios": "^1.6.7",
     "copy-to-clipboard": "3.3.1",
     "isomorphic-dompurify": "0.24.0",
+    "ky": "^1.7.2",
     "next": "^14.1.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",

package/src/common/analytics/entities.ts

@@ -20,7 +20,6 @@ export enum EVENT_PARAM {
   COLUMN_NAME = "column_name",
   CURRENT_QUERY = "current_query",
   ENTITY_NAME = "entity_name",
-  ENTITY_TYPE = "entity_type",
   FILTER_NAME = "filter_name",
   FILTER_VALUE = "filter_value",
   INDEX = "index",
@@ -52,7 +51,6 @@ export type EventParams = {
   [EVENT_NAME.BULK_DOWNLOAD_REQUESTED]: {
     [EVENT_PARAM.CATALOG]: string;
     [EVENT_PARAM.CURRENT_QUERY]: string;
-    [EVENT_PARAM.ENTITY_TYPE]: string;
     [EVENT_PARAM.INDEX]: string;
     [EVENT_PARAM.TOOL_NAME]: string;
   };

package/src/common/analytics/readme-analytics.md

@@ -6,10 +6,20 @@ See below a list of the currently available events.
 
 ### GA4 Event Inventory
 
-| Event                     | Parameters                                                      | Description                                                     |
-| ------------------------- | --------------------------------------------------------------- | --------------------------------------------------------------- |
-| `bulk_download_requested` | `catalog`, `current_query`, `entity_type`, `index`, `tool_name` | Runs when the HCA-DCP "Request curl command" button is selected |
-| `entity_selected`         | `entity_name`                                                   | Runs when an entity (tab) is selected                           |
-| `entity_table_paginated`  | `entity_name`, `pagination_directed`                            | Runs when the page forward/backwards buttons are clicked        |
-| `entity_table_sorted`     | `entity_name`, `column_name`, `sort_direction`                  | Runs each time a column in the entity table is sorted           |
-| `filter_selected`         | `filter_name`, `filter_value`                                   | Runs each time a filter is selected                             |
+| Event                     | Parameters                                       | Description                                                     |
+| ------------------------- | ------------------------------------------------ | --------------------------------------------------------------- |
+| `bulk_download_requested` | `catalog`, `current_query`, `index`, `tool_name` | Runs when the HCA-DCP "Request curl command" button is selected |
+| `entity_selected`         | `entity_name`                                    | Runs when an entity (tab) is selected                           |
+| `entity_table_paginated`  | `entity_name`, `pagination_direction`            | Runs when the page forward/backwards buttons are clicked        |
+| `entity_table_sorted`     | `entity_name`, `column_name`, `sort_direction`   | Runs each time a column in the entity table is sorted           |
+| `filter_selected`         | `filter_name`, `filter_value`                    | Runs each time a filter is selected                             |
+
+### Tracking-related ID Inventory
+
+Some GA4 Events are tracked using ids instead of events. Below is an inventory of the ids that, when clicked, trigger an event:
+
+| Component            | Id name                          | "All Elements" or "Just Links"? | Purpose                                     |
+| -------------------- | -------------------------------- | ------------------------------- | ------------------------------------------- |
+| `SupportRequestForm` | `button-support-request`         | "All Elements"                  | To track submitted support requests         |
+| `ExportMethod`       | The value passed as `trackingId` | "All Elements"                  | To separately track ExportMethod events     |
+| `ExportButton`       | `button-cohort-export`           | "Just Links"                    | To track clicks to the Cohort Export button |

package/src/components/Export/common/tracking.ts

@@ -23,7 +23,6 @@ export function bulkDownloadTracking(
   track(EVENT_NAME.BULK_DOWNLOAD_REQUESTED, {
     [EVENT_PARAM.CATALOG]: catalog,
     [EVENT_PARAM.CURRENT_QUERY]: currentQuery,
-    [EVENT_PARAM.ENTITY_TYPE]: "Bulk Download",
     [EVENT_PARAM.INDEX]: index,
     [EVENT_PARAM.TOOL_NAME]: toolName,
   });