@datawheel/data-explorer 1.0.20 → 1.0.22

package/dist/main.d.mts

@@ -5,7 +5,7 @@ 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';
+import { StateFromReducersMapObject, ThunkAction, Action } from '@reduxjs/toolkit';
 import * as redux from 'redux';
 
 declare enum Aggregator {
@@ -377,7 +377,6 @@ interface QueryItem {
     chart: string | null;
     params: QueryParams;
     result: QueryResult;
-    link?: string;
 }
 interface QueryParams {
     booleans: Record<string, undefined | boolean>;
@@ -456,6 +455,11 @@ interface PropertyItem extends QueryParamsItem {
     name: string;
 }
 
+interface FileDescriptor {
+    content: Blob | string;
+    extension: string;
+    name: string;
+}
 type Formatter = (value: number | null, locale?: string) => string;
 interface PanelDescriptor {
     key: string;
@@ -467,7 +471,7 @@ interface ViewProps<TData extends Record<string, any> = Record<string, string |
     cube: TesseractCube;
     panelKey: string | null;
     params: QueryParams;
-    result?: QueryResult<TData>;
+    result: QueryResult<TData>;
     table?: MRT_TableInstance<TData & Record<string, any>>;
     isError?: boolean;
     isLoading?: boolean;
@@ -478,7 +482,7 @@ interface ViewProps<TData extends Record<string, any> = Record<string, string |
 }
 
 /** */
-declare function DebugView(props: ViewProps): React.JSX.Element | null;
+declare function DebugView(props: ViewProps): React.JSX.Element;
 
 declare const explorerTranslation: {
     action_copy: string;
@@ -529,7 +533,6 @@ declare const explorerTranslation: {
         action_clear_description: string;
         action_execute: string;
         add_columns: string;
-        submit: string;
         column_title: string;
         current_endpoint: string;
         dimmenu_abbrjoint: string;
@@ -831,7 +834,6 @@ declare const defaultTranslation: {
         action_clear_description: string;
         action_execute: string;
         add_columns: string;
-        submit: string;
         column_title: string;
         current_endpoint: string;
         dimmenu_abbrjoint: string;
@@ -1092,15 +1094,6 @@ declare function ExplorerComponent<Locale extends string>(props: {
      * @default undefined
      */
     defaultCube?: string | undefined;
-    /**
-     * The locale to use in the Explorer component UI.
-     * This value is passed to the Translation utility and controls the language
-     * for the labels throughout the user interface.
-     *  Must be equal to one of the
-     * keys in the object provided to the `translations` property.
-     * @default "en"
-     */
-    defaultLocale?: Locale;
     /**
      * Specifies which property should be used to filter elements in the member
      * selection control of the Cuts parameter area.
@@ -1113,6 +1106,14 @@ declare function ExplorerComponent<Locale extends string>(props: {
      * @default "measures"
      */
     defaultOpenParams?: "measures" | "drilldowns" | "cuts" | "options";
+    /**
+     * The locale to use in the Explorer component UI.
+     * This value is passed to the Translation utility and controls the language
+     * for the labels throughout the user interface. Must be equal to one of the
+     * keys in the object provided to the `translations` property.
+     * @default "en"
+     */
+    locale?: Locale;
     /**
      * Defines an index of formatter functions available to the measures shown
      * in the app, besides a limited list of default ones. The key used comes
@@ -1187,16 +1188,16 @@ declare namespace ExplorerComponent {
     var displayName: string;
 }
 
+/** */
 declare function PivotView<TData extends Record<string, unknown>>(props: {} & ViewProps<TData> & MRT_TableOptions<TData>): React.JSX.Element;
 
-type TData = Record<string, string | number> & Record<string, any>;
+type TData = Record<string, any> & Record<string, string | number>;
 type TableView = {
     table: MRT_TableInstance<TData>;
     getColumn(id: string): AnyResultColumn | undefined;
     columns: AnyResultColumn[];
-    setPagination: (pagination: MRT_PaginationState) => void;
 } & ViewProps;
-declare function TableView({ table, isError, isLoading, data, pagination, setPagination, result }: TableView): React.JSX.Element;
+declare function TableView({ table, result, isError, isLoading, data, pagination, setPagination }: TableView): React.JSX.Element;
 declare namespace TableView {
     var displayName: string;
 }
@@ -1219,7 +1220,9 @@ declare function thunkExtraArg(): {
     complexity: ComplexityModuleClient;
     previewLimit: number;
 };
+type ExplorerThunkArg = ReturnType<typeof thunkExtraArg>;
 type ExplorerState = StateFromReducersMapObject<typeof reducerMap>;
+type ExplorerThunk<ReturnType = void> = ThunkAction<ReturnType, ExplorerState, ExplorerThunkArg, Action<string>>;
 
 declare const LOADINGSTATUS: {
     readonly FETCHING: "FETCHING";
@@ -1239,6 +1242,11 @@ interface LoadingState {
     trigger: string | null;
 }
 
+interface QueriesState {
+    current: string;
+    itemMap: Record<string, QueryItem>;
+}
+
 interface ServerState {
     cubeMap: Record<string, TesseractCube>;
     locale: string;
@@ -1247,18 +1255,42 @@ interface ServerState {
     url: string;
 }
 
-interface QueriesState {
-    current: string;
-    itemMap: Record<string, QueryItem>;
-}
-
 type ExplorerActionMap = typeof actions;
 declare const actions: {
+    willDownloadQuery(format: `${Format}`): ExplorerThunk<Promise<FileDescriptor>>;
+    willExecuteQuery(params?: {
+        limit?: number;
+        offset?: number;
+    }): ExplorerThunk<Promise<void>>;
+    willFetchQuery(params?: {
+        limit?: number;
+        offset?: number;
+        withoutPagination?: boolean;
+    }): ExplorerThunk<Promise<QueryResult>>;
+    willFetchMembers(level: string, localeStr?: string, cubeName?: string): ExplorerThunk<Promise<TesseractMembersResponse>>;
+    willHydrateParams(suggestedCube?: string): ExplorerThunk<Promise<void>>;
+    willParseQueryUrl(url: string | URL): ExplorerThunk<Promise<void>>;
+    willReloadCubes(params?: {
+        locale: {
+            code: string;
+        };
+    }): ExplorerThunk<Promise<{
+        [k: string]: TesseractCube;
+    }>>;
+    willRequestQuery(): ExplorerThunk<Promise<void>>;
+    willSetCube(cubeName: string, measuresActive?: number, locale?: string): ExplorerThunk<Promise<void>>;
+    willReloadCube({ locale }: {
+        locale: {
+            code: string;
+        };
+    }): ExplorerThunk<Promise<void>>;
+    willSetupClient(baseURL: string, defaultLocale?: string, requestConfig?: RequestInit): ExplorerThunk<Promise<{
+        [k: string]: TesseractCube;
+    }>>;
     resetQueries: _reduxjs_toolkit.ActionCreatorWithPayload<Record<string, any>, "explorerQueries/resetQueries">;
     removeQuery: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/removeQuery">;
     selectQuery: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/selectQuery">;
     updateQuery: _reduxjs_toolkit.ActionCreatorWithPayload<QueryItem, "explorerQueries/updateQuery">;
-    updateCurrentQuery: _reduxjs_toolkit.ActionCreatorWithPayload<QueryItem, "explorerQueries/updateCurrentQuery">;
     switchPanel: _reduxjs_toolkit.ActionCreatorWithPayload<string | null, "explorerQueries/switchPanel">;
     updateChart: _reduxjs_toolkit.ActionCreatorWithPayload<string | null, "explorerQueries/updateChart">;
     removeCut: _reduxjs_toolkit.ActionCreatorWithPayload<string, "explorerQueries/removeCut">;
@@ -1295,6 +1327,13 @@ declare const actions: {
     }, "explorerQueries/updateSorting">;
     clearSorting: _reduxjs_toolkit.ActionCreatorWithoutPayload<"explorerQueries/clearSorting">;
     updateResult: _reduxjs_toolkit.ActionCreatorWithPayload<QueryResult<Record<string, unknown>>, "explorerQueries/updateResult">;
+    setLoadingState(status: LoadingStatus, message?: string): {
+        readonly type: "explorerLoading/setLoadingState:FETCHING" | "explorerLoading/setLoadingState:SUCCESS" | "explorerLoading/setLoadingState:FAILURE";
+        readonly payload: string | undefined;
+    };
+    setLoadingMessage: _reduxjs_toolkit.ActionCreatorWithPayload<LoadingMessage, "explorerLoading/setLoadingMessage">;
+    updateServer: _reduxjs_toolkit.ActionCreatorWithPayload<Partial<ServerState>, "explorerServer/updateServer">;
+    resetServer: _reduxjs_toolkit.ActionCreatorWithoutPayload<"explorerServer/resetServer">;
 };
 
 type ExplorerBoundActionMap = {
@@ -1310,12 +1349,6 @@ interface SettingsContextProps {
     paginationConfig: Pagination;
     measuresActive?: number;
     toolbarConfig?: ToolbarConfigType;
-    serverConfig?: RequestInit;
-    serverURL: string;
-    defaultDataLocale?: string;
-    defaultCube?: string;
-    defaultLocale: string;
-    locale: string;
 }
 /**
  * A wrapper for the Consumer, for use with class components.
@@ -1329,10 +1362,9 @@ declare function useSettings(): SettingsContextProps;
 declare function VizbuilderView(props: {
     cube: TesseractCube;
     params: QueryParams;
-}): React.JSX.Element;
+    result: QueryResult;
+}): false | React.JSX.Element;
 
 declare function TourStep(props: TourStepsPropsType): React.JSX.Element;
 
-declare function RawResponseView(props: any): React.JSX.Element;
-
-export { DebugView, ExplorerComponent as Explorer, type ExplorerState, type ExplorerStepType, PivotView, RawResponseView, SettingsConsumer, TableView, ToolbarButton, TourStep, TranslationConsumer, type Translation as TranslationDict, type ViewProps, VizbuilderView, reducer as explorerReducer, thunkExtraArg as explorerThunkExtraArg, defaultTranslation as translationDict, useSettings, useTranslation };
+export { DebugView, ExplorerComponent as Explorer, type ExplorerState, type ExplorerStepType, PivotView, SettingsConsumer, TableView, ToolbarButton, TourStep, TranslationConsumer, type Translation as TranslationDict, type ViewProps, VizbuilderView, reducer as explorerReducer, thunkExtraArg as explorerThunkExtraArg, defaultTranslation as translationDict, useSettings, useTranslation };