@gen3/frontend 0.10.88 → 0.10.91

package/dist/index.d.ts

@@ -1,14 +1,14 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as React$1 from 'react';
 import React__default, { ReactNode, CSSProperties, ReactElement, PropsWithChildren, RefObject } from 'react';
-import { HistogramDataArray, AggregationsData, EnumFilterValue, JSONObject, SharedFieldMapping, FacetDefinition, CohortItem, FileItem } from '@gen3/core';
+import { HistogramDataArray, AggregationsData, EnumFilterValue, ExportDatasetFields, JSONObject, SharedFieldMapping, FacetDefinition, ServiceAndMethod, CohortItem, FileItem } from '@gen3/core';
 import { EChartsOption, SetOptionOpts } from 'echarts';
 import * as _mantine_core from '@mantine/core';
 import { ButtonProps, BoxProps, TitleOrder } from '@mantine/core';
 import { MRT_RowData, MRT_Cell, MRT_Row, MRT_Column, MRT_TableInstance } from 'mantine-react-table';
 import * as tailwind_styled_components_dist_tailwind from 'tailwind-styled-components/dist/tailwind';
 import * as type_fest_source_partial_deep from 'type-fest/source/partial-deep';
-import { GetServerSideProps, GetStaticProps, NextPage, NextApiRequest, NextApiResponse } from 'next';
+import { GetServerSideProps, NextPage, GetStaticProps, NextApiRequest, NextApiResponse } from 'next';
 import { IconType } from 'react-icons';
 
 declare const User$1: () => react_jsx_runtime.JSX.Element;
@@ -623,13 +623,13 @@ interface DiscoveryPageTitle {
     enabled: boolean;
     text: string;
 }
-interface DataLibraryActionButton {
-    type: 'manifest' | 'zip' | 'download' | 'link' | 'externalLink' | 'add-to-workspace';
+interface ExportFromDiscoveryActionButton {
+    type: 'manifest' | 'zip' | 'download' | 'link' | 'externalLink' | 'addToDataLibrary';
     label?: string;
     icon?: string;
     requiresLogin?: boolean;
     tooltip?: string;
-    actionFunction: string;
+    disabled?: boolean;
 }
 interface SearchBar {
     enabled: boolean;
@@ -649,16 +649,16 @@ interface AuthorizationValues {
     enabled: boolean;
     menuText: string;
 }
-interface ExportToDataLibrary {
-    buttons: DataLibraryActionButton[];
+interface ExportFromDiscoveryActions {
+    buttons: ExportFromDiscoveryActionButton[];
     enabled?: boolean;
     verifyExternalLogins?: boolean;
-    loginRequireForAllButtons?: boolean;
-    manifestFieldName?: string;
+    exportDataFields: ExportDatasetFields;
 }
 interface DataAuthorization {
     columnTooltip?: string;
     supportedValues?: Record<string, AuthorizationValues>;
+    isMesh?: boolean;
     enabled?: boolean;
 }
 interface DataLoader {
@@ -690,7 +690,7 @@ interface DiscoveryIndexConfig {
         advSearchFilters?: AdvancedSearchFilters;
         aiSearch?: boolean;
         pageTitle: DiscoveryPageTitle;
-        exportToDataLibrary?: ExportToDataLibrary;
+        exportFromDiscovery?: ExportFromDiscoveryActions;
         search?: SearchConfig;
         authorization: DataAuthorization;
         dataLoader?: DataLoader;
@@ -708,15 +708,24 @@ interface DiscoveryIndexConfig {
 interface DiscoveryConfig {
     metadataConfig: Array<DiscoveryIndexConfig>;
 }
-interface UserAuthMapping {
-    service: string;
-    method: string;
-}
 
 interface DiscoveryIndexPanelProps {
     discoveryConfig: DiscoveryIndexConfig;
     indexSelector: ReactNode | null;
 }
+/**
+ * DiscoveryIndexPanel is a React functional component that renders a discovery panel interface.
+ * It includes features such as search, sorting, filtering, charts, export functionality, and a discovery table.
+ * The component uses hooks for handling state, API data loading, and interface interactions.
+ *
+ * @param {Object} props - The properties object passed to the component.
+ * @param {Object} props.discoveryConfig - Configuration object for setting up the discovery panel.
+ * @param {Object} props.discoveryConfig.features - Defines enabled features (e.g., search, charts, export).
+ * @param {Object} props.discoveryConfig.minimalFieldMapping - Field mapping configuration, such as `uid`.
+ * @param {JSX.Element} props.indexSelector - React component for selecting an index in the discovery panel.
+ *
+ * @return {JSX.Element} A fully featured discovery interface including search functionality, a table, charts, filters, and more.
+ */
 declare const DiscoveryIndexPanel: ({ discoveryConfig, indexSelector, }: DiscoveryIndexPanelProps) => react_jsx_runtime.JSX.Element;
 
 declare const TagCloud: () => react_jsx_runtime.JSX.Element;
@@ -725,6 +734,7 @@ declare const TagCloud: () => react_jsx_runtime.JSX.Element;
 interface CellRenderFunctionProps<T = any, C extends MRT_RowData = JSONObject> {
     value: T;
     cell?: MRT_Cell<C>;
+    row?: MRT_Row<C>;
 }
 /**
  * A Cell Renderer Function is a function that takes a value and returns a ReactElement
@@ -753,6 +763,12 @@ declare class DiscoveryCellRendererFactory {
     static registerCellRendererCatalog(catalog: Record<string, CellRendererFunctionCatalogEntry>): void;
 }
 
+interface ActionBarProps extends ExportFromDiscoveryActions {
+    selectedResources: any[];
+}
+declare const ActionBar: React__default.FC<ActionBarProps>;
+//# sourceMappingURL=ActionBar.d.ts.map
+
 interface AiSearchProps {
     placeholder?: string;
     uidForStorage?: string;
@@ -803,7 +819,7 @@ interface TagInfo {
     display: boolean;
     label: string;
 }
-declare const getTagInfo: (tagData: TagData, tagsConfig: TagsConfig) => TagInfo;
+declare const getTagInfo: (tagData: TagData, tagsConfig?: TagsConfig) => TagInfo;
 
 declare const registerDefaultDiscoveryDataLoaders: () => void;
 
@@ -1073,6 +1089,7 @@ interface AnalysisToolConfiguration {
     count?: number;
     countUnits?: string;
     cardType?: 'regular' | 'compact';
+    btnText?: string;
 }
 interface AnalysisCenterConfiguration {
     tools: Array<AnalysisToolConfiguration>;
@@ -1154,7 +1171,7 @@ declare const convertSecondsToMilliseconds: (seconds: number) => number;
 declare const MinutesToMilliseconds: (minutes: number) => number;
 
 declare const resourcePathFromProjectID: (projectID: string) => string;
-declare const userHasMethodForServiceOnResource: (method: string, service: string, resourcePath: string, userAuthMapping?: Record<string, Array<UserAuthMapping>>) => boolean;
+declare const userHasMethodForServiceOnResource: (method: string, service: string, resourcePath: string, userAuthMapping?: Record<string, Array<ServiceAndMethod>>) => boolean;
 
 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";
 
@@ -1218,8 +1235,14 @@ declare class ContentDatabase {
     getAll<T extends Record<string, any>>(filepath: string, filter: string): Promise<Array<T>>;
 }
 
-declare const ContentSource: ContentDatabase;
-//# sourceMappingURL=index.d.ts.map
+declare class ContentSource {
+    private static instance;
+    private contentDatabase;
+    private constructor();
+    static getInstance(): ContentSource;
+    getContentDatabase(): ContentDatabase;
+}
+declare const _default: ContentSource;
 
 interface SessionConfiguration {
     /**
@@ -1324,7 +1347,10 @@ interface Gen3ProviderProps {
     modalsConfig: ModalsConfig;
     children?: ReactNode | undefined;
 }
-declare const createMantineTheme: (fonts: Fonts, colors: Record<string, TenStringArray>) => type_fest_source_partial_deep.PartialObjectDeep<_mantine_core.MantineTheme, {}>;
+declare const createMantineTheme: (fonts: Fonts, colors: Record<string, TenStringArray>) => type_fest_source_partial_deep.PartialObjectDeep<_mantine_core.MantineTheme, {
+    recurseIntoArrays: false;
+    allowUndefinedInNonTupleArrays: true;
+}>;
 /**
  * Gen3Provider wraps around the entire app and provides general configurations
  * for the whole website like color scheme, icons, fonts, and sessionConfigs like
@@ -1403,7 +1429,7 @@ interface Props$3 extends NavPageLayoutProps {
 declare const LandingPage: ({ headerProps, footerProps, landingPage }: Props$3) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=Landing.d.ts.map
 
-declare const LandingPageGetStaticProps: GetStaticProps;
+declare const LandingPageGetServerSideProps: GetServerSideProps;
 
 type ExplorerPageProps = NavPageLayoutProps & CohortBuilderProps;
 
@@ -1622,6 +1648,7 @@ interface TableColumnsConfig {
 }
 interface DataLibraryConfig {
     useAPI: boolean;
+    requiresLogin?: boolean;
     size?: string;
     actions: DataLibraryActionsConfig;
     fileTable?: {
@@ -1735,4 +1762,5 @@ declare function export_default$1(req: NextApiRequest, res: NextApiResponse): Pr
 
 declare function export_default(req: NextApiRequest, res: NextApiResponse): Promise<void>;
 
-export { AISearchPageGetServerSideProps, ActionButton, AdminAuthZPageGetServerSideProps, AiSearch, AISearchPage as AiSearchPage, AnalysisCenter, type AnalysisCenterSection, AnalysisCenterWithSections, type AnalysisCenterWithSectionsConfiguration, AnalysisEditorPage, AnalysisEditorPageGetServerSideProps, AnalysisPage, AnalysisPageGetServerSideProps, type AnalysisPageLayoutProps, type AnalysisToolConfiguration, AuthzPage, type BannerProps, BaseModal, type CellRenderFunctionProps, type CellRendererFunctionProps, type ChartProps, Charts, CohortBuilder, type CohortBuilderConfiguration, type CohortBuilderProps, CohortManager, type CohortPanelConfig, CollapsableSidebar, ColorThemePage, ColorThemePageGetServerSideProps, ContentSource, CreateCredentialsAPIKeyModal, CrosswalkPage, CrosswalkPageGetServerSideProps, Custom404Page, DataLibraryPage, DataLibraryPageGetServerSideProps, DictionaryPage, DictionaryPageGetServerSideProps, DiscoveryCellRendererFactory, type DiscoveryConfig, DiscoveryProvider as DiscoveryConfigProvider, DiscoveryIndexPanel, DiscoveryPage, DiscoveryPageGetServerSideProps, DiscoveryRowRendererFactory, DropdownButton, EnumFacetChart, ErrorCard, ExplorerPage, ExplorerPageGetServerSideProps, ExplorerPageGetServerSidePropsForConfigId, type ExplorerPageProps, ExplorerTableCellRendererFactory, ExplorerTableDetailsPanelFactory, FirstTimeModal, type Fonts, Footer, type FooterProps, Gen3Button, Gen3ButtonReverse, Gen3Link, Gen3ModalsProvider, Gen3Provider, GqlQueryEditor, Header, type HeaderProps, HoverLink, LandingPage, LandingPageGetStaticProps, LoginButton, type LoginConfig, LoginPage, LoginPageGetServerSideProps, LoginPanel, LoginProvidersPanel, MinutesToMilliseconds, type ModalsConfig, NavPageLayout, type NavPageLayoutProps, NavigationBar, NavigationButton, type NavigationProps, NoAccessModal, NotebookLitePage, NotebookLitePageGetStaticProps, type ProfileConfig, ProfilePage, ProfilePageGetServerSideProps, ProfileProvider, ProtectedContent, 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, TopBar, type TopBarProps, UploadJSONButton, User$1 as User, Workspace, type WorkspaceConfig, WorkspaceNoAccessPage, WorkspaceNoAccessPageServerSideProps, WorkspacePage, WorkspacePageGetServerSideProps, capitalize, computeRowSpan, convertMinutesToMilliseconds, convertSecondsToMilliseconds, create10ColorAccessibleContrast, create10ColorPallet, createMantineTheme, export_default$1 as credentialsLogin, export_default as credentialsLogout, extractObjectKey, focusStyles, getCurrentUnixTimestamp, getNavPageLayoutPropsFromConfig, getParamsValueAsString, getTagInfo, hasOwnProperty, isArrayOfString, isPropertyKey, isTextTransform, processLabel, processRangeKeyLabel, registerCohortBuilderDefaultPreviewRenderers, registerCohortDiscoveryApp, registerCohortSimilarityApp, registerDefaultDiscoveryDataLoaders, registerDiscoveryDefaultCellRenderers, registerDiscoveryDefaultStudyPreviewRenderers, registerExplorerDefaultCellRenderers, registerMetadataSchemaApp, removeKey, resourcePathFromProjectID, export_default$2 as sessionLogout, export_default$3 as sessionToken, stripTrailingSlash, toDisplayName, truncateString, unixTimeToString, useDiscoveryContext, userHasMethodForServiceOnResource };
+export { AISearchPageGetServerSideProps, ActionBar, ActionButton, AdminAuthZPageGetServerSideProps, AiSearch, AISearchPage as AiSearchPage, AnalysisCenter, AnalysisCenterWithSections, AnalysisEditorPage, AnalysisEditorPageGetServerSideProps, AnalysisPage, AnalysisPageGetServerSideProps, AuthzPage, BaseModal, Charts, CohortBuilder, CohortManager, CollapsableSidebar, ColorThemePage, ColorThemePageGetServerSideProps, _default as ContentSource, CreateCredentialsAPIKeyModal, CrosswalkPage, CrosswalkPageGetServerSideProps, Custom404Page, DataLibraryPage, DataLibraryPageGetServerSideProps, DictionaryPage, DictionaryPageGetServerSideProps, DiscoveryCellRendererFactory, DiscoveryProvider as DiscoveryConfigProvider, DiscoveryIndexPanel, DiscoveryPage, DiscoveryPageGetServerSideProps, DiscoveryRowRendererFactory, DropdownButton, EnumFacetChart, ErrorCard, ExplorerPage, ExplorerPageGetServerSideProps, ExplorerPageGetServerSidePropsForConfigId, ExplorerTableCellRendererFactory, ExplorerTableDetailsPanelFactory, FirstTimeModal, Footer, Gen3Button, Gen3ButtonReverse, Gen3Link, Gen3ModalsProvider, Gen3Provider, GqlQueryEditor, Header, HoverLink, LandingPage, LandingPageGetServerSideProps, LoginButton, LoginPage, LoginPageGetServerSideProps, LoginPanel, LoginProvidersPanel, MinutesToMilliseconds, NavPageLayout, NavigationBar, NavigationButton, NoAccessModal, NotebookLitePage, NotebookLitePageGetStaticProps, ProfilePage, ProfilePageGetServerSideProps, ProfileProvider, ProtectedContent, QueryPage, QueryPageGetServerSideProps, ReactECharts, ResourcesFilters, SPECIAL_CASE_FIELDS, SessionExpiredModal, StudyGroup, SubmissionPage, SubmissionPageGetServerSideProps, TagCloud, TailwindConfig, TopBar, UploadJSONButton, User$1 as User, Workspace, WorkspaceNoAccessPage, WorkspaceNoAccessPageServerSideProps, WorkspacePage, WorkspacePageGetServerSideProps, capitalize, computeRowSpan, convertMinutesToMilliseconds, convertSecondsToMilliseconds, create10ColorAccessibleContrast, create10ColorPallet, createMantineTheme, export_default$1 as credentialsLogin, export_default as credentialsLogout, extractObjectKey, focusStyles, getCurrentUnixTimestamp, getNavPageLayoutPropsFromConfig, getParamsValueAsString, getTagInfo, hasOwnProperty, isArrayOfString, isPropertyKey, isTextTransform, processLabel, processRangeKeyLabel, registerCohortBuilderDefaultPreviewRenderers, registerCohortDiscoveryApp, registerCohortSimilarityApp, registerDefaultDiscoveryDataLoaders, registerDiscoveryDefaultCellRenderers, registerDiscoveryDefaultStudyPreviewRenderers, registerExplorerDefaultCellRenderers, registerMetadataSchemaApp, removeKey, resourcePathFromProjectID, export_default$2 as sessionLogout, export_default$3 as sessionToken, stripTrailingSlash, toDisplayName, truncateString, unixTimeToString, useDiscoveryContext, userHasMethodForServiceOnResource };
+export type { AnalysisCenterSection, AnalysisCenterWithSectionsConfiguration, AnalysisPageLayoutProps, AnalysisToolConfiguration, BannerProps, CellRenderFunctionProps, CellRendererFunctionProps, ChartProps, CohortBuilderConfiguration, CohortBuilderProps, CohortPanelConfig, DiscoveryConfig, ExplorerPageProps, Fonts, FooterProps, HeaderProps, LoginConfig, ModalsConfig, NavPageLayoutProps, NavigationProps, ProfileConfig, ReactEChartsProps, RegisteredIcons, RowRenderFunctionParams, SessionConfiguration, StudyDetailsField, SummaryChart, TableDetailsPanelProps, TagData, TagsConfig, TenStringArray, TopBarProps, WorkspaceConfig };