@firecms/core 3.0.0-canary.9 → 3.0.0-canary.90

package/dist/core/DrawerNavigationItem.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+export declare function DrawerNavigationItem({ name, icon, drawerOpen, tooltipsOpen, url, onClick }: {
+    icon: React.ReactElement;
+    name: string;
+    tooltipsOpen: boolean;
+    drawerOpen: boolean;
+    url: string;
+    onClick?: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/core/EntityEditView.d.ts

@@ -1,4 +1,5 @@
-import { Entity, EntityCollection, User } from "../types";
+import { Entity, EntityCollection, EntityValues, ResolvedEntityCollection, User } from "../types";
+import { ValidationError } from "yup";
 export interface EntityEditViewProps<M extends Record<string, any>> {
     path: string;
     collection: EntityCollection<M>;
@@ -6,7 +7,6 @@ export interface EntityEditViewProps<M extends Record<string, any>> {
     copy?: boolean;
     selectedSubPath?: string;
     parentCollectionIds: string[];
-    formWidth?: number | string;
     onValuesAreModified: (modified: boolean) => void;
     onUpdate?: (params: {
         entity: Entity<any>;
@@ -19,4 +19,18 @@ export interface EntityEditViewProps<M extends Record<string, any>> {
  * You probably don't want to use this view directly since it is bound to the
  * side panel. Instead, you might want to use {@link EntityForm} or {@link EntityCollectionView}
  */
-export declare function EntityEditView<M extends Record<string, any>, UserType extends User>({ path, entityId, selectedSubPath, copy, collection, parentCollectionIds, onValuesAreModified, formWidth, onUpdate, onClose, }: EntityEditViewProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function EntityEditView<M extends Record<string, any>, UserType extends User>({ entityId, ...props }: EntityEditViewProps<M>): import("react/jsx-runtime").JSX.Element;
+export declare function EntityEditViewInner<M extends Record<string, any>>({ path, entityId: entityIdProp, selectedSubPath: selectedSubPathProp, copy, collection, parentCollectionIds, onValuesAreModified, onUpdate, onClose, entity, dataLoading, }: EntityEditViewProps<M> & {
+    entity?: Entity<M>;
+    dataLoading: boolean;
+}): import("react/jsx-runtime").JSX.Element;
+export type EntityFormSaveParams<M extends Record<string, any>> = {
+    collection: ResolvedEntityCollection<M>;
+    path: string;
+    entityId: string | undefined;
+    values: EntityValues<M>;
+    previousValues?: EntityValues<M>;
+    closeAfterSave: boolean;
+    autoSave: boolean;
+};
+export declare function yupToFormErrors(yupError: ValidationError): Record<string, any>;

package/dist/core/FireCMS.d.ts

@@ -8,7 +8,7 @@ import { EntityCollection, FireCMSProps, User } from "../types";
  *
  * You only need to use this component if you are building a custom app.
  *
- * @constructor
+
  * @group Core
  */
 export declare function FireCMS<UserType extends User, EC extends EntityCollection>(props: FireCMSProps<UserType, EC>): import("react/jsx-runtime").JSX.Element;

package/dist/core/NavigationRoutes.d.ts

@@ -6,8 +6,8 @@ export type NavigationRoutesProps = {
     /**
      * In case you need to override the home page
      */
-    HomePage?: React.ComponentType;
-    customRoutes?: React.ReactNode[];
+    homePage?: React.ReactNode;
+    children?: React.ReactNode | React.ReactNode[];
 };
 /**
  * This component is in charge of rendering
@@ -15,7 +15,7 @@ export type NavigationRoutesProps = {
  * or the home route) related to a {@link NavigationController}.
  * This component needs a parent {@link FireCMS}
  *
- * @constructor
+
  * @group Components
  */
 export declare const NavigationRoutes: React.NamedExoticComponent<NavigationRoutesProps>;

package/dist/core/index.d.ts

@@ -1,8 +1,7 @@
 export * from "./FireCMS";
-export type { ScaffoldProps } from "./Scaffold";
-export { Scaffold } from "./Scaffold";
-export type { DrawerProps } from "./Drawer";
-export { Drawer, DrawerNavigationItem } from "./Drawer";
+export * from "../app/Scaffold";
+export * from "./DefaultDrawer";
+export * from "./DrawerNavigationItem";
 export * from "./field_configs";
 export * from "./SideDialogs";
 export * from "./NavigationRoutes";

package/dist/form/PropertiesForm.d.ts

@@ -0,0 +1,8 @@
+import { PropertiesOrBuilders } from "../types";
+import { FormexController } from "@firecms/formex";
+export type PropertiesFormProps<M extends Record<string, any> = Record<string, any>> = {
+    properties: PropertiesOrBuilders<M>;
+    propertiesOrder?: string[];
+    formex: FormexController<M>;
+};
+export declare function PropertiesForm<M extends Record<string, any> = Record<string, any>>({ properties, propertiesOrder, formex }: PropertiesFormProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/form/components/ErrorFocus.d.ts

@@ -1,4 +1,4 @@
 import React from "react";
 export declare const ErrorFocus: ({ containerRef }: {
-    containerRef?: React.RefObject<HTMLDivElement> | undefined;
+    containerRef?: React.RefObject<HTMLDivElement>;
 }) => null;

package/dist/form/components/FieldHelperText.d.ts

@@ -1,12 +1,12 @@
-import { ResolvedProperty } from "../../types";
+import { Property, ResolvedProperty } from "../../types";
 /**
  * Component in charge of rendering the description of a field
  * as well as the error message if any.
  */
 export declare function FieldHelperText({ error, showError, property, includeDescription, disabled }: {
     error?: string;
-    showError: boolean;
-    property: ResolvedProperty;
+    showError?: boolean;
+    property: ResolvedProperty | Property;
     includeDescription?: boolean;
     disabled?: boolean;
 }): import("react/jsx-runtime").JSX.Element | null;

package/dist/form/components/StorageItemPreview.d.ts

@@ -1,14 +1,14 @@
-import { Entity, EntityCollection, ResolvedStringProperty } from "../../types";
+import { ResolvedStringProperty } from "../../types";
 import { PreviewSize } from "../../preview";
 interface StorageItemPreviewProps {
     name: string;
     property: ResolvedStringProperty;
     value: string;
-    entity: Entity<any>;
     onRemove: (value: string) => void;
     size: PreviewSize;
     disabled: boolean;
-    collection: EntityCollection;
+    placeholder?: boolean;
+    className?: string;
 }
-export declare function StorageItemPreview({ name, property, value, entity, onRemove, disabled, size, collection }: StorageItemPreviewProps): import("react/jsx-runtime").JSX.Element;
+export declare function StorageItemPreview({ name, property, value, onRemove, disabled, size, placeholder, className }: StorageItemPreviewProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/field_bindings/MapFieldBinding.d.ts

@@ -6,4 +6,4 @@ import { FieldProps } from "../../types";
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function MapFieldBinding({ propertyKey, value, showError, error, disabled, property, setValue, partOfBlock, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<Record<string, any>>): import("react/jsx-runtime").JSX.Element;
+export declare function MapFieldBinding({ propertyKey, value, showError, error, disabled, property, partOfBlock, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<Record<string, any>>): import("react/jsx-runtime").JSX.Element;

package/dist/form/field_bindings/StorageUploadFieldBinding.d.ts

@@ -1,4 +1,4 @@
-import { Entity, EntityCollection, FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
+import { FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
 import { StorageFieldItem } from "../../util/useStorageUploadController";
 type StorageUploadFieldProps = FieldProps<string | string[]>;
 /**
@@ -11,7 +11,6 @@ type StorageUploadFieldProps = FieldProps<string | string[]>;
 export declare function StorageUploadFieldBinding({ propertyKey, value, setValue, error, showError, autoFocus, tableMode, property, includeDescription, context, isSubmitting, }: StorageUploadFieldProps): import("react/jsx-runtime").JSX.Element;
 export interface StorageUploadProps {
     value: StorageFieldItem[];
-    collection: EntityCollection;
     setInternalValue: (v: StorageFieldItem[]) => void;
     name: string;
     property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
@@ -19,11 +18,10 @@ export interface StorageUploadProps {
     multipleFilesSupported: boolean;
     autoFocus: boolean;
     disabled: boolean;
-    entity: Entity<any>;
     storage: StorageConfig;
     onFilesAdded: (acceptedFiles: File[]) => void;
     storagePathBuilder: (file: File) => string;
     onFileUploadComplete: (uploadedPath: string, entry: StorageFieldItem, fileMetadata?: any) => Promise<void>;
 }
-export declare function StorageUpload({ collection, property, name, value, setInternalValue, onChange, multipleFilesSupported, onFileUploadComplete, disabled, onFilesAdded, autoFocus, storage, entity, storagePathBuilder, }: StorageUploadProps): import("react/jsx-runtime").JSX.Element;
+export declare function StorageUpload({ property, name, value, setInternalValue, onChange, multipleFilesSupported, onFileUploadComplete, disabled, onFilesAdded, autoFocus, storage, storagePathBuilder, }: StorageUploadProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/index.d.ts

@@ -15,7 +15,5 @@ import { MarkdownFieldBinding } from "./field_bindings/MarkdownFieldBinding";
 import { ArrayCustomShapedFieldBinding } from "./field_bindings/ArrayCustomShapedFieldBinding";
 export { ArrayCustomShapedFieldBinding, RepeatFieldBinding, MultiSelectBinding, ArrayOfReferencesFieldBinding, BlockFieldBinding, DateTimeFieldBinding, ReadOnlyFieldBinding, MapFieldBinding, KeyValueFieldBinding, ReferenceFieldBinding, SelectFieldBinding, StorageUploadFieldBinding, SwitchFieldBinding, MarkdownFieldBinding, TextFieldBinding };
 export * from "./components";
-export type { EntityFormProps } from "./EntityForm";
-export { EntityForm } from "./EntityForm";
 export { PropertyFieldBinding } from "./PropertyFieldBinding";
 export * from "./useClearRestoreValue";

package/dist/hooks/data/delete.d.ts

@@ -2,8 +2,8 @@ import { DataSource, DeleteEntityProps, Entity, EntityCallbacks, FireCMSContext,
 /**
  * @group Hooks and utilities
  */
-export type DeleteEntityWithCallbacksProps<M extends Record<string, any>> = DeleteEntityProps<M> & {
-    callbacks?: EntityCallbacks<M>;
+export type DeleteEntityWithCallbacksProps<M extends Record<string, any>, UserType extends User = User> = DeleteEntityProps<M> & {
+    callbacks?: EntityCallbacks<M, UserType>;
     onDeleteSuccess?: (entity: Entity<M>) => void;
     onDeleteFailure?: (entity: Entity<M>, e: Error) => void;
     onPreDeleteHookError?: (entity: Entity<M>, e: Error) => void;

package/dist/hooks/data/save.d.ts

@@ -1,9 +1,8 @@
-import { DataSource, Entity, EntityCallbacks, EntityCollection, FireCMSContext, SaveEntityProps, User } from "../../types";
+import { DataSource, Entity, EntityCollection, FireCMSContext, SaveEntityProps, User } from "../../types";
 /**
  * @group Hooks and utilities
  */
 export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEntityProps<M> & {
-    callbacks?: EntityCallbacks<M>;
     onSaveSuccess?: (updatedEntity: Entity<M>) => void;
     onSaveFailure?: (e: Error) => void;
     onPreSaveHookError?: (e: Error) => void;
@@ -36,7 +35,7 @@ export type SaveEntityWithCallbacksProps<M extends Record<string, any>> = SaveEn
  * @group Hooks and utilities
  */
 export declare function saveEntityWithCallbacks<M extends Record<string, any>, UserType extends User>({ collection, path, entityId, values, previousValues, status, dataSource, context, onSaveSuccess, onSaveFailure, onPreSaveHookError, onSaveSuccessHookError }: SaveEntityWithCallbacksProps<M> & {
-    collection: EntityCollection<M>;
+    collection: EntityCollection<M, UserType>;
     dataSource: DataSource;
     context: FireCMSContext<UserType>;
 }): Promise<void>;

package/dist/hooks/data/useDataSource.d.ts

@@ -3,4 +3,4 @@ import { DataSource, EntityCollection } from "../../types";
  * Use this hook to get the datasource being used
  * @group Hooks and utilities
  */
-export declare const useDataSource: (collection?: EntityCollection) => DataSource;
+export declare const useDataSource: (collection?: EntityCollection<any, any>) => DataSource;

package/dist/hooks/data/useEntityFetch.d.ts

@@ -2,10 +2,10 @@ import { Entity, EntityCollection, User } from "../../types";
 /**
  * @group Hooks and utilities
  */
-export interface EntityFetchProps<M extends Record<string, any>> {
+export interface EntityFetchProps<M extends Record<string, any>, UserType extends User = User> {
     path: string;
     entityId?: string;
-    collection: EntityCollection<M>;
+    collection: EntityCollection<M, UserType>;
     useCache?: boolean;
 }
 /**
@@ -25,4 +25,4 @@ export interface EntityFetchResult<M extends Record<string, any>> {
  * @param useCache
  * @group Hooks and utilities
  */
-export declare function useEntityFetch<M extends Record<string, any>, UserType extends User>({ path: inputPath, entityId, collection, useCache }: EntityFetchProps<M>): EntityFetchResult<M>;
+export declare function useEntityFetch<M extends Record<string, any>, UserType extends User>({ path: inputPath, entityId, collection, useCache }: EntityFetchProps<M, UserType>): EntityFetchResult<M>;

package/dist/hooks/index.d.ts

@@ -7,6 +7,7 @@ export * from "./useNavigationController";
 export * from "./useResolvedNavigationFrom";
 export * from "./useStorageSource";
 export * from "./useAuthController";
+export * from "./useDialogsController";
 export * from "./useSideDialogsController";
 export * from "./useSideEntityController";
 export * from "./useFireCMSContext";
@@ -20,3 +21,4 @@ export * from "./useCustomizationController";
 export * from "./useBuildNavigationController";
 export * from "./useBuildLocalConfigurationPersistence";
 export * from "./useBuildModeController";
+export * from "./useValidateAuthenticator";

package/dist/hooks/useBuildNavigationController.d.ts

@@ -1,5 +1,5 @@
 import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
-type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
+export type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
     basePath?: string;
     baseCollectionPath?: string;
     authController: AuthController<UserType>;
@@ -21,4 +21,3 @@ type BuildNavigationContextProps<EC extends EntityCollection, UserType extends U
 };
 export declare function useBuildNavigationController<EC extends EntityCollection, UserType extends User>(props: BuildNavigationContextProps<EC, UserType>): NavigationController;
 export declare function getSidePanelKey(path: string, entityId?: string): string;
-export {};

package/dist/hooks/useProjectLog.d.ts

@@ -1,8 +1,8 @@
-import { AuthController } from "../types";
+import { AuthController, DataSourceDelegate, FireCMSPlugin } from "../types";
 export declare const DEFAULT_SERVER_DEV = "https://api-kdoe6pj3qq-ey.a.run.app";
 export declare const DEFAULT_SERVER = "https://api-drplyi3b6q-ey.a.run.app";
 export type AccessResponse = {
     blocked?: boolean;
     message?: string;
 };
-export declare function useProjectLog(authController: AuthController): AccessResponse | null;
+export declare function useProjectLog(authController: AuthController, dataSourceDelegate: DataSourceDelegate, plugins?: FireCMSPlugin<any, any, any>[]): AccessResponse | null;

package/dist/hooks/useValidateAuthenticator.d.ts

@@ -0,0 +1,21 @@
+import { AuthController, Authenticator, DataSourceDelegate, StorageSource, User } from "../index";
+/**
+ * This hook is used internally for validating an authenticator.
+ *
+ * @param authController
+ * @param authentication
+ * @param storageSource
+ * @param dataSourceDelegate
+ */
+export declare function useValidateAuthenticator<UserType extends User = User, Controller extends AuthController<UserType> = AuthController<UserType>>({ disabled, authController, authenticator, storageSource, dataSourceDelegate }: {
+    disabled?: boolean;
+    authController: Controller;
+    authenticator?: boolean | Authenticator<UserType, Controller>;
+    dataSourceDelegate: DataSourceDelegate;
+    storageSource: StorageSource;
+}): {
+    canAccessMainView: boolean;
+    authLoading: boolean;
+    notAllowedError: any;
+    authVerified: boolean;
+};

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./core";
+export * from "./app";
 export * from "./types";
 export * from "./form";
 export * from "./preview";