@gen3/frontend 0.10.46 → 0.10.48

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import React$1, { ReactElement, PropsWithChildren, ReactNode, CSSProperties } from 'react';
+import * as React$1 from 'react';
+import React__default, { 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';
@@ -13,6 +14,11 @@ type StylingOverrideWithMergeControl = Record<string, string> & {
     mergeMode?: StylingMergeMode;
 };
 
+interface TitleAndDescription {
+    title: string;
+    description?: string;
+}
+
 interface ColumnLinks {
     heading: string;
     items: ReadonlyArray<{
@@ -205,7 +211,7 @@ interface ClassProps {
     readonly className?: string;
 }
 interface HoverLinkProps extends ClassProps {
-    children?: React$1.ReactNode;
+    children?: React__default.ReactNode;
     readonly href: string;
 }
 /**
@@ -231,7 +237,7 @@ declare const HoverLink: ({ className, href, children }: HoverLinkProps) => reac
 declare const NavigationBar: ({ logo, title, items, classNames, }: NavigationProps) => ReactElement;
 //# sourceMappingURL=NavigationBar.d.ts.map
 
-type NavigationButtonProps = ButtonProps & React$1.ComponentPropsWithoutRef<'a'> & {
+type NavigationButtonProps = ButtonProps & React__default.ComponentPropsWithoutRef<'a'> & {
     $selected?: boolean;
 };
 declare const NavigationButton: ({ $selected, ...props }: NavigationButtonProps) => react_jsx_runtime.JSX.Element;
@@ -252,6 +258,17 @@ interface SummaryStatisticsConfig {
     displayFunction?: string;
 }
 
+interface SummaryChart extends Partial<TitleAndDescription> {
+    readonly chartType: string;
+    readonly valueType?: 'count' | 'percent';
+    readonly dataLabels?: Record<string, string>;
+}
+interface ChartProps {
+    data: HistogramDataArray;
+    total: number;
+    valueType?: 'count' | 'percent';
+}
+
 interface TagData {
     name: string;
     category: string;
@@ -403,6 +420,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;
@@ -415,6 +443,7 @@ interface DiscoveryIndexConfig {
         search?: SearchConfig;
         authorization: DataAuthorization;
         dataLoader?: DataLoader;
+        chartsSection?: ChartsSection;
     };
     aggregations: SummaryStatisticsConfig[];
     tags: TagsConfig;
@@ -502,12 +531,12 @@ declare const registerDiscoveryDefaultStudyPreviewRenderers: () => void;
 
 interface DiscoveryProviderValue {
     discoveryConfig: DiscoveryIndexConfig;
-    setStudyDetails: React$1.Dispatch<React$1.SetStateAction<JSONObject>>;
+    setStudyDetails: React__default.Dispatch<React__default.SetStateAction<JSONObject>>;
     studyDetails: JSONObject;
 }
 declare const useDiscoveryContext: () => DiscoveryProviderValue;
 declare const DiscoveryProvider: ({ children, discoveryIndexConfig, }: {
-    children: React$1.ReactNode;
+    children: React__default.ReactNode;
     discoveryIndexConfig: DiscoveryIndexConfig;
 }) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=DiscoveryProvider.d.ts.map
@@ -549,7 +578,7 @@ interface APICredentials {
 }
 
 declare const ProfileProvider: ({ children, profileConfig, }: {
-    children: React$1.ReactNode;
+    children: React__default.ReactNode;
     profileConfig: ProfileConfig;
 }) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=ProfileProvider.d.ts.map
@@ -568,7 +597,7 @@ declare const ResourcesFilters: ({ selectedFilters, setFilters, }: ResourcesFilt
 //# sourceMappingURL=ResourcesFilters.d.ts.map
 
 interface LoginButtonProps {
-    readonly icon?: React$1.ReactElement | string;
+    readonly icon?: React__default.ReactElement | string;
     readonly hideText?: boolean;
     className?: string;
     tooltip?: string;
@@ -659,22 +688,11 @@ declare const NoAccessModal: ({ openModal, }: {
 
 interface Gen3StandardModalsProviderProps {
     config: ModalsConfig;
-    children: React$1.ReactNode;
+    children: React__default.ReactNode;
 }
 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 }: {
@@ -687,22 +705,23 @@ declare const processRangeKeyLabel: (key: [number, number]) => string;
 /**
  * Computes the row span for each item in the charts object.
  *
- * @param { Record<string, SummaryChart>} charts - The charts object containing summary charts.
+ * @param { number } numItems - The charts object containing summary charts.
  * @param {number} [numCols=3] - The number of columns per row.
  * @returns {number[]} - An array of row spans for each item in the charts object.
  */
-declare const computeRowSpan: (charts: Record<string, SummaryChart>, numCols?: number) => Array<number>;
+declare const computeRowSpan: (numItems: number, numCols?: number) => Array<number>;
 
 interface ChartsProps {
-    index: string;
     charts: Record<string, SummaryChart>;
     counts?: number;
     data: AggregationsData;
     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: ({ charts, data, counts, isSuccess, numCols, style, showLegends, }: ChartsProps) => react_jsx_runtime.JSX.Element;
 
 interface ReactEChartsProps {
     option: EChartsOption;
@@ -728,7 +747,7 @@ interface FacetChartProps {
     readonly maxBins?: number;
     readonly valueLabel?: string;
 }
-declare const EnumFacetChart: React$1.FC<FacetChartProps>;
+declare const EnumFacetChart: React__default.FC<FacetChartProps>;
 
 type RendererFunction<T> = (props: T, ...params: any[]) => ReactNode;
 interface RendererFunctionCatalogEntry<T> {
@@ -874,14 +893,16 @@ interface ManifestFieldsConfig {
 }
 interface DataTypeConfig {
     dataType: string;
-    nodeCountTitle: string;
-    fieldMapping: ReadonlyArray<FieldToName>;
-    manifestMapping?: ManifestFieldsConfig;
+    nodeCountTitle?: string;
     accessibleFieldCheckList?: string[];
     accessibleValidationField?: string;
     tierAccessLevel?: 'libre' | 'regular' | 'private';
     tierAccessLimit?: number;
 }
+interface DataTypeConfigWithManifest extends DataTypeConfig {
+    manifestMapping?: ManifestFieldsConfig;
+    fieldMapping?: ReadonlyArray<FieldToName>;
+}
 interface DownloadButtonConfig extends DownloadButtonProps {
     dropdownId?: string;
 }
@@ -892,7 +913,7 @@ interface DropdownsWithButtonsProps extends DropdownButtonsConfig {
     dropdownItems: ReadonlyArray<DownloadButtonProps>;
 }
 interface CohortPanelConfig {
-    readonly guppyConfig: DataTypeConfig;
+    readonly guppyConfig: DataTypeConfigWithManifest;
     readonly tabTitle: string;
     readonly charts?: Record<string, SummaryChart>;
     readonly table?: SummaryTable;
@@ -968,6 +989,10 @@ declare const userHasMethodForServiceOnResource: (method: string, service: strin
 declare const focusStyles = "focus-visible:outline-none focus-visible:ring-offset-2 focus:ring-offset-white rounded-md focus-visible:ring-inset focus-visible:ring-2 focus-visible:ring-focusColor";
 
 declare const stripTrailingSlash: (str: string) => string;
+declare const SPECIAL_CASE_FIELDS: {
+    icd_10_code: string;
+};
+declare const toDisplayName: (field: string) => string;
 
 declare const isArrayOfString: (value: any) => value is Array<string>;
 declare const isTextTransform: (value: any) => value is CSSProperties["textTransform"];
@@ -1053,9 +1078,13 @@ interface ErrorCardProps {
     message: string;
     icon?: ReactElement;
 }
-declare const ErrorCard: React$1.FunctionComponent<ErrorCardProps>;
+declare const ErrorCard: React__default.FunctionComponent<ErrorCardProps>;
 //# sourceMappingURL=ErrorCard.d.ts.map
 
+declare const registerCohortDiscoveryApp: () => React$1.ReactNode;
+
+declare const registerCohortDiversityApp: () => React$1.ReactNode;
+
 interface Gen3ProviderProps {
     colors: Record<string, TenStringArray>;
     icons: RegisteredIcons;
@@ -1388,4 +1417,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, 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 };
+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, SPECIAL_CASE_FIELDS, 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, registerCohortDiscoveryApp, registerCohortDiversityApp, registerDefaultDiscoveryDataLoaders, registerDiscoveryDefaultCellRenderers, registerDiscoveryDefaultStudyPreviewRenderers, registerExplorerDefaultCellRenderers, removeKey, resourcePathFromProjectID, export_default$2 as sessionLogout, export_default$3 as sessionToken, stripTrailingSlash, toDisplayName, truncateString, unixTimeToString, useDiscoveryContext, userHasMethodForServiceOnResource };