@firecms/core 3.0.0-3.0.0-canary.8.0 → 3.0.0-3.0.0-canary.44.0

package/README.md

@@ -49,7 +49,7 @@ FireCMS is based on this great technologies:
 The easiest way to get going is to check our quickstart guide! You will just
 need to follow some quick steps:
 
-https://firecms.co/docs/quickstart
+https://firecms.co/docs
 
 ### Demo
 

package/dist/components/ClearFilterSortButton.d.ts

@@ -0,0 +1,5 @@
+import { EntityTableController } from "../types";
+export declare function ClearFilterSortButton({ tableController, enabled }: {
+    enabled: boolean;
+    tableController: EntityTableController;
+}): import("react/jsx-runtime").JSX.Element | null;

package/dist/components/EntityCollectionTable/EntityCollectionRowActions.d.ts

@@ -15,17 +15,17 @@ import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionContro
  */
 export declare const EntityCollectionRowActions: ({ entity, collection, fullPath, width, frozen, isSelected, selectionEnabled, size, highlightEntity, onCollectionChange, unhighlightEntity, actions, hideId, selectionController, }: {
     entity: Entity<any>;
-    collection?: EntityCollection<any, import("src/types/user").User> | undefined;
-    fullPath?: string | undefined;
+    collection?: EntityCollection<any>;
+    fullPath?: string;
     width: number;
-    frozen?: boolean | undefined;
+    frozen?: boolean;
     size: CollectionSize;
-    isSelected?: boolean | undefined;
-    selectionEnabled?: boolean | undefined;
-    actions?: EntityAction[] | undefined;
-    hideId?: boolean | undefined;
-    onCollectionChange?: (() => void) | undefined;
-    selectionController?: SelectionController | undefined;
-    highlightEntity?: ((entity: Entity<any>) => void) | undefined;
-    unhighlightEntity?: ((entity: Entity<any>) => void) | undefined;
+    isSelected?: boolean;
+    selectionEnabled?: boolean;
+    actions?: EntityAction[];
+    hideId?: boolean;
+    onCollectionChange?: () => void;
+    selectionController?: SelectionController;
+    highlightEntity?: (entity: Entity<any>) => void;
+    unhighlightEntity?: (entity: Entity<any>) => void;
 }) => import("react/jsx-runtime").JSX.Element;

package/dist/components/EntityCollectionTable/EntityCollectionTable.d.ts

@@ -24,4 +24,4 @@ import { EntityCollectionTableProps } from "./EntityCollectionTableProps";
  * @see VirtualTable
  * @group Components
  */
-export declare const EntityCollectionTable: <M extends Record<string, any>, UserType extends User>({ forceFilter, actionsStart, actions, title, tableRowActionsBuilder, uniqueFieldValidator, getPropertyFor, onValueChange, selectionController, highlightedEntities, onEntityClick, onColumnResize, onSizeChanged, textSearchEnabled, hoverRow, inlineEditing, additionalFields, displayedColumnIds, defaultSize, properties, tableController, filterable, sortable, endAdornment, AddColumnComponent, AdditionalHeaderWidget, additionalIDHeaderWidget, emptyComponent, getIdColumnWidth, onTextSearchClick, textSearchLoading }: EntityCollectionTableProps<M>) => import("react/jsx-runtime").JSX.Element;
+export declare const EntityCollectionTable: <M extends Record<string, any>, UserType extends User>({ className, forceFilter, actionsStart, actions, title, tableRowActionsBuilder, uniqueFieldValidator, getPropertyFor, onValueChange, selectionController, highlightedEntities, onEntityClick, onColumnResize, onSizeChanged, textSearchEnabled, hoverRow, inlineEditing, additionalFields, displayedColumnIds, defaultSize, properties, tableController, filterable, sortable, endAdornment, AddColumnComponent, AdditionalHeaderWidget, additionalIDHeaderWidget, emptyComponent, getIdColumnWidth, onTextSearchClick, textSearchLoading, enablePopupIcon }: EntityCollectionTableProps<M>) => import("react/jsx-runtime").JSX.Element;

package/dist/components/EntityCollectionTable/EntityCollectionTableProps.d.ts

@@ -5,6 +5,7 @@ import { OnCellValueChange, OnColumnResizeParams, UniqueFieldValidator } from ".
  * @group Collection components
  */
 export type EntityCollectionTableProps<M extends Record<string, any>, UserType extends User = User> = {
+    className?: string;
     /**
      * Display these entities as selected
      */
@@ -65,7 +66,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
      * {@link EntityTableController}
      */
     tableController: EntityTableController<M>;
-    displayedColumnIds: PropertyColumnConfig[];
+    displayedColumnIds?: PropertyColumnConfig[];
     forceFilter?: FilterValues<Extract<keyof M, string>>;
     textSearchEnabled?: boolean;
     inlineEditing?: boolean;
@@ -87,6 +88,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, UserType e
     getIdColumnWidth?: () => number;
     onTextSearchClick?: () => void;
     textSearchLoading?: boolean;
+    enablePopupIcon: boolean;
 };
 export type GetPropertyForProps<M extends Record<string, any>> = {
     propertyKey: string;
@@ -95,5 +97,5 @@ export type GetPropertyForProps<M extends Record<string, any>> = {
 };
 export type PropertyColumnConfig = {
     key: string;
-    disabled: boolean;
+    disabled?: boolean;
 };

package/dist/components/EntityCollectionTable/PropertyTableCell.d.ts

@@ -14,5 +14,6 @@ export interface PropertyTableCellProps<T extends CMSType> {
     entity: Entity<any>;
     path: string;
     disabled: boolean;
+    enablePopupIcon?: boolean;
 }
 export declare const PropertyTableCell: React.FunctionComponent<PropertyTableCellProps<any>>;

package/dist/components/EntityCollectionTable/internal/CollectionTableToolbar.d.ts

@@ -2,17 +2,14 @@ import React from "react";
 import { CollectionSize } from "../../../types";
 interface CollectionTableToolbarProps {
     size: CollectionSize;
-    filterIsSet: boolean;
     loading: boolean;
-    forceFilter?: boolean;
     actionsStart?: React.ReactNode;
     actions?: React.ReactNode;
     title?: React.ReactNode;
     onTextSearchClick?: () => void;
     onTextSearch?: (searchString?: string) => void;
     onSizeChanged: (size: CollectionSize) => void;
-    clearFilter?: () => void;
     textSearchLoading?: boolean;
 }
-export declare function CollectionTableToolbar(props: CollectionTableToolbarProps): import("react/jsx-runtime").JSX.Element;
+export declare function CollectionTableToolbar({ actions, actionsStart, loading, onSizeChanged, onTextSearch, onTextSearchClick, size, textSearchLoading, title }: CollectionTableToolbarProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/EntityCollectionTable/internal/popup_field/PopupFormField.d.ts

@@ -16,7 +16,7 @@ interface PopupFormFieldProps<M extends Record<string, any>> {
      * Callback when the value of a cell has been edited
      * @param params
      */
-    onCellValueChange?: (params: OnCellValueChangeParams<any, M>) => Promise<void> | void;
+    onCellValueChange?: (params: OnCellValueChangeParams<any, any>) => Promise<void> | void;
 }
 export declare function PopupFormField<M extends Record<string, any>>(props: PopupFormFieldProps<M>): import("react/jsx-runtime").JSX.Element | null;
 export declare function PopupFormFieldInternal<M extends Record<string, any>>({ tableKey, entity: entityProp, customFieldValidator, propertyKey, collection: inputCollection, path, cellRect, open, onClose, onCellValueChange, container }: PopupFormFieldProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/EntityCollectionView/EntityCollectionView.d.ts

@@ -4,8 +4,18 @@ import { EntityCollection } from "../../types";
  * @group Components
  */
 export type EntityCollectionViewProps<M extends Record<string, any>> = {
-    fullPath: string;
+    /**
+     * Complete path where this collection is located.
+     * It defaults to the collection path if not provided.
+     */
+    fullPath?: string;
+    /**
+     * If this is a subcollection, specify the parent collection ids.
+     */
     parentCollectionIds?: string[];
+    /**
+     * Whether this is a subcollection or not.
+     */
     isSubCollection?: boolean;
     className?: string;
 } & EntityCollection<M>;

package/dist/components/EntityCollectionView/EntityCollectionViewStartActions.d.ts

@@ -0,0 +1,11 @@
+import { EntityCollection, EntityTableController, SelectionController } from "../../types";
+export type EntityCollectionViewStartActionsProps<M extends Record<string, any>> = {
+    collection: EntityCollection<M>;
+    path: string;
+    relativePath: string;
+    parentCollectionIds: string[];
+    selectionController: SelectionController<M>;
+    tableController: EntityTableController<M>;
+    collectionEntitiesCount: number;
+};
+export declare function EntityCollectionViewStartActions<M extends Record<string, any>>({ collection, relativePath, parentCollectionIds, path, selectionController, tableController, collectionEntitiesCount }: EntityCollectionViewStartActionsProps<M>): import("react/jsx-runtime").JSX.Element;

package/dist/components/EntityPreview.d.ts

@@ -17,13 +17,13 @@ export type EntityPreviewProps = {
  * It is used by default in reference fields and whenever a reference is displayed.
  */
 export declare function EntityPreview({ actions, disabled, hover, collection: collectionProp, previewProperties, onClick, size, includeEntityNavigation, entity }: EntityPreviewProps): import("react/jsx-runtime").JSX.Element;
-type EntityPreviewContainerProps = {
+export type EntityPreviewContainerProps = {
     children: React.ReactNode;
     hover?: boolean;
+    fullwidth?: boolean;
     size: PreviewSize;
     className?: string;
     style?: React.CSSProperties;
     onClick?: (e: React.SyntheticEvent) => void;
 };
 export declare const EntityPreviewContainer: React.FC<EntityPreviewContainerProps>;
-export {};

package/dist/components/FireCMSAppBar.d.ts

@@ -1,7 +1,7 @@
 import React from "react";
 import { User } from "../types";
 export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
-    title: string;
+    title: React.ReactNode;
     /**
      * A component that gets rendered on the upper side of the main toolbar
      */
@@ -12,6 +12,7 @@ export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
     drawerOpen: boolean;
     className?: string;
     style?: React.CSSProperties;
+    logo?: string;
     user?: User;
 } & ADDITIONAL_PROPS;
 /**
@@ -23,4 +24,4 @@ export type FireCMSAppBarProps<ADDITIONAL_PROPS = object> = {
  * @param drawerOpen
  * @constructor
  */
-export declare const FireCMSAppBar: ({ title, endAdornment, startAdornment, drawerOpen, dropDownActions, includeDrawer, className, style, user: userProp }: FireCMSAppBarProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FireCMSAppBar: ({ title, endAdornment, startAdornment, drawerOpen, dropDownActions, includeDrawer, className, style, logo, user: userProp }: FireCMSAppBarProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/SelectableTable/SelectableTable.d.ts

@@ -1,7 +1,7 @@
 import React from "react";
 import { CollectionSize, Entity, EntityTableController, FilterValues } from "../../types";
 import { CellRendererParams, VirtualTableColumn } from "../VirtualTable";
-import { OnCellValueChange, OnColumnResizeParams } from "../common/types";
+import { OnCellValueChange, OnColumnResizeParams } from "../common";
 export type SelectableTableProps<M extends Record<string, any>> = {
     /**
      * Callback when a cell value changes.

package/dist/components/common/types.d.ts

@@ -1,4 +1,4 @@
-import { CollectionSize, Entity, FireCMSContext, ResolvedProperty, SelectedCellProps } from "../../types";
+import { CollectionSize, ResolvedProperty, SelectedCellProps } from "../../types";
 export type EntityCollectionTableController<M extends Record<string, any>> = {
     /**
      * This cell is displayed as selected
@@ -28,14 +28,12 @@ export type EntityCollectionTableController<M extends Record<string, any>> = {
  * Props passed in a callback when the content of a cell in a table has been edited
  * @group Collection components
  */
-export interface OnCellValueChangeParams<T = any, M extends Record<string, any> = any> {
+export interface OnCellValueChangeParams<T = any, D = any> {
     value: T;
     propertyKey: string;
-    entity: Entity<M>;
+    data?: D;
     onValueUpdated: () => void;
-    setError: (e: Error) => void;
-    fullPath: string;
-    context: FireCMSContext;
+    setError: (e: Error | undefined) => void;
 }
 /**
  * @group Collection components

package/dist/contexts/AuthControllerContext.d.ts

@@ -1,3 +1,3 @@
 import React from "react";
 import { AuthController } from "../types";
-export declare const AuthControllerContext: React.Context<AuthController>;
+export declare const AuthControllerContext: React.Context<AuthController<any, any>>;

package/dist/core/NavigationRoutes.d.ts

@@ -6,7 +6,7 @@ export type NavigationRoutesProps = {
     /**
      * In case you need to override the home page
      */
-    HomePage?: React.ComponentType;
+    homePage?: React.ReactNode;
     customRoutes?: React.ReactNode[];
 };
 /**

package/dist/core/Scaffold.d.ts

@@ -9,7 +9,7 @@ export interface ScaffoldProps<ExtraDrawerProps = object, ExtraAppbarProps = obj
     /**
      * 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
      */

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/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

@@ -20,3 +20,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, 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, 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;
+};