@firecms/core 3.0.0-canary.6 → 3.0.0-canary.60

package/dist/core/Scaffold.d.ts

@@ -2,14 +2,15 @@ import React from "react";
 import { DrawerProps } from "./Drawer";
 import { FireCMSAppBarProps } from "../components";
 export declare const DRAWER_WIDTH = 280;
+export declare function useDrawer(): DrawerProps;
 /**
  * @group Core
  */
-export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = object> {
+export interface ScaffoldProps<ExtraAppbarProps = object> {
     /**
      * Name of the app, displayed as the main title and in the tab title
      */
-    name: string;
+    name?: React.ReactNode;
     /**
      * Logo to be displayed in the drawer of the CMS
      */
@@ -19,21 +20,16 @@ export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = obj
      */
     includeDrawer?: boolean;
     /**
-     * In case you need to override the view that gets rendered as a drawer
-     * @see DefaultDrawer
+     * You can define a custom drawer to be displayed in the scaffold.
+     * Use the hook `useDrawer` to access the context values.
      */
-    Drawer?: React.ComponentType<DrawerProps<ExtraDrawerProps>>;
-    /**
-     * Additional props passed to the custom Drawer
-     */
-    drawerProps?: Partial<DrawerProps> & ExtraDrawerProps;
+    drawer?: React.ReactNode;
     /**
      * Open the drawer on hover
      */
     autoOpenDrawer?: boolean;
     /**
-     * A component that gets rendered on the upper side of the main toolbar.
-     * `toolbarExtraWidget` has no effect if this is set.
+     * The AppBar component to be used in the scaffold.
      */
     FireCMSAppBar?: React.ComponentType<FireCMSAppBarProps<ExtraAppbarProps>>;
     /**
@@ -52,4 +48,4 @@ export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = obj
  * @constructor
  * @group Core
  */
-export declare const Scaffold: React.NamedExoticComponent<React.PropsWithChildren<ScaffoldProps<object, object>>>;
+export declare const Scaffold: React.NamedExoticComponent<React.PropsWithChildren<ScaffoldProps<object>>>;

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 "./Scaffold";
+export * from "./Drawer";
+export * from "./DrawerNavigationItem";
 export * from "./field_configs";
 export * from "./SideDialogs";
 export * from "./NavigationRoutes";

package/dist/form/EntityForm.d.ts

@@ -72,6 +72,6 @@ export type EntityFormSaveParams<M extends Record<string, any>> = {
  * @group Components
  */
 export declare const EntityForm: typeof EntityFormInternal;
-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;
+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;
 export declare function yupToFormErrors(yupError: ValidationError): Record<string, any>;
 export {};

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/StorageItemPreview.d.ts

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

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

@@ -7,4 +7,4 @@ export interface StorageUploadItemProps {
     imageSize: number;
     simple: boolean;
 }
-export declare function StorageUploadProgress({ storagePath, entry, metadata, onFileUploadComplete, imageSize, simple }: StorageUploadItemProps): import("react/jsx-runtime").JSX.Element;
+export declare function StorageUploadProgress({ storagePath, entry, metadata, onFileUploadComplete, imageSize, simple, }: StorageUploadItemProps): import("react/jsx-runtime").JSX.Element;

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

@@ -4,4 +4,4 @@ import { FieldProps } from "../../types";
  *
  * @group Form fields
  */
-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;
+export declare function KeyValueFieldBinding({ propertyKey, value, showError, error, disabled, property, setValue, tableMode, includeDescription, underlyingValueHasChanged, autoFocus, context }: FieldProps<Record<string, any>>): import("react/jsx-runtime").JSX.Element;

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<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;
+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;

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

@@ -1,4 +1,4 @@
-import { Entity, FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
+import { Entity, EntityCollection, FieldProps, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig } from "../../types";
 import { StorageFieldItem } from "../../util/useStorageUploadController";
 type StorageUploadFieldProps = FieldProps<string | string[]>;
 /**
@@ -8,9 +8,10 @@ type StorageUploadFieldProps = FieldProps<string | string[]>;
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function StorageUploadFieldBinding({ propertyKey, value, setValue, error, showError, autoFocus, tableMode, property, includeDescription, context, isSubmitting }: StorageUploadFieldProps): import("react/jsx-runtime").JSX.Element;
+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[]>;
@@ -24,5 +25,5 @@ export interface StorageUploadProps {
     storagePathBuilder: (file: File) => string;
     onFileUploadComplete: (uploadedPath: string, entry: StorageFieldItem, fileMetadata?: any) => Promise<void>;
 }
-export declare function StorageUpload({ property, name, value, setInternalValue, onChange, multipleFilesSupported, onFileUploadComplete, disabled, onFilesAdded, autoFocus, storage, entity, storagePathBuilder }: StorageUploadProps): import("react/jsx-runtime").JSX.Element;
+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 {};

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

@@ -1,5 +1,5 @@
 import { FieldProps } from "../../types";
-interface TextFieldProps<T extends string | number> extends FieldProps<T> {
+interface TextFieldBindingProps<T extends string | number> extends FieldProps<T> {
     allowInfinity?: boolean;
 }
 /**
@@ -8,5 +8,5 @@ interface TextFieldProps<T extends string | number> extends FieldProps<T> {
  * and tables to the specified properties.
  * @group Form fields
  */
-export declare function TextFieldBinding<T extends string | number>({ propertyKey, value, setValue, error, showError, disabled, autoFocus, property, includeDescription, }: TextFieldProps<T>): import("react/jsx-runtime").JSX.Element;
+export declare function TextFieldBinding<T extends string | number>({ context, propertyKey, value, setValue, error, showError, disabled, autoFocus, property, includeDescription, }: TextFieldBindingProps<T>): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/form/validation.d.ts

@@ -21,5 +21,5 @@ interface PropertyContext<T extends CMSType> {
 }
 export declare function getYupEntitySchema<M extends Record<string, any>>(entityId: string, properties: ResolvedProperties<M>, customFieldValidator?: CustomFieldValidator): ObjectSchema<any>;
 export declare function mapPropertyToYup<T extends CMSType>(propertyContext: PropertyContext<T>): AnySchema<unknown>;
-export declare function getYupMapObjectSchema<M extends Record<string, any>>({ property, entityId, customFieldValidator, name }: PropertyContext<M>): ObjectSchema<any>;
+export declare function getYupMapObjectSchema({ property, entityId, customFieldValidator, name }: PropertyContext<Record<string, any>>): ObjectSchema<any>;
 export {};

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

@@ -1,6 +1,6 @@
-import { DataSource } from "../../types";
+import { DataSource, EntityCollection } from "../../types";
 /**
  * Use this hook to get the datasource being used
  * @group Hooks and utilities
  */
-export declare const useDataSource: () => 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,10 +1,13 @@
-import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, User, UserConfigurationPersistence } from "../types";
-type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
+import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
+export type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
     basePath?: string;
     baseCollectionPath?: string;
     authController: AuthController<UserType>;
     collections?: EC[] | EntityCollectionsBuilder<EC>;
+    collectionPermissions?: PermissionsBuilder;
     views?: CMSView[] | CMSViewsBuilder;
+    adminViews?: CMSView[] | CMSViewsBuilder;
+    viewsOrder?: string[];
     userConfigPersistence?: UserConfigurationPersistence;
     dataSourceDelegate: DataSourceDelegate;
     /**
@@ -16,6 +19,5 @@ type BuildNavigationContextProps<EC extends EntityCollection, UserType extends U
      */
     injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
 };
-export declare function useBuildNavigationController<EC extends EntityCollection, UserType extends User>({ basePath, baseCollectionPath, authController, collections: collectionsProp, views: baseViews, userConfigPersistence, dataSourceDelegate, injectCollections }: BuildNavigationContextProps<EC, UserType>): NavigationController;
+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,4 +1,8 @@
-import { AuthController } from "../types";
+import { AuthController, 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 declare function useProjectLog(authController: AuthController): void;
+export type AccessResponse = {
+    blocked?: boolean;
+    message?: string;
+};
+export declare function useProjectLog(authController: AuthController, plugins?: FireCMSPlugin<any, any, any>[]): AccessResponse | null;

package/dist/hooks/useStorageSource.d.ts

@@ -1,6 +1,6 @@
-import { StorageSource } from "../types";
+import { EntityCollection, StorageSource } from "../types";
 /**
  * Use this hook to get the storage source being used
  * @group Hooks and utilities
  */
-export declare const useStorageSource: () => StorageSource;
+export declare const useStorageSource: (collection?: EntityCollection) => StorageSource;

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;
+};