@firecms/collection_editor 3.0.0-canary.24 → 3.0.0-canary.240

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 (75) hide show
  1. package/LICENSE +114 -21
  2. package/dist/ConfigControllerProvider.d.ts +1 -2
  3. package/dist/index.d.ts +1 -0
  4. package/dist/index.es.js +10109 -4774
  5. package/dist/index.es.js.map +1 -1
  6. package/dist/index.umd.js +10795 -3
  7. package/dist/index.umd.js.map +1 -1
  8. package/dist/types/collection_editor_controller.d.ts +3 -2
  9. package/dist/types/collection_inference.d.ts +1 -1
  10. package/dist/types/config_permissions.d.ts +2 -2
  11. package/dist/types/persisted_collection.d.ts +1 -1
  12. package/dist/ui/CollectionViewHeaderAction.d.ts +3 -2
  13. package/dist/ui/EditorCollectionActionStart.d.ts +2 -0
  14. package/dist/ui/PropertyAddColumnComponent.d.ts +3 -1
  15. package/dist/ui/collection_editor/CollectionDetailsForm.d.ts +3 -1
  16. package/dist/ui/collection_editor/CollectionEditorDialog.d.ts +3 -2
  17. package/dist/ui/collection_editor/CollectionEditorWelcomeView.d.ts +2 -2
  18. package/dist/ui/collection_editor/CollectionPropertiesEditorForm.d.ts +1 -1
  19. package/dist/ui/collection_editor/LayoutModeSwitch.d.ts +5 -0
  20. package/dist/ui/collection_editor/PropertyEditView.d.ts +8 -0
  21. package/dist/ui/collection_editor/PropertyTree.d.ts +9 -9
  22. package/dist/ui/collection_editor/SubcollectionsEditTab.d.ts +1 -1
  23. package/dist/ui/collection_editor/import/CollectionEditorImportMapping.d.ts +7 -0
  24. package/dist/ui/collection_editor/properties/MarkdownPropertyField.d.ts +4 -0
  25. package/dist/ui/collection_editor/properties/StringPropertyField.d.ts +1 -1
  26. package/dist/useCollectionEditorPlugin.d.ts +8 -11
  27. package/dist/utils/collections.d.ts +6 -0
  28. package/package.json +24 -35
  29. package/src/ConfigControllerProvider.tsx +64 -66
  30. package/src/index.ts +1 -0
  31. package/src/types/collection_editor_controller.tsx +6 -5
  32. package/src/types/collection_inference.ts +1 -1
  33. package/src/types/config_permissions.ts +1 -1
  34. package/src/types/persisted_collection.ts +2 -3
  35. package/src/ui/CollectionViewHeaderAction.tsx +10 -5
  36. package/src/ui/EditorCollectionAction.tsx +10 -63
  37. package/src/ui/EditorCollectionActionStart.tsx +88 -0
  38. package/src/ui/HomePageEditorCollectionAction.tsx +19 -13
  39. package/src/ui/NewCollectionButton.tsx +1 -1
  40. package/src/ui/NewCollectionCard.tsx +3 -3
  41. package/src/ui/PropertyAddColumnComponent.tsx +11 -6
  42. package/src/ui/collection_editor/CollectionDetailsForm.tsx +112 -18
  43. package/src/ui/collection_editor/CollectionEditorDialog.tsx +101 -34
  44. package/src/ui/collection_editor/CollectionEditorWelcomeView.tsx +13 -28
  45. package/src/ui/collection_editor/CollectionPropertiesEditorForm.tsx +37 -36
  46. package/src/ui/collection_editor/EntityCustomViewsSelectDialog.tsx +6 -5
  47. package/src/ui/collection_editor/EnumForm.tsx +11 -7
  48. package/src/ui/collection_editor/GetCodeDialog.tsx +56 -26
  49. package/src/ui/collection_editor/LayoutModeSwitch.tsx +54 -0
  50. package/src/ui/collection_editor/PropertyEditView.tsx +257 -79
  51. package/src/ui/collection_editor/PropertyFieldPreview.tsx +7 -10
  52. package/src/ui/collection_editor/PropertyTree.tsx +9 -7
  53. package/src/ui/collection_editor/SubcollectionsEditTab.tsx +26 -19
  54. package/src/ui/collection_editor/UnsavedChangesDialog.tsx +3 -5
  55. package/src/ui/collection_editor/import/CollectionEditorImportDataPreview.tsx +33 -9
  56. package/src/ui/collection_editor/import/CollectionEditorImportMapping.tsx +42 -9
  57. package/src/ui/collection_editor/properties/BlockPropertyField.tsx +32 -20
  58. package/src/ui/collection_editor/properties/DateTimePropertyField.tsx +54 -47
  59. package/src/ui/collection_editor/properties/EnumPropertyField.tsx +3 -1
  60. package/src/ui/collection_editor/properties/MapPropertyField.tsx +7 -6
  61. package/src/ui/collection_editor/properties/MarkdownPropertyField.tsx +139 -0
  62. package/src/ui/collection_editor/properties/ReferencePropertyField.tsx +2 -0
  63. package/src/ui/collection_editor/properties/RepeatPropertyField.tsx +0 -1
  64. package/src/ui/collection_editor/properties/StoragePropertyField.tsx +34 -19
  65. package/src/ui/collection_editor/properties/StringPropertyField.tsx +1 -10
  66. package/src/ui/collection_editor/properties/UrlPropertyField.tsx +1 -0
  67. package/src/ui/collection_editor/properties/validation/ValidationPanel.tsx +2 -2
  68. package/src/ui/collection_editor/templates/pages_template.ts +1 -6
  69. package/src/ui/collection_editor/utils/strings.ts +13 -6
  70. package/src/useCollectionEditorPlugin.tsx +32 -32
  71. package/src/utils/collections.ts +37 -0
  72. package/dist/ui/RootCollectionSuggestions.d.ts +0 -3
  73. package/dist/ui/collection_editor/PropertySelectItem.d.ts +0 -8
  74. package/src/ui/RootCollectionSuggestions.tsx +0 -63
  75. package/src/ui/collection_editor/PropertySelectItem.tsx +0 -32
@@ -0,0 +1,139 @@
1
+ import React from "react";
2
+ import { StringPropertyValidation } from "./validation/StringPropertyValidation";
3
+ import { ValidationPanel } from "./validation/ValidationPanel";
4
+ import { Field, getIn, useFormex } from "@firecms/formex";
5
+
6
+ import { CloudUploadIcon, DebouncedTextField, ExpandablePanel, TextField, Typography } from "@firecms/ui";
7
+
8
+ export function MarkdownPropertyField({
9
+ disabled,
10
+ showErrors
11
+ }: {
12
+ disabled: boolean;
13
+ showErrors: boolean;
14
+ }) {
15
+
16
+ const {
17
+ values,
18
+ setFieldValue
19
+ } = useFormex();
20
+
21
+ const baseStoragePath = "storage";
22
+
23
+ const metadata = `${baseStoragePath}.metadata`;
24
+ const fileName = `${baseStoragePath}.fileName`;
25
+ const maxSize = `${baseStoragePath}.maxSize`;
26
+ const storagePath = `${baseStoragePath}.storagePath`;
27
+
28
+ const fileNameValue = getIn(values, fileName) ?? "{rand}_{file}";
29
+ const storagePathValue = getIn(values, storagePath) ?? "/";
30
+ const maxSizeValue = getIn(values, maxSize);
31
+
32
+ const hasFilenameCallback = typeof fileNameValue === "function";
33
+ const hasStoragePathCallback = typeof storagePathValue === "function";
34
+
35
+ return (
36
+ <>
37
+ <div className={"col-span-12"}>
38
+
39
+ <ValidationPanel>
40
+
41
+ <StringPropertyValidation disabled={disabled}
42
+ length={true}
43
+ lowercase={true}
44
+ max={true}
45
+ min={true}
46
+ trim={true}
47
+ uppercase={true}
48
+ showErrors={showErrors}/>
49
+
50
+ </ValidationPanel>
51
+
52
+ </div>
53
+
54
+ <div className={"col-span-12"}>
55
+ <ExpandablePanel
56
+ title={
57
+ <div className="flex flex-row text-surface-500">
58
+ <CloudUploadIcon/>
59
+ <Typography variant={"subtitle2"}
60
+ className="ml-2">
61
+ File upload config
62
+ </Typography>
63
+ </div>
64
+ }>
65
+
66
+ <div className={"grid grid-cols-12 gap-2 p-4"}>
67
+
68
+
69
+ <div className={"col-span-12"}>
70
+ <Field name={fileName}
71
+ as={DebouncedTextField}
72
+ label={"File name"}
73
+ size={"small"}
74
+ disabled={hasFilenameCallback || disabled}
75
+ value={hasFilenameCallback ? "-" : fileNameValue}
76
+ />
77
+ </div>
78
+ <div className={"col-span-12"}>
79
+ <Field name={storagePath}
80
+ as={DebouncedTextField}
81
+ label={"Storage path"}
82
+ disabled={hasStoragePathCallback || disabled}
83
+ size={"small"}
84
+ value={hasStoragePathCallback ? "-" : storagePathValue}
85
+ />
86
+ <Typography variant={"caption"} className={"ml-3.5 mt-1 mb-2"}>
87
+ <p>You can use the following placeholders in
88
+ the file name
89
+ and storage path values:</p>
90
+ <ul>
91
+ <li>{"{file} - Full name of the uploaded file"}</li>
92
+ <li>{"{file.name} - Name of the uploaded file without extension"}</li>
93
+ <li>{"{file.ext} - Extension of the uploaded file"}</li>
94
+ <li>{"{entityId} - ID of the entity"}</li>
95
+ <li>{"{propertyKey} - ID of this field"}</li>
96
+ <li>{"{path} - Path of this entity"}</li>
97
+ <li>{"{rand} - Random value used to avoid name collisions"}</li>
98
+ </ul>
99
+ </Typography>
100
+
101
+ <Typography variant={"caption"} className={"ml-3.5 mt-1 mb-2"}>
102
+ When using Markdown, the URL of the uploaded files are always saved in the text value
103
+ (not
104
+ the path).
105
+ </Typography>
106
+ </div>
107
+
108
+ <div className={"col-span-12"}>
109
+ <DebouncedTextField name={maxSize}
110
+ type={"number"}
111
+ label={"Max size (in bytes)"}
112
+ size={"small"}
113
+ value={maxSizeValue !== undefined && maxSizeValue !== null ? maxSizeValue.toString() : ""}
114
+ onChange={(e) => {
115
+ const value = e.target.value;
116
+ if (value === "") setFieldValue(maxSize, undefined);
117
+ else setFieldValue(maxSize, parseInt(value));
118
+ }}
119
+ />
120
+ </div>
121
+
122
+ </div>
123
+ </ExpandablePanel>
124
+ </div>
125
+
126
+ <div className={"col-span-12"}>
127
+
128
+ <TextField name={"defaultValue"}
129
+ disabled={disabled}
130
+ onChange={(e: any) => {
131
+ setFieldValue("defaultValue", e.target.value === "" ? undefined : e.target.value);
132
+ }}
133
+ label={"Default value"}
134
+ value={getIn(values, "defaultValue") ?? ""}/>
135
+
136
+ </div>
137
+ </>
138
+ );
139
+ }
@@ -89,6 +89,8 @@ export function CollectionsSelect({
89
89
  value={value ?? ""}
90
90
  position={"item-aligned"}
91
91
  name={pathPath}
92
+ size={"large"}
93
+ fullWidth={true}
92
94
  onChange={handleChange}
93
95
  label={"Target collection"}
94
96
  renderValue={(selected) => {
@@ -39,7 +39,6 @@ export function RepeatPropertyField({
39
39
 
40
40
  const onPropertyChanged = ({ id, property, namespace }:
41
41
  { id?: string, property: Property, namespace?: string }) => {
42
- console.log("onPropertyChanged", id, property, namespace);
43
42
  setFieldValue("of", property);
44
43
  };
45
44
 
@@ -1,10 +1,9 @@
1
1
  import React from "react";
2
2
  import {
3
3
  Button,
4
- Checkbox,
4
+ CloudUploadIcon,
5
5
  DebouncedTextField,
6
6
  ExpandablePanel,
7
- FileUploadIcon,
8
7
  MultiSelect,
9
8
  MultiSelectItem,
10
9
  Typography
@@ -44,11 +43,13 @@ export function StoragePropertyField({
44
43
 
45
44
  const metadata = `${baseStoragePath}.metadata`;
46
45
  const fileName = `${baseStoragePath}.fileName`;
46
+ const maxSize = `${baseStoragePath}.maxSize`;
47
47
  const storagePath = `${baseStoragePath}.storagePath`;
48
48
  const storeUrl = `${baseStoragePath}.storeUrl`;
49
49
 
50
50
  const fileNameValue = getIn(values, fileName) ?? "{rand}_{file}";
51
51
  const storagePathValue = getIn(values, storagePath) ?? "/";
52
+ const maxSizeValue = getIn(values, maxSize);
52
53
 
53
54
  const storedValue = getIn(values, acceptedFiles);
54
55
  const fileTypesValue: string[] | undefined = Array.isArray(storedValue) ? storedValue : undefined;
@@ -56,10 +57,10 @@ export function StoragePropertyField({
56
57
 
57
58
  const handleTypesChange = (value: string[]) => {
58
59
  if (!value) setFieldValue(acceptedFiles, undefined);
59
- else if (value.includes("all")) setFieldValue(acceptedFiles, undefined);
60
- else if (value.length >= Object.keys(fileTypes).length) setFieldValue(acceptedFiles, undefined);
61
- else if (allFileTypesSelected)
62
- setFieldValue(acceptedFiles, Object.keys(fileTypes).filter((v) => !value.includes(v)));
60
+ // else if (value.includes("all")) setFieldValue(acceptedFiles, undefined);
61
+ // else if (value.length >= Object.keys(fileTypes).length) setFieldValue(acceptedFiles, undefined);
62
+ // else if (allFileTypesSelected)
63
+ // setFieldValue(acceptedFiles, Object.keys(fileTypes).filter((v) => !value.includes(v)));
63
64
  else setFieldValue(acceptedFiles, value);
64
65
  };
65
66
 
@@ -73,8 +74,8 @@ export function StoragePropertyField({
73
74
 
74
75
  <ExpandablePanel
75
76
  title={
76
- <div className="flex flex-row text-gray-500">
77
- <FileUploadIcon/>
77
+ <div className="flex flex-row text-surface-500">
78
+ <CloudUploadIcon/>
78
79
  <Typography variant={"subtitle2"}
79
80
  className="ml-2">
80
81
  File upload config
@@ -87,10 +88,12 @@ export function StoragePropertyField({
87
88
  <div className={"col-span-12"}>
88
89
 
89
90
  <MultiSelect
91
+ className={"w-full"}
92
+ placeholder={"All file types allowed"}
90
93
  disabled={disabled}
91
94
  name={acceptedFiles}
92
95
  value={fileTypesValue ?? []}
93
- onMultiValueChange={handleTypesChange}
96
+ onValueChange={handleTypesChange}
94
97
  label={allFileTypesSelected ? undefined : "Allowed file types"}
95
98
  renderValues={(selected) => {
96
99
  if (!selected || selected.length === 0) return "All file types allowed";
@@ -99,21 +102,15 @@ export function StoragePropertyField({
99
102
  .join(", ");
100
103
  }}>
101
104
 
102
- <MultiSelectItem key={"all"} value={"all"} className={"flex items-center gap-2"}>
103
- <Checkbox
104
- checked={!fileTypesValue}/>
105
- All
106
- </MultiSelectItem>
107
-
108
105
  {Object.entries(fileTypes).map(([value, label]) => (
109
106
  <MultiSelectItem key={value} value={value} className={"flex items-center gap-2"}>
110
- <Checkbox
111
- checked={allFileTypesSelected || fileTypesValue.indexOf(value) > -1}/>
107
+ {/*<Checkbox*/}
108
+ {/* checked={allFileTypesSelected || fileTypesValue.indexOf(value) > -1}/>*/}
112
109
  <div className={"flex-grow"}>
113
110
  {label}
114
111
  </div>
115
112
  <Button size={"small"}
116
- variant={"outlined"}
113
+ variant={"text"}
117
114
  onClick={(e) => {
118
115
  e.preventDefault();
119
116
  e.stopPropagation();
@@ -161,7 +158,10 @@ export function StoragePropertyField({
161
158
 
162
159
  <Field name={storeUrl}
163
160
  type="checkbox">
164
- {({ field, form }: FormexFieldProps) => {
161
+ {({
162
+ field,
163
+ form
164
+ }: FormexFieldProps) => {
165
165
  return <SwitchControl
166
166
  label={"Save URL instead of storage path"}
167
167
  disabled={existing || disabled}
@@ -178,6 +178,21 @@ export function StoragePropertyField({
178
178
  You can only change this prop upon creation.
179
179
  </Typography>
180
180
  </div>
181
+
182
+ <div className={"col-span-12"}>
183
+ <DebouncedTextField name={maxSize}
184
+ type={"number"}
185
+ label={"Max size (in bytes)"}
186
+ size={"small"}
187
+ value={maxSizeValue !== undefined && maxSizeValue !== null ? maxSizeValue.toString() : ""}
188
+ onChange={(e) => {
189
+ const value = e.target.value;
190
+ if (value === "") setFieldValue(maxSize, undefined);
191
+ else setFieldValue(maxSize, parseInt(value));
192
+ }}
193
+ />
194
+ </div>
195
+
181
196
  </div>
182
197
  </ExpandablePanel>
183
198
 
@@ -10,7 +10,7 @@ export function StringPropertyField({
10
10
  disabled,
11
11
  showErrors
12
12
  }: {
13
- widgetId: "text_field" | "multiline" | "markdown" | "email";
13
+ widgetId: "text_field" | "multiline" | "email";
14
14
  disabled: boolean;
15
15
  showErrors: boolean;
16
16
  }) {
@@ -42,15 +42,6 @@ export function StringPropertyField({
42
42
  trim={true}
43
43
  uppercase={true}
44
44
  showErrors={showErrors}/>}
45
- {widgetId === "markdown" &&
46
- <StringPropertyValidation disabled={disabled}
47
- length={true}
48
- lowercase={true}
49
- max={true}
50
- min={true}
51
- trim={true}
52
- uppercase={true}
53
- showErrors={showErrors}/>}
54
45
 
55
46
  {widgetId === "email" &&
56
47
  <StringPropertyValidation disabled={disabled}
@@ -24,6 +24,7 @@ export function UrlPropertyField({
24
24
  <Select
25
25
  disabled={disabled}
26
26
  position={"item-aligned"}
27
+ fullWidth={true}
27
28
  onValueChange={(value: string) => {
28
29
  if (value === "[NONE]")
29
30
  setFieldValue("url", true);
@@ -10,9 +10,9 @@ export function ValidationPanel({
10
10
  <ExpandablePanel
11
11
  initiallyExpanded={false}
12
12
  asField={true}
13
- className="p-4"
13
+ innerClassName="p-4"
14
14
  title={
15
- <div className="flex flex-row text-gray-500">
15
+ <div className="flex flex-row text-surface-500">
16
16
  <RuleIcon/>
17
17
  <Typography variant={"subtitle2"}
18
18
  className="ml-2">
@@ -19,7 +19,7 @@ export const pagesCollectionTemplate: EntityCollection = {
19
19
  validation: {
20
20
  required: true,
21
21
  unique: true,
22
- matches: /^[a-z0-9]+(?:-[a-z0-9]+)*$/,
22
+ matches: "^[a-z0-9]+(?:-[a-z0-9]+)*$",
23
23
  matchesMessage: "Must be lowercase, alphanumeric, and hyphenated"
24
24
  }
25
25
  },
@@ -178,11 +178,6 @@ export const pagesCollectionTemplate: EntityCollection = {
178
178
  name: "Is Published",
179
179
  columnWidth: 100,
180
180
  description: "Should this page be live on the site?"
181
- },
182
- author_uid: {
183
- dataType: "reference",
184
- name: "Author",
185
- path: "users"
186
181
  }
187
182
  }
188
183
  };
@@ -1,9 +1,16 @@
1
1
  export function camelCase(str: string): string {
2
2
  if (!str) return "";
3
- return (str.slice(0, 1).toLowerCase() + str.slice(1))
4
- .replace(/([-_ ]){1,}/g, " ")
5
- .split(/[-_ ]/)
6
- .reduce((cur, acc) => {
7
- return cur + acc[0].toUpperCase() + acc.substring(1);
8
- }, "");
3
+ if (str.length === 1) return str.toLowerCase();
4
+
5
+ // Split by hyphens, underscores, or spaces and filter out empty strings
6
+ const parts = str.split(/[-_ ]+/).filter(Boolean);
7
+
8
+ if (parts.length === 0) return "";
9
+
10
+ // Start with first part in lowercase
11
+ return parts[0].toLowerCase() +
12
+ // Transform remaining parts to have first letter uppercase
13
+ parts.slice(1)
14
+ .map(part => part.charAt(0).toUpperCase() + part.substring(1).toLowerCase())
15
+ .join('');
9
16
  }
@@ -4,18 +4,18 @@ import { ConfigControllerProvider } from "./ConfigControllerProvider";
4
4
  import { CollectionEditorPermissionsBuilder } from "./types/config_permissions";
5
5
  import { EditorCollectionAction } from "./ui/EditorCollectionAction";
6
6
  import { HomePageEditorCollectionAction } from "./ui/HomePageEditorCollectionAction";
7
- import { NewCollectionCard } from "./ui/NewCollectionCard";
8
7
  import { PersistedCollection } from "./types/persisted_collection";
9
8
  import { CollectionInference } from "./types/collection_inference";
10
9
  import { CollectionsConfigController } from "./types/config_controller";
11
- import { RootCollectionSuggestions } from "./ui/RootCollectionSuggestions";
12
10
  import { CollectionViewHeaderAction } from "./ui/CollectionViewHeaderAction";
13
11
  import { PropertyAddColumnComponent } from "./ui/PropertyAddColumnComponent";
14
12
  import { NewCollectionButton } from "./ui/NewCollectionButton";
15
- import { AddIcon, Button, Typography } from "@firecms/ui";
13
+ import { AddIcon, Button, Paper, Typography } from "@firecms/ui";
16
14
  import { useCollectionEditorController } from "./useCollectionEditorController";
15
+ import { EditorCollectionActionStart } from "./ui/EditorCollectionActionStart";
16
+ import { NewCollectionCard } from "./ui/NewCollectionCard";
17
17
 
18
- export interface CollectionConfigControllerProps<EC extends PersistedCollection = PersistedCollection, UserType extends User = User> {
18
+ export interface CollectionConfigControllerProps<EC extends PersistedCollection = PersistedCollection, USER extends User = User> {
19
19
 
20
20
  /**
21
21
  * Firebase app where the configuration is saved.
@@ -25,14 +25,14 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
25
25
  /**
26
26
  * Define what actions can be performed on the configuration.
27
27
  */
28
- configPermissions?: CollectionEditorPermissionsBuilder<UserType, EC>;
28
+ configPermissions?: CollectionEditorPermissionsBuilder<USER, EC>;
29
29
 
30
30
  /**
31
31
  * The words you define here will not be allowed to be used as group
32
32
  * names when creating collections.
33
33
  * e.g. ["admin"]
34
34
  */
35
- reservedGroups: string[];
35
+ reservedGroups?: string[];
36
36
 
37
37
  extraView?: {
38
38
  View: React.ComponentType<{
@@ -41,17 +41,15 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
41
41
  icon: React.ReactNode
42
42
  };
43
43
 
44
- pathSuggestions?: (path: string) => Promise<string[]>;
45
-
46
44
  collectionInference?: CollectionInference;
47
45
 
48
46
  getData?: (path: string, parentPaths: string[]) => Promise<object[]>;
49
47
 
50
- getUser: (uid: string) => UserType | null;
48
+ getUser?: (uid: string) => USER | null;
51
49
 
52
50
  onAnalyticsEvent?: (event: string, params?: object) => void;
53
51
 
54
- introMode?: "new_project" | "existing_project";
52
+ includeIntroView?: boolean;
55
53
 
56
54
  }
57
55
 
@@ -62,23 +60,22 @@ export interface CollectionConfigControllerProps<EC extends PersistedCollection
62
60
  * @param configPermissions
63
61
  * @param reservedGroups
64
62
  * @param extraView
65
- * @param pathSuggestions
63
+ * @param getData
66
64
  * @param getUser
67
65
  * @param collectionInference
68
66
  */
69
- export function useCollectionEditorPlugin<EC extends PersistedCollection = PersistedCollection, UserType extends User = User>
67
+ export function useCollectionEditorPlugin<EC extends PersistedCollection = PersistedCollection, USER extends User = User>
70
68
  ({
71
69
  collectionConfigController,
72
- introMode,
73
70
  configPermissions,
74
71
  reservedGroups,
75
72
  extraView,
76
- pathSuggestions,
77
73
  getUser,
78
74
  collectionInference,
79
75
  getData,
80
- onAnalyticsEvent
81
- }: CollectionConfigControllerProps<EC, UserType>): FireCMSPlugin<any, any, PersistedCollection> {
76
+ onAnalyticsEvent,
77
+ includeIntroView = true
78
+ }: CollectionConfigControllerProps<EC, USER>): FireCMSPlugin<any, any, PersistedCollection> {
82
79
 
83
80
  return {
84
81
  key: "collection_editor",
@@ -91,20 +88,20 @@ export function useCollectionEditorPlugin<EC extends PersistedCollection = Persi
91
88
  collectionInference,
92
89
  reservedGroups,
93
90
  extraView,
94
- pathSuggestions,
95
91
  getUser,
96
92
  getData,
97
- onAnalyticsEvent
93
+ onAnalyticsEvent,
98
94
  }
99
95
  },
100
96
  homePage: {
101
97
  additionalActions: <NewCollectionButton/>,
102
- additionalChildrenStart: introMode ? <IntroWidget introMode={introMode}/> : undefined,
103
- additionalChildrenEnd: <RootCollectionSuggestions introMode={introMode}/>,
98
+ additionalChildrenStart: includeIntroView ? <IntroWidget/> : undefined,
99
+ // additionalChildrenEnd: <RootCollectionSuggestions introMode={introMode}/>,
104
100
  CollectionActions: HomePageEditorCollectionAction,
105
- AdditionalCards: introMode ? undefined : NewCollectionCard,
101
+ AdditionalCards: NewCollectionCard,
106
102
  },
107
103
  collectionView: {
104
+ CollectionActionsStart: EditorCollectionActionStart,
108
105
  CollectionActions: EditorCollectionAction,
109
106
  HeaderAction: CollectionViewHeaderAction,
110
107
  AddColumnComponent: PropertyAddColumnComponent
@@ -112,9 +109,7 @@ export function useCollectionEditorPlugin<EC extends PersistedCollection = Persi
112
109
  };
113
110
  }
114
111
 
115
- export function IntroWidget({ introMode }: {
116
- introMode?: "new_project" | "existing_project";
117
- }) {
112
+ export function IntroWidget() {
118
113
 
119
114
  const navigation = useNavigationController();
120
115
  if (!navigation.topLevelNavigation)
@@ -129,17 +124,19 @@ export function IntroWidget({ introMode }: {
129
124
  }).createCollections
130
125
  : true;
131
126
 
127
+ if (!navigation.initialised || (navigation.collections ?? []).length > 0) {
128
+ return null;
129
+ }
130
+
132
131
  return (
133
- <div className={"mt-8 flex flex-col mt-8 p-2"}>
134
- <Typography variant={"h4"} className="mb-4">Welcome</Typography>
135
- <Typography paragraph={true}>Your admin panel is ready ✌️</Typography>
136
- <Typography paragraph={true}>
132
+ <Paper
133
+ className={"my-4 px-4 py-6 flex flex-col bg-white dark:bg-surface-accent-800 gap-2"}>
134
+ <Typography variant={"subtitle2"} className={"uppercase"}>No collections found</Typography>
135
+ <Typography>
137
136
  Start building collections in FireCMS easily. Map them to your existing
138
- database data, import from files, or use our templates. Simplify your data management process
139
- now.
137
+ database data, import from files, or use our templates.
140
138
  </Typography>
141
139
  {canCreateCollections && <Button
142
- className={"mt-4"}
143
140
  onClick={collectionEditorController && canCreateCollections
144
141
  ? () => collectionEditorController.createCollection({
145
142
  parentCollectionIds: [],
@@ -149,6 +146,9 @@ export function IntroWidget({ introMode }: {
149
146
  : undefined}>
150
147
  <AddIcon/>Create your first collection
151
148
  </Button>}
152
- </div>
149
+ <Typography color={"secondary"}>
150
+ You can also define collections programmatically.
151
+ </Typography>
152
+ </Paper>
153
153
  );
154
154
  }
@@ -0,0 +1,37 @@
1
+ import {
2
+ EntityCallbacks,
3
+ EntityCollection,
4
+ joinCollectionLists,
5
+ makePropertiesEditable,
6
+ ModifyCollectionProps,
7
+ Properties
8
+ } from "@firecms/core";
9
+ import { PersistedCollection } from "../types/persisted_collection";
10
+
11
+ /**
12
+ * Function in charge of merging collections defined in code with those stored in the backend.
13
+ */
14
+ export const mergeCollections = (baseCollections: EntityCollection[],
15
+ backendCollections: PersistedCollection[] = [],
16
+ modifyCollection?: (props: ModifyCollectionProps) => EntityCollection | void
17
+ ) => {
18
+
19
+ const markAsEditable = (c: PersistedCollection) => {
20
+ makePropertiesEditable(c.properties as Properties);
21
+ c.subcollections?.forEach(markAsEditable);
22
+ };
23
+
24
+ backendCollections.forEach(markAsEditable);
25
+
26
+ const result = joinCollectionLists(baseCollections, backendCollections, [], modifyCollection);
27
+
28
+ // sort the collections so they are in the same order as the base collections
29
+ result.sort((a, b) => baseCollections.findIndex(c => c.id === a.id) - baseCollections.findIndex(c => c.id === b.id));
30
+ console.debug("Collections result", {
31
+ baseCollections,
32
+ backendCollections,
33
+ result
34
+ });
35
+
36
+ return result;
37
+ }
@@ -1,3 +0,0 @@
1
- export declare function RootCollectionSuggestions({ introMode }: {
2
- introMode?: "new_project" | "existing_project";
3
- }): import("react/jsx-runtime").JSX.Element;
@@ -1,8 +0,0 @@
1
- import { PropertyConfig } from "@firecms/core";
2
- export interface PropertySelectItemProps {
3
- value: string;
4
- optionDisabled: boolean;
5
- propertyConfig: PropertyConfig;
6
- existing: boolean;
7
- }
8
- export declare function PropertySelectItem({ value, optionDisabled, propertyConfig, existing }: PropertySelectItemProps): import("react/jsx-runtime").JSX.Element;
@@ -1,63 +0,0 @@
1
- import { unslugify, useAuthController, useNavigationController } from "@firecms/core";
2
- import { AddIcon, Chip, CircularProgress, Collapse, Typography, } from "@firecms/ui";
3
- import { useCollectionEditorController } from "../useCollectionEditorController";
4
- import React from "react";
5
-
6
- export function RootCollectionSuggestions({ introMode }: { introMode?: "new_project" | "existing_project" }) {
7
-
8
- const authController = useAuthController();
9
- const navigationController = useNavigationController();
10
-
11
- const collectionEditorController = useCollectionEditorController();
12
- const canCreateCollections = collectionEditorController.configPermissions
13
- ? collectionEditorController.configPermissions({
14
- user: authController.user
15
- }).createCollections
16
- : true;
17
-
18
- const rootPathSuggestions = collectionEditorController.rootPathSuggestions;
19
-
20
- const showSuggestions = (rootPathSuggestions ?? []).length > 3 || ((navigationController.collections ?? []).length === 0 && (rootPathSuggestions ?? []).length > 0);
21
- const forceShowSuggestions = introMode === "existing_project";
22
- return <Collapse
23
- in={forceShowSuggestions || showSuggestions}>
24
-
25
- <div
26
- className={"flex flex-col gap-1 p-2 my-4"}>
27
-
28
- {!introMode && <Typography variant={"body2"} color={"secondary"}>
29
- Create a collection <b>automatically</b> from your data:
30
- </Typography>}
31
-
32
- {introMode === "existing_project" && <Typography>
33
- You will see your <b>database collections</b> here, a few seconds after project creation
34
- </Typography>}
35
-
36
- <div
37
- className={"flex flex-row gap-1 overflow-scroll no-scrollbar "}>
38
- {(rootPathSuggestions ?? []).map((path) => {
39
- return (
40
- <div key={path}>
41
- <Chip
42
- icon={<AddIcon size={"small"}/>}
43
- colorScheme={"cyanLighter"}
44
- onClick={collectionEditorController && canCreateCollections
45
- ? () => collectionEditorController.createCollection({
46
- initialValues: { path, name: unslugify(path) },
47
- parentCollectionIds: [],
48
- redirect: true,
49
- sourceClick: "root_collection_suggestion"
50
- })
51
- : undefined}
52
- size="small">
53
- {path}
54
- </Chip>
55
- </div>
56
- );
57
- })}
58
- {rootPathSuggestions === undefined && <CircularProgress size={"small"}/>}
59
- {rootPathSuggestions?.length === 0 && <Typography variant={"caption"}>No suggestions</Typography>}
60
- </div>
61
- </div>
62
- </Collapse>
63
- }