@gen3/frontend 0.10.98 → 0.11.0

package/dist/index.d.ts

@@ -127,11 +127,17 @@ interface NavigationProps {
     readonly loginIcon?: ReactElement | string;
     readonly classNames?: StylingOverrideWithMergeControl;
 }
-interface HeaderData {
+interface HeaderMetadata {
     title: string;
     content: string;
     key: string;
 }
+/**
+ * Type guard to check if an object is of type HeaderMetadata
+ * @param obj - The object to check
+ * @returns True if the object is a valid HeaderMetadata
+ */
+declare const isHeaderMetadata: (obj: unknown) => obj is HeaderMetadata;
 /**
  * Sitewide props that can be passed to Pages
  */
@@ -183,7 +189,7 @@ interface Gen3AppConfigData {
     version?: string;
     description?: string;
     schema?: JSONObject;
-    headerMetadata?: HeaderData;
+    headerMetadata?: HeaderMetadata;
 }
 
 interface ServiceColorAndLabel {
@@ -363,6 +369,15 @@ interface ChartProps {
     };
     showLegendInChart?: boolean;
 }
+interface CollapsableChartsPanelConfiguration {
+    enabled: boolean;
+    title?: string;
+    showLegends?: {
+        enabled: boolean;
+        showSwitch?: boolean;
+    };
+    charts?: Record<string, SummaryChart>;
+}
 
 interface ChartsProps {
     charts: Record<string, SummaryChart>;
@@ -377,6 +392,16 @@ interface ChartsProps {
 declare const Charts: ({ charts, data, counts, isSuccess, numCols, style, showLegends, }: ChartsProps) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=Charts.d.ts.map
 
+interface ChartsPanelProps {
+    config: CollapsableChartsPanelConfiguration;
+    data: AggregationsData;
+    isFetching?: boolean;
+    isSuccess?: boolean;
+    isError?: boolean;
+}
+declare const CollapsableCharts: ({ config, data }: ChartsPanelProps) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=CollapsableCharts.d.ts.map
+
 interface ReactEChartsProps {
     option: EChartsOption;
     style?: CSSProperties;
@@ -793,6 +818,7 @@ interface DropdownsWithButtonsProps extends DropdownButtonsConfig {
 interface CohortPanelConfiguration {
     guppyConfig: DataTypeConfigWithManifest;
     tabTitle: string;
+    chartsSection?: CollapsableChartsPanelConfiguration;
     charts?: Record<string, SummaryChart>;
     table?: SummaryTable;
     filters?: TabsConfig;
@@ -1194,9 +1220,9 @@ interface NavPageLayoutProps {
     headerProps: Readonly<HeaderProps>;
     footerProps: Readonly<FooterProps>;
     mainProps?: Partial<MainContentProps>;
-    headerData: HeaderData;
+    headerMetadata: HeaderMetadata;
 }
-declare const NavPageLayout: ({ headerProps, footerProps, mainProps, headerData, children, }: PropsWithChildren<NavPageLayoutProps>) => react_jsx_runtime.JSX.Element;
+declare const NavPageLayout: ({ headerProps, footerProps, mainProps, headerMetadata, children, }: PropsWithChildren<NavPageLayoutProps>) => react_jsx_runtime.JSX.Element;
 
 interface SummaryStatisticsConfig {
     name: string;
@@ -1441,18 +1467,6 @@ interface DataLoader {
     dataFetchArgs?: JSONObject;
     sortingAndPagination?: 'client' | 'server';
 }
-interface SummaryChartWithField extends SummaryChart {
-    field: string;
-}
-interface ChartsSection {
-    enabled: boolean;
-    title?: string;
-    showLegends?: {
-        enabled: boolean;
-        showSwitch?: boolean;
-    };
-    charts?: Record<string, SummaryChartWithField>;
-}
 interface DiscoveryIndexConfig {
     guidType?: string;
     studyField?: string;
@@ -1465,7 +1479,7 @@ interface DiscoveryIndexConfig {
         search?: SearchConfig;
         authorization: DataAuthorization;
         dataLoader?: DataLoader;
-        chartsSection?: ChartsSection;
+        chartsSection?: CollapsableChartsPanelConfiguration;
     };
     aggregations: SummaryStatisticsConfig[];
     tags: TagsConfig;
@@ -1585,6 +1599,37 @@ interface StudyTabGroupProps extends StudyTabGroup {
 declare const StudyGroup: ({ data, header, fields }: StudyTabGroupProps) => react_jsx_runtime.JSX.Element | null;
 //# sourceMappingURL=StudyGroup.d.ts.map
 
+declare const StudyProvider: ({ children, }: {
+    children: React__default.ReactNode;
+}) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=StudyProvider.d.ts.map
+
+/**
+ * Non tabbed version of the StudyDetailsPanel
+ */
+
+interface SinglePageStudyDetailsPanelProps {
+    readonly data: JSONObject;
+    readonly studyConfig?: StudyPageConfig;
+    readonly authorization?: DataAuthorization;
+}
+declare const SinglePageStudyDetailsPanel: ({ data, studyConfig, authorization, }: SinglePageStudyDetailsPanelProps) => ReactElement;
+//# sourceMappingURL=SinglePageStudyDetailsPanel.d.ts.map
+
+interface StudyDetailsPanelProps {
+    readonly data: JSONObject;
+    readonly studyConfig: StudyDetailView;
+}
+declare const StudyDetailsPanel: ({ data, studyConfig, }: StudyDetailsPanelProps) => ReactElement;
+//# sourceMappingURL=StudyDetailsPanel.d.ts.map
+
+interface StudyGroupPanelProps {
+    readonly groups: StudyTabGroup[];
+    readonly data: JSONObject;
+}
+declare const StudyGroupPanel: ({ data, groups }: StudyGroupPanelProps) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=StudyGroupPanel.d.ts.map
+
 interface TagInfo {
     color: string;
     display: boolean;
@@ -1695,10 +1740,16 @@ interface AnalysisToolConfiguration {
     hasDemo?: boolean;
     loginRequired: boolean;
     href: string;
+    appId?: string;
     count?: number;
+    countIndex?: string;
     countUnits?: string;
+    noDataTooltip?: string;
     cardType?: 'regular' | 'compact';
     btnText?: string;
+    tags?: Array<string>;
+    readonly rightComponent?: React.FC;
+    readonly selectionScreen?: React.FC;
 }
 interface AnalysisCenterConfiguration extends Gen3AppConfigData {
     tools: Array<AnalysisToolConfiguration>;
@@ -1737,6 +1788,16 @@ declare const AnalysisCenter: ({ tools, showFilterAndSort, }: AnalysisCenterConf
 declare const AnalysisCenterWithSections: React__default.FC<AnalysisCenterWithSectionsConfiguration>;
 //# sourceMappingURL=AnalysisCenterWithSections.d.ts.map
 
+interface StaticNotebookViewerProps$1 {
+    notebook: string;
+}
+declare const StaticNotebookViewer: ({ notebook }: StaticNotebookViewerProps$1) => react_jsx_runtime.JSX.Element;
+
+interface StaticNotebookViewerProps {
+    notebook: string;
+}
+declare const StaticNotebookIFrame: ({ notebook }: StaticNotebookViewerProps) => react_jsx_runtime.JSX.Element;
+
 /**
  * Retrieves navigation page layout properties from configuration.
  * Note: GEN3_COMMONS_NAME depends on siteConfig.json value in the data commons package
@@ -1808,14 +1869,14 @@ declare const registerCohortDiscoveryApp: () => React$1.ReactNode;
 
 declare const registerCohortSimilarityApp: () => React$1.ReactNode;
 
-interface DictionaryConfig extends Record<string, string | number | boolean | undefined | HeaderData> {
+interface DictionaryConfig extends Record<string, string | number | boolean | undefined | HeaderMetadata> {
     showGraph: boolean;
     showDownloads: boolean;
     historyStorageId: string;
     maxHistoryItems: number;
     version?: string;
     description?: string;
-    headerMetadata?: HeaderData;
+    headerMetadata?: HeaderMetadata;
 }
 interface DictionaryProps {
     config: DictionaryConfig;
@@ -2055,7 +2116,7 @@ declare const AdminAuthZPageGetServerSideProps: () => Promise<{
         headerProps: Readonly<HeaderProps>;
         footerProps: Readonly<FooterProps>;
         mainProps?: Partial<MainContentProps>;
-        headerData: HeaderData;
+        headerMetadata: HeaderMetadata;
     };
 }>;
 
@@ -2119,7 +2180,7 @@ declare const AnalysisEditorPageGetServerSideProps: () => Promise<{
         headerProps: Readonly<HeaderProps>;
         footerProps: Readonly<FooterProps>;
         mainProps?: Partial<MainContentProps>;
-        headerData: HeaderData;
+        headerMetadata: HeaderMetadata;
     };
 }>;
 
@@ -2300,5 +2361,7 @@ declare function export_default$1(req: NextApiRequest, res: NextApiResponse): Pr
 
 declare function export_default(req: NextApiRequest, res: NextApiResponse): Promise<void>;
 
-export { AISearchPageGetServerSideProps, AccessLevel, ActionBar, ActionButton, AdminAuthZPageGetServerSideProps, AiSearch, AISearchPage as AiSearchPage, AnalysisCenter, AnalysisCenterWithSections, AnalysisEditorPage, AnalysisEditorPageGetServerSideProps, AnalysisPage, AnalysisPageGetServerSideProps, AuthzPage, BAD_DATA_MESSAGE, Banner, BaseModal, Charts, CohortBuilder, CohortManager, CollapsableSidebar, ColorThemePage, ColorThemePageGetServerSideProps, _default as ContentSource, CreateCredentialsAPIKeyModal, CrosswalkPage, CrosswalkPageGetServerSideProps, Custom404Page, DAYS_IN_YEAR, DEFAULT_MAXIMUM, DEFAULT_MINIMUM, DEFAULT_VISIBLE_ITEMS, DataLibraryPage, DataLibraryPageGetServerSideProps, DictionaryPage, DictionaryPageGetServerSideProps, DiscoveryCellRendererFactory, DiscoveryProvider as DiscoveryConfigProvider, DiscoveryIndexPanel, DiscoveryPage, DiscoveryPageGetServerSideProps, DiscoveryRowRendererFactory, DropdownButton, EnumFacet, EnumFacetChart, ErrorCard, ExactValueFacet, ExplorerPage, ExplorerPageGetServerSideProps, ExplorerPageGetServerSidePropsForConfigId, ExplorerTableCellRendererFactory, ExplorerTableDetailsPanelFactory, FacetControlsHeader, FacetExpander, FacetSelector, FacetSortPanel, FacetTabs, FirstTimeModal, Footer, Gen3Button, Gen3ButtonReverse, Gen3Link, Gen3ModalsProvider, Gen3Provider, GqlQueryEditor, Header, HoverLink, LandingPage, LandingPageGetServerSideProps, LoginButton, LoginPage, LoginPageGetServerSideProps, LoginPanel, LoginProvidersPanel, MinutesToMilliseconds, MultiSelectValueFacet, NavPageLayout, NavigationBar, NavigationButton, NoAccessModal, NotebookLitePage, NotebookLitePageGetStaticProps, ProfilePage, ProfilePageGetServerSideProps, ProfileProvider, ProtectedContent, QueryExpression, QueryExpressionContext, QueryExpressionSection, QueryPage, QueryPageGetServerSideProps, RangeFacet, ReactECharts, ResourcesFilters, SPECIAL_CASE_FIELDS, SessionExpiredModal, StudyGroup, SubmissionPage, SubmissionPageGetServerSideProps, TabbedCohortBuilder, TabbedCohortBuilderPage, TabbedCohortBuilderPageGetServerSideProps, TagCloud, TailwindConfig, TopBar, UploadJSONButton, User$1 as User, Workspace, WorkspaceNoAccessPage, WorkspaceNoAccessPageServerSideProps, WorkspacePage, WorkspacePageGetServerSideProps, accessibleFieldName, addIntersectionToIncludes, addUnion, export_default as analysisApiCohortDiscovery, buildNested, capitalize, classifyFacets, compareKeysAscending, compareKeysDescending, computeRowSpan, convertMinutesToMilliseconds, convertPathsToTree, convertSecondsToMilliseconds, convertToStringArray, create10ColorAccessibleContrast, create10ColorPallet, createMantineTheme, export_default$2 as credentialsLogin, export_default$1 as credentialsLogout, extractObjectKey, extractRangeValues, focusStyles, getAllFieldsFromFilterConfigs, getCurrentUnixTimestamp, getNavPageLayoutPropsFromConfig, getParamsValueAsString, getTagInfo, hasOwnProperty, isArrayOfString, isEnumFacetResponse, isPropertyKey, isTextTransform, mapFacetSortToSortType, processBucketData, processLabel, processRangeData, processRangeKeyLabel, registerCohortBuilderDefaultPreviewRenderers, registerCohortDiscoveryApp, registerCohortSimilarityApp, registerDefaultDiscoveryDataLoaders, registerDiscoveryDefaultCellRenderers, registerDiscoveryDefaultStudyPreviewRenderers, registerExplorerDefaultCellRenderers, registerMetadataSchemaApp, removeIntersectionFromEnum, removeKey, removeUnion, resourcePathFromProjectID, export_default$3 as sessionLogout, export_default$4 as sessionToken, stripTrailingSlash, toDisplayName, truncateString, unixTimeToString, updateFacetEnum, useClearFilters, useDiscoveryContext, useExtractEnumFilterValues, useExtractRangeFilterValues, useFieldNameToTitle, useGetFacetFilters, useUpdateFilters, userHasMethodForServiceOnResource };
-export type { AdvancedRangeFacetHooks, AllowableRange, AnalysisCenterSection, AnalysisCenterWithSectionsConfiguration, AnalysisPageLayoutProps, AnalysisToolConfiguration, AuthorizationValues, BannerLevelCategories, BannerProps, CellRenderFunctionProps, CellRendererFunctionProps, ChartProps, ClearFacetFunction, ClearFacetHook, ClearIndexedFacetFunction, CohortBuilderCategoryConfig, CohortBuilderConfiguration, CohortBuilderProps, CohortBuilderTabCategoryConfig, CohortPanelConfiguration, CustomFacetHooks, DataAuthorization, DiscoveryConfig, EnumChartProps, EnumFacetData, EnumFacetDataChangedFunction, EnumFacetDataHooks, EnumFacetResponse, EnumOperandValue, ExplorerPageProps, FacetCardProps, FacetCommonHooks, FacetDataHooks, FacetRequiredHooks, FacetResponse, FacetSortType, FacetType, FieldNameToTitleFunction, FieldToName, Fonts, FooterProps, FromToRange, FromToRangeValues, GetEnumFacetDataFunction, GetFacetCombineModeFunction, GetFacetDataFunction, GetRangeFacetDataFunction, GetRangeFacetWithDefinedRangesDataFunction, GetTotalCountsFunction, HeaderProps, LoginConfig, ModalsConfig, NavPageLayoutProps, NavigationProps, NumericFacetCardProps, NumericRangeFacetHooks, ProfileConfig, QueryOptions, RangeFacetHooks, RangeFacetResponse, RangeFromOp, RangeToOp, ReactEChartsProps, RegisteredIcons, RowRenderFunctionParams, SelectFacetFilterFunction, SelectedFields$1 as SelectedFields, SessionConfiguration, SetFacetCombineModeFunction, SortType, StudyDetailsField, SummaryChart, TabbedCohortBuilderConfiguration, TabbedCohortBuilderFacetConfig, TableDetailsPanelProps, TagData, TagsConfig, TenStringArray, TopBarProps, UpdateFacetFilterFunction, UpdateFacetFilterHook, UserAuthMapping, WorkspaceConfig };
+declare const staticNotebookAPI: (req: NextApiRequest, res: NextApiResponse) => Promise<void | Response>;
+
+export { AISearchPageGetServerSideProps, AccessLevel, ActionBar, ActionButton, AdminAuthZPageGetServerSideProps, AiSearch, AISearchPage as AiSearchPage, AnalysisCenter, AnalysisCenterWithSections, AnalysisEditorPage, AnalysisEditorPageGetServerSideProps, AnalysisPage, AnalysisPageGetServerSideProps, AuthzPage, BAD_DATA_MESSAGE, Banner, BaseModal, Charts, CohortBuilder, CohortManager, CollapsableCharts, CollapsableSidebar, ColorThemePage, ColorThemePageGetServerSideProps, _default as ContentSource, CreateCredentialsAPIKeyModal, CrosswalkPage, CrosswalkPageGetServerSideProps, Custom404Page, DAYS_IN_YEAR, DEFAULT_MAXIMUM, DEFAULT_MINIMUM, DEFAULT_VISIBLE_ITEMS, DataLibraryPage, DataLibraryPageGetServerSideProps, DictionaryPage, DictionaryPageGetServerSideProps, DiscoveryCellRendererFactory, DiscoveryProvider as DiscoveryConfigProvider, DiscoveryIndexPanel, DiscoveryPage, DiscoveryPageGetServerSideProps, DiscoveryRowRendererFactory, DropdownButton, EnumFacet, EnumFacetChart, ErrorCard, ExactValueFacet, ExplorerPage, ExplorerPageGetServerSideProps, ExplorerPageGetServerSidePropsForConfigId, ExplorerTableCellRendererFactory, ExplorerTableDetailsPanelFactory, FacetControlsHeader, FacetExpander, FacetSelector, FacetSortPanel, FacetTabs, FirstTimeModal, Footer, Gen3Button, Gen3ButtonReverse, Gen3Link, Gen3ModalsProvider, Gen3Provider, GqlQueryEditor, Header, HoverLink, LandingPage, LandingPageGetServerSideProps, LoginButton, LoginPage, LoginPageGetServerSideProps, LoginPanel, LoginProvidersPanel, MinutesToMilliseconds, MultiSelectValueFacet, NavPageLayout, NavigationBar, NavigationButton, NoAccessModal, NotebookLitePage, NotebookLitePageGetStaticProps, ProfilePage, ProfilePageGetServerSideProps, ProfileProvider, ProtectedContent, QueryExpression, QueryExpressionContext, QueryExpressionSection, QueryPage, QueryPageGetServerSideProps, RangeFacet, ReactECharts, ResourcesFilters, SPECIAL_CASE_FIELDS, SessionExpiredModal, SinglePageStudyDetailsPanel, StaticNotebookIFrame, StaticNotebookViewer, StudyDetailsPanel, StudyGroup, StudyGroupPanel, StudyProvider, SubmissionPage, SubmissionPageGetServerSideProps, TabbedCohortBuilder, TabbedCohortBuilderPage, TabbedCohortBuilderPageGetServerSideProps, TagCloud, TailwindConfig, TopBar, UploadJSONButton, User$1 as User, Workspace, WorkspaceNoAccessPage, WorkspaceNoAccessPageServerSideProps, WorkspacePage, WorkspacePageGetServerSideProps, accessibleFieldName, addIntersectionToIncludes, addUnion, export_default as analysisApiCohortDiscovery, buildNested, capitalize, classifyFacets, compareKeysAscending, compareKeysDescending, computeRowSpan, convertMinutesToMilliseconds, convertPathsToTree, convertSecondsToMilliseconds, convertToStringArray, create10ColorAccessibleContrast, create10ColorPallet, createMantineTheme, export_default$2 as credentialsLogin, export_default$1 as credentialsLogout, extractObjectKey, extractRangeValues, focusStyles, getAllFieldsFromFilterConfigs, getCurrentUnixTimestamp, getNavPageLayoutPropsFromConfig, getParamsValueAsString, getTagInfo, hasOwnProperty, isArrayOfString, isEnumFacetResponse, isHeaderMetadata, isPropertyKey, isTextTransform, mapFacetSortToSortType, processBucketData, processLabel, processRangeData, processRangeKeyLabel, registerCohortBuilderDefaultPreviewRenderers, registerCohortDiscoveryApp, registerCohortSimilarityApp, registerDefaultDiscoveryDataLoaders, registerDiscoveryDefaultCellRenderers, registerDiscoveryDefaultStudyPreviewRenderers, registerExplorerDefaultCellRenderers, registerMetadataSchemaApp, removeIntersectionFromEnum, removeKey, removeUnion, resourcePathFromProjectID, export_default$3 as sessionLogout, export_default$4 as sessionToken, staticNotebookAPI, stripTrailingSlash, toDisplayName, truncateString, unixTimeToString, updateFacetEnum, useClearFilters, useDiscoveryContext, useExtractEnumFilterValues, useExtractRangeFilterValues, useFieldNameToTitle, useGetFacetFilters, useUpdateFilters, userHasMethodForServiceOnResource };
+export type { AdvancedRangeFacetHooks, AllowableRange, AnalysisCenterSection, AnalysisCenterWithSectionsConfiguration, AnalysisPageLayoutProps, AnalysisToolConfiguration, AuthorizationValues, BannerLevelCategories, BannerProps, CellRenderFunctionProps, CellRendererFunctionProps, ChartProps, ClearFacetFunction, ClearFacetHook, ClearIndexedFacetFunction, CohortBuilderCategoryConfig, CohortBuilderConfiguration, CohortBuilderProps, CohortBuilderTabCategoryConfig, CohortPanelConfiguration, CollapsableChartsPanelConfiguration, CustomFacetHooks, DataAuthorization, DiscoveryConfig, EnumChartProps, EnumFacetData, EnumFacetDataChangedFunction, EnumFacetDataHooks, EnumFacetResponse, EnumOperandValue, ExplorerPageProps, FacetCardProps, FacetCommonHooks, FacetDataHooks, FacetRequiredHooks, FacetResponse, FacetSortType, FacetType, FieldNameToTitleFunction, FieldToName, Fonts, FooterProps, FromToRange, FromToRangeValues, GetEnumFacetDataFunction, GetFacetCombineModeFunction, GetFacetDataFunction, GetRangeFacetDataFunction, GetRangeFacetWithDefinedRangesDataFunction, GetTotalCountsFunction, HeaderMetadata, HeaderProps, LoginConfig, ModalsConfig, NavPageLayoutProps, NavigationProps, NumericFacetCardProps, NumericRangeFacetHooks, ProfileConfig, QueryOptions, RangeFacetHooks, RangeFacetResponse, RangeFromOp, RangeToOp, ReactEChartsProps, RegisteredIcons, RowRenderFunctionParams, SelectFacetFilterFunction, SelectedFields$1 as SelectedFields, SessionConfiguration, SetFacetCombineModeFunction, SortType, StudyDetailsField, SummaryChart, TabbedCohortBuilderConfiguration, TabbedCohortBuilderFacetConfig, TableDetailsPanelProps, TagData, TagsConfig, TenStringArray, TopBarProps, UpdateFacetFilterFunction, UpdateFacetFilterHook, UserAuthMapping, WorkspaceConfig };