@firecms/core 3.4.0-canary.f6a889a → 3.4.0
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.
- package/dist/components/EntityCollectionTable/internal/CollectionTableToolbar.d.ts +6 -1
- package/dist/components/EntityCollectionTable/internal/popup_field/PopupFormField.d.ts +3 -1
- package/dist/components/EntityCollectionView/EntityCollectionBoardView.d.ts +3 -1
- package/dist/components/EntityCollectionView/EntityCollectionView.d.ts +8 -0
- package/dist/components/EntityCollectionView/EntityCollectionViewActions.d.ts +3 -1
- package/dist/components/EntityCollectionView/EntityCollectionViewStartActions.d.ts +3 -1
- package/dist/components/EntityCollectionView/useBoardDataController.d.ts +3 -1
- package/dist/components/ErrorBoundary.d.ts +1 -3
- package/dist/components/ReferenceTable/ReferenceSelectionTable.d.ts +10 -1
- package/dist/components/SelectableTable/filters/filter_text_input.d.ts +30 -0
- package/dist/components/SelectableTable/filters/filter_text_input.test.d.ts +1 -0
- package/dist/components/common/table_url_params.d.ts +24 -0
- package/dist/components/common/useDataSourceTableController.d.ts +9 -1
- package/dist/components/common/useTableSearchHelper.d.ts +9 -1
- package/dist/core/EntityEditView.d.ts +9 -1
- package/dist/core/EntityEditViewFormActions.d.ts +1 -1
- package/dist/form/EntityForm.d.ts +8 -1
- package/dist/form/EntityFormActions.d.ts +2 -0
- package/dist/hooks/data/delete.d.ts +1 -1
- package/dist/hooks/data/save.d.ts +1 -1
- package/dist/hooks/data/useCollectionFetch.d.ts +7 -1
- package/dist/hooks/data/useEntityFetch.d.ts +9 -1
- package/dist/i18n/__tests__/FireCMSi18nProvider.test.d.ts +1 -0
- package/dist/i18n/__tests__/nested_provider_lifecycle.test.d.ts +1 -0
- package/dist/index.es.js +1753 -1170
- package/dist/index.es.js.map +1 -1
- package/dist/index.umd.js +1751 -1168
- package/dist/index.umd.js.map +1 -1
- package/dist/types/collections.d.ts +14 -0
- package/dist/types/datasource.d.ts +67 -4
- package/dist/types/entities.d.ts +21 -1
- package/dist/types/entity_actions.d.ts +6 -0
- package/dist/types/entity_callbacks.d.ts +21 -0
- package/dist/types/navigation.d.ts +34 -5
- package/dist/types/plugins.d.ts +13 -0
- package/dist/types/properties.d.ts +17 -1
- package/dist/types/side_entity_controller.d.ts +7 -0
- package/dist/types/translations.d.ts +6 -0
- package/dist/util/__tests__/collections.test.d.ts +1 -0
- package/dist/util/__tests__/urls.test.d.ts +1 -0
- package/dist/util/collections.d.ts +1 -1
- package/dist/util/entity_cache.d.ts +11 -0
- package/dist/util/index.d.ts +1 -0
- package/dist/util/navigation_from_path.d.ts +7 -0
- package/dist/util/navigation_utils.d.ts +87 -3
- package/dist/util/parent_references_from_path.d.ts +16 -0
- package/dist/util/paths.d.ts +28 -0
- package/dist/util/permissions.d.ts +10 -4
- package/dist/util/urls.d.ts +22 -0
- package/package.json +4 -4
- package/src/components/DeleteEntityDialog.tsx +2 -0
- package/src/components/EntityCollectionTable/EntityCollectionRowActions.tsx +2 -2
- package/src/components/EntityCollectionTable/EntityCollectionTable.tsx +1 -0
- package/src/components/EntityCollectionTable/internal/CollectionTableToolbar.tsx +7 -0
- package/src/components/EntityCollectionTable/internal/popup_field/PopupFormField.tsx +5 -1
- package/src/components/EntityCollectionView/EntityCollectionBoardView.tsx +12 -0
- package/src/components/EntityCollectionView/EntityCollectionView.tsx +66 -15
- package/src/components/EntityCollectionView/EntityCollectionViewActions.tsx +6 -2
- package/src/components/EntityCollectionView/EntityCollectionViewStartActions.tsx +4 -0
- package/src/components/EntityCollectionView/useBoardDataController.tsx +17 -1
- package/src/components/EntityPreview.tsx +4 -1
- package/src/components/ErrorBoundary.tsx +12 -18
- package/src/components/ReferenceTable/ReferenceSelectionTable.tsx +19 -2
- package/src/components/SelectableTable/filters/StringNumberFilterField.tsx +33 -7
- package/src/components/SelectableTable/filters/filter_text_input.test.ts +184 -0
- package/src/components/SelectableTable/filters/filter_text_input.ts +71 -0
- package/src/components/common/default_entity_actions.tsx +22 -2
- package/src/components/common/table_url_params.ts +172 -0
- package/src/components/common/useDataSourceTableController.tsx +86 -179
- package/src/components/common/useTableSearchHelper.ts +26 -2
- package/src/contexts/SnackbarProvider.tsx +14 -1
- package/src/core/EntityEditView.tsx +20 -3
- package/src/core/EntityEditViewFormActions.tsx +3 -2
- package/src/core/EntitySidePanel.tsx +8 -4
- package/src/form/EntityForm.tsx +31 -10
- package/src/form/EntityFormActions.tsx +2 -0
- package/src/hooks/data/delete.ts +8 -0
- package/src/hooks/data/save.ts +6 -1
- package/src/hooks/data/useCollectionFetch.tsx +21 -1
- package/src/hooks/data/useEntityFetch.tsx +35 -4
- package/src/hooks/useBuildNavigationController.tsx +23 -8
- package/src/hooks/useResolvedNavigationFrom.tsx +3 -1
- package/src/hooks/useValidateAuthenticator.tsx +4 -0
- package/src/i18n/FireCMSi18nProvider.tsx +48 -4
- package/src/i18n/__tests__/FireCMSi18nProvider.test.tsx +91 -0
- package/src/i18n/__tests__/nested_provider_lifecycle.test.tsx +67 -0
- package/src/internal/useBuildDataSource.ts +37 -15
- package/src/internal/useBuildSideEntityController.tsx +19 -5
- package/src/locales/de.ts +5 -0
- package/src/locales/en.ts +5 -0
- package/src/locales/es.ts +5 -0
- package/src/locales/fr.ts +5 -0
- package/src/locales/hi.ts +5 -0
- package/src/locales/it.ts +5 -0
- package/src/locales/pl.ts +5 -0
- package/src/locales/pt.ts +5 -0
- package/src/preview/components/ReferencePreview.tsx +7 -3
- package/src/preview/components/StorageThumbnail.tsx +24 -2
- package/src/routes/FireCMSRoute.tsx +11 -3
- package/src/types/collections.ts +16 -0
- package/src/types/datasource.ts +67 -4
- package/src/types/entities.ts +24 -1
- package/src/types/entity_actions.tsx +6 -0
- package/src/types/entity_callbacks.ts +24 -0
- package/src/types/navigation.ts +35 -5
- package/src/types/plugins.tsx +13 -0
- package/src/types/properties.ts +17 -0
- package/src/types/side_entity_controller.tsx +7 -0
- package/src/types/translations.ts +6 -0
- package/src/util/__tests__/collections.test.ts +32 -0
- package/src/util/__tests__/urls.test.ts +131 -0
- package/src/util/collections.ts +1 -1
- package/src/util/entities.ts +3 -1
- package/src/util/entity_cache.ts +18 -0
- package/src/util/index.ts +1 -0
- package/src/util/navigation_from_path.ts +25 -2
- package/src/util/navigation_utils.ts +208 -2
- package/src/util/parent_references_from_path.ts +42 -3
- package/src/util/paths.ts +40 -3
- package/src/util/permissions.ts +22 -10
- package/src/util/previews.ts +8 -1
- package/src/util/resolutions.ts +8 -0
- package/src/util/urls.ts +52 -0
|
@@ -87,6 +87,13 @@ export interface EntityCollection<M extends Record<string, any> = any, USER exte
|
|
|
87
87
|
* If not specified, the first property simple text property will be used.
|
|
88
88
|
*/
|
|
89
89
|
titleProperty?: keyof M;
|
|
90
|
+
/**
|
|
91
|
+
* Property used as the image thumbnail in Cards and Kanban view modes.
|
|
92
|
+
* Must reference a storage/image property (or an array of them), or a
|
|
93
|
+
* string property with `url: "image"`.
|
|
94
|
+
* If not specified, the first matching image property will be used.
|
|
95
|
+
*/
|
|
96
|
+
imageProperty?: keyof M;
|
|
90
97
|
/**
|
|
91
98
|
* When editing an entity, you can choose to open the entity in a side dialog
|
|
92
99
|
* or in a full screen dialog. Defaults to `full_screen`.
|
|
@@ -432,6 +439,13 @@ export interface CollectionActionsProps<M extends Record<string, any> = any, USE
|
|
|
432
439
|
* `users/1234/addresses`
|
|
433
440
|
*/
|
|
434
441
|
path: string;
|
|
442
|
+
/**
|
|
443
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
444
|
+
*
|
|
445
|
+
* Optional, and never derived by splitting `path` — a parent entity id may itself
|
|
446
|
+
* contain "/". Absent means "not known here", not "no slashes".
|
|
447
|
+
*/
|
|
448
|
+
pathSegments?: string[];
|
|
435
449
|
/**
|
|
436
450
|
* Path of the last collection, like `addresses`
|
|
437
451
|
*/
|
|
@@ -7,6 +7,20 @@ import { FireCMSContext } from "./firecms_context";
|
|
|
7
7
|
*/
|
|
8
8
|
export interface FetchEntityProps<M extends Record<string, any> = any> {
|
|
9
9
|
path: string;
|
|
10
|
+
/**
|
|
11
|
+
* The path split at its real segment boundaries, e.g.
|
|
12
|
+
* `["nodes", "node/42", "edges"]`.
|
|
13
|
+
*
|
|
14
|
+
* `path` is a single flattened string, so a parent entity id containing "/" cannot be
|
|
15
|
+
* recovered from it — `"nodes/node/42/edges"` is indistinguishable from a three-level
|
|
16
|
+
* nesting. This is the unambiguous form: one array element per segment, entity ids
|
|
17
|
+
* kept whole however many slashes they contain.
|
|
18
|
+
*
|
|
19
|
+
* For any backend whose ids cannot contain "/" this is exactly `path.split("/")`, so
|
|
20
|
+
* delegates that do not care can keep using `path`. Delegates that do should prefer
|
|
21
|
+
* `pathSegments ?? path.split("/")`.
|
|
22
|
+
*/
|
|
23
|
+
pathSegments?: string[];
|
|
10
24
|
entityId: string;
|
|
11
25
|
databaseId?: string;
|
|
12
26
|
collection?: EntityCollection<M, any>;
|
|
@@ -23,6 +37,20 @@ export type ListenEntityProps<M extends Record<string, any> = any> = FetchEntity
|
|
|
23
37
|
*/
|
|
24
38
|
export interface FetchCollectionProps<M extends Record<string, any> = any> {
|
|
25
39
|
path: string;
|
|
40
|
+
/**
|
|
41
|
+
* The path split at its real segment boundaries, e.g.
|
|
42
|
+
* `["nodes", "node/42", "edges"]`.
|
|
43
|
+
*
|
|
44
|
+
* `path` is a single flattened string, so a parent entity id containing "/" cannot be
|
|
45
|
+
* recovered from it — `"nodes/node/42/edges"` is indistinguishable from a three-level
|
|
46
|
+
* nesting. This is the unambiguous form: one array element per segment, entity ids
|
|
47
|
+
* kept whole however many slashes they contain.
|
|
48
|
+
*
|
|
49
|
+
* For any backend whose ids cannot contain "/" this is exactly `path.split("/")`, so
|
|
50
|
+
* delegates that do not care can keep using `path`. Delegates that do should prefer
|
|
51
|
+
* `pathSegments ?? path.split("/")`.
|
|
52
|
+
*/
|
|
53
|
+
pathSegments?: string[];
|
|
26
54
|
collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
|
|
27
55
|
filter?: FilterValues<Extract<keyof M, string>>;
|
|
28
56
|
limit?: number;
|
|
@@ -43,6 +71,20 @@ export type ListenCollectionProps<M extends Record<string, any> = any> = FetchCo
|
|
|
43
71
|
*/
|
|
44
72
|
export interface SaveEntityProps<M extends Record<string, any> = any> {
|
|
45
73
|
path: string;
|
|
74
|
+
/**
|
|
75
|
+
* The path split at its real segment boundaries, e.g.
|
|
76
|
+
* `["nodes", "node/42", "edges"]`.
|
|
77
|
+
*
|
|
78
|
+
* `path` is a single flattened string, so a parent entity id containing "/" cannot be
|
|
79
|
+
* recovered from it — `"nodes/node/42/edges"` is indistinguishable from a three-level
|
|
80
|
+
* nesting. This is the unambiguous form: one array element per segment, entity ids
|
|
81
|
+
* kept whole however many slashes they contain.
|
|
82
|
+
*
|
|
83
|
+
* For any backend whose ids cannot contain "/" this is exactly `path.split("/")`, so
|
|
84
|
+
* delegates that do not care can keep using `path`. Delegates that do should prefer
|
|
85
|
+
* `pathSegments ?? path.split("/")`.
|
|
86
|
+
*/
|
|
87
|
+
pathSegments?: string[];
|
|
46
88
|
values: Partial<EntityValues<M>>;
|
|
47
89
|
entityId?: string;
|
|
48
90
|
previousValues?: Partial<EntityValues<M>>;
|
|
@@ -54,6 +96,11 @@ export interface SaveEntityProps<M extends Record<string, any> = any> {
|
|
|
54
96
|
*/
|
|
55
97
|
export interface DeleteEntityProps<M extends Record<string, any> = any> {
|
|
56
98
|
entity: Entity<M>;
|
|
99
|
+
/**
|
|
100
|
+
* `entity.path` split at its real segment boundaries, when the caller knows them.
|
|
101
|
+
* Never derived from `entity.path` — see `pathSegments` on FetchCollectionProps.
|
|
102
|
+
*/
|
|
103
|
+
pathSegments?: string[];
|
|
57
104
|
collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
|
|
58
105
|
}
|
|
59
106
|
/**
|
|
@@ -133,11 +180,17 @@ export interface DataSource {
|
|
|
133
180
|
* @param entityId
|
|
134
181
|
* @return `true` if there are no other fields besides the given entity
|
|
135
182
|
*/
|
|
136
|
-
checkUniqueField(path: string, name: string, value: any, entityId?: string, collection?: EntityCollection
|
|
183
|
+
checkUniqueField(path: string, name: string, value: any, entityId?: string, collection?: EntityCollection,
|
|
184
|
+
/**
|
|
185
|
+
* Appended last, and optional, so existing implementations and callers keep
|
|
186
|
+
* working unchanged — a function declaring fewer parameters stays assignable.
|
|
187
|
+
* See `pathSegments` on FetchCollectionProps.
|
|
188
|
+
*/
|
|
189
|
+
pathSegments?: string[]): Promise<boolean>;
|
|
137
190
|
/**
|
|
138
191
|
* Generate an id for a new entity
|
|
139
192
|
*/
|
|
140
|
-
generateEntityId(path: string, collection: EntityCollection): string;
|
|
193
|
+
generateEntityId(path: string, collection: EntityCollection, pathSegments?: string[]): string;
|
|
141
194
|
/**
|
|
142
195
|
* Count the number of entities in a collection
|
|
143
196
|
*/
|
|
@@ -155,11 +208,17 @@ export interface DataSource {
|
|
|
155
208
|
initTextSearch?: (props: {
|
|
156
209
|
context: FireCMSContext;
|
|
157
210
|
path: string;
|
|
211
|
+
/**
|
|
212
|
+
* `path` split at its real segment boundaries, when known. Never derived from `path`.
|
|
213
|
+
*/
|
|
214
|
+
pathSegments?: string[];
|
|
158
215
|
collection: EntityCollection;
|
|
159
216
|
parentCollectionIds?: string[];
|
|
160
217
|
}) => Promise<boolean>;
|
|
161
218
|
}
|
|
162
219
|
export type FilterCombinationValidProps = {
|
|
220
|
+
/** `path` split at its real segment boundaries — see `pathSegments` on FetchCollectionProps. */
|
|
221
|
+
pathSegments?: string[];
|
|
163
222
|
path: string;
|
|
164
223
|
collection: EntityCollection<any>;
|
|
165
224
|
filterValues: FilterValues<any>;
|
|
@@ -245,11 +304,11 @@ export interface DataSourceDelegate {
|
|
|
245
304
|
* @param collection
|
|
246
305
|
* @return `true` if there are no other fields besides the given entity
|
|
247
306
|
*/
|
|
248
|
-
checkUniqueField(path: string, name: string, value: any, entityId?: string, collection?: EntityCollection): Promise<boolean>;
|
|
307
|
+
checkUniqueField(path: string, name: string, value: any, entityId?: string, collection?: EntityCollection, pathSegments?: string[]): Promise<boolean>;
|
|
249
308
|
/**
|
|
250
309
|
* Generate an id for a new entity
|
|
251
310
|
*/
|
|
252
|
-
generateEntityId(path: string, collection?: EntityCollection): string;
|
|
311
|
+
generateEntityId(path: string, collection?: EntityCollection, pathSegments?: string[]): string;
|
|
253
312
|
/**
|
|
254
313
|
* Count the number of entities in a collection
|
|
255
314
|
*/
|
|
@@ -270,6 +329,10 @@ export interface DataSourceDelegate {
|
|
|
270
329
|
initTextSearch?: (props: {
|
|
271
330
|
context: FireCMSContext;
|
|
272
331
|
path: string;
|
|
332
|
+
/**
|
|
333
|
+
* `path` split at its real segment boundaries, when known. Never derived from `path`.
|
|
334
|
+
*/
|
|
335
|
+
pathSegments?: string[];
|
|
273
336
|
databaseId?: string;
|
|
274
337
|
collection: EntityCollection;
|
|
275
338
|
parentCollectionIds?: string[];
|
package/dist/types/entities.d.ts
CHANGED
|
@@ -17,6 +17,16 @@ export interface Entity<M extends object = any> {
|
|
|
17
17
|
* to the root of the database).
|
|
18
18
|
*/
|
|
19
19
|
path: string;
|
|
20
|
+
/**
|
|
21
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
22
|
+
*
|
|
23
|
+
* `path` is a single flattened string, so a parent entity id containing "/" cannot be
|
|
24
|
+
* recovered from it. This keeps each segment whole.
|
|
25
|
+
*
|
|
26
|
+
* Optional, and never derived by splitting `path` — a guess would be wrong in exactly
|
|
27
|
+
* the case the field exists for. Absent means "not known here", not "no slashes".
|
|
28
|
+
*/
|
|
29
|
+
pathSegments?: string[];
|
|
20
30
|
/**
|
|
21
31
|
* Current values
|
|
22
32
|
*/
|
|
@@ -46,7 +56,17 @@ export declare class EntityReference {
|
|
|
46
56
|
* Optional database ID where the entity is stored (if multiple databases are used)
|
|
47
57
|
*/
|
|
48
58
|
readonly databaseId?: string;
|
|
49
|
-
|
|
59
|
+
/**
|
|
60
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
61
|
+
*
|
|
62
|
+
* `path` is a single flattened string, so a parent entity id containing "/" cannot be
|
|
63
|
+
* recovered from it. This keeps each segment whole.
|
|
64
|
+
*
|
|
65
|
+
* Optional, and never derived by splitting `path` — a guess would be wrong in exactly
|
|
66
|
+
* the case the field exists for. Absent means "not known here", not "no slashes".
|
|
67
|
+
*/
|
|
68
|
+
readonly pathSegments?: string[];
|
|
69
|
+
constructor(id: string, path: string, databaseId?: string, pathSegments?: string[]);
|
|
50
70
|
get pathWithId(): string;
|
|
51
71
|
get pathWithIdAndDatabase(): string;
|
|
52
72
|
isEntityReference(): boolean;
|
|
@@ -55,6 +55,12 @@ export type EntityActionClickProps<M extends object, USER extends User = User> =
|
|
|
55
55
|
entity?: Entity<M>;
|
|
56
56
|
context: FireCMSContext<USER>;
|
|
57
57
|
fullPath?: string;
|
|
58
|
+
/**
|
|
59
|
+
* `fullPath` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`,
|
|
60
|
+
* when the caller knows them. Absent means "not known here" — never derived from
|
|
61
|
+
* `fullPath`, since a parent id may itself contain "/".
|
|
62
|
+
*/
|
|
63
|
+
pathSegments?: string[];
|
|
58
64
|
fullIdPath?: string;
|
|
59
65
|
collection?: EntityCollection<M>;
|
|
60
66
|
/**
|
|
@@ -69,6 +69,13 @@ export interface EntityOnFetchProps<M extends Record<string, any> = any, USER ex
|
|
|
69
69
|
* Might contain unresolved aliases.
|
|
70
70
|
*/
|
|
71
71
|
path: string;
|
|
72
|
+
/**
|
|
73
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
74
|
+
*
|
|
75
|
+
* Optional, and never derived by splitting `path` — a parent entity id may itself
|
|
76
|
+
* contain "/". Absent means "not known here", not "no slashes".
|
|
77
|
+
*/
|
|
78
|
+
pathSegments?: string[];
|
|
72
79
|
/**
|
|
73
80
|
* Fetched entity
|
|
74
81
|
*/
|
|
@@ -106,6 +113,13 @@ export interface EntityOnSaveProps<M extends Record<string, any> = any, USER ext
|
|
|
106
113
|
* Might contain unresolved aliases.
|
|
107
114
|
*/
|
|
108
115
|
path: string;
|
|
116
|
+
/**
|
|
117
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
118
|
+
*
|
|
119
|
+
* Optional, and never derived by splitting `path` — a parent entity id may itself
|
|
120
|
+
* contain "/". Absent means "not known here", not "no slashes".
|
|
121
|
+
*/
|
|
122
|
+
pathSegments?: string[];
|
|
109
123
|
/**
|
|
110
124
|
* Full path where this entity is being saved, with alias resolved
|
|
111
125
|
*/
|
|
@@ -144,6 +158,13 @@ export interface EntityOnDeleteProps<M extends Record<string, any> = any, USER e
|
|
|
144
158
|
* Path of the parent collection
|
|
145
159
|
*/
|
|
146
160
|
path: string;
|
|
161
|
+
/**
|
|
162
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
163
|
+
*
|
|
164
|
+
* Optional, and never derived by splitting `path` — a parent entity id may itself
|
|
165
|
+
* contain "/". Absent means "not known here", not "no slashes".
|
|
166
|
+
*/
|
|
167
|
+
pathSegments?: string[];
|
|
147
168
|
/**
|
|
148
169
|
* Deleted entity id
|
|
149
170
|
*/
|
|
@@ -48,8 +48,12 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
|
|
|
48
48
|
/**
|
|
49
49
|
* Get the collection configuration for a given path.
|
|
50
50
|
* The collection is resolved from the given path or alias.
|
|
51
|
+
*
|
|
52
|
+
* Pass `pathSegments` when you have them: without them the path is split on "/" and
|
|
53
|
+
* asserted to have an odd number of parts, which a chain containing a slash-bearing
|
|
54
|
+
* entity id fails — it throws instead of resolving.
|
|
51
55
|
*/
|
|
52
|
-
getCollection: (pathOrId: string, includeUserOverride?: boolean) => EC | undefined;
|
|
56
|
+
getCollection: (pathOrId: string, includeUserOverride?: boolean, pathSegments?: string[]) => EC | undefined;
|
|
53
57
|
/**
|
|
54
58
|
* Get the top level collection configuration for a given id
|
|
55
59
|
*/
|
|
@@ -99,23 +103,48 @@ export type NavigationController<EC extends EntityCollection = EntityCollection<
|
|
|
99
103
|
/**
|
|
100
104
|
* Turn a path with collection ids into a resolved path.
|
|
101
105
|
* The ids (typically used in urls) will be replaced with relative paths (typically used in database paths)
|
|
106
|
+
*
|
|
107
|
+
* Pass `pathSegments` whenever you have them. Without them this has to find the entity
|
|
108
|
+
* ids inside the flattened string by reading up to the next "/", which is wrong for any
|
|
109
|
+
* id that contains one — the chain then shifts by a segment and resolution fails.
|
|
110
|
+
*
|
|
102
111
|
* @param pathWithAliases
|
|
112
|
+
* @param pathSegments `pathWithAliases` split at its real segment boundaries, if known
|
|
113
|
+
*/
|
|
114
|
+
resolveIdsFrom: (pathWithAliases: string, pathSegments?: string[]) => string;
|
|
115
|
+
/**
|
|
116
|
+
* The segment-wise counterpart of {@link resolveIdsFrom}: replaces collection ids with
|
|
117
|
+
* their real paths while carrying every entity id through whole, slashes included.
|
|
118
|
+
*
|
|
119
|
+
* Idempotent — segments that are already resolved pass through unchanged.
|
|
120
|
+
*
|
|
121
|
+
* Optional so that a `navigationController` built against an earlier version keeps
|
|
122
|
+
* working: callers fall back to using the segments as given, which is what happened
|
|
123
|
+
* before this method existed. Controllers built by `useBuildNavigationController`
|
|
124
|
+
* always provide it.
|
|
125
|
+
*
|
|
126
|
+
* @param pathSegments
|
|
103
127
|
*/
|
|
104
|
-
|
|
128
|
+
resolveSegmentsFrom?: (pathSegments: string[]) => string[];
|
|
105
129
|
/**
|
|
106
130
|
* Call this method to recalculate the navigation
|
|
107
131
|
*/
|
|
108
132
|
refreshNavigation: () => void;
|
|
109
133
|
/**
|
|
110
|
-
* Retrieve all the related parent references for a given path
|
|
134
|
+
* Retrieve all the related parent references for a given path.
|
|
135
|
+
*
|
|
136
|
+
* `path` is expected escaped, as it comes from the URL. Pass `pathSegments` when the
|
|
137
|
+
* path at hand is a raw datasource path, whose ids may contain a bare "/".
|
|
138
|
+
*
|
|
111
139
|
* @param path
|
|
140
|
+
* @param pathSegments `path` split at its real segment boundaries, with raw ids
|
|
112
141
|
*/
|
|
113
|
-
getParentReferencesFromPath: (path: string) => EntityReference[];
|
|
142
|
+
getParentReferencesFromPath: (path: string, pathSegments?: string[]) => EntityReference[];
|
|
114
143
|
/**
|
|
115
144
|
* Retrieve all the related parent collection ids for a given path
|
|
116
145
|
* @param path
|
|
117
146
|
*/
|
|
118
|
-
getParentCollectionIds: (path: string) => string[];
|
|
147
|
+
getParentCollectionIds: (path: string, pathSegments?: string[]) => string[];
|
|
119
148
|
/**
|
|
120
149
|
* Resolve paths from a list of ids
|
|
121
150
|
* @param ids
|
package/dist/types/plugins.d.ts
CHANGED
|
@@ -121,18 +121,24 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
|
|
|
121
121
|
blockSearch?: (props: {
|
|
122
122
|
context: FireCMSContext;
|
|
123
123
|
path: string;
|
|
124
|
+
/** `path` split at its real segment boundaries, when known. */
|
|
125
|
+
pathSegments?: string[];
|
|
124
126
|
collection: EC;
|
|
125
127
|
parentCollectionIds?: string[];
|
|
126
128
|
}) => boolean;
|
|
127
129
|
showTextSearchBar?: (props: {
|
|
128
130
|
context: FireCMSContext;
|
|
129
131
|
path: string;
|
|
132
|
+
/** `path` split at its real segment boundaries, when known. */
|
|
133
|
+
pathSegments?: string[];
|
|
130
134
|
collection: EC;
|
|
131
135
|
parentCollectionIds?: string[];
|
|
132
136
|
}) => boolean;
|
|
133
137
|
onTextSearchClick?: (props: {
|
|
134
138
|
context: FireCMSContext;
|
|
135
139
|
path: string;
|
|
140
|
+
/** `path` split at its real segment boundaries, when known. */
|
|
141
|
+
pathSegments?: string[];
|
|
136
142
|
collection: EC;
|
|
137
143
|
parentCollectionIds?: string[];
|
|
138
144
|
}) => Promise<boolean>;
|
|
@@ -258,6 +264,13 @@ export interface PluginHomePageActionsProps<EP extends object = object, M extend
|
|
|
258
264
|
export interface PluginFormActionProps<USER extends User = User, EC extends EntityCollection = EntityCollection> {
|
|
259
265
|
entityId?: string;
|
|
260
266
|
path: string;
|
|
267
|
+
/**
|
|
268
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
269
|
+
*
|
|
270
|
+
* Optional, and never derived by splitting `path` — a parent entity id may itself
|
|
271
|
+
* contain "/". Absent means "not known here", not "no slashes".
|
|
272
|
+
*/
|
|
273
|
+
pathSegments?: string[];
|
|
261
274
|
parentCollectionIds: string[];
|
|
262
275
|
status: EntityStatus;
|
|
263
276
|
collection: EC;
|
|
@@ -433,6 +433,22 @@ export type PropertyBuilderProps<M extends Record<string, any> = any> = {
|
|
|
433
433
|
* Current value of this property
|
|
434
434
|
*/
|
|
435
435
|
propertyValue?: any;
|
|
436
|
+
/**
|
|
437
|
+
* Path of this property within the entity, in dot notation, e.g.
|
|
438
|
+
* `my_map.my_field` or `my_array.0.my_field`.
|
|
439
|
+
* Useful to look up sibling values in `values` with `getValueInPath`.
|
|
440
|
+
*
|
|
441
|
+
* When a property builder is used as the `of` prop of an array property,
|
|
442
|
+
* it is resolved twice: once per existing element, with an index
|
|
443
|
+
* qualified key (`my_array.0`), and once as the template for the element
|
|
444
|
+
* shape, with the array's own key (`my_array`). In the latter case
|
|
445
|
+
* `propertyValue` is the whole array, since the template is not bound to
|
|
446
|
+
* any element.
|
|
447
|
+
*
|
|
448
|
+
* It may be undefined if the property is resolved outside the context of
|
|
449
|
+
* an entity.
|
|
450
|
+
*/
|
|
451
|
+
propertyKey?: string;
|
|
436
452
|
/**
|
|
437
453
|
* Index of this property (only for arrays)
|
|
438
454
|
*/
|
|
@@ -456,7 +472,7 @@ export type PropertyBuilderProps<M extends Record<string, any> = any> = {
|
|
|
456
472
|
* current value of the property, as well as the path and entity ID.
|
|
457
473
|
* @group Entity properties
|
|
458
474
|
*/
|
|
459
|
-
export type PropertyBuilder<T extends CMSType = any, M extends Record<string, any> = any> = ({ values, previousValues, propertyValue, index, path, entityId, authController }: PropertyBuilderProps<M>) => Property<T> | null;
|
|
475
|
+
export type PropertyBuilder<T extends CMSType = any, M extends Record<string, any> = any> = ({ values, previousValues, propertyValue, propertyKey, index, path, entityId, authController }: PropertyBuilderProps<M>) => Property<T> | null;
|
|
460
476
|
/**
|
|
461
477
|
* @group Entity properties
|
|
462
478
|
*/
|
|
@@ -15,6 +15,13 @@ export interface EntitySidePanelProps<M extends Record<string, any> = any> {
|
|
|
15
15
|
* Full CMS path of the entity, including the collection and sub-collections.
|
|
16
16
|
*/
|
|
17
17
|
fullIdPath?: string;
|
|
18
|
+
/**
|
|
19
|
+
* `path` split at its real segment boundaries, e.g. `["nodes", "node/42", "edges"]`.
|
|
20
|
+
*
|
|
21
|
+
* Optional, and never derived by splitting `path` — a guess would be wrong in exactly
|
|
22
|
+
* the case the field exists for. Absent means "not known here", not "no slashes".
|
|
23
|
+
*/
|
|
24
|
+
pathSegments?: string[];
|
|
18
25
|
/**
|
|
19
26
|
* ID of the entity, if not set, it means we are creating a new entity
|
|
20
27
|
*/
|
|
@@ -368,6 +368,8 @@ export interface FireCMSTranslations {
|
|
|
368
368
|
download: string;
|
|
369
369
|
large_number_of_documents: string;
|
|
370
370
|
include_undefined_values: string;
|
|
371
|
+
/** Toggle in the export dialog, only shown when a filter or sort is active */
|
|
372
|
+
export_apply_filter_sort: string;
|
|
371
373
|
submit: string;
|
|
372
374
|
no_filterable_properties: string;
|
|
373
375
|
apply_filters: string;
|
|
@@ -547,6 +549,10 @@ export interface FireCMSTranslations {
|
|
|
547
549
|
order_property_not_found: string;
|
|
548
550
|
no_number_properties: string;
|
|
549
551
|
order_property_description: string;
|
|
552
|
+
image_property: string;
|
|
553
|
+
image_property_not_found: string;
|
|
554
|
+
no_image_properties: string;
|
|
555
|
+
image_property_description: string;
|
|
550
556
|
display_settings: string;
|
|
551
557
|
default_row_size: string;
|
|
552
558
|
side_dialog_width: string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -9,4 +9,4 @@ export declare function resolveDefaultSelectedView(defaultSelectedView: string |
|
|
|
9
9
|
* @param permissionsBuilder
|
|
10
10
|
*/
|
|
11
11
|
export declare const applyPermissionsFunctionIfEmpty: (collections: EntityCollection[], permissionsBuilder?: PermissionsBuilder<any, any>) => EntityCollection[];
|
|
12
|
-
export declare function getLocalChangesBackup(collection: EntityCollection): "manual_apply" | "auto_apply";
|
|
12
|
+
export declare function getLocalChangesBackup(collection: EntityCollection): false | "manual_apply" | "auto_apply";
|
|
@@ -1,3 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Key identifying one entity in a cache.
|
|
3
|
+
*
|
|
4
|
+
* The id is escaped so that a `(path, entityId)` pair maps to exactly one key. Without it
|
|
5
|
+
* `("a", "b/c")` and `("a/b", "c")` both flatten to `"a/b/c"`, and one entity's cached
|
|
6
|
+
* values are served for the other.
|
|
7
|
+
*
|
|
8
|
+
* `encodeEntityId` is the identity for any id without "/", "?", "#" or "%", so this changes
|
|
9
|
+
* no key in an app whose ids cannot contain them.
|
|
10
|
+
*/
|
|
11
|
+
export declare function entityCacheKey(path: string | undefined, entityId: string | undefined): string;
|
|
1
12
|
/**
|
|
2
13
|
* Saves data to the in-memory cache and persists it individually in `localStorage`.
|
|
3
14
|
* @param path - The unique path/key for the data.
|
package/dist/util/index.d.ts
CHANGED
|
@@ -6,6 +6,8 @@ export interface NavigationViewEntityInternal<M extends Record<string, any>> {
|
|
|
6
6
|
path: string;
|
|
7
7
|
fullIdPath: string;
|
|
8
8
|
fullPath: string;
|
|
9
|
+
/** `path` split at its real boundaries — see `pathSegments` on the datasource props. */
|
|
10
|
+
pathSegments: string[];
|
|
9
11
|
parentCollection: EntityCollection<M>;
|
|
10
12
|
}
|
|
11
13
|
export interface NavigationViewCollectionInternal<M extends Record<string, any>> {
|
|
@@ -14,6 +16,8 @@ export interface NavigationViewCollectionInternal<M extends Record<string, any>>
|
|
|
14
16
|
path: string;
|
|
15
17
|
fullIdPath: string;
|
|
16
18
|
fullPath: string;
|
|
19
|
+
/** `path` split at its real boundaries — see `pathSegments` on the datasource props. */
|
|
20
|
+
pathSegments: string[];
|
|
17
21
|
collection: EntityCollection<M>;
|
|
18
22
|
}
|
|
19
23
|
export interface NavigationViewEntityCustomInternal<M extends Record<string, any>> {
|
|
@@ -21,6 +25,8 @@ export interface NavigationViewEntityCustomInternal<M extends Record<string, any
|
|
|
21
25
|
path: string;
|
|
22
26
|
fullIdPath: string;
|
|
23
27
|
fullPath: string;
|
|
28
|
+
/** `path` split at its real boundaries — see `pathSegments` on the datasource props. */
|
|
29
|
+
pathSegments: string[];
|
|
24
30
|
entityId: string;
|
|
25
31
|
view: EntityCustomView<M>;
|
|
26
32
|
}
|
|
@@ -39,5 +45,6 @@ export declare function getNavigationEntriesFromPath(props: {
|
|
|
39
45
|
currentFullPath?: string;
|
|
40
46
|
currentFullIdPath?: string;
|
|
41
47
|
currentFullUrlPath?: string;
|
|
48
|
+
currentPathSegments?: string[];
|
|
42
49
|
contextEntityViews?: EntityCustomView<any>[];
|
|
43
50
|
}): NavigationViewInternal[];
|
|
@@ -23,22 +23,104 @@ export declare function encodeEntityId(entityId: string): string;
|
|
|
23
23
|
* @group Hooks and utilities
|
|
24
24
|
*/
|
|
25
25
|
export declare function decodeEntityId(encodedEntityId: string): string;
|
|
26
|
+
/**
|
|
27
|
+
* Segments of a subcollection sitting under the entity `entityId` of `parentPathSegments`.
|
|
28
|
+
*
|
|
29
|
+
* The parent entity id is kept whole however many slashes it contains, while the
|
|
30
|
+
* subcollection's own configured path is spread — a collection path never contains an
|
|
31
|
+
* entity id, so splitting that one is unambiguous.
|
|
32
|
+
*
|
|
33
|
+
* So `["test"] + "test/test" + "accommodation"` yields three segments,
|
|
34
|
+
* `["test", "test/test", "accommodation"]`, where splitting the flattened path
|
|
35
|
+
* `"test/test/test/accommodation"` would wrongly yield four.
|
|
36
|
+
*
|
|
37
|
+
* Returns undefined when the parent segments are unknown: the parent chain cannot be
|
|
38
|
+
* recovered from a flattened path, so there is nothing honest to build on.
|
|
39
|
+
*
|
|
40
|
+
* @group Hooks and utilities
|
|
41
|
+
*/
|
|
42
|
+
export declare function buildSubcollectionPathSegments(parentPathSegments: string[] | undefined, entityId: string | undefined, subcollectionPath: string): string[] | undefined;
|
|
26
43
|
export declare function getLastSegment(path: string): string;
|
|
27
|
-
|
|
44
|
+
/**
|
|
45
|
+
* The outcome of walking a segment chain against a collection tree.
|
|
46
|
+
* @group Hooks and utilities
|
|
47
|
+
*/
|
|
48
|
+
export type PathSegmentsWalkStep = {
|
|
49
|
+
collection: EntityCollection;
|
|
50
|
+
/** Resolved path of this collection, e.g. `"products/pid/locales"`. */
|
|
51
|
+
collectionPath: string;
|
|
52
|
+
/** `collectionPath` split at its real segment boundaries. */
|
|
53
|
+
collectionSegments: string[];
|
|
54
|
+
/** The entity addressed inside it, when the chain continues past the collection. */
|
|
55
|
+
entityId?: string;
|
|
56
|
+
};
|
|
57
|
+
export type PathSegmentsWalk = {
|
|
58
|
+
/** Segments with every collection id replaced by the collection's real `path`. */
|
|
59
|
+
resolved: string[];
|
|
60
|
+
/** The collection the chain ends in, if the whole chain matched. */
|
|
61
|
+
collection?: EntityCollection;
|
|
62
|
+
/** One entry per collection level traversed, outermost first. */
|
|
63
|
+
steps: PathSegmentsWalkStep[];
|
|
64
|
+
/** The first segment that could not be matched, if the walk stopped early. */
|
|
65
|
+
unmatched?: string;
|
|
66
|
+
};
|
|
67
|
+
/**
|
|
68
|
+
* Walk a segment chain against a collection tree, matching a collection by either its
|
|
69
|
+
* `path` or its `id` and treating exactly one segment as each entity id.
|
|
70
|
+
*
|
|
71
|
+
* This is the primitive the string-based helpers cannot have: working on the flattened
|
|
72
|
+
* path they must *guess* where an entity id ends by reading up to the next "/", which is
|
|
73
|
+
* wrong for any id that contains one. Here the boundaries are given.
|
|
74
|
+
*
|
|
75
|
+
* Stops at the first segment it cannot match and reports it, rather than throwing.
|
|
76
|
+
*
|
|
77
|
+
* @group Hooks and utilities
|
|
78
|
+
*/
|
|
79
|
+
export declare function walkPathSegments(pathSegments: string[], allCollections: EntityCollection[]): PathSegmentsWalk;
|
|
80
|
+
/**
|
|
81
|
+
* Resolve collection aliases in a segment array: every collection id is replaced by the
|
|
82
|
+
* collection's real `path`, and every entity id is carried through untouched.
|
|
83
|
+
*
|
|
84
|
+
* The segment-wise counterpart of {@link resolveCollectionPathIds}, and the reason it
|
|
85
|
+
* exists: that one works on the flattened string, so an entity id containing "/" shifts
|
|
86
|
+
* the rest of the chain by a segment and resolution fails with
|
|
87
|
+
* "Collection definition not found for segment starting with …".
|
|
88
|
+
*
|
|
89
|
+
* Matching accepts either a collection's `path` or its `id`, so already-resolved segments
|
|
90
|
+
* pass through unchanged — the function is idempotent.
|
|
91
|
+
*
|
|
92
|
+
* Mirrors the string version when a chain cannot be matched: it warns and carries the
|
|
93
|
+
* remainder through unresolved, rather than throwing.
|
|
94
|
+
*
|
|
95
|
+
* @group Hooks and utilities
|
|
96
|
+
*/
|
|
97
|
+
export declare function resolveCollectionPathSegments(pathSegments: string[], allCollections: EntityCollection[]): string[];
|
|
98
|
+
/**
|
|
99
|
+
* Find the collection a segment chain addresses, whether it ends on the collection itself
|
|
100
|
+
* or on one of its entities.
|
|
101
|
+
*
|
|
102
|
+
* The segment-wise counterpart of {@link getCollectionByPathOrId}, which asserts an odd
|
|
103
|
+
* number of "/"-separated parts — an assertion a slash-bearing entity id fails, throwing
|
|
104
|
+
* where it should simply have resolved.
|
|
105
|
+
*
|
|
106
|
+
* @group Hooks and utilities
|
|
107
|
+
*/
|
|
108
|
+
export declare function getCollectionByPathSegments(pathSegments: string[], collections: EntityCollection[]): EntityCollection | undefined;
|
|
109
|
+
export declare function resolveCollectionPathIds(path: string, allCollections: EntityCollection[], pathSegments?: string[]): string;
|
|
28
110
|
/**
|
|
29
111
|
* Find the corresponding view at any depth for a given path.
|
|
30
112
|
* Note that path or segments of the paths can be collection aliases.
|
|
31
113
|
* @param pathOrId
|
|
32
114
|
* @param collections
|
|
33
115
|
*/
|
|
34
|
-
export declare function getCollectionByPathOrId(pathOrId: string, collections: EntityCollection[]): EntityCollection | undefined;
|
|
116
|
+
export declare function getCollectionByPathOrId(pathOrId: string, collections: EntityCollection[], pathSegments?: string[]): EntityCollection | undefined;
|
|
35
117
|
/**
|
|
36
118
|
* Get the subcollection combinations from a path:
|
|
37
119
|
* "sites/es/locales" => ["sites/es/locales", "sites"]
|
|
38
120
|
* @param subpaths
|
|
39
121
|
*/
|
|
40
122
|
export declare function getCollectionPathsCombinations(subpaths: string[]): string[];
|
|
41
|
-
export declare function navigateToEntity({ openEntityMode, collection, entityId, copy, path, fullIdPath, selectedTab, sideEntityController, onClose, navigation }: {
|
|
123
|
+
export declare function navigateToEntity({ openEntityMode, collection, entityId, copy, path, fullIdPath, pathSegments, selectedTab, sideEntityController, onClose, navigation }: {
|
|
42
124
|
openEntityMode: "side_panel" | "full_screen";
|
|
43
125
|
collection?: EntityCollection;
|
|
44
126
|
entityId?: string;
|
|
@@ -46,6 +128,8 @@ export declare function navigateToEntity({ openEntityMode, collection, entityId,
|
|
|
46
128
|
copy?: boolean;
|
|
47
129
|
path: string;
|
|
48
130
|
fullIdPath?: string;
|
|
131
|
+
/** `path` split at its real segment boundaries. */
|
|
132
|
+
pathSegments?: string[];
|
|
49
133
|
sideEntityController: SideEntityController;
|
|
50
134
|
onClose?: () => void;
|
|
51
135
|
navigation: NavigationController;
|
|
@@ -1,6 +1,22 @@
|
|
|
1
1
|
import { EntityCollection, EntityReference } from "../types";
|
|
2
|
+
/**
|
|
3
|
+
* References to every parent entity in a path.
|
|
4
|
+
*
|
|
5
|
+
* NOTE on encoding: `path` is expected ESCAPED, because it comes from the URL — the entity
|
|
6
|
+
* ids in it are decoded on the way out. Pass `pathSegments` instead whenever the path at
|
|
7
|
+
* hand is a raw datasource path (`entity.path`), which is not escaped and whose ids may
|
|
8
|
+
* therefore contain a bare "/": splitting that would silently produce the wrong references.
|
|
9
|
+
*/
|
|
2
10
|
export declare function getParentReferencesFromPath(props: {
|
|
3
11
|
path: string;
|
|
4
12
|
collections: EntityCollection[] | undefined;
|
|
5
13
|
currentFullPath?: string;
|
|
14
|
+
currentPathSegments?: string[];
|
|
15
|
+
/** `path` split at its real segment boundaries, with RAW ids. Takes precedence. */
|
|
16
|
+
pathSegments?: string[];
|
|
6
17
|
}): EntityReference[];
|
|
18
|
+
/**
|
|
19
|
+
* The segment-wise counterpart: the boundaries are given, so an entity id keeps its
|
|
20
|
+
* slashes and nothing has to be decoded.
|
|
21
|
+
*/
|
|
22
|
+
export declare function getParentReferencesFromPathSegments(pathSegments: string[], collections: EntityCollection[]): EntityReference[];
|