@gen3/frontend 0.10.49 → 0.10.51

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React$1 from 'react';
-import React__default, { ReactElement, PropsWithChildren, ReactNode, CSSProperties } from 'react';
+import React__default, { ReactElement, PropsWithChildren, ReactNode, CSSProperties, RefObject } from 'react';
 import { ButtonProps, TitleOrder } from '@mantine/core';
 import { HistogramDataArray, JSONObject, AggregationsData, EnumFilterValue, FacetDefinition } from '@gen3/core';
-import { MRT_RowData, MRT_Cell, MRT_Row } from 'mantine-react-table';
+import { MRT_RowData, MRT_Cell, MRT_Row, MRT_Column, MRT_TableInstance } from 'mantine-react-table';
 import { EChartsOption, SetOptionOpts } from 'echarts';
 import { GetServerSideProps, GetStaticProps, NextPage, NextApiRequest, NextApiResponse } from 'next';
 import { IconType } from 'react-icons';
@@ -185,11 +185,18 @@ interface HeaderData {
     content: string;
     key: string;
 }
+/**
+ * Sitewide props that can be passed to Pages
+ */
+interface CommonsData {
+    contactEmail?: string;
+}
 interface HeaderProps {
     top: TopBarProps;
     navigation: NavigationProps;
     banners?: Array<BannerProps>;
     type?: 'horizontal' | 'vertical' | 'original';
+    readonly siteProps?: CommonsData;
 }
 interface MainContentProps {
     fixed: boolean;
@@ -618,7 +625,7 @@ interface ButtonOptions {
     title: string;
     dataTestId: string;
 }
-interface Props$3 {
+interface Props$4 {
     openModal: boolean;
     title: ReactNode;
     size?: string | number;
@@ -645,7 +652,7 @@ interface Props$3 {
  * @see https://mantine.dev/core/modal/
  * @returns a mantine modal with a built in button for closing the modal
  */
-declare const BaseModal: ({ openModal, title, size, children, leftButtons, buttons, withCloseButton, onClose, closeOnClickOutside, closeOnEscape, }: Props$3) => react_jsx_runtime.JSX.Element;
+declare const BaseModal: ({ openModal, title, size, children, leftButtons, buttons, withCloseButton, onClose, closeOnClickOutside, closeOnEscape, }: Props$4) => react_jsx_runtime.JSX.Element;
 
 interface BaseModalConfig {
     title?: string;
@@ -853,8 +860,13 @@ interface SummaryTable {
 /**
  * Represents the props required for a cell renderer function.
  */
-interface CellRendererFunctionProps {
-    cell: MRT_Cell<JSONObject>;
+interface CellRendererFunctionProps<T extends MRT_RowData = JSONObject> {
+    cell: MRT_Cell<T>;
+    renderedCellValue: ReactNode;
+    column: MRT_Column<T>;
+    row: MRT_Row<T>;
+    rowRef?: RefObject<HTMLTableRowElement> | undefined;
+    table: MRT_TableInstance<T>;
     params?: Record<string, unknown>;
 }
 
@@ -949,12 +961,47 @@ interface GqlQueryEditorProps extends GqlQueryEndpointProps {
 declare const GqlQueryEditor: ({ graphQLEndpoint, }: GqlQueryEditorProps) => ReactElement;
 //# sourceMappingURL=GqlQueryEditor.d.ts.map
 
-declare const WorkspacesPanel: () => react_jsx_runtime.JSX.Element;
-//# sourceMappingURL=WorkspacesPanel.d.ts.map
-
-interface WorkspaceConfiguration extends Record<string, any> {
+interface WorkspaceAdditionalInfo {
     title?: string;
+    description?: string;
+    icon?: string;
+    image?: string;
+}
+interface LaunchStepIndicatorConfiguration {
+    steps: Array<{
+        label: string;
+        description?: string;
+    }>;
+}
+interface WorkspaceConfig {
+    title?: string;
+    workspaceInfo?: Record<string, WorkspaceAdditionalInfo>;
+    launchStepIndicatorConfig: LaunchStepIndicatorConfiguration;
+}
+
+interface WorkspaceProps {
+    config: WorkspaceConfig;
 }
+declare const Workspace: ({ config }: WorkspaceProps) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=Workspace.d.ts.map
+
+interface AnalysisToolConfig {
+    title: string;
+    image?: string;
+    icon: string | ReactElement;
+    type: string;
+    description: string;
+    hasDemo?: boolean;
+    loginRequired: boolean;
+    href: string;
+}
+interface AnalysisCenterConfiguration {
+    tools: Array<AnalysisToolConfig>;
+    showFilterAndSort?: boolean;
+}
+
+declare const AnalysisCenter: ({ tools, showFilterAndSort, }: AnalysisCenterConfiguration) => ReactElement;
+//# sourceMappingURL=AnalysisCenter.d.ts.map
 
 declare const create10ColorPallet: (mainColor: string) => Record<string, string>;
 declare const create10ColorAccessibleContrast: (pallet: Record<string, string>) => Record<string, string>;
@@ -1011,6 +1058,7 @@ declare const getNavPageLayoutPropsFromConfig: () => Promise<NavPageLayoutProps>
 
 interface ContentSource$1 {
     get<T extends Record<string, undefined>>(filepath: string): Promise<T>;
+    getAll<T extends Record<string, unknown>>(filepath: string, filter: string): Promise<Array<T>>;
 }
 interface Gen3Icon {
     body: string;
@@ -1044,6 +1092,7 @@ declare class ContentDatabase {
     store: ContentSource$1;
     constructor(config: CreateDatabase);
     get<T extends Record<string, any>>(filepath: string): Promise<T>;
+    getAll<T extends Record<string, any>>(filepath: string, filter: string): Promise<Array<T>>;
 }
 
 declare const ContentSource: ContentDatabase;
@@ -1074,11 +1123,11 @@ interface SessionConfiguration {
     logoutInactiveUsers?: boolean;
 }
 
-interface ErrorCardProps {
+interface MessageTextProps {
     message: string;
-    icon?: ReactElement;
 }
-declare const ErrorCard: React__default.FunctionComponent<ErrorCardProps>;
+
+declare const ErrorCard: React__default.FunctionComponent<MessageTextProps>;
 //# sourceMappingURL=ErrorCard.d.ts.map
 
 declare const registerCohortDiscoveryApp: () => React$1.ReactNode;
@@ -1087,7 +1136,7 @@ declare const registerCohortDiversityApp: () => React$1.ReactNode;
 
 interface Gen3ProviderProps {
     colors: Record<string, TenStringArray>;
-    icons: RegisteredIcons;
+    icons: Array<RegisteredIcons>;
     fonts: Fonts;
     sessionConfig: SessionConfiguration;
     modalsConfig: ModalsConfig;
@@ -1166,10 +1215,10 @@ interface LandingPageProps {
     }>;
 }
 
-interface Props$2 extends NavPageLayoutProps {
+interface Props$3 extends NavPageLayoutProps {
     landingPage: LandingPageProps;
 }
-declare const LandingPage: ({ headerProps, footerProps, landingPage }: Props$2) => react_jsx_runtime.JSX.Element;
+declare const LandingPage: ({ headerProps, footerProps, landingPage }: Props$3) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=Landing.d.ts.map
 
 declare const LandingPageGetStaticProps: GetStaticProps;
@@ -1186,10 +1235,10 @@ declare const ColorThemePage: ({ headerProps, footerProps }: NavPageLayoutProps)
 
 declare const ColorThemePageGetServerSideProps: GetServerSideProps<NavPageLayoutProps>;
 
-interface Props$1 extends NavPageLayoutProps {
+interface Props$2 extends NavPageLayoutProps {
     profileConfig: ProfileConfig;
 }
-declare const ProfilePage: ({ headerProps, footerProps, profileConfig }: Props$1) => react_jsx_runtime.JSX.Element;
+declare const ProfilePage: ({ headerProps, footerProps, profileConfig }: Props$2) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=Profile.d.ts.map
 
 declare const ProfilePageGetServerSideProps: GetServerSideProps<NavPageLayoutProps>;
@@ -1268,10 +1317,10 @@ interface Authz {
     resources: Resource[];
 }
 
-interface Props extends NavPageLayoutProps {
+interface Props$1 extends NavPageLayoutProps {
     authz: Authz;
 }
-declare const AuthzPage: ({ headerProps, footerProps, authz }: Props) => react_jsx_runtime.JSX.Element;
+declare const AuthzPage: ({ headerProps, footerProps, authz }: Props$1) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=Authz.d.ts.map
 
 declare const AdminAuthZPageGetServerSideProps: () => Promise<{
@@ -1309,20 +1358,53 @@ declare const SubmissionPage: ({ submissionConfig, headerProps, footerProps, }:
 
 declare const SubmissionPageGetServerSideProps: GetServerSideProps<SubmissionsPageLayoutProps>;
 
-interface WorkspacePageProps extends NavPageLayoutProps {
-    workspaceProps: WorkspaceConfiguration;
+interface WorkspacePageLayoutProps extends NavPageLayoutProps {
+    workspaceProps: WorkspaceConfig;
 }
 
-declare const WorkspacesPage: ({ headerProps, footerProps, workspaceProps, }: WorkspacePageProps) => JSX.Element;
-//# sourceMappingURL=Workspaces.d.ts.map
+declare const WorkspacePage: ({ headerProps, footerProps, workspaceProps, }: WorkspacePageLayoutProps) => JSX.Element;
+//# sourceMappingURL=Workspace.d.ts.map
 
-declare const WorkspacesPageGetServerSideProps: GetServerSideProps<WorkspacePageProps>;
+declare const WorkspaceNoAccessPage: ({ headerProps, footerProps, }: NavPageLayoutProps) => JSX.Element;
+//# sourceMappingURL=WorkspaceNoAccess.d.ts.map
+
+declare const WorkspacePageGetServerSideProps: GetServerSideProps<WorkspacePageLayoutProps>;
+declare const WorkspaceNoAccessPageServerSideProps: GetServerSideProps<NavPageLayoutProps>;
+
+interface AnalysisPageLayoutProps extends NavPageLayoutProps {
+    tools: Array<AnalysisToolConfig>;
+}
+
+declare const AnalysisPage: ({ headerProps, footerProps, tools, }: AnalysisPageLayoutProps) => JSX.Element;
+//# sourceMappingURL=Analysis.d.ts.map
+
+declare const AnalysisPageGetServerSideProps: GetServerSideProps<AnalysisPageLayoutProps>;
+
+interface Props extends NavPageLayoutProps {
+    analysisFile?: any;
+}
+declare const AnalysisEditorPage: ({ headerProps, footerProps, analysisFile, }: Props) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=Analysis.d.ts.map
+
+declare const AnalysisEditorPageGetServerSideProps: () => Promise<{
+    props: {
+        headerProps: Readonly<HeaderProps>;
+        footerProps: Readonly<FooterProps>;
+        mainProps?: Partial<MainContentProps>;
+        headerData: HeaderData;
+    };
+}>;
 
 declare const AISearchPage: ({ headerProps, footerProps, }: NavPageLayoutProps) => JSX.Element;
 //# sourceMappingURL=AiSearch.d.ts.map
 
 declare const AISearchPageGetServerSideProps: GetServerSideProps<NavPageLayoutProps>;
 
+declare const NotebookLitePage: ({ headerProps, footerProps }: NavPageLayoutProps) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=NotebookLite.d.ts.map
+
+declare const NotebookLitePageGetStaticProps: GetStaticProps;
+
 interface CrosswalkName {
     id: string;
     label: string;
@@ -1417,4 +1499,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, 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 };
+export { AISearchPageGetServerSideProps, AdminAuthZPageGetServerSideProps, AiSearch, AISearchPage as AiSearchPage, AnalysisCenter, AnalysisEditorPage, AnalysisEditorPageGetServerSideProps, AnalysisPage, AnalysisPageGetServerSideProps, 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, type ExplorerPageProps, 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, NotebookLitePage, NotebookLitePageGetStaticProps, 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, Workspace, type WorkspaceConfig, WorkspaceNoAccessPage, WorkspaceNoAccessPageServerSideProps, WorkspacePage, WorkspacePageGetServerSideProps, 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 };