@datawheel/data-explorer 1.2.0 → 1.3.1

package/dist/main.d.mts

@@ -1,8 +1,8 @@
 import React, { ReactNode } from 'react';
 import { MRT_TableInstance, MRT_ColumnDef, MRT_PaginationState, MRT_TableOptions } from 'mantine-react-table';
 import { TranslationDict, TranslationContextProps } from '@datawheel/use-translation';
+import { Translation as Translation$1, VizbuilderProvider } from '@datawheel/vizbuilder/react';
 import { CSSObject } from '@mantine/core';
-import { Translation as Translation$1 } from '@datawheel/vizbuilder/react';
 import { StepType, TourProps } from '@reactour/tour';
 import * as _reduxjs_toolkit from '@reduxjs/toolkit';
 import { StateFromReducersMapObject } from '@reduxjs/toolkit';
@@ -204,6 +204,7 @@ interface TesseractDimension {
     type: DimensionType;
     hierarchies: TesseractHierarchy[];
     default_hierarchy: string;
+    required?: boolean;
 }
 interface TesseractHierarchy {
     name: string;
@@ -392,6 +393,7 @@ interface QueryParams {
     pagiOffset: number;
     sortDir: "asc" | "desc";
     sortKey: string | undefined;
+    timeComplete: string | undefined;
 }
 interface QueryResult<D = Record<string, unknown>> {
     data: D[];
@@ -406,7 +408,9 @@ interface QueryResult<D = Record<string, unknown>> {
     url: string;
 }
 interface ResultEntityType {
-    level: TesseractLevel;
+    level: TesseractLevel & {
+        dimension?: string;
+    };
     property: TesseractProperty;
     measure: TesseractMeasure;
 }
@@ -471,6 +475,7 @@ interface ViewProps<TData extends Record<string, any> = Record<string, string |
     table?: MRT_TableInstance<TData & Record<string, any>>;
     isError?: boolean;
     isLoading?: boolean;
+    isFetching?: boolean;
     data?: Record<string, string | number>[];
     columns?: MRT_ColumnDef<TData>[];
     pagination?: MRT_PaginationState;
@@ -765,23 +770,31 @@ declare const defaultTranslation: {
             title: string;
         };
         list: {
-            join: string;
-            suffix: string;
-            prefix: string;
             n_more: string;
         };
         title: {
+            main: string;
             main_on_period: string;
             main_over_period: string;
-            main: string;
             measure_on_period: string;
             measure_over_period: string;
             nonidealstate: string;
-            series_members: string;
+            scale_day: string;
+            scale_month: string;
+            scale_quarter: string;
+            scale_week: string;
+            scale_year: string;
             series: string;
+            series_members: string;
             time_range: string;
             total: string;
         };
+        transient: {
+            title_one_row: string;
+            title_loading: string;
+            title_empty: string;
+            description_empty: string;
+        };
     }>;
     action_copy: string;
     action_copy_done: string;
@@ -1037,6 +1050,17 @@ declare const defaultTranslation: {
 declare const useTranslation: any;
 declare const TranslationConsumer: any;
 
+interface ToolBarButtonProps {
+    icon: ReactNode;
+    label?: string;
+    onClick?: () => void;
+}
+interface ToolbarConfigType {
+    buttons: ToolBarButtonProps[];
+    showLabels: Boolean;
+}
+declare function ToolbarButton({ icon, label, onClick }: ToolBarButtonProps): React.JSX.Element;
+
 interface ExplorerStepType extends StepType {
     actionBefore?: () => void;
 }
@@ -1050,17 +1074,6 @@ interface TourStepsPropsType {
     texts: string[] | string;
 }
 
-interface ToolBarButtonProps {
-    icon: ReactNode;
-    label?: string;
-    onClick?: () => void;
-}
-interface ToolbarConfigType {
-    buttons: ToolBarButtonProps[];
-    showLabels: Boolean;
-}
-declare function ToolbarButton({ icon, label, onClick }: ToolBarButtonProps): React.JSX.Element;
-
 type Pagination = {
     rowsLimits: number[];
     defaultLimit: Pagination["rowsLimits"][number];
@@ -1101,6 +1114,13 @@ declare function ExplorerComponent<Locale extends string>(props: {
      * @default "en"
      */
     defaultLocale?: Locale;
+    /**
+     * The locale to use for sorting cube items within the SelectCubes component.
+     * This controls the sorting of subtopics and cube buttons.
+     * If not set, the defaultLocale will be used.
+     * @default undefined
+     */
+    sortLocale?: string;
     /**
      * Specifies which property should be used to filter elements in the member
      * selection control of the Cuts parameter area.
@@ -1159,6 +1179,10 @@ declare function ExplorerComponent<Locale extends string>(props: {
      * The Translation labels to use in the UI.
      */
     translations?: Record<Locale, Translation>;
+    /**
+     * Set of settings to pass to the VizbuilderProvider.
+     */
+    vizbuilderSettings?: React.ComponentProps<typeof VizbuilderProvider>;
     /**
      * Determines whether Explorer should be rendered within a MantineProvider
      * @default true
@@ -1265,6 +1289,7 @@ declare const actions: {
     removeDrilldown: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/removeDrilldown">;
     removeMeasure: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/removeMeasure">;
     removeFilter: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/removeFilter">;
+    removeTimeComplete: _reduxjs_toolkit.ActionCreatorWithoutPayload<"explorerQueries/removeTimeComplete">;
     resetAllParams: _reduxjs_toolkit.ActionCreatorWithPayload<Partial<QueryParams>, "explorerQueries/resetAllParams">;
     resetCuts: _reduxjs_toolkit.ActionCreatorWithPayload<Record<string, CutItem>, "explorerQueries/resetCuts">;
     resetDrilldowns: _reduxjs_toolkit.ActionCreatorWithPayload<Record<string, DrilldownItem>, "explorerQueries/resetDrilldowns">;
@@ -1282,6 +1307,7 @@ declare const actions: {
     }, "explorerQueries/updateCube">;
     updateCut: _reduxjs_toolkit.ActionCreatorWithPayload<CutItem, "explorerQueries/updateCut">;
     updateDrilldown: _reduxjs_toolkit.ActionCreatorWithPayload<DrilldownItem, "explorerQueries/updateDrilldown">;
+    updateTimeComplete: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/updateTimeComplete">;
     updateFilter: _reduxjs_toolkit.ActionCreatorWithPayload<FilterItem, "explorerQueries/updateFilter">;
     updateLocale: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/updateLocale">;
     updateMeasure: _reduxjs_toolkit.ActionCreatorWithPayload<MeasureItem, "explorerQueries/updateMeasure">;