@databiosphere/findable-ui 14.0.0 → 15.0.0

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

@@ -2,6 +2,7 @@ on:
   push:
     branches:
       - main
+  workflow_dispatch: # Enable manual triggering
 
 permissions:
   contents: write
@@ -16,12 +17,8 @@ jobs:
       - 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
+          config-file: release-please-config.json
+          token: ${{ secrets.GITHUB_TOKEN }}
 
       # The logic below handles the npm publication:
       - uses: actions/checkout@v4

package/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "15.0.0"
+}

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [15.0.0](https://github.com/DataBiosphere/findable-ui/compare/v14.0.0...v15.0.0) (2024-11-19)
+
+
+### ⚠ BREAKING CHANGES
+
+* added file download tracking ([#260](https://github.com/DataBiosphere/findable-ui/issues/260)) (#263)
+
+### Features
+
+* add optional version information to footer ([#258](https://github.com/DataBiosphere/findable-ui/issues/258)) ([#265](https://github.com/DataBiosphere/findable-ui/issues/265)) ([7a245ca](https://github.com/DataBiosphere/findable-ui/commit/7a245caf8f8966da3406f04559ecbf19ad978b6e))
+* added file download tracking ([#260](https://github.com/DataBiosphere/findable-ui/issues/260)) ([#263](https://github.com/DataBiosphere/findable-ui/issues/263)) ([092ad93](https://github.com/DataBiosphere/findable-ui/commit/092ad9390cff425c2bcc4a65e7212bde5acd573f))
+
+
+### Bug Fixes
+
+* add support for inclusion of orphans in verbatim PFB ([#264](https://github.com/DataBiosphere/findable-ui/issues/264)) ([#269](https://github.com/DataBiosphere/findable-ui/issues/269)) ([5f295e0](https://github.com/DataBiosphere/findable-ui/commit/5f295e0d008fb5db92b82f7ac1aa09dbbac06bbe))
+* remove `console.log` from `getHeadersTableData` ([#256](https://github.com/DataBiosphere/findable-ui/issues/256)) ([#261](https://github.com/DataBiosphere/findable-ui/issues/261)) ([7a87206](https://github.com/DataBiosphere/findable-ui/commit/7a872063aac9bee7ca05c55c6dc007ca83f5df61))
+* simplify release-please config and remove pat ([#267](https://github.com/DataBiosphere/findable-ui/issues/267)) ([#268](https://github.com/DataBiosphere/findable-ui/issues/268)) ([b6d3efa](https://github.com/DataBiosphere/findable-ui/commit/b6d3efab4c10a71b162df5168595e3142454d62e))
+
 ## [14.0.0](https://github.com/DataBiosphere/findable-ui/compare/v13.0.1...v14.0.0) (2024-11-05)
 
 

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

@@ -7,6 +7,7 @@ export declare enum EVENT_NAME {
     ENTITY_SELECTED = "entity_selected",
     ENTITY_TABLE_PAGINATED = "entity_table_paginated",
     ENTITY_TABLE_SORTED = "entity_table_sorted",
+    FILE_DOWNLOADED = "file_downloaded",
     FILTER_SELECTED = "filter_selected",
     INDEX_ANALYZE_IN_TERRA_REQUESTED = "index_analyze_in_terra_requested",
     INDEX_FILE_MANIFEST_REQUESTED = "index_file_manifest_requested"
@@ -20,6 +21,8 @@ export declare enum EVENT_PARAM {
     FILTER_NAME = "filter_name",
     FILTER_VALUE = "filter_value",
     PAGINATION_DIRECTION = "pagination_direction",
+    RELATED_ENTITY_ID = "related_entity_id",
+    RELATED_ENTITY_NAME = "related_entity_name",
     SORT_DIRECTION = "sort_direction",
     TOOL_NAME = "tool_name"
 }
@@ -57,6 +60,11 @@ export type EventParams = {
         [EVENT_PARAM.COLUMN_NAME]: string;
         [EVENT_PARAM.SORT_DIRECTION]: SORT_DIRECTION;
     };
+    [EVENT_NAME.FILE_DOWNLOADED]: {
+        [EVENT_PARAM.ENTITY_NAME]: string;
+        [EVENT_PARAM.RELATED_ENTITY_ID]: string;
+        [EVENT_PARAM.RELATED_ENTITY_NAME]: string;
+    };
     [EVENT_NAME.FILTER_SELECTED]: {
         [EVENT_PARAM.FILTER_NAME]: string;
         [EVENT_PARAM.FILTER_VALUE]: string;

package/lib/common/analytics/entities.js

@@ -7,6 +7,7 @@ export var EVENT_NAME;
     EVENT_NAME["ENTITY_SELECTED"] = "entity_selected";
     EVENT_NAME["ENTITY_TABLE_PAGINATED"] = "entity_table_paginated";
     EVENT_NAME["ENTITY_TABLE_SORTED"] = "entity_table_sorted";
+    EVENT_NAME["FILE_DOWNLOADED"] = "file_downloaded";
     EVENT_NAME["FILTER_SELECTED"] = "filter_selected";
     EVENT_NAME["INDEX_ANALYZE_IN_TERRA_REQUESTED"] = "index_analyze_in_terra_requested";
     EVENT_NAME["INDEX_FILE_MANIFEST_REQUESTED"] = "index_file_manifest_requested";
@@ -21,6 +22,8 @@ export var EVENT_PARAM;
     EVENT_PARAM["FILTER_NAME"] = "filter_name";
     EVENT_PARAM["FILTER_VALUE"] = "filter_value";
     EVENT_PARAM["PAGINATION_DIRECTION"] = "pagination_direction";
+    EVENT_PARAM["RELATED_ENTITY_ID"] = "related_entity_id";
+    EVENT_PARAM["RELATED_ENTITY_NAME"] = "related_entity_name";
     EVENT_PARAM["SORT_DIRECTION"] = "sort_direction";
     EVENT_PARAM["TOOL_NAME"] = "tool_name";
 })(EVENT_PARAM || (EVENT_PARAM = {}));

package/lib/components/Export/common/tracking.d.ts

@@ -3,14 +3,21 @@
  * @param entity_name - Entity (tab) name.
  * @param toolName - Tool name.
  */
-export declare function bulkDownloadTracking(entity_name: string, toolName: string): void;
+export declare function trackBulkDownloadRequested(entity_name: string, toolName: string): void;
 /**
  * Executes event tracking for the file manifest export.
  * @param entity_name - Entity (tab) name.
  */
-export declare function fileManifestTracking(entity_name: string): void;
+export declare function trackFileManifestRequested(entity_name: string): void;
 /**
  * Executes event tracking for the Terra export.
  * @param entity_name - Entity (tab) name.
  */
-export declare function exportToTerraTracking(entity_name: string): void;
+export declare function trackExportToTerraRequested(entity_name: string): void;
+/**
+ * Executes event tracking for individual file downloads
+ * @param entity_name - The name of the file downloaded.
+ * @param related_entity_id - The ID of the file's dataset / project
+ * @param related_entity_name -The name of the file's dataset / project
+ */
+export declare function trackFileDownloaded(entity_name: string, related_entity_id: string, related_entity_name: string): void;

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

@@ -5,7 +5,7 @@ import { EVENT_NAME, EVENT_PARAM } from "../../../common/analytics/entities";
  * @param entity_name - Entity (tab) name.
  * @param toolName - Tool name.
  */
-export function bulkDownloadTracking(entity_name, toolName) {
+export function trackBulkDownloadRequested(entity_name, toolName) {
     // Track the bulk download requested event.
     track(EVENT_NAME.BULK_DOWNLOAD_REQUESTED, {
         [EVENT_PARAM.ENTITY_NAME]: entity_name,
@@ -16,7 +16,7 @@ export function bulkDownloadTracking(entity_name, toolName) {
  * Executes event tracking for the file manifest export.
  * @param entity_name - Entity (tab) name.
  */
-export function fileManifestTracking(entity_name) {
+export function trackFileManifestRequested(entity_name) {
     // Track the file manifest requested event.
     track(EVENT_NAME.INDEX_FILE_MANIFEST_REQUESTED, {
         [EVENT_PARAM.ENTITY_NAME]: entity_name,
@@ -26,9 +26,23 @@ export function fileManifestTracking(entity_name) {
  * Executes event tracking for the Terra export.
  * @param entity_name - Entity (tab) name.
  */
-export function exportToTerraTracking(entity_name) {
+export function trackExportToTerraRequested(entity_name) {
     // Track the export to terra event.
     track(EVENT_NAME.INDEX_ANALYZE_IN_TERRA_REQUESTED, {
         [EVENT_PARAM.ENTITY_NAME]: entity_name,
     });
 }
+/**
+ * Executes event tracking for individual file downloads
+ * @param entity_name - The name of the file downloaded.
+ * @param related_entity_id - The ID of the file's dataset / project
+ * @param related_entity_name -The name of the file's dataset / project
+ */
+export function trackFileDownloaded(entity_name, related_entity_id, related_entity_name) {
+    // Track the file downloaded event.
+    track(EVENT_NAME.FILE_DOWNLOADED, {
+        [EVENT_PARAM.ENTITY_NAME]: entity_name,
+        [EVENT_PARAM.RELATED_ENTITY_ID]: related_entity_id,
+        [EVENT_PARAM.RELATED_ENTITY_NAME]: related_entity_name,
+    });
+}

package/lib/components/Export/components/DownloadCurlCommand/downloadCurlCommand.d.ts

@@ -13,5 +13,5 @@ interface DownloadCurlCommandProps {
     filters: Filters;
     formFacet: FormFacet;
 }
-export declare const DownloadCurlCommand: ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, }: DownloadCurlCommandProps) => JSX.Element;
+export declare const DownloadCurlCommand: ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, }: DownloadCurlCommandProps) => JSX.Element;
 export {};

package/lib/components/Export/components/DownloadCurlCommand/downloadCurlCommand.js

@@ -4,18 +4,18 @@ import { useExploreState } from "../../../../hooks/useExploreState";
 import { useFileManifest } from "../../../../hooks/useFileManifest/useFileManifest";
 import { useRequestFileManifest } from "../../../../hooks/useFileManifest/useRequestFileManifest";
 import { BULK_DOWNLOAD_EXECUTION_ENVIRONMENT, } from "../../common/entities";
-import { bulkDownloadTracking } from "../../common/tracking";
+import { trackBulkDownloadRequested } from "../../common/tracking";
 import { DownloadCurlCommandNotStarted } from "./components/DownloadCurlCommandNotStarted/downloadCurlCommandNotStarted";
 import { DownloadCurlCommandReady } from "./components/DownloadCurlCommandReady/downloadCurlCommandReady";
-export const DownloadCurlCommand = ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, }) => {
-    useRequestFileManifest(MANIFEST_DOWNLOAD_FORMAT.CURL, filters, fileSummaryFacetName);
+export const DownloadCurlCommand = ({ DownloadCurlForm, DownloadCurlStart, DownloadCurlSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, }) => {
+    useRequestFileManifest(fileManifestType, MANIFEST_DOWNLOAD_FORMAT.CURL, filters, fileSummaryFacetName);
     const [executionEnvironment, setExecutionEnvironment] = useState(BULK_DOWNLOAD_EXECUTION_ENVIRONMENT.BASH);
     const { exploreState: { tabValue: entityList }, } = useExploreState();
     const { data, isLoading, run } = useFileManifest();
     const curlCommand = getBulkDownloadCurlCommand(data, executionEnvironment);
     return curlCommand ? (React.createElement(DownloadCurlCommandReady, { curlCommand: curlCommand, DownloadCurlSuccess: DownloadCurlSuccess })) : (React.createElement(DownloadCurlCommandNotStarted, { DownloadCurlForm: DownloadCurlForm, DownloadCurlStart: DownloadCurlStart, executionEnvironment: executionEnvironment, fileManifestState: fileManifestState, formFacet: formFacet, isLoading: isLoading, onRequestManifest: () => {
             // Execute GTM tracking.
-            bulkDownloadTracking(entityList, executionEnvironment);
+            trackBulkDownloadRequested(entityList, executionEnvironment);
             // Request manifest.
             run();
         }, setExecutionEnvironment: setExecutionEnvironment }));

package/lib/components/Export/components/ExportToTerra/exportToTerra.d.ts

@@ -15,4 +15,4 @@ export interface ExportToTerraProps {
     manifestDownloadFormat?: ManifestDownloadFormat;
     manifestDownloadFormats: ManifestDownloadFormat[];
 }
-export declare const ExportToTerra: ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }: ExportToTerraProps) => JSX.Element;
+export declare const ExportToTerra: ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }: ExportToTerraProps) => JSX.Element;

package/lib/components/Export/components/ExportToTerra/exportToTerra.js

@@ -3,18 +3,18 @@ import { useExploreState } from "../../../../hooks/useExploreState";
 import { useExportToTerraResponseURL } from "../../../../hooks/useExportToTerraResponseURL";
 import { useFileManifest } from "../../../../hooks/useFileManifest/useFileManifest";
 import { useRequestFileManifest } from "../../../../hooks/useFileManifest/useRequestFileManifest";
-import { exportToTerraTracking } from "../../common/tracking";
+import { trackExportToTerraRequested } from "../../common/tracking";
 import { ExportToTerraNotStarted } from "./components/ExportToTerraNotStarted/exportToTerraNotStarted";
 import { ExportToTerraReady } from "./components/ExportToTerraReady/exportToTerraReady";
-export const ExportToTerra = ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }) => {
+export const ExportToTerra = ({ ExportForm, ExportToTerraStart, ExportToTerraSuccess, fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, manifestDownloadFormat, manifestDownloadFormats, }) => {
     const { exploreState: { tabValue: entityList }, } = useExploreState();
-    useRequestFileManifest(manifestDownloadFormat, filters, fileSummaryFacetName);
+    useRequestFileManifest(fileManifestType, manifestDownloadFormat, filters, fileSummaryFacetName);
     const { requestParams } = fileManifestState;
     const { data, isLoading, run } = useFileManifest();
     const exportURL = useExportToTerraResponseURL(requestParams, data);
     return exportURL ? (React.createElement(ExportToTerraReady, { ExportToTerraSuccess: ExportToTerraSuccess, exportURL: exportURL })) : (React.createElement(ExportToTerraNotStarted, { ExportTerraForm: ExportForm, ExportToTerraStart: ExportToTerraStart, fileManifestState: fileManifestState, formFacet: formFacet, isLoading: isLoading, manifestDownloadFormats: manifestDownloadFormats, onRequestManifest: () => {
             // Execute GA tracking
-            exportToTerraTracking(entityList);
+            trackExportToTerraRequested(entityList);
             // Request manifest
             run();
         } }));

package/lib/components/Export/components/ManifestDownload/components/ManifestDownloadEntity/manifestDownloadEntity.d.ts

@@ -5,4 +5,4 @@ export interface ManifestDownloadEntityProps {
     filters: Filters;
     metadataFilters: Filters;
 }
-export declare const ManifestDownloadEntity: ({ filters, metadataFilters, }: ManifestDownloadEntityProps) => JSX.Element;
+export declare const ManifestDownloadEntity: ({ fileManifestType, filters, metadataFilters, }: ManifestDownloadEntityProps) => JSX.Element;

package/lib/components/Export/components/ManifestDownload/components/ManifestDownloadEntity/manifestDownloadEntity.js

@@ -3,8 +3,8 @@ import { MANIFEST_DOWNLOAD_FORMAT } from "../../../../../../apis/azul/common/ent
 import { useRequestFileManifest } from "../../../../../../hooks/useFileManifest/useRequestFileManifest";
 import { FileManifestDownload } from "./components/FileManifestDownload/fileManifestDownload";
 import { FileManifestSpreadsheet } from "./components/FileManifestSpreadsheet/fileManifestSpreadsheet";
-export const ManifestDownloadEntity = ({ filters, metadataFilters, }) => {
-    useRequestFileManifest(MANIFEST_DOWNLOAD_FORMAT.COMPACT, filters, undefined);
+export const ManifestDownloadEntity = ({ fileManifestType, filters, metadataFilters, }) => {
+    useRequestFileManifest(fileManifestType, MANIFEST_DOWNLOAD_FORMAT.COMPACT, filters, undefined);
     return (React.createElement(React.Fragment, null,
         React.createElement(FileManifestSpreadsheet, { filters: metadataFilters }),
         React.createElement(FileManifestDownload, { filters: filters })));

package/lib/components/Export/components/ManifestDownload/manifestDownload.d.ts

@@ -13,4 +13,4 @@ export interface ManifestDownloadProps {
     ManifestDownloadStart: ElementType;
     ManifestDownloadSuccess: ElementType;
 }
-export declare const ManifestDownload: ({ fileManifestState, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, ManifestDownloadStart, ManifestDownloadSuccess, }: ManifestDownloadProps) => JSX.Element;
+export declare const ManifestDownload: ({ fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, ManifestDownloadStart, ManifestDownloadSuccess, }: ManifestDownloadProps) => JSX.Element;

package/lib/components/Export/components/ManifestDownload/manifestDownload.js

@@ -3,16 +3,16 @@ import { MANIFEST_DOWNLOAD_FORMAT } from "../../../../apis/azul/common/entities"
 import { useExploreState } from "../../../../hooks/useExploreState";
 import { useFileManifest } from "../../../../hooks/useFileManifest/useFileManifest";
 import { useRequestFileManifest } from "../../../../hooks/useFileManifest/useRequestFileManifest";
-import { fileManifestTracking } from "../../common/tracking";
+import { trackFileManifestRequested } from "../../common/tracking";
 import { ManifestDownloadNotStarted } from "./components/ManifestDownloadNotStarted/manifestDownloadNotStarted";
 import { ManifestDownloadReady } from "./components/ManifestDownloadReady/manifestDownloadReady";
-export const ManifestDownload = ({ fileManifestState, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, ManifestDownloadStart, ManifestDownloadSuccess, }) => {
-    useRequestFileManifest(MANIFEST_DOWNLOAD_FORMAT.COMPACT, filters, fileSummaryFacetName);
+export const ManifestDownload = ({ fileManifestState, fileManifestType, fileSummaryFacetName, filters, formFacet, ManifestDownloadForm, ManifestDownloadStart, ManifestDownloadSuccess, }) => {
+    useRequestFileManifest(fileManifestType, MANIFEST_DOWNLOAD_FORMAT.COMPACT, filters, fileSummaryFacetName);
     const { exploreState: { tabValue: entityList }, } = useExploreState();
     const { data, isLoading, run } = useFileManifest();
     const manifestURL = getManifestDownloadURL(data);
     return manifestURL ? (React.createElement(ManifestDownloadReady, { ManifestDownloadSuccess: ManifestDownloadSuccess, manifestURL: manifestURL })) : (React.createElement(ManifestDownloadNotStarted, { ManifestDownloadForm: ManifestDownloadForm, ManifestDownloadStart: ManifestDownloadStart, fileManifestState: fileManifestState, formFacet: formFacet, isLoading: isLoading, onRequestManifest: () => {
-            fileManifestTracking(entityList);
+            trackFileManifestRequested(entityList);
             run();
         } }));
 };

package/lib/components/Filter/components/FilterTag/filterTag.styles.d.ts

@@ -1,5 +1,5 @@
 export declare const SupersededTag: import("@emotion/styled").StyledComponent<import("@mui/material").ChipOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
     ref?: ((instance: HTMLDivElement | null) => void | import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | import("react").RefObject<HTMLDivElement> | null | undefined;
-}, "label" | "style" | "className" | "classes" | "tabIndex" | "color" | "children" | "sx" | "variant" | "disabled" | "size" | "icon" | "avatar" | "clickable" | "deleteIcon" | "onDelete" | "skipFocusWhenDisabled"> & {
+}, "label" | "style" | "className" | "classes" | "tabIndex" | "color" | "children" | "sx" | "variant" | "disabled" | "size" | "avatar" | "clickable" | "deleteIcon" | "icon" | "onDelete" | "skipFocusWhenDisabled"> & {
     theme?: import("@emotion/react").Theme;
 }, {}, {}>;

package/lib/components/Index/components/AzulFileDownload/azulFileDownload.d.ts

@@ -1,4 +1,7 @@
 export interface AzulFileDownloadProps {
+    entityName: string;
+    relatedEntityId: string;
+    relatedEntityName: string;
     url?: string;
 }
-export declare const AzulFileDownload: ({ url, }: AzulFileDownloadProps) => JSX.Element;
+export declare const AzulFileDownload: ({ entityName, relatedEntityId, relatedEntityName, url, }: AzulFileDownloadProps) => JSX.Element;

package/lib/components/Index/components/AzulFileDownload/azulFileDownload.js

@@ -4,9 +4,10 @@ import { useFileLocation } from "../../../../hooks/useFileLocation";
 import { DownloadIcon } from "../../../common/CustomIcon/components/DownloadIcon/downloadIcon";
 import { LoadingIcon } from "../../../common/CustomIcon/components/LoadingIcon/loadingIcon";
 import { IconButton } from "../../../common/IconButton/iconButton";
+import { trackFileDownloaded } from "../../../Export/common/tracking";
 import { StyledIconButton } from "./azulFileDownload.styles";
 import { AZUL_FILE_DOWNLOAD_TEST_ID, AZUL_FILE_REQUEST_DOWNLOAD_PENDING_TEST_ID, AZUL_FILE_REQUEST_DOWNLOAD_TEST_ID, } from "./common/constants";
-export const AzulFileDownload = ({ url, }) => {
+export const AzulFileDownload = ({ entityName, relatedEntityId, relatedEntityName, url, }) => {
     const { fileUrl, isLoading, run } = useFileLocation(url);
     const downloadRef = useRef(null);
     const [isRequestPending, setIsRequestPending] = useState(false);
@@ -24,6 +25,7 @@ export const AzulFileDownload = ({ url, }) => {
     return (React.createElement(Fragment, null,
         isRequestPending ? (React.createElement(StyledIconButton, { color: "primary", "data-testid": AZUL_FILE_REQUEST_DOWNLOAD_PENDING_TEST_ID, Icon: LoadingIcon, size: "medium" })) : (React.createElement(IconButton, { color: "primary", "data-testid": AZUL_FILE_REQUEST_DOWNLOAD_TEST_ID, disabled: !url, Icon: isLoading ? LoadingIcon : DownloadIcon, onClick: () => {
                 setIsRequestPending(true);
+                trackFileDownloaded(entityName, relatedEntityId, relatedEntityName);
                 run();
             }, size: "medium" })),
         React.createElement(Box, { component: "a", "data-testid": AZUL_FILE_DOWNLOAD_TEST_ID, download: true, ref: downloadRef, sx: { display: "none" } })));

package/lib/components/Layout/components/Footer/components/VersionInfo/components/Tooltip/components/Title/constants.d.ts

@@ -0,0 +1,2 @@
+import { LinkOwnProps } from "@mui/material";
+export declare const LINK_PROPS: Partial<LinkOwnProps>;

package/lib/components/Layout/components/Footer/components/VersionInfo/components/Tooltip/components/Title/constants.js

@@ -0,0 +1,3 @@
+export const LINK_PROPS = {
+    color: "inherit",
+};

package/lib/components/Layout/components/Footer/components/VersionInfo/components/Tooltip/components/Title/title.d.ts

@@ -0,0 +1,2 @@
+import { VersionInfoProps } from "../../../../types";
+export declare const Title: ({ versionInfo, }: Pick<VersionInfoProps, "versionInfo">) => JSX.Element | null;

package/lib/components/Layout/components/Footer/components/VersionInfo/components/Tooltip/components/Title/title.js

@@ -0,0 +1,27 @@
+import { Typography } from "@mui/material";
+import React from "react";
+import { useConfig } from "../../../../../../../../../../hooks/useConfig";
+import { TEXT_BODY_SMALL_400_2_LINES } from "../../../../../../../../../../theme/common/typography";
+import { Link } from "../../../../../../../../../Links/components/Link/link";
+import { getGitHash, getVersion } from "../../../../utils";
+import { LINK_PROPS } from "./constants";
+import { getCommitUrl, getReleaseUrl } from "./utils";
+export const Title = ({ versionInfo, }) => {
+    const { config: { gitHubUrl }, } = useConfig();
+    if (!versionInfo)
+        return null;
+    const { buildDate, catalog, gitHash, version } = versionInfo;
+    return (React.createElement(Typography, { component: "div", variant: TEXT_BODY_SMALL_400_2_LINES },
+        buildDate && (React.createElement("div", null,
+            React.createElement("span", null, "Build Date: "),
+            React.createElement("span", null, buildDate))),
+        React.createElement("div", null,
+            React.createElement("span", null, "Version: "),
+            React.createElement(Link, { ...LINK_PROPS, label: getVersion(version), url: getReleaseUrl(gitHubUrl, versionInfo) })),
+        gitHash && (React.createElement("div", null,
+            React.createElement("span", null, "Git Commit: "),
+            React.createElement(Link, { ...LINK_PROPS, label: getGitHash(gitHash), url: getCommitUrl(gitHubUrl, versionInfo) }))),
+        catalog && (React.createElement("div", null,
+            React.createElement("span", null, "Catalog: "),
+            React.createElement("span", null, catalog)))));
+};

package/lib/components/Layout/components/Footer/components/VersionInfo/components/Tooltip/components/Title/utils.d.ts

@@ -0,0 +1,15 @@
+import { VersionInfo } from "../../../../types";
+/**
+ * Returns GitHub commit URL for the given git hash.
+ * @param gitHubRepoUrl - GitHub repository URL.
+ * @param versionInfo - Version info.
+ * @returns GitHub commit URL.
+ */
+export declare function getCommitUrl(gitHubRepoUrl?: string, versionInfo?: VersionInfo): string;
+/**
+ * Returns GitHub release URL for the given release version.
+ * @param gitHubRepoUrl - GitHub repository URL.
+ * @param versionInfo - Version info.
+ * @returns GitHub release URL.
+ */
+export declare function getReleaseUrl(gitHubRepoUrl?: string, versionInfo?: VersionInfo): string;

package/lib/components/Layout/components/Footer/components/VersionInfo/components/Tooltip/components/Title/utils.js

@@ -0,0 +1,26 @@
+/**
+ * Returns GitHub commit URL for the given git hash.
+ * @param gitHubRepoUrl - GitHub repository URL.
+ * @param versionInfo - Version info.
+ * @returns GitHub commit URL.
+ */
+export function getCommitUrl(gitHubRepoUrl, versionInfo) {
+    if (!gitHubRepoUrl || !versionInfo)
+        return "";
+    if (!versionInfo.gitHash)
+        return "";
+    return `${gitHubRepoUrl}/commit/${versionInfo.gitHash}`;
+}
+/**
+ * Returns GitHub release URL for the given release version.
+ * @param gitHubRepoUrl - GitHub repository URL.
+ * @param versionInfo - Version info.
+ * @returns GitHub release URL.
+ */
+export function getReleaseUrl(gitHubRepoUrl, versionInfo) {
+    if (!gitHubRepoUrl || !versionInfo)
+        return "";
+    if (!versionInfo.version)
+        return "";
+    return `${gitHubRepoUrl}/releases/tag/${versionInfo.version}`;
+}

package/lib/components/Layout/components/Footer/components/VersionInfo/constants.d.ts

@@ -0,0 +1,3 @@
+import { ChipProps, TooltipProps } from "@mui/material";
+export declare const CHIP_PROPS: Partial<ChipProps>;
+export declare const TOOLTIP_PROPS: Partial<TooltipProps>;

package/lib/components/Layout/components/Footer/components/VersionInfo/constants.js

@@ -0,0 +1,27 @@
+import { CHIP_PROPS as MUI_CHIP_PROPS } from "../../../../../../styles/common/mui/chip";
+export const CHIP_PROPS = {
+    color: MUI_CHIP_PROPS.COLOR.DEFAULT,
+    size: MUI_CHIP_PROPS.SIZE.SMALL,
+};
+export const TOOLTIP_PROPS = {
+    arrow: true,
+    slotProps: {
+        popper: {
+            modifiers: [
+                {
+                    name: "offset",
+                    options: {
+                        offset: [0, -4],
+                    },
+                },
+                {
+                    name: "preventOverflow",
+                    options: { padding: 8 },
+                },
+            ],
+        },
+        tooltip: {
+            sx: { maxWidth: "none" },
+        },
+    },
+};

package/lib/components/Layout/components/Footer/components/VersionInfo/types.d.ts

@@ -0,0 +1,12 @@
+import { ChipProps, TooltipProps } from "@mui/material";
+export interface VersionInfo {
+    buildDate?: string;
+    catalog?: string;
+    gitHash?: string;
+    version?: string;
+}
+export interface VersionInfoProps {
+    chipProps?: Partial<ChipProps>;
+    tooltipProps?: Partial<TooltipProps>;
+    versionInfo?: VersionInfo;
+}

package/lib/components/Layout/components/Footer/components/VersionInfo/types.js

@@ -0,0 +1 @@
+export {};

package/lib/components/Layout/components/Footer/components/VersionInfo/utils.d.ts

@@ -0,0 +1,19 @@
+import { VersionInfo } from "./types";
+/**
+ * Returns displayable shortened version of Git hash.
+ * @param gitHash - Git hash.
+ * @returns displayable shortened version of Git hash.
+ */
+export declare function getGitHash(gitHash?: string): string | undefined;
+/**
+ * Returns Chip label based on version info.
+ * @param versionInfo - Version info.
+ * @returns Chip label.
+ */
+export declare function getLabel(versionInfo?: VersionInfo): string | undefined;
+/**
+ * Returns displayable version, or "Unversioned" if version is not provided.
+ * @param version - Version info.
+ * @returns Version.
+ */
+export declare function getVersion(version?: string): string;

package/lib/components/Layout/components/Footer/components/VersionInfo/utils.js

@@ -0,0 +1,29 @@
+/**
+ * Returns displayable shortened version of Git hash.
+ * @param gitHash - Git hash.
+ * @returns displayable shortened version of Git hash.
+ */
+export function getGitHash(gitHash) {
+    return gitHash?.substring(0, 7);
+}
+/**
+ * Returns Chip label based on version info.
+ * @param versionInfo - Version info.
+ * @returns Chip label.
+ */
+export function getLabel(versionInfo) {
+    if (!versionInfo)
+        return;
+    const { catalog, gitHash, version } = versionInfo;
+    return [getVersion(version), getGitHash(gitHash), catalog]
+        .filter(Boolean)
+        .join("-");
+}
+/**
+ * Returns displayable version, or "Unversioned" if version is not provided.
+ * @param version - Version info.
+ * @returns Version.
+ */
+export function getVersion(version) {
+    return version || "Unversioned";
+}

package/lib/components/Layout/components/Footer/components/VersionInfo/versionInfo.d.ts

@@ -0,0 +1,3 @@
+import { BaseComponentProps } from "../../../../../types";
+import { VersionInfoProps } from "./types";
+export declare const VersionInfo: ({ chipProps, className, tooltipProps, versionInfo, }: BaseComponentProps & VersionInfoProps) => JSX.Element | null;

package/lib/components/Layout/components/Footer/components/VersionInfo/versionInfo.js

@@ -0,0 +1,10 @@
+import { Tooltip } from "@mui/material";
+import React from "react";
+import { Title } from "./components/Tooltip/components/Title/title";
+import { CHIP_PROPS, TOOLTIP_PROPS } from "./constants";
+import { getLabel } from "./utils";
+import { StyledChip } from "./versionInfo.styles";
+export const VersionInfo = ({ chipProps, className, tooltipProps, versionInfo, }) => {
+    return (React.createElement(Tooltip, { ...TOOLTIP_PROPS, title: React.createElement(Title, { versionInfo: versionInfo }), ...tooltipProps },
+        React.createElement(StyledChip, { ...CHIP_PROPS, className: className, label: getLabel(versionInfo), ...chipProps })));
+};

package/lib/components/Layout/components/Footer/components/VersionInfo/versionInfo.styles.d.ts

@@ -0,0 +1,5 @@
+export declare const StyledChip: import("@emotion/styled").StyledComponent<import("@mui/material").ChipOwnProps & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
+    ref?: ((instance: HTMLDivElement | null) => void | import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | import("react").RefObject<HTMLDivElement> | null | undefined;
+}, "label" | "style" | "className" | "classes" | "tabIndex" | "color" | "children" | "sx" | "variant" | "disabled" | "size" | "avatar" | "clickable" | "deleteIcon" | "icon" | "onDelete" | "skipFocusWhenDisabled"> & {
+    theme?: import("@emotion/react").Theme;
+}, {}, {}>;

package/lib/components/Layout/components/Footer/components/VersionInfo/versionInfo.styles.js

@@ -0,0 +1,9 @@
+import styled from "@emotion/styled";
+import { Chip } from "@mui/material";
+import { inkLight } from "../../../../../../styles/common/mixins/colors";
+export const StyledChip = styled(Chip) `
+  border-radius: 4px;
+  .MuiChip-label {
+    color: ${inkLight};
+  }
+`;

package/lib/components/Layout/components/Footer/footer.d.ts

@@ -2,9 +2,10 @@ import { ReactNode } from "react";
 import { Social } from "../../../common/Socials/socials";
 import { NavLinkItem } from "../Header/components/Content/components/Navigation/navigation";
 export interface FooterProps {
-    Branding: ReactNode;
+    Branding?: ReactNode;
     className?: string;
     navLinks?: NavLinkItem[];
     socials?: Social[];
+    versionInfo?: ReactNode;
 }
-export declare const Footer: ({ Branding, className, navLinks, socials, }: FooterProps) => JSX.Element;
+export declare const Footer: ({ Branding, className, navLinks, socials, versionInfo, }: FooterProps) => JSX.Element;

package/lib/components/Layout/components/Footer/footer.js

@@ -2,12 +2,13 @@ import { Toolbar } from "@mui/material";
 import React from "react";
 import { ANCHOR_TARGET } from "../../../Links/common/entities";
 import { AppBar, Link, Links, Socials } from "./footer.styles";
-export const Footer = ({ Branding, className, navLinks, socials, }) => {
+export const Footer = ({ Branding, className, navLinks, socials, versionInfo, }) => {
     return (React.createElement(AppBar, { className: className, color: "inherit", component: "footer", variant: "footer" },
         React.createElement(Toolbar, { variant: "dense" },
             Branding,
-            (navLinks || socials) && (React.createElement(Links, null,
+            (navLinks || socials || versionInfo) && (React.createElement(Links, null,
                 navLinks &&
                     navLinks.map(({ label, target = ANCHOR_TARGET.SELF, url }, i) => (React.createElement(Link, { key: `${url}${i}`, label: label, target: target, url: url }))),
-                socials && React.createElement(Socials, { buttonSize: "small", socials: socials }))))));
+                socials && React.createElement(Socials, { buttonSize: "small", socials: socials }),
+                versionInfo)))));
 };

package/lib/components/Layout/components/Outline/components/ContentsTab/contentsTab.styles.d.ts

@@ -1,5 +1,5 @@
 export declare const Tab: import("@emotion/styled").StyledComponent<import("@mui/material").TabOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
     ref?: ((instance: HTMLDivElement | null) => void | import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | import("react").RefObject<HTMLDivElement> | null | undefined;
-}, "label" | "style" | "className" | "classes" | "tabIndex" | "children" | "sx" | "disabled" | "value" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "icon" | "disableFocusRipple" | "wrapped" | "iconPosition"> & {
+}, "label" | "style" | "className" | "classes" | "tabIndex" | "children" | "sx" | "disabled" | "value" | "action" | "icon" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "wrapped" | "iconPosition"> & {
     theme?: import("@emotion/react").Theme;
 }, {}, {}>;

package/lib/components/Layout/components/Outline/outline.styles.d.ts

@@ -10,7 +10,7 @@ export declare const Tabs: import("@emotion/styled").StyledComponent<import("@mu
 }, {}, {}>;
 export declare const Tab: import("@emotion/styled").StyledComponent<import("@mui/material").TabOwnProps & Omit<import("@mui/material").ButtonBaseOwnProps, "classes"> & import("@mui/material/OverridableComponent").CommonProps & Omit<Omit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, "ref"> & {
     ref?: ((instance: HTMLDivElement | null) => void | import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES[keyof import("react").DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES]) | import("react").RefObject<HTMLDivElement> | null | undefined;
-}, "label" | "style" | "className" | "classes" | "tabIndex" | "children" | "sx" | "disabled" | "value" | "action" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "icon" | "disableFocusRipple" | "wrapped" | "iconPosition"> & {
+}, "label" | "style" | "className" | "classes" | "tabIndex" | "children" | "sx" | "disabled" | "value" | "action" | "icon" | "centerRipple" | "disableRipple" | "disableTouchRipple" | "focusRipple" | "focusVisibleClassName" | "LinkComponent" | "onFocusVisible" | "TouchRippleProps" | "touchRippleRef" | "disableFocusRipple" | "wrapped" | "iconPosition"> & {
     theme?: import("@emotion/react").Theme;
 } & Props, {}, {}>;
 export {};