@datawheel/data-explorer 0.3.9 → 0.3.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/dist/main.d.mts +276 -18
  2. package/dist/main.mjs +197 -1016
  3. package/package.json +2 -2
package/dist/main.d.mts CHANGED
@@ -1,7 +1,8 @@
1
1
  import React, { ReactNode } from 'react';
2
2
  import { MRT_TableInstance, MRT_ColumnDef, MRT_PaginationState, MRT_TableOptions } from 'mantine-react-table';
3
- import { TranslationContextProps } from '@datawheel/use-translation';
3
+ import { TranslationDict, TranslationContextProps } from '@datawheel/use-translation';
4
4
  import { CSSObject } from '@mantine/core';
5
+ import { Translation as Translation$1 } from '@datawheel/vizbuilder/react';
5
6
  import { StepType, TourProps } from '@reactour/tour';
6
7
  import * as _reduxjs_toolkit from '@reduxjs/toolkit';
7
8
  import { StateFromReducersMapObject, ThunkAction, Action } from '@reduxjs/toolkit';
@@ -481,7 +482,7 @@ interface ViewProps<TData extends Record<string, any> = Record<string, string |
481
482
  /** */
482
483
  declare function DebugView(props: ViewProps): React.JSX.Element;
483
484
 
484
- declare const defaultTranslation: {
485
+ declare const explorerTranslation: {
485
486
  action_copy: string;
486
487
  action_copy_done: string;
487
488
  action_download: string;
@@ -731,10 +732,19 @@ declare const defaultTranslation: {
731
732
  selected_items: string;
732
733
  unselected_items: string;
733
734
  };
734
- vizbuilder: {
735
+ };
736
+ declare const vizbuilderTranslation: ExtendibleTranslation<Translation$1>;
737
+ type ExtendibleTranslation<T extends {}> = {
738
+ [K in keyof T]: T[K] extends object ? ExtendibleTranslation<T[K]> : string;
739
+ } & {
740
+ [K: string]: string | TranslationDict;
741
+ };
742
+ type Translation = ExtendibleTranslation<typeof explorerTranslation & {
743
+ vizbuilder: typeof vizbuilderTranslation;
744
+ }>;
745
+ declare const defaultTranslation: {
746
+ vizbuilder: ExtendibleTranslation<{
735
747
  action_close: string;
736
- action_share: string;
737
- share_copied: string;
738
748
  action_enlarge: string;
739
749
  action_fileissue: string;
740
750
  action_retry: string;
@@ -742,6 +752,7 @@ declare const defaultTranslation: {
742
752
  average: string;
743
753
  max: string;
744
754
  min: string;
755
+ sum: string;
745
756
  };
746
757
  chart_labels: {
747
758
  ci: string;
@@ -758,25 +769,271 @@ declare const defaultTranslation: {
758
769
  join: string;
759
770
  suffix: string;
760
771
  prefix: string;
772
+ n_more: string;
761
773
  };
762
774
  title: {
763
- series: string;
764
- series_members: string;
765
- main: string;
766
- measure_over_period: string;
767
- main_over_period: string;
768
775
  main_on_period: string;
776
+ main_over_period: string;
777
+ main: string;
769
778
  measure_on_period: string;
779
+ measure_over_period: string;
780
+ nonidealstate: string;
781
+ series_members: string;
782
+ series: string;
783
+ time_range: string;
770
784
  total: string;
771
785
  };
772
- transient: {
773
- title_loading: string;
774
- title_empty: string;
775
- description_empty: string;
786
+ }>;
787
+ action_copy: string;
788
+ action_copy_done: string;
789
+ action_download: string;
790
+ action_open: string;
791
+ action_reload: string;
792
+ sidebar: {
793
+ dataset: string;
794
+ };
795
+ comparison: {
796
+ BT: string;
797
+ EQ: string;
798
+ GT: string;
799
+ GTE: string;
800
+ LT: string;
801
+ LTE: string;
802
+ NEQ: string;
803
+ };
804
+ debug_view: {
805
+ tab_label: string;
806
+ httpheaders: string;
807
+ jssource_prefix: string;
808
+ jssource_suffix: string;
809
+ url_aggregate: string;
810
+ url_logiclayer: string;
811
+ };
812
+ direction: {
813
+ ASC: string;
814
+ DESC: string;
815
+ };
816
+ formats: {
817
+ csv: string;
818
+ json: string;
819
+ tsv: string;
820
+ parquet: string;
821
+ jsonrecords: string;
822
+ xlsx: string;
823
+ };
824
+ loading: {
825
+ title: string;
826
+ message_heavyquery: string;
827
+ message_default: string;
828
+ };
829
+ params: {
830
+ add_metadata: string;
831
+ action_clear: string;
832
+ action_clear_description: string;
833
+ action_execute: string;
834
+ add_columns: string;
835
+ column_title: string;
836
+ current_endpoint: string;
837
+ dimmenu_abbrjoint: string;
838
+ dimmenu_dimension: string;
839
+ dimmenu_hierarchy: string;
840
+ dimmenu_level: string;
841
+ filter_mode: string;
842
+ filter_by: string;
843
+ error_no_cut_selected_detail: string;
844
+ error_no_cut_selected_title: string;
845
+ error_no_dimension_selected_detail: string;
846
+ error_no_dimension_selected_title: string;
847
+ error_fetchmembers_detail: string;
848
+ error_fetchmembers_title: string;
849
+ label_amount: string;
850
+ label_boolean_debug: string;
851
+ label_boolean_distinct: string;
852
+ label_boolean_exclude_default_members: string;
853
+ label_boolean_full_results: string;
854
+ label_boolean_nonempty: string;
855
+ label_boolean_parents: string;
856
+ label_boolean_sparse: string;
857
+ label_clear: string;
858
+ label_cube: string;
859
+ label_cuts_filterby_id: string;
860
+ label_cuts_filterby_name: string;
861
+ label_cuts_filterby_any: string;
862
+ label_fullscreen: string;
863
+ label_locale: string;
864
+ label_search: string;
865
+ label_no_results: string;
866
+ label_dataset: string;
867
+ label_localeoption: string;
868
+ label_measure: string;
869
+ label_pagination_limit: string;
870
+ label_pagination_offset: string;
871
+ label_sorting_key: string;
872
+ label_sorting_order: string;
873
+ label_source: string;
874
+ label_subtopic: string;
875
+ label_table: string;
876
+ label_timelevel: string;
877
+ label_topic: string;
878
+ search_placeholder: string;
879
+ tag_cuts_plural: string;
880
+ tag_cuts: string;
881
+ tag_drilldowns_abbrjoint: string;
882
+ tag_drilldowns: string;
883
+ title_area_cuts: string;
884
+ title_area_drilldowns: string;
885
+ title_area_filters: string;
886
+ title_area_measures: string;
887
+ title_area_options: string;
888
+ title_area_pagination: string;
889
+ title_area_sorting: string;
890
+ title_caption: string;
891
+ title_downloaddata: string;
892
+ title_members: string;
893
+ title_properties: string;
894
+ tooltip_area_cuts: string;
895
+ tooltip_area_drilldowns: string;
896
+ tooltip_area_filters: string;
897
+ tooltip_area_measures: string;
898
+ tooltip_area_options: string;
899
+ };
900
+ pivot_view: {
901
+ tab_label: string;
902
+ error_missingparams: string;
903
+ error_onedimension: string;
904
+ error_internal: string;
905
+ error_internal_detail: string;
906
+ label_ddcolumn: string;
907
+ label_ddcolumnprop: string;
908
+ label_ddrow: string;
909
+ label_ddrowprop: string;
910
+ label_formatter: string;
911
+ label_valmeasure: string;
912
+ loading_details: string;
913
+ loading_title: string;
914
+ title_download: string;
915
+ title_params: string;
916
+ warning: string;
917
+ warning_notsummeasure: string;
918
+ warning_propertypivot: string;
919
+ warning_sumdimensions: string;
920
+ };
921
+ placeholders: {
922
+ incomplete: string;
923
+ unselected: string;
924
+ none: string;
925
+ };
926
+ previewMode: {
927
+ btn_get_all: string;
928
+ btn_get_preview: string;
929
+ description_full: string;
930
+ description_preview: string;
931
+ title_full: string;
932
+ title_preview: string;
933
+ };
934
+ queries: {
935
+ action_create: string;
936
+ action_parse: string;
937
+ error_not_query: string;
938
+ error_no_drilldowns: string;
939
+ error_no_measures: string;
940
+ error_one_hierarchy_per_dimension: string;
941
+ error_one_cut_per_dimension: string;
942
+ column_title: string;
943
+ unset_parameters: string;
944
+ };
945
+ results: {
946
+ error_execquery_detail: string;
947
+ error_disconnected_title: string;
948
+ error_serveroffline_title: string;
949
+ error_serveroffline_detail: string;
950
+ error_emptyresult_title: string;
951
+ error_emptyresult_detail: string;
952
+ count_rows: string;
953
+ count_rows_plural: string;
954
+ };
955
+ selectlevel_placeholder: string;
956
+ selectmeasure_placeholder: string;
957
+ selecttimelevel_placeholder: string;
958
+ table_view: {
959
+ tab_label: string;
960
+ numeral_format: string;
961
+ sort_asc: string;
962
+ sort_desc: string;
963
+ };
964
+ tour: {
965
+ controls: {
966
+ prev: string;
967
+ next: string;
968
+ help: string;
776
969
  };
970
+ steps: {
971
+ welcome: {
972
+ title: string;
973
+ text1: string;
974
+ text2: string;
975
+ };
976
+ locale: {
977
+ title: string;
978
+ text1: string;
979
+ text2: string;
980
+ };
981
+ dataset: {
982
+ title: string;
983
+ text1: string;
984
+ text2: string;
985
+ };
986
+ search: {
987
+ title: string;
988
+ text1: string;
989
+ text2: string;
990
+ };
991
+ table: {
992
+ title: string;
993
+ text1: string;
994
+ text2: string;
995
+ };
996
+ columns: {
997
+ title: string;
998
+ text1: string;
999
+ text2: string;
1000
+ };
1001
+ filters: {
1002
+ title: string;
1003
+ text1: string;
1004
+ text2: string;
1005
+ };
1006
+ download: {
1007
+ title: string;
1008
+ text1: string;
1009
+ };
1010
+ api: {
1011
+ title: string;
1012
+ text1: string;
1013
+ };
1014
+ vizbuilderTab: {
1015
+ title: string;
1016
+ text1: string;
1017
+ };
1018
+ last: {
1019
+ title: string;
1020
+ text: string;
1021
+ button: string;
1022
+ };
1023
+ };
1024
+ };
1025
+ transfer_input: {
1026
+ count_hidden: string;
1027
+ count_hidden_plural: string;
1028
+ search_placeholder: string;
1029
+ select_all: string;
1030
+ unselect_all: string;
1031
+ select_filtered: string;
1032
+ unselect_filtered: string;
1033
+ selected_items: string;
1034
+ unselected_items: string;
777
1035
  };
778
1036
  };
779
- type TranslationDict = typeof defaultTranslation;
780
1037
  declare const useTranslation: any;
781
1038
  declare const TranslationConsumer: any;
782
1039
 
@@ -895,7 +1152,7 @@ declare function ExplorerComponent<Locale extends string>(props: {
895
1152
  /**
896
1153
  * The Translation labels to use in the UI.
897
1154
  */
898
- translations?: Record<Locale, TranslationDict>;
1155
+ translations?: Record<Locale, Translation>;
899
1156
  /**
900
1157
  * Determines whether Explorer should be rendered within a MantineProvider
901
1158
  * @default true
@@ -1001,6 +1258,7 @@ declare const actions: {
1001
1258
  willFetchQuery(params?: {
1002
1259
  limit?: number;
1003
1260
  offset?: number;
1261
+ withoutPagination?: boolean;
1004
1262
  }): ExplorerThunk<Promise<QueryResult>>;
1005
1263
  willFetchMembers(level: string, localeStr?: string, cubeName?: string): ExplorerThunk<Promise<TesseractMembersResponse>>;
1006
1264
  willHydrateParams(suggestedCube?: string): ExplorerThunk<Promise<void>>;
@@ -1097,8 +1355,8 @@ declare function VizbuilderView(props: {
1097
1355
  cube: TesseractCube;
1098
1356
  params: QueryParams;
1099
1357
  result: QueryResult;
1100
- }): React.JSX.Element;
1358
+ }): false | React.JSX.Element;
1101
1359
 
1102
1360
  declare function TourStep(props: TourStepsPropsType): React.JSX.Element;
1103
1361
 
1104
- export { DebugView, ExplorerComponent as Explorer, type ExplorerState, type ExplorerStepType, PivotView, SettingsConsumer, TableView, ToolbarButton, TourStep, TranslationConsumer, type TranslationDict, type ViewProps, VizbuilderView, reducer as explorerReducer, thunkExtraArg as explorerThunkExtraArg, defaultTranslation as translationDict, useSettings, useTranslation };
1362
+ 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 };