@gen3/frontend 0.11.11 → 0.11.12

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { JSONObject, HistogramDataArray, AggregationsData, EnumFilterValue, FacetDefinition, IndexAndField, Operation, CombineMode, DataFetchingResult, Accessibility, SharedFieldMapping, Includes, Intersection, OperatorWithFieldAndArrayOfOperands, ServiceAndMethod, DataLibraryStoreMode, ExportDatasetFields, FilterSet, CohortItem, FileItem } from '@gen3/core';
+import { JSONObject, HistogramDataArray, AggregationsData, EnumFilterValue, IndexAndField, Operation, CombineMode, DataFetchingResult, Accessibility, SharedFieldMapping, Includes, Intersection, OperatorWithFieldAndArrayOfOperands, ServiceAndMethod, DataLibraryStoreMode, ExportDatasetFields, FilterSet, CohortItem, FileItem } from '@gen3/core';
 import * as React$1 from 'react';
 import React__default, { ReactElement, ReactNode, CSSProperties, ComponentType, RefObject, PropsWithChildren } from 'react';
 import { EChartsOption, SetOptionOpts } from 'echarts';
 import { MRT_Row, MRT_RowData, MRT_Cell, MRT_Column, MRT_TableInstance } from 'mantine-react-table';
 import * as _mantine_core from '@mantine/core';
-import { ButtonProps, BoxProps, TitleOrder } from '@mantine/core';
+import { ButtonProps, BoxProps, FloatingPosition, SegmentedControlProps as SegmentedControlProps$1, TitleOrder } from '@mantine/core';
 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, NextPage, GetStaticProps, NextApiRequest, NextApiResponse } from 'next';
@@ -428,10 +428,31 @@ interface FacetChartProps {
 }
 declare const EnumFacetChart: React__default.FC<FacetChartProps>;
 
+type NumericFacetProps = Omit<NumericFacetCardProps, 'facetName'> & {
+    readonly rangeDatatype?: string;
+    readonly minimum: number | undefined;
+    readonly maximum: number | undefined;
+    readonly clearValues?: boolean;
+    readonly isFacetView: boolean;
+};
+/**
+ * Represent a range. Used to configure a row
+ * of a range list.
+ */
+interface RangeBucketElement {
+    readonly from: number;
+    readonly to: number;
+    readonly key: string;
+    readonly label: string;
+    readonly valueLabel?: string;
+    readonly value?: number;
+}
+type NumericUnits = 'days' | 'years' | 'percent' | 'year';
 interface NumericFromTo {
     readonly from: number;
     readonly to: number;
 }
+type GetNumericRangeFacetDataFunction = (field: string, ranges: ReadonlyArray<NumericFromTo>, queryOptions?: QueryOptions) => number;
 
 type QueryOptions = Record<string, unknown>;
 interface FacetCardProps<T extends FacetCommonHooks> {
@@ -463,7 +484,7 @@ interface FacetCardProps<T extends FacetCommonHooks> {
         readonly iconStyle?: string;
     };
 }
-type FacetType = 'enum' | 'exact' | 'range' | 'age' | 'year' | 'years' | 'days' | 'percent' | 'datetime' | 'toggle' | 'multiselect';
+type FacetType = 'enum' | 'exact' | 'range' | 'age' | 'year' | 'years' | 'days' | 'percent' | 'datetime' | 'toggle' | 'multiselect' | 'upload';
 type ClearFacetFunction = (field: string) => void;
 type ClearIndexedFacetFunction = (index: string, field: string) => void;
 type GetTotalCountsFunction = () => number;
@@ -628,6 +649,17 @@ interface EnumChartProps {
     readonly height: number;
     readonly valueLabel?: string;
 }
+interface FacetDefinition {
+    readonly description?: string;
+    readonly field: string;
+    readonly dataField?: string;
+    readonly index: string;
+    readonly type: FacetType;
+    readonly range?: AllowableRange;
+    readonly hasData?: boolean;
+    readonly label?: string;
+    readonly sharedWithIndices?: Array<IndexAndField>;
+}
 
 type RendererFunction<T> = (props: T, ...params: any[]) => ReactNode;
 interface RendererFunctionCatalogEntry<T> {
@@ -949,6 +981,24 @@ declare const DEFAULT_MAXIMUM = 100;
 declare const BAD_DATA_MESSAGE = "No data for this field";
 declare const DAYS_IN_YEAR = 365.25;
 
+interface TabbablePanelProps {
+    index: string;
+    filters: TabsConfig;
+    tabTitle: string;
+    facetDefinitions: Record<string, FacetDefinition>;
+    facetDataHooks: Record<FacetType, FacetDataHooks>;
+    onAccessChange?: (value: Accessibility) => void;
+    accessLevel?: Accessibility;
+    showAccessLevel?: boolean;
+}
+
+declare const AccordionPanel: ({ index, filters, tabTitle, facetDefinitions, facetDataHooks, onAccessChange, accessLevel, showAccessLevel, }: TabbablePanelProps) => react_jsx_runtime.JSX.Element;
+
+declare const DropdownPanel: ({ index, filters, tabTitle, facetDefinitions, facetDataHooks, onAccessChange, accessLevel, showAccessLevel, }: TabbablePanelProps) => react_jsx_runtime.JSX.Element;
+
+declare const TabbedPanel: ({ index, filters, tabTitle, facetDefinitions, facetDataHooks, }: TabbablePanelProps) => react_jsx_runtime.JSX.Element;
+//# sourceMappingURL=TabbedPanel.d.ts.map
+
 interface EnumFacetHooks extends FacetDataHooks {
     useGetFacetData: GetEnumFacetDataFunction;
     updateVisibleValues?: EnumFacetDataChangedFunction;
@@ -1085,6 +1135,14 @@ interface FacetExpanderProps {
  */
 declare const FacetExpander: React__default.FC<FacetExpanderProps>;
 
+interface FiltersPanelProps {
+    dataFunctions: Record<FacetType, FacetDataHooks>;
+    fields: ReadonlyArray<FacetDefinition>;
+    valueLabel: string;
+}
+declare const FiltersPanel: ({ fields, dataFunctions, valueLabel, }: FiltersPanelProps) => JSX.Element;
+//# sourceMappingURL=FiltersPanel.d.ts.map
+
 interface ProtectedContentProps {
     children?: ReactNode;
     referer?: string;
@@ -1914,6 +1972,71 @@ declare const CollapsableSidebar: _mantine_core.MantineComponent<{
     ref: HTMLDivElement;
 }>;
 
+interface DropdownWithIconProps {
+    /**
+     *    if true, doesn't set width to be "target"
+     */
+    disableTargetWidth?: string;
+    /**
+     *   Left Icon for the taret button, can be undefined too
+     */
+    LeftIcon?: JSX.Element;
+    /**
+     *   Right Icon for the taret button, can be undefined too (default to dropdown icon)
+     */
+    RightIcon?: JSX.Element;
+    /**
+     *    Content for target button
+     */
+    TargetButtonChildren: ReactNode;
+    /**
+     *    disables the target button and menu
+     */
+    targetButtonDisabled?: boolean;
+    /**
+     *    array dropdown items. Need to pass title, onClick and icon event handler is optional
+     */
+    dropdownElements: Array<{
+        title: string;
+        onClick?: () => void;
+        icon?: JSX.Element;
+        disabled?: boolean;
+    }>;
+    /**
+     *    only provide menuLabelText if we want label for dropdown elements
+     */
+    menuLabelText?: string;
+    /**
+     *    custom class / stylings for menuLabelText
+     */
+    menuLabelCustomClass?: string;
+    /**
+     *    custom position for Menu
+     */
+    customPosition?: FloatingPosition;
+    /**
+     *    whether the dropdown should fill the height of its parent
+     */
+    fullHeight?: boolean;
+    /**
+     *   custom z-index for Menu, defaults to undefined
+     */
+    zIndex?: number;
+    /**
+     * custom test id
+     */
+    customDataTestId?: string;
+    /**
+      tooltip
+     */
+    tooltip?: string;
+    /**
+     * aria-label for the button
+     */
+    buttonAriaLabel?: string;
+}
+declare const DropdownWithIcon: ({ disableTargetWidth, LeftIcon, RightIcon, TargetButtonChildren, targetButtonDisabled, dropdownElements, menuLabelText, menuLabelCustomClass, customPosition, fullHeight, zIndex, customDataTestId, tooltip, buttonAriaLabel, }: DropdownWithIconProps) => JSX.Element;
+
 declare const ActionButton: ({ title, enabled, type, leftIcon, rightIcon, tooltipText, }: DownloadButtonProps) => react_jsx_runtime.JSX.Element;
 //# sourceMappingURL=ActionButton.d.ts.map
 
@@ -1931,6 +2054,12 @@ interface Gen3ButtonProps {
 declare const Gen3Button: tailwind_styled_components_dist_tailwind.TailwindComponent<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Gen3ButtonProps>;
 declare const Gen3ButtonReverse: tailwind_styled_components_dist_tailwind.TailwindComponent<React$1.DetailedHTMLProps<React$1.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Gen3ButtonProps>;
 
+type SegmentedControlProps = SegmentedControlProps$1 & {
+    readonly padding?: number;
+};
+declare const SegmentedControl: React__default.FC<SegmentedControlProps>;
+//# sourceMappingURL=SegmentedControl.d.ts.map
+
 interface Gen3ProviderProps {
     icons: Array<RegisteredIcons>;
     sessionConfig: SessionConfiguration;
@@ -2365,5 +2494,5 @@ declare function export_default(req: NextApiRequest, res: NextApiResponse): Prom
 
 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, toCountsString, 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 };
+export { AISearchPageGetServerSideProps, AccessLevel, AccordionPanel, 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, DropdownPanel, DropdownWithIcon, EnumFacet, EnumFacetChart, ErrorCard, ExactValueFacet, ExplorerPage, ExplorerPageGetServerSideProps, ExplorerPageGetServerSidePropsForConfigId, ExplorerTableCellRendererFactory, ExplorerTableDetailsPanelFactory, FacetControlsHeader, FacetExpander, FacetSelector, FacetSortPanel, FacetTabs, FiltersPanel, 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, SegmentedControl, SessionExpiredModal, SinglePageStudyDetailsPanel, StaticNotebookIFrame, StaticNotebookViewer, StudyDetailsPanel, StudyGroup, StudyGroupPanel, StudyProvider, SubmissionPage, SubmissionPageGetServerSideProps, TabbedCohortBuilder, TabbedCohortBuilderPage, TabbedCohortBuilderPageGetServerSideProps, TabbedPanel, 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, toCountsString, 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, FacetDefinition, FacetRequiredHooks, FacetResponse, FacetSortType, FacetType, FieldNameToTitleFunction, FieldToName, Fonts, FooterProps, FromToRange, FromToRangeValues, GetEnumFacetDataFunction, GetFacetCombineModeFunction, GetFacetDataFunction, GetNumericRangeFacetDataFunction, GetRangeFacetDataFunction, GetRangeFacetWithDefinedRangesDataFunction, GetTotalCountsFunction, HeaderMetadata, HeaderProps, LoginConfig, ModalsConfig, NavPageLayoutProps, NavigationProps, NumericFacetCardProps, NumericFacetProps, NumericFromTo, NumericRangeFacetHooks, NumericUnits, ProfileConfig, QueryOptions, RangeBucketElement, 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 };