@procore/saved-views 5.1.0-alpha.4 → 5.1.0-alpha.5

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.
@@ -2,7 +2,7 @@ import { Locale, MapLocalesToTranslations } from '@procore/globalization-toolkit
2
2
  import * as React from 'react';
3
3
  import React__default from 'react';
4
4
  import { DataTableConfig, TableApi, ColumnDefinition } from '@procore/data-table';
5
- import { ColumnState, Column, FilterModel, GridApi } from 'ag-grid-community';
5
+ import { ColumnState, FilterModel, GridApi } from 'ag-grid-community';
6
6
  import * as styled_components from 'styled-components';
7
7
 
8
8
  declare function getTranslations(envLocale: Locale): Partial<MapLocalesToTranslations>;
@@ -25,7 +25,7 @@ interface ISmartGridConfig {
25
25
  groupId: string;
26
26
  open: boolean;
27
27
  }[];
28
- rowGroupState: Column[];
28
+ rowGroupState: string[];
29
29
  rowHeight: number | undefined;
30
30
  filterState: FilterModel;
31
31
  }
@@ -39,7 +39,18 @@ interface ISavedView {
39
39
  name: string;
40
40
  description?: string;
41
41
  table_config?: DataTableConfig | ISmartGridConfig;
42
- view_level: ViewLevel | 'default';
42
+ view_level: ViewLevel | 'default' | 'temporary';
43
+ }
44
+
45
+ interface IDefaultViewConfig<ProviderConfig = DataTableConfig | ISmartGridConfig> {
46
+ id: string;
47
+ name: string;
48
+ table_config: ProviderConfig;
49
+ view_level: 'default';
50
+ }
51
+ interface IDataTableDefaultViewConfig extends IDefaultViewConfig<DataTableConfig> {
52
+ }
53
+ interface ISmartGridDefaultViewConfig extends IDefaultViewConfig<ISmartGridConfig> {
43
54
  }
44
55
 
45
56
  type TableProvider = 'smart-grid' | 'data-table';
@@ -50,20 +61,27 @@ interface IBaseSavedViewsProps {
50
61
  userId: number;
51
62
  projectId: number;
52
63
  companyId: number;
64
+ stickyViewsKey: string;
65
+ }
66
+ interface ISavedViewsProps extends Omit<IBaseSavedViewsProps, 'stickyViewsKey'> {
67
+ defaultView: ISavedView;
68
+ presetViews: ISavedView[];
69
+ onSelect: ({ item }: {
70
+ item: ISavedView;
71
+ }) => ISavedView;
72
+ tableConfig: ISmartGridConfig | DataTableConfig;
73
+ provider: TableProvider;
53
74
  }
54
75
 
55
76
  interface IDataTableSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
56
77
  tableApi: TableApi;
57
- defaultViewName?: string;
58
- defaultViewConfig?: DataTableConfig;
78
+ defaultViews: IDataTableDefaultViewConfig[];
59
79
  columnDefinitions: ColumnDefinition[];
60
80
  }
61
81
 
62
82
  interface ISmartGridSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
63
83
  gridApi: GridApi;
64
- defaultViewName?: string;
65
- defaultViewFilters: FilterModel | null;
66
- defaultRowHeight: number;
84
+ defaultViews: ISmartGridDefaultViewConfig[];
67
85
  }
68
86
 
69
87
  interface IPermissions {
@@ -71,27 +89,6 @@ interface IPermissions {
71
89
  can_create_company_saved_views: boolean;
72
90
  }
73
91
 
74
- type SavedViewCollectionMenuItemProps = {
75
- item: ISavedView;
76
- key?: string;
77
- selected: boolean;
78
- canUpdate?: boolean;
79
- canEditOrDelete?: boolean;
80
- onUpdate?: (data: ISavedView) => void;
81
- onDelete?: (data: {
82
- savedView: ISavedView;
83
- }) => void;
84
- onEdit?: (data: {
85
- savedView: ISavedView;
86
- }) => void;
87
- isUpdateProcessing?: boolean;
88
- permissions?: IPermissions;
89
- onClearTemporary?: () => void;
90
- };
91
- declare const SavedViewCollectionMenuItem: (props: SavedViewCollectionMenuItemProps) => React.JSX.Element;
92
-
93
- declare const ExpandedPanel: styled_components.StyledComponent<any, any, any, any>;
94
-
95
92
  declare enum ModalType {
96
93
  CREATE = "create",
97
94
  UPDATE = "update",
@@ -99,7 +96,7 @@ declare enum ModalType {
99
96
  SHARED_VIEW = "sharedView"
100
97
  }
101
98
 
102
- type PanelContentProps = {
99
+ interface IPanelContentProps {
103
100
  openModal: (type: ModalType) => void;
104
101
  onDelete: () => void;
105
102
  onSelect: (data: {
@@ -110,19 +107,36 @@ type PanelContentProps = {
110
107
  tableConfig: DataTableConfig | ISmartGridConfig;
111
108
  provider: TableProvider;
112
109
  defaultView: ISavedView;
113
- stickyViewsKey: string;
110
+ presetViews: ISavedView[];
114
111
  userId: number;
115
112
  savedViews?: ISavedView[];
116
113
  onClearTemporary?: () => void;
114
+ }
115
+
116
+ type SavedViewCollectionMenuItemProps = {
117
+ item: ISavedView;
118
+ key?: string;
119
+ selected: boolean;
120
+ canUpdate?: boolean;
121
+ canEditOrDelete?: boolean;
122
+ onUpdate?: (data: ISavedView) => void;
123
+ onDelete?: (data: {
124
+ savedView: ISavedView;
125
+ }) => void;
126
+ onEdit?: (data: {
127
+ savedView: ISavedView;
128
+ }) => void;
129
+ isUpdateProcessing?: boolean;
130
+ permissions?: IPermissions;
131
+ onClearTemporary?: () => void;
117
132
  };
118
- declare const PanelContent: (props: PanelContentProps) => React__default.JSX.Element;
133
+ declare const SavedViewCollectionMenuItem: (props: SavedViewCollectionMenuItemProps) => React.JSX.Element;
119
134
 
120
- declare const SmartGridSavedViews: (props: ISmartGridSavedViewsExternalConsumerProps) => React__default.JSX.Element;
135
+ declare const ExpandedPanel: styled_components.StyledComponent<any, any, any, any>;
121
136
 
122
- interface IDataTableSavedViewsRef {
123
- setTableConfig: (config: DataTableConfig) => void;
124
- }
125
- declare const DataTableSavedViews: React__default.ForwardRefExoticComponent<IDataTableSavedViewsExternalConsumerProps & React__default.RefAttributes<IDataTableSavedViewsRef>>;
137
+ declare const PanelContent: (props: IPanelContentProps) => React__default.JSX.Element;
138
+
139
+ declare const SavedViews: (props: ISavedViewsProps) => React__default.JSX.Element;
126
140
 
127
141
  type Props = {
128
142
  onDelete(): void;
@@ -131,7 +145,7 @@ type Props = {
131
145
  };
132
146
  declare const SavedViewsDeleteConfirmationModalShared: React__default.FC<Props>;
133
147
 
134
- type SavedViewsFormModalProps = {
148
+ type FormModalProps = {
135
149
  open: boolean;
136
150
  mode: ModalType;
137
151
  isLoading?: boolean;
@@ -144,6 +158,13 @@ type SavedViewsFormModalProps = {
144
158
  setOpenEditCreateModal: (open: boolean) => void;
145
159
  defaultView: ISavedView;
146
160
  };
147
- declare const SavedViewsFormModal: React__default.FC<SavedViewsFormModalProps>;
161
+ declare const FormModal: React__default.FC<FormModalProps>;
162
+
163
+ declare const SmartGridSavedViews: (props: ISmartGridSavedViewsExternalConsumerProps) => React__default.JSX.Element;
164
+
165
+ interface IDataTableSavedViewsRef {
166
+ setTableConfig: (config: DataTableConfig) => void;
167
+ }
168
+ declare const DataTableSavedViews: React__default.ForwardRefExoticComponent<IDataTableSavedViewsExternalConsumerProps & React__default.RefAttributes<IDataTableSavedViewsRef>>;
148
169
 
149
- export { DataTableSavedViews, ExpandedPanel, type IDataTableSavedViewsRef, PanelContent, type PanelContentProps, SavedViewCollectionMenuItem, SavedViewsDeleteConfirmationModalShared, SavedViewsFormModal, SmartGridSavedViews, getTranslations, useSavedViewsPanel };
170
+ export { DataTableSavedViews, ExpandedPanel, FormModal, type IDataTableDefaultViewConfig, type IDataTableSavedViewsRef, type ISmartGridDefaultViewConfig, PanelContent, SavedViewCollectionMenuItem, SavedViews, SavedViewsDeleteConfirmationModalShared, SmartGridSavedViews, getTranslations, useSavedViewsPanel };
@@ -2,7 +2,7 @@ import { Locale, MapLocalesToTranslations } from '@procore/globalization-toolkit
2
2
  import * as React from 'react';
3
3
  import React__default from 'react';
4
4
  import { DataTableConfig, TableApi, ColumnDefinition } from '@procore/data-table';
5
- import { ColumnState, Column, FilterModel, GridApi } from 'ag-grid-community';
5
+ import { ColumnState, FilterModel, GridApi } from 'ag-grid-community';
6
6
  import * as styled_components from 'styled-components';
7
7
 
8
8
  declare function getTranslations(envLocale: Locale): Partial<MapLocalesToTranslations>;
@@ -25,7 +25,7 @@ interface ISmartGridConfig {
25
25
  groupId: string;
26
26
  open: boolean;
27
27
  }[];
28
- rowGroupState: Column[];
28
+ rowGroupState: string[];
29
29
  rowHeight: number | undefined;
30
30
  filterState: FilterModel;
31
31
  }
@@ -39,7 +39,18 @@ interface ISavedView {
39
39
  name: string;
40
40
  description?: string;
41
41
  table_config?: DataTableConfig | ISmartGridConfig;
42
- view_level: ViewLevel | 'default';
42
+ view_level: ViewLevel | 'default' | 'temporary';
43
+ }
44
+
45
+ interface IDefaultViewConfig<ProviderConfig = DataTableConfig | ISmartGridConfig> {
46
+ id: string;
47
+ name: string;
48
+ table_config: ProviderConfig;
49
+ view_level: 'default';
50
+ }
51
+ interface IDataTableDefaultViewConfig extends IDefaultViewConfig<DataTableConfig> {
52
+ }
53
+ interface ISmartGridDefaultViewConfig extends IDefaultViewConfig<ISmartGridConfig> {
43
54
  }
44
55
 
45
56
  type TableProvider = 'smart-grid' | 'data-table';
@@ -50,20 +61,27 @@ interface IBaseSavedViewsProps {
50
61
  userId: number;
51
62
  projectId: number;
52
63
  companyId: number;
64
+ stickyViewsKey: string;
65
+ }
66
+ interface ISavedViewsProps extends Omit<IBaseSavedViewsProps, 'stickyViewsKey'> {
67
+ defaultView: ISavedView;
68
+ presetViews: ISavedView[];
69
+ onSelect: ({ item }: {
70
+ item: ISavedView;
71
+ }) => ISavedView;
72
+ tableConfig: ISmartGridConfig | DataTableConfig;
73
+ provider: TableProvider;
53
74
  }
54
75
 
55
76
  interface IDataTableSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
56
77
  tableApi: TableApi;
57
- defaultViewName?: string;
58
- defaultViewConfig?: DataTableConfig;
78
+ defaultViews: IDataTableDefaultViewConfig[];
59
79
  columnDefinitions: ColumnDefinition[];
60
80
  }
61
81
 
62
82
  interface ISmartGridSavedViewsExternalConsumerProps extends IBaseSavedViewsProps {
63
83
  gridApi: GridApi;
64
- defaultViewName?: string;
65
- defaultViewFilters: FilterModel | null;
66
- defaultRowHeight: number;
84
+ defaultViews: ISmartGridDefaultViewConfig[];
67
85
  }
68
86
 
69
87
  interface IPermissions {
@@ -71,27 +89,6 @@ interface IPermissions {
71
89
  can_create_company_saved_views: boolean;
72
90
  }
73
91
 
74
- type SavedViewCollectionMenuItemProps = {
75
- item: ISavedView;
76
- key?: string;
77
- selected: boolean;
78
- canUpdate?: boolean;
79
- canEditOrDelete?: boolean;
80
- onUpdate?: (data: ISavedView) => void;
81
- onDelete?: (data: {
82
- savedView: ISavedView;
83
- }) => void;
84
- onEdit?: (data: {
85
- savedView: ISavedView;
86
- }) => void;
87
- isUpdateProcessing?: boolean;
88
- permissions?: IPermissions;
89
- onClearTemporary?: () => void;
90
- };
91
- declare const SavedViewCollectionMenuItem: (props: SavedViewCollectionMenuItemProps) => React.JSX.Element;
92
-
93
- declare const ExpandedPanel: styled_components.StyledComponent<any, any, any, any>;
94
-
95
92
  declare enum ModalType {
96
93
  CREATE = "create",
97
94
  UPDATE = "update",
@@ -99,7 +96,7 @@ declare enum ModalType {
99
96
  SHARED_VIEW = "sharedView"
100
97
  }
101
98
 
102
- type PanelContentProps = {
99
+ interface IPanelContentProps {
103
100
  openModal: (type: ModalType) => void;
104
101
  onDelete: () => void;
105
102
  onSelect: (data: {
@@ -110,19 +107,36 @@ type PanelContentProps = {
110
107
  tableConfig: DataTableConfig | ISmartGridConfig;
111
108
  provider: TableProvider;
112
109
  defaultView: ISavedView;
113
- stickyViewsKey: string;
110
+ presetViews: ISavedView[];
114
111
  userId: number;
115
112
  savedViews?: ISavedView[];
116
113
  onClearTemporary?: () => void;
114
+ }
115
+
116
+ type SavedViewCollectionMenuItemProps = {
117
+ item: ISavedView;
118
+ key?: string;
119
+ selected: boolean;
120
+ canUpdate?: boolean;
121
+ canEditOrDelete?: boolean;
122
+ onUpdate?: (data: ISavedView) => void;
123
+ onDelete?: (data: {
124
+ savedView: ISavedView;
125
+ }) => void;
126
+ onEdit?: (data: {
127
+ savedView: ISavedView;
128
+ }) => void;
129
+ isUpdateProcessing?: boolean;
130
+ permissions?: IPermissions;
131
+ onClearTemporary?: () => void;
117
132
  };
118
- declare const PanelContent: (props: PanelContentProps) => React__default.JSX.Element;
133
+ declare const SavedViewCollectionMenuItem: (props: SavedViewCollectionMenuItemProps) => React.JSX.Element;
119
134
 
120
- declare const SmartGridSavedViews: (props: ISmartGridSavedViewsExternalConsumerProps) => React__default.JSX.Element;
135
+ declare const ExpandedPanel: styled_components.StyledComponent<any, any, any, any>;
121
136
 
122
- interface IDataTableSavedViewsRef {
123
- setTableConfig: (config: DataTableConfig) => void;
124
- }
125
- declare const DataTableSavedViews: React__default.ForwardRefExoticComponent<IDataTableSavedViewsExternalConsumerProps & React__default.RefAttributes<IDataTableSavedViewsRef>>;
137
+ declare const PanelContent: (props: IPanelContentProps) => React__default.JSX.Element;
138
+
139
+ declare const SavedViews: (props: ISavedViewsProps) => React__default.JSX.Element;
126
140
 
127
141
  type Props = {
128
142
  onDelete(): void;
@@ -131,7 +145,7 @@ type Props = {
131
145
  };
132
146
  declare const SavedViewsDeleteConfirmationModalShared: React__default.FC<Props>;
133
147
 
134
- type SavedViewsFormModalProps = {
148
+ type FormModalProps = {
135
149
  open: boolean;
136
150
  mode: ModalType;
137
151
  isLoading?: boolean;
@@ -144,6 +158,13 @@ type SavedViewsFormModalProps = {
144
158
  setOpenEditCreateModal: (open: boolean) => void;
145
159
  defaultView: ISavedView;
146
160
  };
147
- declare const SavedViewsFormModal: React__default.FC<SavedViewsFormModalProps>;
161
+ declare const FormModal: React__default.FC<FormModalProps>;
162
+
163
+ declare const SmartGridSavedViews: (props: ISmartGridSavedViewsExternalConsumerProps) => React__default.JSX.Element;
164
+
165
+ interface IDataTableSavedViewsRef {
166
+ setTableConfig: (config: DataTableConfig) => void;
167
+ }
168
+ declare const DataTableSavedViews: React__default.ForwardRefExoticComponent<IDataTableSavedViewsExternalConsumerProps & React__default.RefAttributes<IDataTableSavedViewsRef>>;
148
169
 
149
- export { DataTableSavedViews, ExpandedPanel, type IDataTableSavedViewsRef, PanelContent, type PanelContentProps, SavedViewCollectionMenuItem, SavedViewsDeleteConfirmationModalShared, SavedViewsFormModal, SmartGridSavedViews, getTranslations, useSavedViewsPanel };
170
+ export { DataTableSavedViews, ExpandedPanel, FormModal, type IDataTableDefaultViewConfig, type IDataTableSavedViewsRef, type ISmartGridDefaultViewConfig, PanelContent, SavedViewCollectionMenuItem, SavedViews, SavedViewsDeleteConfirmationModalShared, SmartGridSavedViews, getTranslations, useSavedViewsPanel };