@firecms/core 3.0.0-alpha.70 → 3.0.0-alpha.71

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 (225) hide show
  1. package/package.json +3 -3
  2. package/src/components/ArrayContainer.d.ts +42 -0
  3. package/src/components/CircularProgressCenter.d.ts +11 -0
  4. package/src/components/DeleteConfirmationDialog.d.ts +9 -0
  5. package/src/components/EntityCollectionTable/EntityCollectionTable.d.ts +30 -0
  6. package/src/components/EntityCollectionTable/EntityCollectionTableProps.d.ts +106 -0
  7. package/src/components/EntityCollectionTable/fields/TableReferenceField.d.ts +15 -0
  8. package/src/components/EntityCollectionTable/fields/TableStorageUpload.d.ts +33 -0
  9. package/src/components/EntityCollectionTable/filters/BooleanFilterField.d.ts +9 -0
  10. package/src/components/EntityCollectionTable/filters/DateTimeFilterField.d.ts +11 -0
  11. package/src/components/EntityCollectionTable/filters/ReferenceFilterField.d.ts +14 -0
  12. package/src/components/EntityCollectionTable/filters/StringNumberFilterField.d.ts +13 -0
  13. package/src/components/EntityCollectionTable/index.d.ts +4 -0
  14. package/src/components/EntityCollectionTable/internal/CollectionTableToolbar.d.ts +18 -0
  15. package/src/components/EntityCollectionTable/internal/DeleteEntityDialog.d.ts +12 -0
  16. package/src/components/EntityCollectionTable/internal/EntityCollectionRowActions.d.ts +35 -0
  17. package/src/components/EntityCollectionTable/internal/EntityTableCell.d.ts +26 -0
  18. package/src/components/EntityCollectionTable/internal/EntityTableCellActions.d.ts +9 -0
  19. package/src/components/EntityCollectionTable/internal/PropertyTableCell.d.ts +18 -0
  20. package/src/components/EntityCollectionTable/internal/common.d.ts +4 -0
  21. package/src/components/EntityCollectionTable/internal/default_entity_actions.d.ts +6 -0
  22. package/src/components/EntityCollectionTable/internal/popup_field/ElementResizeListener.d.ts +5 -0
  23. package/src/components/EntityCollectionTable/internal/popup_field/PopupFormField.d.ts +23 -0
  24. package/src/components/EntityCollectionTable/internal/popup_field/useDraggable.d.ts +13 -0
  25. package/src/components/EntityCollectionTable/internal/popup_field/useWindowSize.d.ts +6 -0
  26. package/src/components/EntityCollectionTable/types.d.ts +39 -0
  27. package/src/components/EntityCollectionTable/useDebouncedData.d.ts +9 -0
  28. package/src/components/EntityCollectionTable/useEntityCollectionTableController.d.ts +21 -0
  29. package/src/components/EntityCollectionView/EntityCollectionView.d.ts +37 -0
  30. package/src/components/EntityCollectionView/EntityCollectionViewActions.d.ts +14 -0
  31. package/src/components/EntityCollectionView/useColumnsIds.d.ts +4 -0
  32. package/src/components/EntityPreview.d.ts +11 -0
  33. package/src/components/ErrorBoundary.d.ts +11 -0
  34. package/src/components/ErrorTooltip.d.ts +2 -0
  35. package/src/components/ErrorView.d.ts +19 -0
  36. package/src/components/FieldConfigBadge.d.ts +4 -0
  37. package/src/components/FireCMSAppBar.d.ts +26 -0
  38. package/src/components/FireCMSLogo.d.ts +7 -0
  39. package/src/components/HomePage/DefaultHomePage.d.ts +21 -0
  40. package/src/components/HomePage/FavouritesView.d.ts +3 -0
  41. package/src/components/HomePage/NavigationCollectionCard.d.ts +17 -0
  42. package/src/components/HomePage/NavigationGroup.d.ts +4 -0
  43. package/src/components/HomePage/index.d.ts +3 -0
  44. package/src/components/LabelWithIcon.d.ts +14 -0
  45. package/src/components/NotFoundPage.d.ts +1 -0
  46. package/src/components/ReferenceSelectionInner.d.ts +58 -0
  47. package/src/components/ReferenceWidget.d.ts +28 -0
  48. package/src/components/VirtualTable/VirtualTable.d.ts +11 -0
  49. package/src/components/VirtualTable/VirtualTableCell.d.ts +14 -0
  50. package/src/components/VirtualTable/VirtualTableHeader.d.ts +27 -0
  51. package/src/components/VirtualTable/VirtualTableHeaderRow.d.ts +2 -0
  52. package/src/components/VirtualTable/VirtualTableProps.d.ts +215 -0
  53. package/src/components/VirtualTable/VirtualTableRow.d.ts +3 -0
  54. package/src/components/VirtualTable/common.d.ts +2 -0
  55. package/src/components/VirtualTable/fields/VirtualTableDateField.d.ts +11 -0
  56. package/src/components/VirtualTable/fields/VirtualTableInput.d.ts +8 -0
  57. package/src/components/VirtualTable/fields/VirtualTableNumberInput.d.ts +8 -0
  58. package/src/components/VirtualTable/fields/VirtualTableSelect.d.ts +15 -0
  59. package/src/components/VirtualTable/fields/VirtualTableSwitch.d.ts +7 -0
  60. package/src/components/VirtualTable/index.d.ts +2 -0
  61. package/src/components/VirtualTable/types.d.ts +34 -0
  62. package/src/components/index.d.ts +20 -0
  63. package/src/contexts/AuthControllerContext.d.ts +3 -0
  64. package/src/contexts/DataSourceContext.d.ts +3 -0
  65. package/src/contexts/DialogsProvider.d.ts +4 -0
  66. package/src/contexts/ModeController.d.ts +4 -0
  67. package/src/contexts/NavigationContext.d.ts +3 -0
  68. package/src/contexts/SideDialogsControllerContext.d.ts +3 -0
  69. package/src/contexts/SideEntityControllerContext.d.ts +3 -0
  70. package/src/contexts/SnackbarProvider.d.ts +2 -0
  71. package/src/contexts/StorageSourceContext.d.ts +3 -0
  72. package/src/contexts/UserConfigurationPersistenceContext.d.ts +3 -0
  73. package/src/contexts/index.d.ts +3 -0
  74. package/src/core/Drawer.d.ts +23 -0
  75. package/src/core/EntitySidePanel.d.ts +10 -0
  76. package/src/core/FireCMS.d.ts +14 -0
  77. package/src/core/NavigationRoutes.d.ts +21 -0
  78. package/src/core/Scaffold.d.ts +52 -0
  79. package/src/core/SideDialogs.d.ts +23 -0
  80. package/src/core/field_configs.d.ts +7 -0
  81. package/src/core/index.d.ts +10 -0
  82. package/src/core/useBuildLocalConfigurationPersistence.d.ts +2 -0
  83. package/src/core/useBuildModeController.d.ts +6 -0
  84. package/src/form/EntityForm.d.ts +75 -0
  85. package/src/form/PropertyFieldBinding.d.ts +30 -0
  86. package/src/form/components/CustomIdField.d.ts +9 -0
  87. package/src/form/components/ErrorFocus.d.ts +4 -0
  88. package/src/form/components/FieldHelperText.d.ts +12 -0
  89. package/src/form/components/FormikArrayContainer.d.ts +18 -0
  90. package/src/form/components/StorageItemPreview.d.ts +13 -0
  91. package/src/form/components/StorageUploadProgress.d.ts +10 -0
  92. package/src/form/components/SwitchControl.d.ts +8 -0
  93. package/src/form/components/index.d.ts +3 -0
  94. package/src/form/field_bindings/ArrayCustomShapedFieldBinding.d.ts +9 -0
  95. package/src/form/field_bindings/ArrayOfReferencesFieldBinding.d.ts +11 -0
  96. package/src/form/field_bindings/BlockFieldBinding.d.ts +10 -0
  97. package/src/form/field_bindings/DateTimeFieldBinding.d.ts +11 -0
  98. package/src/form/field_bindings/KeyValueFieldBinding.d.ts +7 -0
  99. package/src/form/field_bindings/MapFieldBinding.d.ts +9 -0
  100. package/src/form/field_bindings/MarkdownFieldBinding.d.ts +9 -0
  101. package/src/form/field_bindings/MultiSelectBinding.d.ts +9 -0
  102. package/src/form/field_bindings/ReadOnlyFieldBinding.d.ts +10 -0
  103. package/src/form/field_bindings/ReferenceFieldBinding.d.ts +9 -0
  104. package/src/form/field_bindings/RepeatFieldBinding.d.ts +10 -0
  105. package/src/form/field_bindings/SelectFieldBinding.d.ts +12 -0
  106. package/src/form/field_bindings/StorageUploadFieldBinding.d.ts +28 -0
  107. package/src/form/field_bindings/SwitchFieldBinding.d.ts +12 -0
  108. package/src/form/field_bindings/TextFieldBinding.d.ts +12 -0
  109. package/src/form/index.d.ts +20 -0
  110. package/src/form/useClearRestoreValue.d.ts +13 -0
  111. package/src/form/validation.d.ts +25 -0
  112. package/src/hooks/data/delete.d.ts +37 -0
  113. package/src/hooks/data/save.d.ts +42 -0
  114. package/src/hooks/data/useCollectionFetch.d.ts +50 -0
  115. package/src/hooks/data/useDataOrder.d.ts +12 -0
  116. package/src/hooks/data/useDataSource.d.ts +6 -0
  117. package/src/hooks/data/useEntityFetch.d.ts +28 -0
  118. package/src/hooks/index.d.ts +19 -0
  119. package/src/hooks/useAuthController.d.ts +11 -0
  120. package/src/hooks/useBrowserTitleAndIcon.d.ts +6 -0
  121. package/src/hooks/useClipboard.d.ts +57 -0
  122. package/src/hooks/useDialogsController.d.ts +11 -0
  123. package/src/hooks/useFireCMSContext.d.ts +12 -0
  124. package/src/hooks/useLargeLayout.d.ts +1 -0
  125. package/src/hooks/useModeController.d.ts +20 -0
  126. package/src/hooks/useNavigationController.d.ts +9 -0
  127. package/src/hooks/useReferenceDialog.d.ts +18 -0
  128. package/src/hooks/useResolvedNavigationFrom.d.ts +72 -0
  129. package/src/hooks/useSideDialogsController.d.ts +18 -0
  130. package/src/hooks/useSideEntityController.d.ts +12 -0
  131. package/src/hooks/useSnackbarController.d.ts +41 -0
  132. package/src/hooks/useStorageSource.d.ts +6 -0
  133. package/src/hooks/useUserConfigurationPersistence.d.ts +8 -0
  134. package/src/index.d.ts +8 -0
  135. package/src/internal/EntityView.d.ts +22 -0
  136. package/src/internal/common.d.ts +3 -0
  137. package/src/internal/useBuildDataSource.d.ts +22 -0
  138. package/src/internal/useBuildNavigationController.d.ts +14 -0
  139. package/src/internal/useBuildSideDialogsController.d.ts +2 -0
  140. package/src/internal/useBuildSideEntityController.d.ts +4 -0
  141. package/src/internal/useLocaleConfig.d.ts +1 -0
  142. package/src/internal/useRestoreScroll.d.ts +6 -0
  143. package/src/internal/useUnsavedChangesDialog.d.ts +14 -0
  144. package/src/preview/PropertyPreview.d.ts +7 -0
  145. package/src/preview/PropertyPreviewProps.d.ts +43 -0
  146. package/src/preview/components/ArrayEnumPreview.d.ts +11 -0
  147. package/src/preview/components/AsyncPreviewComponent.d.ts +11 -0
  148. package/src/preview/components/BooleanPreview.d.ts +7 -0
  149. package/src/preview/components/DatePreview.d.ts +7 -0
  150. package/src/preview/components/EmptyValue.d.ts +4 -0
  151. package/src/preview/components/EnumValuesChip.d.ts +13 -0
  152. package/src/preview/components/ImagePreview.d.ts +12 -0
  153. package/src/preview/components/ReferencePreview.d.ts +22 -0
  154. package/src/preview/components/StorageThumbnail.d.ts +13 -0
  155. package/src/preview/components/UrlComponentPreview.d.ts +12 -0
  156. package/src/preview/index.d.ts +23 -0
  157. package/src/preview/property_previews/ArrayOfMapsPreview.d.ts +5 -0
  158. package/src/preview/property_previews/ArrayOfReferencesPreview.d.ts +5 -0
  159. package/src/preview/property_previews/ArrayOfStorageComponentsPreview.d.ts +5 -0
  160. package/src/preview/property_previews/ArrayOfStringsPreview.d.ts +5 -0
  161. package/src/preview/property_previews/ArrayOneOfPreview.d.ts +5 -0
  162. package/src/preview/property_previews/ArrayPropertyEnumPreview.d.ts +5 -0
  163. package/src/preview/property_previews/ArrayPropertyPreview.d.ts +5 -0
  164. package/src/preview/property_previews/MapPropertyPreview.d.ts +8 -0
  165. package/src/preview/property_previews/NumberPropertyPreview.d.ts +6 -0
  166. package/src/preview/property_previews/SkeletonPropertyComponent.d.ts +14 -0
  167. package/src/preview/property_previews/StringPropertyPreview.d.ts +6 -0
  168. package/src/preview/util.d.ts +7 -0
  169. package/src/types/analytics.d.ts +1 -0
  170. package/src/types/appcheck.d.ts +26 -0
  171. package/src/types/auth.d.ts +40 -0
  172. package/src/types/collections.d.ts +451 -0
  173. package/src/types/datasource.d.ts +262 -0
  174. package/src/types/dialogs_controller.d.ts +32 -0
  175. package/src/types/entities.d.ts +57 -0
  176. package/src/types/entity_actions.d.ts +35 -0
  177. package/src/types/entity_callbacks.d.ts +171 -0
  178. package/src/types/entity_link_builder.d.ts +7 -0
  179. package/src/types/export_import.d.ts +21 -0
  180. package/src/types/fields.d.ts +181 -0
  181. package/src/types/firecms.d.ts +151 -0
  182. package/src/types/firecms_context.d.ts +110 -0
  183. package/src/types/index.d.ts +26 -0
  184. package/src/types/local_config_persistence.d.ts +21 -0
  185. package/src/types/locales.d.ts +4 -0
  186. package/src/types/modify_collections.d.ts +5 -0
  187. package/src/types/navigation.d.ts +178 -0
  188. package/src/types/permissions.d.ts +63 -0
  189. package/src/types/plugins.d.ts +179 -0
  190. package/src/types/properties.d.ts +681 -0
  191. package/src/types/property_config.d.ts +42 -0
  192. package/src/types/resolved_entities.d.ts +98 -0
  193. package/src/types/side_dialogs_controller.d.ts +57 -0
  194. package/src/types/side_entity_controller.d.ts +83 -0
  195. package/src/types/storage.d.ts +82 -0
  196. package/src/types/user.d.ts +36 -0
  197. package/src/util/arrays.d.ts +1 -0
  198. package/src/util/builders.d.ts +64 -0
  199. package/src/util/chip_utils.d.ts +3 -0
  200. package/src/util/collections.d.ts +3 -0
  201. package/src/util/common.d.ts +2 -0
  202. package/src/util/dates.d.ts +1 -0
  203. package/src/util/entities.d.ts +28 -0
  204. package/src/util/enums.d.ts +7 -0
  205. package/src/util/flatten_object.d.ts +3 -0
  206. package/src/util/hash.d.ts +1 -0
  207. package/src/util/icons.d.ts +4 -0
  208. package/src/util/index.d.ts +20 -0
  209. package/src/util/join_collections.d.ts +9 -0
  210. package/src/util/make_properties_editable.d.ts +3 -0
  211. package/src/util/navigation_from_path.d.ts +24 -0
  212. package/src/util/navigation_utils.d.ts +20 -0
  213. package/src/util/objects.d.ts +10 -0
  214. package/src/util/parent_references_from_path.d.ts +6 -0
  215. package/src/util/paths.d.ts +14 -0
  216. package/src/util/permissions.d.ts +5 -0
  217. package/src/util/plurals.d.ts +18 -0
  218. package/src/util/property_utils.d.ts +23 -0
  219. package/src/util/references.d.ts +2 -0
  220. package/src/util/regexp.d.ts +7 -0
  221. package/src/util/resolutions.d.ts +64 -0
  222. package/src/util/storage.d.ts +3 -0
  223. package/src/util/strings.d.ts +6 -0
  224. package/src/util/useDebounce.d.ts +1 -0
  225. package/src/util/useStorageUploadController.d.ts +36 -0
@@ -0,0 +1,20 @@
1
+ export type { ErrorViewProps } from "./ErrorView";
2
+ export { ErrorView } from "./ErrorView";
3
+ export type { EntityPreviewProps } from "./EntityPreview";
4
+ export { EntityPreview } from "./EntityPreview";
5
+ export type { ReferenceSelectionInnerProps } from "./ReferenceSelectionInner";
6
+ export { ReferenceSelectionInner } from "./ReferenceSelectionInner";
7
+ export { CircularProgressCenter } from "./CircularProgressCenter";
8
+ export * from "./HomePage";
9
+ export * from "./EntityCollectionView/EntityCollectionView";
10
+ export * from "./FieldConfigBadge";
11
+ export * from "./EntityCollectionTable";
12
+ export * from "./NotFoundPage";
13
+ export * from "./VirtualTable";
14
+ export * from "./ErrorBoundary";
15
+ export * from "./DeleteConfirmationDialog";
16
+ export * from "./FireCMSLogo";
17
+ export * from "./FireCMSAppBar";
18
+ export * from "./ArrayContainer";
19
+ export * from "./ReferenceWidget";
20
+ export * from "./LabelWithIcon";
@@ -0,0 +1,3 @@
1
+ import React from "react";
2
+ import { AuthController } from "../types";
3
+ export declare const AuthControllerContext: React.Context<AuthController>;
@@ -0,0 +1,3 @@
1
+ import React from "react";
2
+ import { DataSource } from "../types";
3
+ export declare const DataSourceContext: React.Context<DataSource>;
@@ -0,0 +1,4 @@
1
+ import React, { PropsWithChildren } from "react";
2
+ import { DialogsController } from "../types/dialogs_controller";
3
+ export declare const DialogsControllerContext: React.Context<DialogsController>;
4
+ export declare const DialogsProvider: React.FC<PropsWithChildren<{}>>;
@@ -0,0 +1,4 @@
1
+ import React from "react";
2
+ import { ModeController } from "../hooks";
3
+ export declare const ModeControllerContext: React.Context<ModeController>;
4
+ export declare const ModeControllerProvider: React.Provider<ModeController>;
@@ -0,0 +1,3 @@
1
+ import React from "react";
2
+ import { NavigationController } from "../types";
3
+ export declare const NavigationContext: React.Context<NavigationController>;
@@ -0,0 +1,3 @@
1
+ import React from "react";
2
+ import { SideDialogsController } from "../types";
3
+ export declare const SideDialogsControllerContext: React.Context<SideDialogsController>;
@@ -0,0 +1,3 @@
1
+ import React from "react";
2
+ import { SideEntityController } from "../types";
3
+ export declare const SideEntityControllerContext: React.Context<SideEntityController>;
@@ -0,0 +1,2 @@
1
+ import React, { PropsWithChildren } from "react";
2
+ export declare const SnackbarProvider: React.FC<PropsWithChildren<{}>>;
@@ -0,0 +1,3 @@
1
+ import React from "react";
2
+ import { StorageSource } from "../types";
3
+ export declare const StorageSourceContext: React.Context<StorageSource>;
@@ -0,0 +1,3 @@
1
+ import React from "react";
2
+ import { UserConfigurationPersistence } from "../types";
3
+ export declare const UserConfigurationPersistenceContext: React.Context<UserConfigurationPersistence | undefined>;
@@ -0,0 +1,3 @@
1
+ export * from "./SnackbarProvider";
2
+ export * from "./ModeController";
3
+ export * from "./AuthControllerContext";
@@ -0,0 +1,23 @@
1
+ import React from "react";
2
+ /**
3
+ * Props used in case you need to override the default drawer
4
+ * @group Core
5
+ */
6
+ export type DrawerProps<T = {}> = T & {
7
+ hovered: boolean;
8
+ drawerOpen: boolean;
9
+ closeDrawer: () => any;
10
+ };
11
+ /**
12
+ * Default drawer used in the CMS
13
+ * @group Core
14
+ */
15
+ export declare function Drawer({ hovered, drawerOpen, closeDrawer }: DrawerProps): import("react/jsx-runtime").JSX.Element;
16
+ export declare function DrawerNavigationItem({ name, icon, drawerOpen, tooltipsOpen, url, onClick }: {
17
+ icon: React.ReactElement;
18
+ name: string;
19
+ tooltipsOpen: boolean;
20
+ drawerOpen: boolean;
21
+ url: string;
22
+ onClick?: () => void;
23
+ }): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,10 @@
1
+ import { EntitySidePanelProps } from "../types";
2
+ /**
3
+ * This is the component in charge of rendering the side dialog used
4
+ * for editing entities. Use the {@link useSideEntityController} to open
5
+ * and control the dialogs.
6
+ * This component needs a parent {@link FireCMS}
7
+ * {@link useSideEntityController}
8
+ * @group Components
9
+ */
10
+ export declare function EntitySidePanel(props: EntitySidePanelProps): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,14 @@
1
+ import { EntityCollection, FireCMSProps, User } from "../types";
2
+ /**
3
+ * If you are using independent components of the CMS
4
+ * you need to wrap them with this main component, so the internal hooks work.
5
+ *
6
+ * This is the main component of FireCMS. It acts as the provider of all the
7
+ * internal contexts and hooks.
8
+ *
9
+ * You only need to use this component if you are building a custom app.
10
+ *
11
+ * @constructor
12
+ * @group Core
13
+ */
14
+ export declare function FireCMS<UserType extends User, EC extends EntityCollection>(props: FireCMSProps<UserType, EC>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,21 @@
1
+ import React from "react";
2
+ /**
3
+ * @group Components
4
+ */
5
+ export type NavigationRoutesProps = {
6
+ /**
7
+ * In case you need to override the home page
8
+ */
9
+ HomePage?: React.ComponentType;
10
+ customRoutes?: React.ReactNode[];
11
+ };
12
+ /**
13
+ * This component is in charge of rendering
14
+ * all the related routes (entity collection root views, custom views
15
+ * or the home route) related to a {@link NavigationController}.
16
+ * This component needs a parent {@link FireCMS}
17
+ *
18
+ * @constructor
19
+ * @group Components
20
+ */
21
+ export declare const NavigationRoutes: React.NamedExoticComponent<NavigationRoutesProps>;
@@ -0,0 +1,52 @@
1
+ import React from "react";
2
+ import { DrawerProps } from "./Drawer";
3
+ import { FireCMSAppBarProps } from "../components";
4
+ export declare const DRAWER_WIDTH = 280;
5
+ /**
6
+ * @group Core
7
+ */
8
+ export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = object> {
9
+ /**
10
+ * Name of the app, displayed as the main title and in the tab title
11
+ */
12
+ name: string;
13
+ /**
14
+ * Logo to be displayed in the drawer of the CMS
15
+ */
16
+ logo?: string;
17
+ includeDrawer?: boolean;
18
+ /**
19
+ * In case you need to override the view that gets rendered as a drawer
20
+ * @see DefaultDrawer
21
+ */
22
+ Drawer?: React.ComponentType<DrawerProps<ExtraDrawerProps>>;
23
+ /**
24
+ * Additional props passed to the custom Drawer
25
+ */
26
+ drawerProps?: Partial<DrawerProps> & ExtraDrawerProps;
27
+ /**
28
+ * Open the drawer on hover
29
+ */
30
+ autoOpenDrawer?: boolean;
31
+ /**
32
+ * A component that gets rendered on the upper side of the main toolbar.
33
+ * `toolbarExtraWidget` has no effect if this is set.
34
+ */
35
+ FireCMSAppBarComponent?: React.ComponentType<FireCMSAppBarProps<ExtraAppbarProps>>;
36
+ /**
37
+ * Additional props passed to the custom AppBar
38
+ */
39
+ fireCMSAppBarComponentProps?: Partial<FireCMSAppBarProps> & ExtraAppbarProps;
40
+ }
41
+ /**
42
+ * This view acts as a scaffold for FireCMS.
43
+ *
44
+ * It is in charge of displaying the navigation drawer, top bar and main
45
+ * collection views.
46
+ * This component needs a parent {@link FireCMS}
47
+ *
48
+ * @param props
49
+ * @constructor
50
+ * @group Core
51
+ */
52
+ export declare const Scaffold: React.NamedExoticComponent<React.PropsWithChildren<ScaffoldProps<object, object>>>;
@@ -0,0 +1,23 @@
1
+ import React from "react";
2
+ export type SideDialogContextProps = {
3
+ blocked: boolean;
4
+ setBlocked: (blocked: boolean) => void;
5
+ setBlockedNavigationMessage: (message?: React.ReactNode) => void;
6
+ width?: string;
7
+ close: (force?: boolean) => void;
8
+ };
9
+ /**
10
+ * This hook is used to access the properties of a particular side dialog,
11
+ * in contrast with {@link useSideDialogsController} which handles the
12
+ * state of all the dialogs.
13
+ */
14
+ export declare const useSideDialogContext: () => SideDialogContextProps;
15
+ /**
16
+ * This is the component in charge of rendering the side dialogs used
17
+ * for editing entities. Use the {@link useSideEntityController} to open
18
+ * and control the dialogs.
19
+ * This component needs a parent {@link FireCMS}
20
+ * {@link useSideDialogsController}
21
+ * @group Components
22
+ */
23
+ export declare function SideDialogs(): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,7 @@
1
+ import { Property, PropertyConfig, ResolvedProperty } from "../types";
2
+ export declare function isDefaultFieldConfigId(id: string): boolean;
3
+ export declare const DEFAULT_FIELD_CONFIGS: Record<string, PropertyConfig<any>>;
4
+ export declare function getDefaultFieldConfig(property: Property | ResolvedProperty): PropertyConfig | undefined;
5
+ export declare function getFieldConfig(property: Property | ResolvedProperty, propertyConfigs: Record<string, PropertyConfig<any>>): PropertyConfig | undefined;
6
+ export declare function getDefaultFieldId(property: Property | ResolvedProperty): "reference" | "date_time" | "repeat" | "block" | "group" | "switch" | "url" | "email" | "select" | "text_field" | "multiline" | "markdown" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "key_value" | "multi_references" | "custom_array" | undefined;
7
+ export declare function getFieldId(property: Property | ResolvedProperty): string | undefined;
@@ -0,0 +1,10 @@
1
+ export * from "./FireCMS";
2
+ export type { ScaffoldProps } from "./Scaffold";
3
+ export { Scaffold } from "./Scaffold";
4
+ export type { DrawerProps } from "./Drawer";
5
+ export { Drawer, DrawerNavigationItem } from "./Drawer";
6
+ export * from "./field_configs";
7
+ export * from "./SideDialogs";
8
+ export * from "./NavigationRoutes";
9
+ export * from "./useBuildModeController";
10
+ export * from "./useBuildLocalConfigurationPersistence";
@@ -0,0 +1,2 @@
1
+ import { UserConfigurationPersistence } from "../types";
2
+ export declare function useBuildLocalConfigurationPersistence(): UserConfigurationPersistence;
@@ -0,0 +1,6 @@
1
+ import { ModeController } from "../hooks";
2
+ /**
3
+ * Use this hook to build a color mode controller that determines
4
+ * the theme of the CMS
5
+ */
6
+ export declare function useBuildModeController(): ModeController;
@@ -0,0 +1,75 @@
1
+ import { Entity, EntityCollection, EntityStatus, EntityValues, FormContext, ResolvedEntityCollection } from "../types";
2
+ /**
3
+ * @group Components
4
+ */
5
+ export interface EntityFormProps<M extends Record<string, any>> {
6
+ /**
7
+ * New or existing status
8
+ */
9
+ status: EntityStatus;
10
+ /**
11
+ * Path of the collection this entity is located
12
+ */
13
+ path: string;
14
+ /**
15
+ * The collection is used to build the fields of the form
16
+ */
17
+ collection: EntityCollection<M>;
18
+ /**
19
+ * The updated entity is passed from the parent component when the underlying data
20
+ * has changed in the datasource
21
+ */
22
+ entity?: Entity<M>;
23
+ /**
24
+ * The callback function called when Save is clicked and validation is correct
25
+ */
26
+ onEntitySaveRequested: (props: EntityFormSaveParams<M>) => Promise<void>;
27
+ /**
28
+ * The callback function called when discard is clicked
29
+ */
30
+ onDiscard?: () => void;
31
+ /**
32
+ * The callback function when the form is dirty, so the values are different
33
+ * from the original ones
34
+ */
35
+ onModified?: (dirty: boolean) => void;
36
+ /**
37
+ * The callback function when the form original values have been modified
38
+ */
39
+ onValuesChanged?: (values?: EntityValues<M>) => void;
40
+ /**
41
+ *
42
+ * @param id
43
+ */
44
+ onIdChange?: (id: string) => void;
45
+ currentEntityId?: string;
46
+ onFormContextChange?: (formContext: FormContext<M>) => void;
47
+ hideId?: boolean;
48
+ autoSave?: boolean;
49
+ onIdUpdateError?: (error: any) => void;
50
+ }
51
+ export type EntityFormSaveParams<M extends Record<string, any>> = {
52
+ collection: ResolvedEntityCollection<M>;
53
+ path: string;
54
+ entityId: string | undefined;
55
+ values: EntityValues<M>;
56
+ previousValues?: EntityValues<M>;
57
+ closeAfterSave: boolean;
58
+ autoSave: boolean;
59
+ };
60
+ /**
61
+ * This is the form used internally by the CMS
62
+ * @param status
63
+ * @param path
64
+ * @param collection
65
+ * @param entity
66
+ * @param onEntitySave
67
+ * @param onDiscard
68
+ * @param onModified
69
+ * @param onValuesChanged
70
+ * @constructor
71
+ * @group Components
72
+ */
73
+ export declare const EntityForm: typeof EntityFormInternal;
74
+ declare function EntityFormInternal<M extends Record<string, any>>({ status, path, collection: inputCollection, entity, onEntitySaveRequested, onDiscard, onModified, onValuesChanged, onIdChange, onFormContextChange, hideId, autoSave, onIdUpdateError }: EntityFormProps<M>): import("react/jsx-runtime").JSX.Element;
75
+ export {};
@@ -0,0 +1,30 @@
1
+ import { ReactElement } from "react";
2
+ import { CMSType, PropertyFieldBindingProps } from "../types";
3
+ /**
4
+ * This component renders a form field creating the corresponding configuration
5
+ * from a property. For example if bound to a string property, it will generate
6
+ * a text field.
7
+ *
8
+ * You can use it when you are creating a custom field, and need to
9
+ * render additional fields mapped to properties. This is useful if you
10
+ * need to build a complex property mapping, like an array where each index
11
+ * is a different property.
12
+ *
13
+ * Please note that if you build a custom field in a component, the
14
+ * **validation** passed in the property will have no effect. You need to set
15
+ * the validation in the `EntityCollection` definition.
16
+ *
17
+ * @param propertyKey You can use nested names such as `address.street` or `friends[2]`
18
+ * @param property
19
+ * @param context
20
+ * @param includeDescription
21
+ * @param underlyingValueHasChanged
22
+ * @param disabled
23
+ * @param tableMode
24
+ * @param partOfArray
25
+ * @param autoFocus
26
+ * @group Form custom fields
27
+ */
28
+ export declare const PropertyFieldBinding: typeof PropertyFieldBindingInternal;
29
+ declare function PropertyFieldBindingInternal<T extends CMSType = CMSType, CustomProps = any, M extends Record<string, any> = Record<string, any>>({ propertyKey, property, context, includeDescription, underlyingValueHasChanged, disabled, tableMode, partOfArray, partOfBlock, autoFocus, }: PropertyFieldBindingProps<T, M>): ReactElement<PropertyFieldBindingProps<T, M>>;
30
+ export {};
@@ -0,0 +1,9 @@
1
+ import { Entity, EntityStatus, EnumValues } from "../../types";
2
+ export declare function CustomIdField<M extends Record<string, any>>({ customId, entityId, status, onChange, error, entity }: {
3
+ customId?: boolean | EnumValues | "optional";
4
+ entityId?: string;
5
+ status: EntityStatus;
6
+ onChange: (id?: string) => void;
7
+ error: boolean;
8
+ entity: Entity<M> | undefined;
9
+ }): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,4 @@
1
+ import React from "react";
2
+ export declare const ErrorFocus: ({ containerRef }: {
3
+ containerRef?: React.RefObject<HTMLDivElement> | undefined;
4
+ }) => null;
@@ -0,0 +1,12 @@
1
+ import { ResolvedProperty } from "../../types";
2
+ /**
3
+ * Component in charge of rendering the description of a field
4
+ * as well as the error message if any.
5
+ */
6
+ export declare function FieldHelperText({ error, showError, property, includeDescription, disabled }: {
7
+ error: string;
8
+ showError: boolean;
9
+ property: ResolvedProperty;
10
+ includeDescription?: boolean;
11
+ disabled?: boolean;
12
+ }): import("react/jsx-runtime").JSX.Element | null;
@@ -0,0 +1,18 @@
1
+ import React from "react";
2
+ interface ArrayContainerProps<T> {
3
+ value: T[];
4
+ name: string;
5
+ addLabel: string;
6
+ buildEntry: (index: number, internalId: number) => React.ReactNode;
7
+ disabled?: boolean;
8
+ small?: boolean;
9
+ onInternalIdAdded?: (id: number) => void;
10
+ includeAddButton?: boolean;
11
+ newDefaultEntry?: T | null;
12
+ setFieldValue: (field: string, value: any, shouldValidate?: boolean | undefined) => void;
13
+ }
14
+ /**
15
+ * @group Form custom fields
16
+ */
17
+ export declare function FormikArrayContainer<T>({ name, addLabel, value, disabled, buildEntry, small, onInternalIdAdded, includeAddButton, newDefaultEntry, setFieldValue }: ArrayContainerProps<T>): import("react/jsx-runtime").JSX.Element;
18
+ export {};
@@ -0,0 +1,13 @@
1
+ import { Entity, ResolvedStringProperty } from "../../types";
2
+ import { PreviewSize } from "../../preview";
3
+ interface StorageItemPreviewProps {
4
+ name: string;
5
+ property: ResolvedStringProperty;
6
+ value: string;
7
+ entity: Entity<any>;
8
+ onRemove: (value: string) => void;
9
+ size: PreviewSize;
10
+ disabled: boolean;
11
+ }
12
+ export declare function StorageItemPreview({ name, property, value, entity, onRemove, disabled, size }: StorageItemPreviewProps): import("react/jsx-runtime").JSX.Element;
13
+ export {};
@@ -0,0 +1,10 @@
1
+ import { StorageFieldItem } from "../../util/useStorageUploadController";
2
+ export interface StorageUploadItemProps {
3
+ storagePath: string;
4
+ metadata?: any;
5
+ entry: StorageFieldItem;
6
+ onFileUploadComplete: (value: string, entry: StorageFieldItem, metadata?: any) => Promise<void>;
7
+ imageSize: number;
8
+ simple: boolean;
9
+ }
10
+ export declare function StorageUploadProgress({ storagePath, entry, metadata, onFileUploadComplete, imageSize, simple }: StorageUploadItemProps): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,8 @@
1
+ import { FieldProps } from "formik";
2
+ export declare function SwitchControl({ field, form, label, tooltip, disabled, size, allowIndeterminate }: FieldProps & {
3
+ label: string;
4
+ tooltip?: string;
5
+ disabled?: boolean;
6
+ size: "small" | "medium";
7
+ allowIndeterminate?: boolean;
8
+ }): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,3 @@
1
+ export * from "./FormikArrayContainer";
2
+ export * from "./SwitchControl";
3
+ export * from "./FieldHelperText";
@@ -0,0 +1,9 @@
1
+ import { FieldProps } from "../../types";
2
+ /**
3
+ * Array field used for custom
4
+ *
5
+ * This is one of the internal components that get mapped natively inside forms
6
+ * and tables to the specified properties.
7
+ * @group Form fields
8
+ */
9
+ export declare function ArrayCustomShapedFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, tableMode, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T, any, any>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,11 @@
1
+ import { EntityReference, FieldProps } from "../../types";
2
+ type ArrayOfReferencesFieldProps = FieldProps<EntityReference[]>;
3
+ /**
4
+ * This field allows selecting multiple references.
5
+ *
6
+ * This is one of the internal components that get mapped natively inside forms
7
+ * and tables to the specified properties.
8
+ * @group Form fields
9
+ */
10
+ export declare function ArrayOfReferencesFieldBinding({ propertyKey, value, error, showError, disabled, isSubmitting, tableMode, property, includeDescription, setValue, setFieldValue }: ArrayOfReferencesFieldProps): import("react/jsx-runtime").JSX.Element;
11
+ export {};
@@ -0,0 +1,10 @@
1
+ import { FieldProps } from "../../types";
2
+ /**
3
+ * If the `oneOf` property is specified, this fields render each array entry as
4
+ * a `type` select and the corresponding field widget to the selected `type.
5
+ *
6
+ * This is one of the internal components that get mapped natively inside forms
7
+ * and tables to the specified properties.
8
+ * @group Form fields
9
+ */
10
+ export declare function BlockFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, setFieldValue, tableMode, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,11 @@
1
+ import { FieldProps } from "../../types";
2
+ type DateTimeFieldProps = FieldProps<Date>;
3
+ /**
4
+ * Field that allows selecting a date
5
+ *
6
+ * This is one of the internal components that get mapped natively inside forms
7
+ * and tables to the specified properties.
8
+ * @group Form fields
9
+ */
10
+ export declare function DateTimeFieldBinding({ propertyKey, value, setValue, autoFocus, error, showError, disabled, touched, property, includeDescription }: DateTimeFieldProps): import("react/jsx-runtime").JSX.Element;
11
+ export {};
@@ -0,0 +1,7 @@
1
+ import { FieldProps } from "../../types";
2
+ /**
3
+ * Field that allows edition of key value pairs.
4
+ *
5
+ * @group Form fields
6
+ */
7
+ export declare function KeyValueFieldBinding<T extends Record<string, any>>({ propertyKey, value, showError, error, disabled, property, setValue, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,9 @@
1
+ import { FieldProps } from "../../types";
2
+ /**
3
+ * Field that renders the children property fields
4
+ *
5
+ * This is one of the internal components that get mapped natively inside forms
6
+ * and tables to the specified properties.
7
+ * @group Form fields
8
+ */
9
+ export declare function MapFieldBinding<T extends Record<string, any>>({ propertyKey, value, showError, error, disabled, property, setValue, partOfBlock, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,9 @@
1
+ import { FieldProps } from "../../types";
2
+ /**
3
+ * Render a markdown field that allows edition and seeing the preview.
4
+ *
5
+ * This is one of the internal components that get mapped natively inside forms
6
+ * and tables to the specified properties.
7
+ * @group Form fields
8
+ */
9
+ export declare function MarkdownFieldBinding({ propertyKey, value, setValue, error, showError, disabled, autoFocus, touched, property, tableMode, includeDescription, context }: FieldProps<string>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,9 @@
1
+ import { EnumType, FieldProps } from "../../types";
2
+ /**
3
+ * This fields renders a dropdown with multiple selection.
4
+ *
5
+ * This is one of the internal components that get mapped natively inside forms
6
+ * and tables to the specified properties.
7
+ * @group Form fields
8
+ */
9
+ export declare function MultiSelectBinding({ propertyKey, value, setValue, error, showError, disabled, property, includeDescription, autoFocus }: FieldProps<EnumType[], any, any>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,10 @@
1
+ import { FieldProps } from "../../types";
2
+ /**
3
+ *
4
+ * Simply render the non-editable preview of a field
5
+ *
6
+ * This is one of the internal components that get mapped natively inside forms
7
+ * and tables to the specified properties.
8
+ * @group Form fields
9
+ */
10
+ export declare function ReadOnlyFieldBinding({ propertyKey, value, error, showError, tableMode, property, includeDescription, context }: FieldProps<any>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,9 @@
1
+ import { EntityReference, FieldProps } from "../../types";
2
+ /**
3
+ * Field that opens a reference selection dialog.
4
+ *
5
+ * This is one of the internal components that get mapped natively inside forms
6
+ * and tables to the specified properties.
7
+ * @group Form fields
8
+ */
9
+ export declare function ReferenceFieldBinding<M extends Record<string, any>>(props: FieldProps<EntityReference>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,10 @@
1
+ import { FieldProps } from "../../types";
2
+ /**
3
+ * Generic array field that allows reordering and renders the child property
4
+ * as nodes.
5
+ *
6
+ * This is one of the internal components that get mapped natively inside forms
7
+ * and tables to the specified properties.
8
+ * @group Form fields
9
+ */
10
+ export declare function RepeatFieldBinding<T extends Array<any>>({ propertyKey, value, error, showError, isSubmitting, setValue, setFieldValue, tableMode, property, includeDescription, underlyingValueHasChanged, context, disabled }: FieldProps<T>): import("react/jsx-runtime").JSX.Element;
@@ -0,0 +1,12 @@
1
+ import { EnumType, FieldProps } from "../../types";
2
+ type SelectProps<T extends EnumType> = FieldProps<T>;
3
+ /**
4
+ * If `enumValues` are set in the string config, this field renders a select
5
+ * where each option is a colored chip.
6
+ *
7
+ * This is one of the internal components that get mapped natively inside forms
8
+ * and tables to the specified properties.
9
+ * @group Form fields
10
+ */
11
+ export declare function SelectFieldBinding<T extends EnumType>({ propertyKey, value, setValue, error, showError, disabled, autoFocus, touched, property, includeDescription }: SelectProps<T>): import("react/jsx-runtime").JSX.Element;
12
+ export {};
@@ -0,0 +1,28 @@
1
+ import { Entity, FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
2
+ import { StorageFieldItem } from "../../util/useStorageUploadController";
3
+ type StorageUploadFieldProps = FieldProps<string | string[]>;
4
+ /**
5
+ * Field that allows to upload files to Google Cloud Storage.
6
+ *
7
+ * This is one of the internal components that get mapped natively inside forms
8
+ * and tables to the specified properties.
9
+ * @group Form fields
10
+ */
11
+ export declare function StorageUploadFieldBinding({ propertyKey, value, setValue, error, showError, autoFocus, tableMode, property, includeDescription, context, isSubmitting }: StorageUploadFieldProps): import("react/jsx-runtime").JSX.Element;
12
+ export interface StorageUploadProps {
13
+ value: StorageFieldItem[];
14
+ setInternalValue: (v: StorageFieldItem[]) => void;
15
+ name: string;
16
+ property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
17
+ onChange: (value: string | string[] | null) => void;
18
+ multipleFilesSupported: boolean;
19
+ autoFocus: boolean;
20
+ disabled: boolean;
21
+ entity: Entity<any>;
22
+ storage: StorageConfig;
23
+ onFilesAdded: (acceptedFiles: File[]) => void;
24
+ storagePathBuilder: (file: File) => string;
25
+ onFileUploadComplete: (uploadedPath: string, entry: StorageFieldItem, fileMetadata?: any) => Promise<void>;
26
+ }
27
+ export declare function StorageUpload({ property, name, value, setInternalValue, onChange, multipleFilesSupported, onFileUploadComplete, disabled, onFilesAdded, autoFocus, storage, entity, storagePathBuilder }: StorageUploadProps): import("react/jsx-runtime").JSX.Element;
28
+ export {};