@firecms/core 3.3.0 → 3.4.0-canary.2575a08

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 (155) hide show
  1. package/dist/app/useApp.d.ts +1 -0
  2. package/dist/components/EntityCollectionTable/column_utils.d.ts +4 -3
  3. package/dist/components/EntityCollectionTable/internal/CollectionTableToolbar.d.ts +6 -1
  4. package/dist/components/EntityCollectionTable/internal/popup_field/PopupFormField.d.ts +3 -1
  5. package/dist/components/EntityCollectionView/EntityCollectionBoardView.d.ts +3 -1
  6. package/dist/components/EntityCollectionView/EntityCollectionView.d.ts +8 -0
  7. package/dist/components/EntityCollectionView/EntityCollectionViewActions.d.ts +3 -1
  8. package/dist/components/EntityCollectionView/EntityCollectionViewStartActions.d.ts +3 -1
  9. package/dist/components/EntityCollectionView/FiltersDialog.d.ts +2 -1
  10. package/dist/components/EntityCollectionView/useBoardDataController.d.ts +3 -1
  11. package/dist/components/EntityPreview.d.ts +3 -1
  12. package/dist/components/ReferenceTable/ReferenceSelectionTable.d.ts +10 -1
  13. package/dist/components/SelectableTable/filters/filter_text_input.d.ts +30 -0
  14. package/dist/components/SelectableTable/filters/filter_text_input.test.d.ts +1 -0
  15. package/dist/components/common/table_url_params.d.ts +24 -0
  16. package/dist/components/common/useDataSourceTableController.d.ts +9 -1
  17. package/dist/components/common/useTableSearchHelper.d.ts +9 -1
  18. package/dist/core/DefaultDrawer.d.ts +10 -3
  19. package/dist/core/EntityEditView.d.ts +9 -1
  20. package/dist/core/EntityEditViewFormActions.d.ts +1 -1
  21. package/dist/core/field_configs.d.ts +1 -1
  22. package/dist/form/EntityForm.d.ts +8 -1
  23. package/dist/form/EntityFormActions.d.ts +2 -0
  24. package/dist/form/field_bindings/GeopointFieldBinding.d.ts +5 -0
  25. package/dist/form/index.d.ts +1 -0
  26. package/dist/hooks/data/delete.d.ts +1 -1
  27. package/dist/hooks/data/save.d.ts +1 -1
  28. package/dist/hooks/data/useCollectionFetch.d.ts +7 -1
  29. package/dist/hooks/data/useEntityFetch.d.ts +9 -1
  30. package/dist/i18n/__tests__/FireCMSi18nProvider.test.d.ts +1 -0
  31. package/dist/i18n/__tests__/nested_provider_lifecycle.test.d.ts +1 -0
  32. package/dist/index.es.js +3658 -1820
  33. package/dist/index.es.js.map +1 -1
  34. package/dist/index.umd.js +3655 -1817
  35. package/dist/index.umd.js.map +1 -1
  36. package/dist/locales/pl.d.ts +2 -0
  37. package/dist/preview/index.d.ts +1 -0
  38. package/dist/preview/property_previews/GeopointPropertyPreview.d.ts +4 -0
  39. package/dist/types/collections.d.ts +31 -0
  40. package/dist/types/datasource.d.ts +67 -4
  41. package/dist/types/entities.d.ts +21 -1
  42. package/dist/types/entity_actions.d.ts +6 -0
  43. package/dist/types/entity_callbacks.d.ts +21 -0
  44. package/dist/types/navigation.d.ts +34 -5
  45. package/dist/types/plugins.d.ts +13 -0
  46. package/dist/types/properties.d.ts +17 -1
  47. package/dist/types/side_entity_controller.d.ts +7 -0
  48. package/dist/types/translations.d.ts +6 -0
  49. package/dist/util/__tests__/collections.test.d.ts +1 -0
  50. package/dist/util/__tests__/urls.test.d.ts +1 -0
  51. package/dist/util/collections.d.ts +1 -1
  52. package/dist/util/entities.d.ts +1 -0
  53. package/dist/util/entity_cache.d.ts +11 -0
  54. package/dist/util/geopoint.d.ts +22 -0
  55. package/dist/util/index.d.ts +2 -0
  56. package/dist/util/navigation_blocking.d.ts +22 -0
  57. package/dist/util/navigation_from_path.d.ts +17 -0
  58. package/dist/util/navigation_utils.d.ts +107 -3
  59. package/dist/util/parent_references_from_path.d.ts +16 -0
  60. package/dist/util/paths.d.ts +28 -0
  61. package/dist/util/permissions.d.ts +10 -4
  62. package/dist/util/urls.d.ts +22 -0
  63. package/package.json +17 -10
  64. package/src/app/Scaffold.tsx +34 -44
  65. package/src/app/useApp.tsx +1 -0
  66. package/src/components/DeleteEntityDialog.tsx +2 -0
  67. package/src/components/EntityCollectionTable/EntityCollectionRowActions.tsx +2 -2
  68. package/src/components/EntityCollectionTable/EntityCollectionTable.tsx +3 -1
  69. package/src/components/EntityCollectionTable/column_utils.tsx +11 -19
  70. package/src/components/EntityCollectionTable/fields/TableReferenceField.tsx +1 -1
  71. package/src/components/EntityCollectionTable/internal/CollectionTableToolbar.tsx +7 -0
  72. package/src/components/EntityCollectionTable/internal/popup_field/PopupFormField.tsx +5 -1
  73. package/src/components/EntityCollectionView/EntityCollectionBoardView.tsx +12 -0
  74. package/src/components/EntityCollectionView/EntityCollectionView.tsx +66 -15
  75. package/src/components/EntityCollectionView/EntityCollectionViewActions.tsx +6 -2
  76. package/src/components/EntityCollectionView/EntityCollectionViewStartActions.tsx +8 -1
  77. package/src/components/EntityCollectionView/FiltersDialog.tsx +39 -28
  78. package/src/components/EntityCollectionView/useBoardDataController.tsx +17 -1
  79. package/src/components/EntityPreview.tsx +45 -41
  80. package/src/components/ReferenceTable/ReferenceSelectionTable.tsx +19 -2
  81. package/src/components/ReferenceWidget.tsx +1 -1
  82. package/src/components/SelectableTable/filters/ReferenceFilterField.tsx +2 -2
  83. package/src/components/SelectableTable/filters/StringNumberFilterField.tsx +33 -7
  84. package/src/components/SelectableTable/filters/filter_text_input.test.ts +184 -0
  85. package/src/components/SelectableTable/filters/filter_text_input.ts +71 -0
  86. package/src/components/VirtualTable/VirtualTable.tsx +19 -8
  87. package/src/components/common/default_entity_actions.tsx +22 -2
  88. package/src/components/common/table_url_params.ts +172 -0
  89. package/src/components/common/useDataSourceTableController.tsx +126 -163
  90. package/src/components/common/useTableSearchHelper.ts +26 -2
  91. package/src/contexts/SnackbarProvider.tsx +14 -1
  92. package/src/core/DefaultDrawer.tsx +150 -64
  93. package/src/core/DrawerNavigationGroup.tsx +27 -29
  94. package/src/core/DrawerNavigationItem.tsx +10 -12
  95. package/src/core/EntityEditView.tsx +77 -35
  96. package/src/core/EntityEditViewFormActions.tsx +3 -2
  97. package/src/core/EntitySidePanel.tsx +8 -4
  98. package/src/core/field_configs.tsx +15 -0
  99. package/src/form/EntityForm.tsx +31 -10
  100. package/src/form/EntityFormActions.tsx +2 -0
  101. package/src/form/field_bindings/ArrayOfReferencesFieldBinding.tsx +1 -1
  102. package/src/form/field_bindings/GeopointFieldBinding.tsx +139 -0
  103. package/src/form/index.tsx +1 -0
  104. package/src/hooks/data/delete.ts +8 -0
  105. package/src/hooks/data/save.ts +6 -1
  106. package/src/hooks/data/useCollectionFetch.tsx +21 -1
  107. package/src/hooks/data/useEntityFetch.tsx +35 -4
  108. package/src/hooks/useBuildNavigationController.tsx +23 -8
  109. package/src/hooks/useResolvedNavigationFrom.tsx +3 -1
  110. package/src/hooks/useValidateAuthenticator.tsx +4 -0
  111. package/src/i18n/FireCMSi18nProvider.tsx +50 -4
  112. package/src/i18n/__tests__/FireCMSi18nProvider.test.tsx +91 -0
  113. package/src/i18n/__tests__/nested_provider_lifecycle.test.tsx +67 -0
  114. package/src/internal/useBuildDataSource.ts +37 -15
  115. package/src/internal/useBuildSideEntityController.tsx +20 -5
  116. package/src/locales/de.ts +7 -2
  117. package/src/locales/en.ts +7 -2
  118. package/src/locales/es.ts +7 -2
  119. package/src/locales/fr.ts +7 -2
  120. package/src/locales/hi.ts +7 -2
  121. package/src/locales/it.ts +7 -2
  122. package/src/locales/pl.ts +735 -0
  123. package/src/locales/pt.ts +7 -2
  124. package/src/preview/PropertyPreview.tsx +12 -0
  125. package/src/preview/components/ReferencePreview.tsx +7 -3
  126. package/src/preview/components/StorageThumbnail.tsx +24 -2
  127. package/src/preview/index.ts +1 -0
  128. package/src/preview/property_previews/GeopointPropertyPreview.tsx +23 -0
  129. package/src/routes/FireCMSRoute.tsx +54 -27
  130. package/src/types/collections.ts +34 -0
  131. package/src/types/datasource.ts +67 -4
  132. package/src/types/entities.ts +24 -1
  133. package/src/types/entity_actions.tsx +6 -0
  134. package/src/types/entity_callbacks.ts +24 -0
  135. package/src/types/navigation.ts +35 -5
  136. package/src/types/plugins.tsx +13 -0
  137. package/src/types/properties.ts +17 -0
  138. package/src/types/side_entity_controller.tsx +7 -0
  139. package/src/types/translations.ts +6 -0
  140. package/src/util/__tests__/collections.test.ts +32 -0
  141. package/src/util/__tests__/urls.test.ts +131 -0
  142. package/src/util/collections.ts +1 -1
  143. package/src/util/entities.ts +16 -1
  144. package/src/util/entity_cache.ts +18 -0
  145. package/src/util/geopoint.ts +81 -0
  146. package/src/util/index.ts +2 -0
  147. package/src/util/navigation_blocking.ts +45 -0
  148. package/src/util/navigation_from_path.ts +47 -7
  149. package/src/util/navigation_utils.ts +244 -4
  150. package/src/util/parent_references_from_path.ts +45 -4
  151. package/src/util/paths.ts +40 -3
  152. package/src/util/permissions.ts +22 -10
  153. package/src/util/previews.ts +8 -1
  154. package/src/util/resolutions.ts +8 -0
  155. package/src/util/urls.ts +52 -0
@@ -45,6 +45,8 @@ export interface BoardDataController<M extends Record<string, any> = any, COLUMN
45
45
  export interface UseBoardDataControllerProps<M extends Record<string, any> = any> {
46
46
  /** Full path to the collection */
47
47
  fullPath: string;
48
+ /** `fullPath` split at its real segment boundaries; forwarded to the datasource. */
49
+ pathSegments?: string[];
48
50
  /** The entity collection configuration */
49
51
  collection: EntityCollection<M>;
50
52
  /** Property key used for column assignment */
@@ -67,6 +69,7 @@ export interface UseBoardDataControllerProps<M extends Record<string, any> = any
67
69
  */
68
70
  export function useBoardDataController<M extends Record<string, any> = any, COLUMN extends string = string>({
69
71
  fullPath,
72
+ pathSegments,
70
73
  collection,
71
74
  columnProperty,
72
75
  columns,
@@ -79,7 +82,12 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
79
82
  const context = useFireCMSContext();
80
83
  const dataSource = useDataSource(collection);
81
84
  const navigation = useNavigationController();
82
- const resolvedPath = useMemo(() => navigation.resolveIdsFrom(fullPath), [fullPath, navigation.resolveIdsFrom]);
85
+ // Resolved together so the two representations always describe the same chain.
86
+ // Segments are resolved, never derived (see useEntityFetch).
87
+ const resolvedPath = useMemo(() => navigation.resolveIdsFrom(fullPath, pathSegments), [fullPath, pathSegments, navigation.resolveIdsFrom]);
88
+ const resolvedPathSegments = useMemo(() => pathSegments
89
+ ? (navigation.resolveSegmentsFrom?.(pathSegments) ?? pathSegments)
90
+ : undefined, [pathSegments, navigation.resolveSegmentsFrom]);
83
91
 
84
92
  // Stable refs for objects that shouldn't trigger re-subscriptions
85
93
  const dataSourceRef = useRef(dataSource);
@@ -95,11 +103,13 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
95
103
  const orderPropertyRef = useRef(orderProperty);
96
104
  const searchStringRef = useRef(searchString);
97
105
  const resolvedPathRef = useRef(resolvedPath);
106
+ const resolvedPathSegmentsRef = useRef(resolvedPathSegments);
98
107
  filterValuesRef.current = filterValues;
99
108
  columnPropertyRef.current = columnProperty;
100
109
  orderPropertyRef.current = orderProperty;
101
110
  searchStringRef.current = searchString;
102
111
  resolvedPathRef.current = resolvedPath;
112
+ resolvedPathSegmentsRef.current = resolvedPathSegments;
103
113
 
104
114
  // Track item count per column for pagination
105
115
  const [columnItemCounts, setColumnItemCounts] = useState<Record<string, number>>(() => {
@@ -168,6 +178,7 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
168
178
  const currentOrderProperty = orderPropertyRef.current;
169
179
  const currentSearchString = searchStringRef.current;
170
180
  const currentResolvedPath = resolvedPathRef.current;
181
+ const currentPathSegments = resolvedPathSegmentsRef.current;
171
182
 
172
183
  // Build filter for this column
173
184
  const columnFilter: FilterValues<string> = {
@@ -205,6 +216,7 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
205
216
  currentCollection.callbacks!.onFetch!({
206
217
  collection: currentCollection,
207
218
  path: currentResolvedPath,
219
+ pathSegments: currentPathSegments,
208
220
  entity,
209
221
  context: currentContext
210
222
  })
@@ -248,6 +260,7 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
248
260
  if (currentDataSource.listenCollection) {
249
261
  const unsubscribe = currentDataSource.listenCollection<M>({
250
262
  path: currentResolvedPath,
263
+ pathSegments: currentPathSegments,
251
264
  collection: currentCollection,
252
265
  onUpdate,
253
266
  onError,
@@ -262,6 +275,7 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
262
275
  } else {
263
276
  currentDataSource.fetchCollection<M>({
264
277
  path: currentResolvedPath,
278
+ pathSegments: currentPathSegments,
265
279
  collection: currentCollection,
266
280
  searchString: currentSearchString,
267
281
  filter: columnFilter,
@@ -297,6 +311,7 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
297
311
  const currentColumnProperty = columnPropertyRef.current;
298
312
  const currentSearchString = searchStringRef.current;
299
313
  const currentResolvedPath = resolvedPathRef.current;
314
+ const currentPathSegments = resolvedPathSegmentsRef.current;
300
315
  const currentColumns = columns;
301
316
  const currentColumnItemCounts = columnItemCounts;
302
317
 
@@ -316,6 +331,7 @@ export function useBoardDataController<M extends Record<string, any> = any, COLU
316
331
  };
317
332
  currentDataSource.countEntities({
318
333
  path: currentResolvedPath,
334
+ pathSegments: currentPathSegments,
319
335
  collection: currentCollection,
320
336
  filter: columnFilter,
321
337
  searchString: currentSearchString
@@ -63,7 +63,7 @@ export function EntityPreview({
63
63
 
64
64
  const navigationController = useNavigationController();
65
65
 
66
- const collection = collectionProp ?? navigationController.getCollection(entity.path);
66
+ const collection = collectionProp ?? navigationController.getCollection(entity.path, false, entity.pathSegments);
67
67
 
68
68
  if (!collection) {
69
69
  throw Error(`Couldn't find the corresponding collection view for the path: ${entity.path}`);
@@ -177,6 +177,9 @@ export function EntityPreview({
177
177
  sideEntityController.open({
178
178
  entityId: entity.id,
179
179
  path: entity.path,
180
+ // Paired with `entity.path` above; undefined if the entity was
181
+ // loaded without them.
182
+ pathSegments: entity.pathSegments,
180
183
  collection,
181
184
  updateUrl: true
182
185
  });
@@ -200,43 +203,44 @@ export type EntityPreviewContainerProps = {
200
203
  onClick?: (e: React.SyntheticEvent) => void;
201
204
  };
202
205
 
203
- export const EntityPreviewContainer = React.forwardRef<HTMLDivElement, EntityPreviewContainerProps>(({
204
- children,
205
- hover,
206
- onClick,
207
- size = "medium",
208
- style,
209
- className,
210
- fullwidth = true,
211
- ...props
212
- }, ref) => {
213
- return <div
214
- ref={ref}
215
- style={{
216
- ...style,
217
- // @ts-ignore
218
- tabindex: 0
219
- }}
220
- className={cls(
221
- "bg-white dark:bg-surface-900",
222
- "min-h-[44px]",
223
- fullwidth ? "w-full" : "",
224
- "items-center",
225
- hover ? "hover:bg-surface-accent-50 dark:hover:bg-surface-800 group-hover:bg-surface-accent-50 dark:group-hover:bg-surface-800" : "",
226
- size === "small" ? "p-1" : "px-2 py-1",
227
- "flex border rounded-lg",
228
- onClick ? "cursor-pointer" : "",
229
- defaultBorderMixin,
230
- className)}
231
- onClick={(event) => {
232
- if (onClick) {
233
- event.preventDefault();
234
- onClick(event);
235
- }
236
- }}
237
- {...props}>
238
- {children}
239
- </div>;
240
- });
241
-
242
- EntityPreviewContainer.displayName = "EntityPreviewContainer";
206
+ export function EntityPreviewContainer({
207
+ children,
208
+ hover,
209
+ onClick,
210
+ size = "medium",
211
+ style,
212
+ className,
213
+ fullwidth = true,
214
+ ref
215
+ }: EntityPreviewContainerProps & { ref?: React.Ref<HTMLDivElement> }) {
216
+ const divClassName = cls(
217
+ "bg-white dark:bg-surface-900",
218
+ "min-h-[44px]",
219
+ fullwidth ? "w-full" : "",
220
+ "items-center",
221
+ hover ? "hover:bg-surface-accent-50 dark:hover:bg-surface-800 group-hover:bg-surface-accent-50 dark:group-hover:bg-surface-800" : "",
222
+ size === "small" ? "p-1" : "px-2 py-1",
223
+ "flex border rounded-lg",
224
+ onClick ? "cursor-pointer" : "",
225
+ defaultBorderMixin,
226
+ className
227
+ );
228
+
229
+ const handleClick = onClick
230
+ ? (event: React.MouseEvent<HTMLDivElement>) => {
231
+ event.preventDefault();
232
+ onClick(event);
233
+ }
234
+ : undefined;
235
+
236
+ const divProps: React.HTMLAttributes<HTMLDivElement> & { ref?: React.Ref<HTMLDivElement> } = {
237
+ ref,
238
+ tabIndex: 0,
239
+ style,
240
+ className: divClassName,
241
+ onClick: handleClick,
242
+ };
243
+
244
+ return <div {...divProps}>{children}</div>;
245
+ }
246
+
@@ -44,6 +44,15 @@ export interface ReferenceSelectionInnerProps<M extends Record<string, any>> {
44
44
  * dynamic. If not set, the dialog won't open.
45
45
  */
46
46
  path: string;
47
+ /**
48
+ * `path` split at its real segment boundaries, when the caller knows them.
49
+ *
50
+ * Left undefined by default and deliberately NOT derived from `path`: a reference
51
+ * path comes from a property's configuration, so there is no entity chain to recover
52
+ * the boundaries from. Splitting it would silently produce the wrong segments for a
53
+ * subcollection under a slash-bearing parent id, which is worse than not answering.
54
+ */
55
+ pathSegments?: string[];
47
56
 
48
57
  /**
49
58
  * If you are opening the dialog for the first time, you can select some
@@ -96,6 +105,7 @@ export function ReferenceSelectionTable<M extends Record<string, any>>(
96
105
  multiselect,
97
106
  collection,
98
107
  path: pathInput,
108
+ pathSegments,
99
109
  selectedEntityIds: selectedEntityIdsProp,
100
110
  description,
101
111
  forceFilter,
@@ -110,7 +120,7 @@ export function ReferenceSelectionTable<M extends Record<string, any>>(
110
120
  const analyticsController = useAnalyticsController();
111
121
  const customizationController = useCustomizationController();
112
122
 
113
- const fullPath = navigation.resolveIdsFrom(pathInput);
123
+ const fullPath = navigation.resolveIdsFrom(pathInput, pathSegments);
114
124
 
115
125
  const dataSource = useDataSource(collection);
116
126
 
@@ -153,6 +163,7 @@ export function ReferenceSelectionTable<M extends Record<string, any>>(
153
163
  selectedEntityIds.map((entityId) =>
154
164
  dataSource.fetchEntity({
155
165
  path: fullPath,
166
+ pathSegments,
156
167
  entityId,
157
168
  collection
158
169
  })))
@@ -204,6 +215,7 @@ export function ReferenceSelectionTable<M extends Record<string, any>>(
204
215
  });
205
216
  sideEntityController.open({
206
217
  path: fullPath,
218
+ pathSegments,
207
219
  collection,
208
220
  updateUrl: true,
209
221
  onUpdate: ({ entity }) => {
@@ -277,6 +289,7 @@ export function ReferenceSelectionTable<M extends Record<string, any>>(
277
289
  textSearchEnabled
278
290
  } =
279
291
  useTableSearchHelper({
292
+ pathSegments,
280
293
  collection,
281
294
  fullPath,
282
295
  });
@@ -315,6 +328,7 @@ export function ReferenceSelectionTable<M extends Record<string, any>>(
315
328
  actions={<ReferenceDialogActions
316
329
  collection={collection}
317
330
  path={fullPath}
331
+ pathSegments={pathSegments}
318
332
  onNewClick={onNewClick}
319
333
  onClear={onClear}/>
320
334
  }
@@ -341,11 +355,14 @@ export function ReferenceSelectionTable<M extends Record<string, any>>(
341
355
  function ReferenceDialogActions({
342
356
  collection,
343
357
  path,
358
+ pathSegments,
344
359
  onClear,
345
360
  onNewClick
346
361
  }: {
347
362
  collection: EntityCollection<any>,
348
363
  path: string,
364
+ /** `path` split at its real segment boundaries, when known. Never derived from `path`. */
365
+ pathSegments?: string[],
349
366
  onClear: () => void,
350
367
  onNewClick: () => void
351
368
  }) {
@@ -360,7 +377,7 @@ function ReferenceDialogActions({
360
377
  onNewClick();
361
378
  }
362
379
  : undefined;
363
- const addButton = canCreateEntity(collection, authController, path, null) &&
380
+ const addButton = canCreateEntity(collection, authController, path, null, pathSegments) &&
364
381
  onClick && (largeLayout
365
382
  ? <Button
366
383
  onClick={onClick}
@@ -73,7 +73,7 @@ export function ReferenceWidget<M extends Record<string, any>>({
73
73
  if (disabled)
74
74
  return;
75
75
  if (onMultipleReferenceSelected) {
76
- const references = entities ? entities.map(e => getReferenceFrom(e)) : null;
76
+ const references = entities ? entities.filter(Boolean).map(e => getReferenceFrom(e)) : null;
77
77
  onMultipleReferenceSelected({
78
78
  references,
79
79
  entities
@@ -113,11 +113,11 @@ export function ReferenceFilterField({
113
113
  }, [path]);
114
114
 
115
115
  const onSingleEntitySelected = (entity: Entity<any>) => {
116
- updateFilter(operation, getReferenceFrom(entity));
116
+ if (entity) updateFilter(operation, getReferenceFrom(entity));
117
117
  };
118
118
 
119
119
  const onMultipleEntitiesSelected = (entities: Entity<any>[]) => {
120
- updateFilter(operation, entities.map(e => getReferenceFrom(e)));
120
+ updateFilter(operation, entities.filter(Boolean).map(e => getReferenceFrom(e)));
121
121
  };
122
122
 
123
123
  const multiple = multipleSelectOperations.includes(operation);
@@ -11,6 +11,7 @@ import {
11
11
  TextField
12
12
  } from "@firecms/ui";
13
13
  import { EnumValueConfig } from "../../../types";
14
+ import { filterValueToText, parseFilterTextInput } from "./filter_text_input";
14
15
 
15
16
  interface StringNumberFilterFieldProps {
16
17
  name: string,
@@ -60,8 +61,15 @@ export function StringNumberFilterField({
60
61
  const [fieldOperation, fieldValue] = value || [possibleOperations[0], undefined];
61
62
  const [operation, setOperation] = useState<VirtualTableWhereFilterOp | "is-null">(fieldOperation === "==" && fieldValue === null ? "is-null" : fieldOperation);
62
63
  const [internalValue, setInternalValue] = useState<string | number | string[] | number[] | null | undefined>(fieldValue);
64
+ // Raw text of the text input, kept apart from `internalValue` so that intermediate
65
+ // inputs like "-", "0." or ".0" are not destroyed while the user is typing.
66
+ const [inputText, setInputText] = useState<string>(filterValueToText(fieldValue));
67
+ // Value the current `inputText` was built from, used to tell updates coming from
68
+ // outside apart from the ones triggered by the user typing.
69
+ const syncedValueRef = React.useRef(fieldValue);
63
70
 
64
71
  React.useEffect(() => {
72
+ const newValue = value ? value[1] : undefined;
65
73
  if (value) {
66
74
  const [op, val] = value;
67
75
  setOperation(op === "==" && val === null ? "is-null" : op);
@@ -70,15 +78,25 @@ export function StringNumberFilterField({
70
78
  setOperation(possibleOperations[0]);
71
79
  setInternalValue(undefined);
72
80
  }
81
+ // only reset the text when the value was changed somewhere else, so we don't
82
+ // interfere with what the user is currently typing
83
+ if (syncedValueRef.current !== newValue) {
84
+ syncedValueRef.current = newValue;
85
+ setInputText(filterValueToText(newValue));
86
+ }
73
87
  }, [value, possibleOperations[0]]);
74
88
 
75
89
  const isNullOperation = operation === "is-null";
76
90
 
77
- function updateFilter(op: VirtualTableWhereFilterOp | "is-null", val: string | number | string[] | number[] | null | undefined) {
91
+ // `keepInputText` is used when the update originates from the text input, where the
92
+ // text typed by the user is authoritative and must not be overwritten with `val`
93
+ function updateFilter(op: VirtualTableWhereFilterOp | "is-null", val: string | number | string[] | number[] | null | undefined, keepInputText = false) {
78
94
  // Handle "is null" operation
79
95
  if (op === "is-null") {
80
96
  setOperation(op);
81
97
  setInternalValue(null);
98
+ syncedValueRef.current = null;
99
+ setInputText("");
82
100
  setValue(["==", null]);
83
101
  return;
84
102
  }
@@ -96,6 +114,9 @@ export function StringNumberFilterField({
96
114
 
97
115
  setOperation(op);
98
116
  setInternalValue(newValue);
117
+ syncedValueRef.current = newValue;
118
+ if (!keepInputText)
119
+ setInputText(filterValueToText(newValue));
99
120
 
100
121
  const hasNewValue = newValue !== null && Array.isArray(newValue)
101
122
  ? newValue.length > 0
@@ -111,6 +132,14 @@ export function StringNumberFilterField({
111
132
  }
112
133
  }
113
134
 
135
+ function updateFilterFromText(text: string) {
136
+ setInputText(text);
137
+ const { updateValue, value: parsedValue } = parseFilterTextInput(text, dataType);
138
+ // intermediate inputs like "-" or "0." keep the filter as it is
139
+ if (updateValue)
140
+ updateFilter(operation, parsedValue, true);
141
+ }
142
+
114
143
  const multiple = multipleSelectOperations.includes(operation);
115
144
 
116
145
  return (
@@ -138,16 +167,13 @@ export function StringNumberFilterField({
138
167
  {!enumValues && <TextField
139
168
  size={"medium"}
140
169
  type={dataType === "number" ? "number" : undefined}
141
- value={internalValue !== undefined && internalValue != null ? String(internalValue) : ""}
170
+ value={inputText}
142
171
  disabled={isNullOperation}
143
172
  placeholder={isNullOperation ? "null" : undefined}
144
173
  onChange={(evt) => {
145
- const val = dataType === "number"
146
- ? parseFloat(evt.target.value)
147
- : evt.target.value;
148
- updateFilter(operation, val);
174
+ updateFilterFromText(evt.target.value);
149
175
  }}
150
- endAdornment={internalValue !== undefined && internalValue != null && <IconButton
176
+ endAdornment={inputText !== "" && <IconButton
151
177
  onClick={(e) => updateFilter(operation, undefined)}>
152
178
  <CloseIcon />
153
179
  </IconButton>}
@@ -0,0 +1,184 @@
1
+ import { describe, expect, it } from "@jest/globals";
2
+ import { filterValueToText, parseFilterTextInput } from "./filter_text_input";
3
+
4
+ /**
5
+ * Type `text` one character at a time, the way the filter field does, and keep track
6
+ * of the filter value left after every keystroke.
7
+ */
8
+ function typeCharByChar(text: string, dataType: "string" | "number" = "number") {
9
+ let value: string | number | undefined;
10
+ const valueAfterEachKeystroke: (string | number | undefined)[] = [];
11
+ for (let i = 1; i <= text.length; i++) {
12
+ const result = parseFilterTextInput(text.slice(0, i), dataType);
13
+ if (result.updateValue)
14
+ value = result.value;
15
+ valueAfterEachKeystroke.push(value);
16
+ }
17
+ return {
18
+ value,
19
+ valueAfterEachKeystroke
20
+ };
21
+ }
22
+
23
+ describe("parseFilterTextInput with numbers", () => {
24
+
25
+ it("should parse complete numbers", () => {
26
+ expect(parseFilterTextInput("0.01", "number")).toEqual({
27
+ updateValue: true,
28
+ value: 0.01
29
+ });
30
+ expect(parseFilterTextInput("1", "number")).toEqual({
31
+ updateValue: true,
32
+ value: 1
33
+ });
34
+ expect(parseFilterTextInput("1.5", "number")).toEqual({
35
+ updateValue: true,
36
+ value: 1.5
37
+ });
38
+ expect(parseFilterTextInput("-0.5", "number")).toEqual({
39
+ updateValue: true,
40
+ value: -0.5
41
+ });
42
+ expect(parseFilterTextInput(".5", "number")).toEqual({
43
+ updateValue: true,
44
+ value: 0.5
45
+ });
46
+ expect(parseFilterTextInput("1e5", "number")).toEqual({
47
+ updateValue: true,
48
+ value: 100000
49
+ });
50
+ expect(parseFilterTextInput("0.0100", "number")).toEqual({
51
+ updateValue: true,
52
+ value: 0.01
53
+ });
54
+ });
55
+
56
+ it("should keep 0 as a valid filter value", () => {
57
+ expect(parseFilterTextInput("0", "number")).toEqual({
58
+ updateValue: true,
59
+ value: 0
60
+ });
61
+ expect(parseFilterTextInput("0.0", "number")).toEqual({
62
+ updateValue: true,
63
+ value: 0
64
+ });
65
+ expect(parseFilterTextInput("00", "number")).toEqual({
66
+ updateValue: true,
67
+ value: 0
68
+ });
69
+ expect(parseFilterTextInput("-0", "number").updateValue).toBe(true);
70
+ });
71
+
72
+ it("should clear the filter for an empty input", () => {
73
+ expect(parseFilterTextInput("", "number")).toEqual({
74
+ updateValue: true,
75
+ value: undefined
76
+ });
77
+ expect(parseFilterTextInput(" ", "number")).toEqual({
78
+ updateValue: true,
79
+ value: undefined
80
+ });
81
+ });
82
+
83
+ it("should not touch the filter value for intermediate inputs", () => {
84
+ // these are states the user goes through while typing, the text must be kept
85
+ // in the input without the filter value being changed
86
+ expect(parseFilterTextInput("0.", "number")).toEqual({ updateValue: false });
87
+ expect(parseFilterTextInput(".", "number")).toEqual({ updateValue: false });
88
+ expect(parseFilterTextInput("1.", "number")).toEqual({ updateValue: false });
89
+ expect(parseFilterTextInput("-", "number")).toEqual({ updateValue: false });
90
+ expect(parseFilterTextInput("-.", "number")).toEqual({ updateValue: false });
91
+ expect(parseFilterTextInput("+", "number")).toEqual({ updateValue: false });
92
+ expect(parseFilterTextInput("-0.", "number")).toEqual({ updateValue: false });
93
+ expect(parseFilterTextInput("1e", "number")).toEqual({ updateValue: false });
94
+ expect(parseFilterTextInput("1e-", "number")).toEqual({ updateValue: false });
95
+ });
96
+
97
+ it("should not touch the filter value for text that is not a number", () => {
98
+ expect(parseFilterTextInput("abc", "number")).toEqual({ updateValue: false });
99
+ expect(parseFilterTextInput("12abc", "number")).toEqual({ updateValue: false });
100
+ expect(parseFilterTextInput("1.2.3", "number")).toEqual({ updateValue: false });
101
+ expect(parseFilterTextInput("--1", "number")).toEqual({ updateValue: false });
102
+ expect(parseFilterTextInput("0x10", "number")).toEqual({ updateValue: false });
103
+ expect(parseFilterTextInput("Infinity", "number")).toEqual({ updateValue: false });
104
+ expect(parseFilterTextInput("1e999", "number")).toEqual({ updateValue: false });
105
+ });
106
+
107
+ it("should allow typing 0.01 character by character", () => {
108
+ const { value, valueAfterEachKeystroke } = typeCharByChar("0.01");
109
+ expect(value).toBe(0.01);
110
+ // "0" -> 0, "0." -> unchanged, "0.0" -> 0, "0.01" -> 0.01
111
+ expect(valueAfterEachKeystroke).toEqual([0, 0, 0, 0.01]);
112
+ });
113
+
114
+ it("should allow typing other decimals character by character", () => {
115
+ expect(typeCharByChar("0.001").value).toBe(0.001);
116
+ expect(typeCharByChar("-0.5").value).toBe(-0.5);
117
+ expect(typeCharByChar(".5").value).toBe(0.5);
118
+ expect(typeCharByChar(".01").value).toBe(0.01);
119
+ expect(typeCharByChar("1.05").value).toBe(1.05);
120
+ expect(typeCharByChar("10.00001").value).toBe(10.00001);
121
+ expect(typeCharByChar("-.5").value).toBe(-0.5);
122
+ });
123
+
124
+ it("should keep the previous value while typing a trailing decimal separator", () => {
125
+ // typing "1." leaves the value at 1, the text "1." stays in the input
126
+ expect(typeCharByChar("1.").value).toBe(1);
127
+ expect(typeCharByChar("1.").valueAfterEachKeystroke).toEqual([1, 1]);
128
+ });
129
+
130
+ it("should not commit a value until a leading sign is followed by digits", () => {
131
+ expect(typeCharByChar("-").value).toBeUndefined();
132
+ expect(typeCharByChar("-1").valueAfterEachKeystroke).toEqual([undefined, -1]);
133
+ });
134
+
135
+ it("should clear the value when the input is emptied", () => {
136
+ // deleting "0.01" one character at a time, from the end
137
+ const texts = ["0.0", "0.", "0", ""];
138
+ let value: string | number | undefined = 0.01;
139
+ for (const text of texts) {
140
+ const result = parseFilterTextInput(text, "number");
141
+ if (result.updateValue)
142
+ value = result.value;
143
+ }
144
+ expect(value).toBeUndefined();
145
+ });
146
+ });
147
+
148
+ describe("parseFilterTextInput with strings", () => {
149
+
150
+ it("should use the text as the value", () => {
151
+ expect(parseFilterTextInput("abc", "string")).toEqual({
152
+ updateValue: true,
153
+ value: "abc"
154
+ });
155
+ expect(parseFilterTextInput("0.", "string")).toEqual({
156
+ updateValue: true,
157
+ value: "0."
158
+ });
159
+ expect(parseFilterTextInput("", "string")).toEqual({
160
+ updateValue: true,
161
+ value: ""
162
+ });
163
+ expect(parseFilterTextInput(" spaced ", "string")).toEqual({
164
+ updateValue: true,
165
+ value: " spaced "
166
+ });
167
+ });
168
+ });
169
+
170
+ describe("filterValueToText", () => {
171
+
172
+ it("should render values as text", () => {
173
+ expect(filterValueToText(0)).toBe("0");
174
+ expect(filterValueToText(0.01)).toBe("0.01");
175
+ expect(filterValueToText(-0.5)).toBe("-0.5");
176
+ expect(filterValueToText("abc")).toBe("abc");
177
+ expect(filterValueToText("")).toBe("");
178
+ });
179
+
180
+ it("should render empty text for no value", () => {
181
+ expect(filterValueToText(undefined)).toBe("");
182
+ expect(filterValueToText(null)).toBe("");
183
+ });
184
+ });
@@ -0,0 +1,71 @@
1
+ /**
2
+ * Matches text that is a complete number, as opposed to an intermediate state
3
+ * that the user may be in the middle of typing, like "-", "0." or ".".
4
+ * A decimal separator must be followed by at least one digit.
5
+ */
6
+ const completeNumberRegex = /^[+-]?(?:\d+|\d*\.\d+)(?:[eE][+-]?\d+)?$/;
7
+
8
+ export type FilterTextInputParseResult = {
9
+ /**
10
+ * Whether the filter value should be updated with `value`.
11
+ * It is `false` for intermediate inputs that are not a valid value yet,
12
+ * like "-" or "0.", so that the text typed by the user can be kept as it is
13
+ * while the current filter value is left untouched.
14
+ */
15
+ updateValue: boolean;
16
+
17
+ /**
18
+ * Parsed value, only relevant when `updateValue` is `true`.
19
+ * `undefined` means the filter should be cleared.
20
+ */
21
+ value?: string | number;
22
+ };
23
+
24
+ /**
25
+ * Turn the raw text of a filter input into the value used by the filter.
26
+ *
27
+ * The text shown to the user is never derived back from the parsed value, so
28
+ * intermediate states like "0.", ".0" or "-" survive while typing. Numbers are
29
+ * only committed to the filter once the text is a complete number, which makes
30
+ * values such as 0.01 reachable by typing them character by character.
31
+ *
32
+ * Note that `0` is a perfectly valid filter value, only an empty input clears
33
+ * the filter.
34
+ */
35
+ export function parseFilterTextInput(text: string, dataType: "string" | "number"): FilterTextInputParseResult {
36
+
37
+ if (dataType !== "number")
38
+ return {
39
+ updateValue: true,
40
+ value: text
41
+ };
42
+
43
+ const trimmedText = text.trim();
44
+
45
+ if (trimmedText === "")
46
+ return {
47
+ updateValue: true,
48
+ value: undefined
49
+ };
50
+
51
+ if (!completeNumberRegex.test(trimmedText))
52
+ return { updateValue: false };
53
+
54
+ const parsedValue = Number(trimmedText);
55
+ if (!isFinite(parsedValue))
56
+ return { updateValue: false };
57
+
58
+ return {
59
+ updateValue: true,
60
+ value: parsedValue
61
+ };
62
+ }
63
+
64
+ /**
65
+ * Text a filter input should display for a given filter value.
66
+ */
67
+ export function filterValueToText(value: unknown): string {
68
+ if (value === undefined || value === null)
69
+ return "";
70
+ return String(value);
71
+ }