@gen3/frontend 0.10.44 → 0.10.47

package/dist/index.d.ts

@@ -1,12 +1,93 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React$1, { ReactElement, PropsWithChildren, ReactNode, CSSProperties } from 'react';
 import { ButtonProps, TitleOrder } from '@mantine/core';
-import { JSONObject, HistogramDataArray, AggregationsData, EnumFilterValue, FacetDefinition } from '@gen3/core';
+import { HistogramDataArray, JSONObject, AggregationsData, EnumFilterValue, FacetDefinition } from '@gen3/core';
 import { MRT_RowData, MRT_Cell, MRT_Row } from 'mantine-react-table';
 import { EChartsOption, SetOptionOpts } from 'echarts';
 import { GetServerSideProps, GetStaticProps, NextPage, NextApiRequest, NextApiResponse } from 'next';
 import { IconType } from 'react-icons';
 
+type StylingOverride = Record<string, Record<string, string> | string>;
+type StylingMergeMode = 'merge' | 'replace';
+type StylingOverrideWithMergeControl = Record<string, string> & {
+    mergeMode?: StylingMergeMode;
+};
+
+interface ColumnLinks {
+    heading: string;
+    items: ReadonlyArray<{
+        text: string;
+        href?: string;
+        linkType?: 'gen3ff' | 'portal';
+    }>;
+}
+interface BottomLinks {
+    text: string;
+    href: string;
+}
+/**
+ *  A Text items for the footer
+ *
+ */
+interface FooterText {
+    text: string;
+    className?: string;
+}
+interface FooterLinks {
+    links: Array<FooterLink>;
+    className?: string;
+}
+interface FooterLink extends FooterText {
+    href: string;
+    linkType?: 'gen3ff' | 'portal';
+}
+interface FooterLink extends FooterText {
+    href: string;
+    linkType?: 'gen3ff' | 'portal';
+}
+interface FooterLogo extends FooterText {
+    logo: string;
+    description: string;
+    width: number;
+    height: number;
+    href: string;
+}
+type FooterRow = FooterLogo | FooterText | FooterLink | FooterLinks | FooterSectionProps;
+interface FooterColumnProps {
+    heading?: string;
+    rows: Array<Record<string, FooterRow>>;
+    classNames?: StylingOverrideWithMergeControl;
+}
+interface FooterSectionProps {
+    columns: ReadonlyArray<FooterColumnProps>;
+    className?: string;
+}
+interface FooterProps {
+    bottomLinks?: ReadonlyArray<BottomLinks>;
+    columnLinks?: ReadonlyArray<ColumnLinks>;
+    footerLogos?: ReadonlyArray<FooterLogo>;
+    footerRightLogos?: ReadonlyArray<FooterLogo>;
+    rightSection?: FooterSectionProps;
+    leftSection?: FooterSectionProps;
+    classNames?: StylingOverrideWithMergeControl;
+    customFooter?: ReactElement;
+}
+
+declare const Footer: ({ rightSection, leftSection, classNames, }: FooterProps) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=Footer.d.ts.map
+
+interface ClassProps$1 {
+    readonly className?: string;
+}
+interface Gen3LinkProps extends ClassProps$1 {
+    readonly href: string;
+    readonly linkType?: string;
+    readonly text: string;
+    readonly showExternalIcon?: boolean;
+}
+declare const Gen3Link: ({ className, href, linkType, text, showExternalIcon, }: PropsWithChildren<Gen3LinkProps>) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=Gen3Link.d.ts.map
+
 declare enum ContentType {
     Text = "text",
     TextArray = "textArray",
@@ -47,7 +128,7 @@ interface NameAndIcon {
     readonly name: string;
     readonly rightIcon?: string;
     readonly leftIcon?: string;
-    readonly classNames: Record<string, string>;
+    readonly classNames: StylingOverrideWithMergeControl;
     readonly drawBorder?: boolean;
 }
 interface TopIconButtonProps extends NameAndIcon {
@@ -57,41 +138,24 @@ interface TopIconButtonProps extends NameAndIcon {
 interface TopBarProps {
     readonly items: TopIconButtonProps[];
     readonly loginButtonVisibility?: LoginButtonVisibility;
-    readonly classNames?: Record<string, string>;
+    readonly classNames?: StylingOverrideWithMergeControl;
 }
 
-interface BottomLinks {
-    text: string;
-    href: string;
-}
-interface ColumnLinks {
-    heading: string;
-    items: ReadonlyArray<{
-        text: string;
-        href?: string;
-        linkType?: 'gen3ff' | 'portal';
-    }>;
-}
-interface FooterLogo {
-    readonly logo: string;
-    readonly description: string;
-    readonly width: number;
-    readonly height: number;
-}
-interface FooterProps {
-    readonly bottomLinks?: ReadonlyArray<BottomLinks>;
-    readonly columnLinks?: ReadonlyArray<ColumnLinks>;
-    readonly footerLogos?: ReadonlyArray<ReadonlyArray<FooterLogo>>;
-    readonly footerRightLogos?: ReadonlyArray<ReadonlyArray<FooterLogo>>;
-    readonly classNames?: Record<string, string>;
+interface BannerProps {
+    readonly message: string;
+    readonly level: 'INFO' | 'WARNING' | 'ERROR';
+    readonly dismissible: boolean;
+    readonly isExternalLink: boolean;
+    readonly id: number;
 }
+
 interface NavigationButtonProps$1 {
     readonly icon: string;
     readonly tooltip: string;
     readonly href: string;
     readonly name: string;
     readonly iconHeight?: string;
-    readonly classNames?: Record<string, string>;
+    readonly classNames?: StylingOverrideWithMergeControl;
 }
 interface NavigationBarLogo {
     readonly src: string;
@@ -100,14 +164,15 @@ interface NavigationBarLogo {
     readonly width?: number;
     readonly height?: number;
     readonly basePath?: string;
-    readonly classNames?: Record<string, string>;
+    readonly divider?: boolean;
+    readonly classNames?: StylingOverrideWithMergeControl;
 }
 interface NavigationProps {
     readonly logo?: NavigationBarLogo;
     readonly items?: NavigationButtonProps$1[];
     readonly title?: string;
     readonly loginIcon?: ReactElement | string;
-    readonly classNames?: Record<string, string>;
+    readonly classNames?: StylingOverrideWithMergeControl;
 }
 interface HeaderData {
     title: string;
@@ -115,29 +180,15 @@ interface HeaderData {
     key: string;
 }
 interface HeaderProps {
-    readonly top: TopBarProps;
-    readonly navigation: NavigationProps;
-    readonly type?: 'horizontal' | 'vertical' | 'original';
+    top: TopBarProps;
+    navigation: NavigationProps;
+    banners?: Array<BannerProps>;
+    type?: 'horizontal' | 'vertical' | 'original';
 }
 interface MainContentProps {
     fixed: boolean;
 }
 
-declare const Footer: ({ bottomLinks, columnLinks, footerLogos, footerRightLogos, classNames, }: FooterProps) => react_jsx_runtime.JSX.Element;
-//# sourceMappingURL=Footer.d.ts.map
-
-interface ClassProps$1 {
-    readonly className?: string;
-}
-interface Gen3LinkProps extends ClassProps$1 {
-    readonly href: string;
-    readonly linkType?: string;
-    readonly text: string;
-    readonly showExternalIcon?: boolean;
-}
-declare const Gen3Link: ({ className, href, linkType, text, showExternalIcon, }: PropsWithChildren<Gen3LinkProps>) => react_jsx_runtime.JSX.Element;
-//# sourceMappingURL=Gen3Link.d.ts.map
-
 /**
  * Header component.
  *
@@ -147,7 +198,7 @@ declare const Gen3Link: ({ className, href, linkType, text, showExternalIcon, }:
  * @param {string} props.type - The type of header to render. Default value is 'original'.
  * @returns {JSX.Element} - The rendered Header component.
  */
-declare const Header: ({ top, navigation, type }: HeaderProps) => react_jsx_runtime.JSX.Element;
+declare const Header: ({ top, navigation, banners, type, }: HeaderProps) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=Header.d.ts.map
 
 interface ClassProps {
@@ -175,9 +226,9 @@ declare const HoverLink: ({ className, href, children }: HoverLinkProps) => reac
  * @param {Object} NavigationProps.logo - The logo object
  * @param {Array} NavigationProps.items - The array of navigation items
  * @param {Object} NavigationProps.classNames - The custom class names for different elements of the NavigationBar
- * @returns {JSX.Element} The rendered NavigationBar component
+ * @returns {ReactElement} The rendered NavigationBar component
  */
-declare const NavigationBar: ({ logo, items, classNames, }: NavigationProps) => react_jsx_runtime.JSX.Element;
+declare const NavigationBar: ({ logo, title, items, classNames, }: NavigationProps) => ReactElement;
 //# sourceMappingURL=NavigationBar.d.ts.map
 
 type NavigationButtonProps = ButtonProps & React$1.ComponentPropsWithoutRef<'a'> & {
@@ -187,8 +238,8 @@ declare const NavigationButton: ({ $selected, ...props }: NavigationButtonProps)
 //# sourceMappingURL=NavigationButton.d.ts.map
 
 interface NavPageLayoutProps {
-    headerProps: HeaderProps;
-    footerProps: FooterProps;
+    headerProps: Readonly<HeaderProps>;
+    footerProps: Readonly<FooterProps>;
     mainProps?: Partial<MainContentProps>;
     headerData: HeaderData;
 }
@@ -201,6 +252,18 @@ interface SummaryStatisticsConfig {
     displayFunction?: string;
 }
 
+interface SummaryChart {
+    readonly title: string;
+    readonly chartType: 'bar' | 'horizontalStacked' | 'fullPie' | 'donut';
+    readonly valueType?: 'count' | 'percent';
+    readonly dataLabels?: Record<string, string>;
+}
+interface ChartProps {
+    data: HistogramDataArray;
+    total: number;
+    valueType?: 'count' | 'percent';
+}
+
 interface TagData {
     name: string;
     category: string;
@@ -352,6 +415,17 @@ interface TagsConfig {
     tagCategories: TagCategory[];
     showUnknownTags?: boolean;
 }
+interface ChartsSection {
+    enabled: boolean;
+    title?: string;
+    showLegends?: {
+        enabled: boolean;
+        showSwitch?: boolean;
+    };
+    charts?: Array<SummaryChart & {
+        data: string[];
+    }>;
+}
 interface DiscoveryIndexConfig {
     guidType?: string;
     studyField?: string;
@@ -364,6 +438,7 @@ interface DiscoveryIndexConfig {
         search?: SearchConfig;
         authorization: DataAuthorization;
         dataLoader?: DataLoader;
+        chartsSection?: ChartsSection;
     };
     aggregations: SummaryStatisticsConfig[];
     tags: TagsConfig;
@@ -613,17 +688,6 @@ interface Gen3StandardModalsProviderProps {
 declare const Gen3ModalsProvider: ({ config, children, }: Gen3StandardModalsProviderProps) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=Gen3ModalsProvider.d.ts.map
 
-interface SummaryChart {
-    readonly title: string;
-    readonly chartType: string;
-    readonly valueType?: 'count' | 'percent';
-}
-interface ChartProps {
-    data: HistogramDataArray;
-    total: number;
-    valueType?: 'count' | 'percent';
-}
-
 declare const capitalize: (original: string) => string;
 declare const truncateString: (str: string, n: number) => string;
 declare const removeKey: (key: any, { [key]: _, ...rest }: {
@@ -650,8 +714,10 @@ interface ChartsProps {
     isSuccess: boolean;
     isError?: boolean;
     numCols?: number;
+    style?: 'tile' | 'box';
+    showLegends?: boolean;
 }
-declare const Charts: ({ index, charts, data, counts, isSuccess, numCols, }: ChartsProps) => react_jsx_runtime.JSX.Element;
+declare const Charts: ({ index, charts, data, counts, isSuccess, numCols, style, showLegends, }: ChartsProps) => react_jsx_runtime.JSX.Element;
 
 interface ReactEChartsProps {
     option: EChartsOption;
@@ -729,6 +795,7 @@ declare class RenderFactoryTypedInstance<T> implements RendererFactoryInterface<
 interface DetailsPanelComponentProps extends Record<string, unknown> {
     id?: string;
     onClose?: (id?: string) => void;
+    row?: MRT_Row<Record<string, any>>;
 }
 
 interface TableDetailsPanelProps extends DetailsPanelComponentProps {
@@ -792,8 +859,6 @@ interface FieldToName {
     readonly name: string;
 }
 
-type StylingOverride = Record<string, Record<string, string> | string>;
-
 interface DownloadButtonProps {
     enabled?: boolean;
     type?: string;
@@ -922,6 +987,11 @@ declare const stripTrailingSlash: (str: string) => string;
 declare const isArrayOfString: (value: any) => value is Array<string>;
 declare const isTextTransform: (value: any) => value is CSSProperties["textTransform"];
 
+declare const isPropertyKey: (value: unknown) => value is PropertyKey;
+declare const hasOwnProperty: <X extends object, Y extends PropertyKey>(obj?: X, prop?: Y) => obj is X & Record<Y, unknown>;
+declare const getParamsValueAsString: (params?: JSONObject, key?: string) => string | undefined;
+declare const extractObjectKey: <T extends object>(obj: T) => keyof T | undefined;
+
 /**
  * Retrieves navigation page layout properties from configuration.
  * Note: GEN3_COMMONS_NAME depends on siteConfig.json value in the data commons package
@@ -1193,8 +1263,8 @@ declare const AuthzPage: ({ headerProps, footerProps, authz }: Props) => react_j
 declare const AdminAuthZPageGetServerSideProps: () => Promise<{
     props: {
         authz: Authz;
-        headerProps: HeaderProps;
-        footerProps: FooterProps;
+        headerProps: Readonly<HeaderProps>;
+        footerProps: Readonly<FooterProps>;
         mainProps?: Partial<MainContentProps>;
         headerData: HeaderData;
     };
@@ -1333,4 +1403,4 @@ declare function export_default$1(req: NextApiRequest, res: NextApiResponse): Pr
 
 declare function export_default(req: NextApiRequest, res: NextApiResponse): Promise<void>;
 
-export { AISearchPageGetServerSideProps, AdminAuthZPageGetServerSideProps, AiSearch, AISearchPage as AiSearchPage, AuthzPage, BaseModal, CellRenderFunctionProps, CellRendererFunctionProps, ChartProps, Charts, CohortBuilder, CohortBuilderConfiguration, ColorThemePage, ColorThemePageGetServerSideProps, ContentSource, CreateCredentialsAPIKeyModal, CrosswalkPage, CrosswalkPageGetServerSideProps, Custom404Page, DictionaryPage, DictionaryPageGetServerSideProps, DiscoveryCellRendererFactory, DiscoveryConfig, DiscoveryProvider as DiscoveryConfigProvider, DiscoveryIndexPanel, DiscoveryPage, DiscoveryPageGetServerSideProps, DiscoveryRowRendererFactory, EnumFacetChart, ErrorCard, ExplorerPage, ExplorerPageGetServerSideProps, ExplorerTableCellRendererFactory, ExplorerTableDetailsPanelFactory, FirstTimeModal, Fonts, Footer, FooterProps, Gen3Link, Gen3ModalsProvider, Gen3Provider, GqlQueryEditor, Header, HeaderProps, HoverLink, LandingPage, LandingPageGetStaticProps, LoginButton, LoginConfig, LoginPage, LoginPageGetServerSideProps, LoginPanel, LoginProvidersPanel, ModalsConfig, NavPageLayout, NavPageLayoutProps, NavigationBar, NavigationButton, NavigationProps, NoAccessModal, ProfileConfig, ProfilePage, ProfilePageGetServerSideProps, ProfileProvider, QueryPage, QueryPageGetServerSideProps, ReactECharts, ReactEChartsProps, RegisteredIcons, ResourcesFilters, RowRenderFunctionParams, SessionConfiguration, SessionExpiredModal, StudyDetailsField, StudyGroup, SubmissionPage, SubmissionPageGetServerSideProps, SummaryChart, TableDetailsPanelProps, TagCloud, TagData, TagsConfig, TailwindConfig, TenStringArray, TopBarProps, User$1 as User, WorkspaceConfiguration, WorkspacesPage, WorkspacesPageGetServerSideProps, WorkspacesPanel, capitalize, computeRowSpan, create10ColorAccessibleContrast, create10ColorPallet, export_default$1 as credentialsLogin, export_default as credentialsLogout, focusStyles, getCurrentUnixTimestamp, getNavPageLayoutPropsFromConfig, getTagInfo, isArrayOfString, isTextTransform, processLabel, processRangeKeyLabel, registerCohortBuilderDefaultPreviewRenderers, registerDefaultDiscoveryDataLoaders, registerDiscoveryDefaultCellRenderers, registerDiscoveryDefaultStudyPreviewRenderers, registerExplorerDefaultCellRenderers, removeKey, resourcePathFromProjectID, export_default$2 as sessionLogout, export_default$3 as sessionToken, stripTrailingSlash, truncateString, unixTimeToString, useDiscoveryContext, userHasMethodForServiceOnResource };
+export { AISearchPageGetServerSideProps, AdminAuthZPageGetServerSideProps, AiSearch, AISearchPage as AiSearchPage, AuthzPage, type BannerProps, BaseModal, type CellRenderFunctionProps, type CellRendererFunctionProps, type ChartProps, Charts, CohortBuilder, type CohortBuilderConfiguration, ColorThemePage, ColorThemePageGetServerSideProps, ContentSource, CreateCredentialsAPIKeyModal, CrosswalkPage, CrosswalkPageGetServerSideProps, Custom404Page, DictionaryPage, DictionaryPageGetServerSideProps, DiscoveryCellRendererFactory, type DiscoveryConfig, DiscoveryProvider as DiscoveryConfigProvider, DiscoveryIndexPanel, DiscoveryPage, DiscoveryPageGetServerSideProps, DiscoveryRowRendererFactory, EnumFacetChart, ErrorCard, ExplorerPage, ExplorerPageGetServerSideProps, ExplorerTableCellRendererFactory, ExplorerTableDetailsPanelFactory, FirstTimeModal, type Fonts, Footer, type FooterProps, Gen3Link, Gen3ModalsProvider, Gen3Provider, GqlQueryEditor, Header, type HeaderProps, HoverLink, LandingPage, LandingPageGetStaticProps, LoginButton, type LoginConfig, LoginPage, LoginPageGetServerSideProps, LoginPanel, LoginProvidersPanel, type ModalsConfig, NavPageLayout, type NavPageLayoutProps, NavigationBar, NavigationButton, type NavigationProps, NoAccessModal, type ProfileConfig, ProfilePage, ProfilePageGetServerSideProps, ProfileProvider, QueryPage, QueryPageGetServerSideProps, ReactECharts, type ReactEChartsProps, type RegisteredIcons, ResourcesFilters, type RowRenderFunctionParams, type SessionConfiguration, SessionExpiredModal, type StudyDetailsField, StudyGroup, SubmissionPage, SubmissionPageGetServerSideProps, type SummaryChart, type TableDetailsPanelProps, TagCloud, type TagData, type TagsConfig, TailwindConfig, type TenStringArray, type TopBarProps, User$1 as User, type WorkspaceConfiguration, WorkspacesPage, WorkspacesPageGetServerSideProps, WorkspacesPanel, capitalize, computeRowSpan, create10ColorAccessibleContrast, create10ColorPallet, export_default$1 as credentialsLogin, export_default as credentialsLogout, extractObjectKey, focusStyles, getCurrentUnixTimestamp, getNavPageLayoutPropsFromConfig, getParamsValueAsString, getTagInfo, hasOwnProperty, isArrayOfString, isPropertyKey, isTextTransform, processLabel, processRangeKeyLabel, registerCohortBuilderDefaultPreviewRenderers, registerDefaultDiscoveryDataLoaders, registerDiscoveryDefaultCellRenderers, registerDiscoveryDefaultStudyPreviewRenderers, registerExplorerDefaultCellRenderers, removeKey, resourcePathFromProjectID, export_default$2 as sessionLogout, export_default$3 as sessionToken, stripTrailingSlash, truncateString, unixTimeToString, useDiscoveryContext, userHasMethodForServiceOnResource };