@firecms/core 3.0.0-alpha.28 → 3.0.0-alpha.29

package/dist/core/FireCMS.d.ts

@@ -1,4 +1,4 @@
-import { FireCMSProps, User } from "../types";
+import { EntityCollection, FireCMSProps, User } from "../types";
 /**
  * If you are using independent components of the CMS
  * you need to wrap them with this main component, so the internal hooks work.
@@ -12,4 +12,4 @@ import { FireCMSProps, User } from "../types";
  * @constructor
  * @category Core
  */
-export declare function FireCMS<UserType extends User>(props: FireCMSProps<UserType>): import("react/jsx-runtime").JSX.Element;
+export declare function FireCMS<UserType extends User, EC extends EntityCollection>(props: FireCMSProps<UserType, EC>): import("react/jsx-runtime").JSX.Element;

package/dist/core/builders.d.ts

@@ -5,7 +5,7 @@ import { AdditionalFieldDelegate, ArrayProperty, BooleanProperty, CMSType, DateP
  * @param collection
  * @category Builder
  */
-export declare function buildCollection<M extends Record<string, any> = any, AdditionalKey extends string = string, UserType extends User = User>(collection: EntityCollection<M, AdditionalKey, UserType>): EntityCollection<M, AdditionalKey, UserType>;
+export declare function buildCollection<M extends Record<string, any> = any, UserType extends User = User>(collection: EntityCollection<M, UserType>): EntityCollection<M, UserType>;
 /**
  * Identity function we use to defeat the type system of Typescript and preserve
  * the property keys.
@@ -54,7 +54,7 @@ export declare function buildEntityCallbacks<M extends Record<string, any> = any
  * @param additionalFieldDelegate
  * @category Builder
  */
-export declare function buildAdditionalFieldDelegate<M extends Record<string, any>, AdditionalKey extends string = string, UserType extends User = User>(additionalFieldDelegate: AdditionalFieldDelegate<M, AdditionalKey, UserType>): AdditionalFieldDelegate<M, AdditionalKey, UserType>;
+export declare function buildAdditionalFieldDelegate<M extends Record<string, any>, UserType extends User = User>(additionalFieldDelegate: AdditionalFieldDelegate<M, UserType>): AdditionalFieldDelegate<M, UserType>;
 /**
  * Identity function we use to defeat the type system of Typescript and build
  * additional field delegates views with all its properties

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

@@ -11,7 +11,7 @@ export type OnColumnResizeParams = {
 /**
  * @category Collection components
  */
-export type EntityCollectionTableProps<M extends Record<string, any>, AdditionalKey extends string = string, UserType extends User = User> = {
+export type EntityCollectionTableProps<M extends Record<string, any>, UserType extends User = User> = {
     /**
      * Display these entities as selected
      */
@@ -76,7 +76,7 @@ export type EntityCollectionTableProps<M extends Record<string, any>, Additional
     forceFilter?: FilterValues<Extract<keyof M, string>>;
     textSearchEnabled?: boolean;
     inlineEditing?: boolean | ((entity: Entity<M>) => boolean);
-    additionalFields?: AdditionalFieldDelegate<M, AdditionalKey, UserType>[];
+    additionalFields?: AdditionalFieldDelegate<M, UserType>[];
     defaultSize?: CollectionSize;
     properties: ResolvedProperties<M>;
     getPropertyFor?: (props: GetPropertyForProps<M>) => ResolvedProperties<M>[string];
@@ -90,6 +90,8 @@ export type EntityCollectionTableProps<M extends Record<string, any>, Additional
     }) => React.ReactNode;
     AddColumnComponent?: React.ComponentType;
     additionalIDHeaderWidget?: React.ReactNode;
+    emptyComponent?: React.ReactNode;
+    getIdColumnWidth?: () => number;
 };
 export type GetPropertyForProps<M extends Record<string, any>> = {
     propertyKey: string;

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

@@ -1,4 +1,5 @@
-import { CollectionSize, Entity } from "../../../../types";
+import React from "react";
+import { CollectionSize, Entity, EntityAction, EntityCollection, SelectionController } from "../../../../types";
 /**
  *
  * @param entity
@@ -16,16 +17,19 @@ import { CollectionSize, Entity } from "../../../../types";
  *
  * @category Collection components
  */
-export declare function EntityCollectionRowActions<M extends Record<string, any>>({ entity, width, frozen, isSelected, selectionEnabled, size, toggleEntitySelection, onCopyClicked, onEditClicked, onDeleteClicked, hideId }: {
-    entity: Entity<M>;
+export declare const EntityCollectionRowActions: React.NamedExoticComponent<{
+    entity: Entity<any>;
+    collection?: EntityCollection<any, import("../../../../types").User> | undefined;
+    fullPath?: string | undefined;
     width: number;
-    frozen?: boolean;
+    frozen?: boolean | undefined;
     size: CollectionSize;
     isSelected: boolean;
-    selectionEnabled?: boolean;
-    toggleEntitySelection?: (selectedEntity: Entity<M>) => void;
-    onEditClicked?: (selectedEntity: Entity<M>) => void;
-    onCopyClicked?: (selectedEntity: Entity<M>) => void;
-    onDeleteClicked?: (selectedEntity: Entity<M>) => void;
-    hideId?: boolean;
-}): import("react/jsx-runtime").JSX.Element;
+    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;
+}>;

package/dist/core/components/EntityCollectionTable/internal/default_entity_actions.d.ts

@@ -0,0 +1,5 @@
+import { EntityAction } from "../../../../types";
+export declare const editEntityAction: EntityAction;
+export declare const copyEntityAction: EntityAction;
+export declare const archiveEntityAction: EntityAction;
+export declare const deleteEntityAction: EntityAction;

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

@@ -1,40 +1,4 @@
-import { CollectionSize, Entity, EntityCollection, FireCMSContext, ResolvedProperty, SelectedCellProps, User } from "../../../types";
-export type EntityCollectionTableProviderProps<M extends Record<string, any>, AdditionalKey extends string, UserType extends User> = {
-    /**
-     * Absolute collection path
-     */
-    path: string;
-    /**
-     * Use to resolve the collection properties for specific path, entity id or values
-     */
-    collection: EntityCollection<M>;
-    /**
-     * List of entities that will be displayed on top, no matter the ordering.
-     * This is used for reference fields selection
-     */
-    entitiesDisplayedFirst?: Entity<M>[];
-    /**
-     * Callback when anywhere on the table is clicked
-     */
-    onEntityClick?(entity: Entity<M>): void;
-    /**
-     * Callback when the selected size of the table is changed
-     */
-    onSizeChanged?(size: CollectionSize): void;
-    /**
-     * Can the table be edited inline
-     */
-    inlineEditing: ((entity: Entity<any>) => boolean) | boolean;
-    /**
-     * Builder for creating the buttons in each row
-     * @param entity
-     * @param size
-     */
-    tableRowActionsBuilder?: ({ entity, size }: {
-        entity: Entity<M>;
-        size: CollectionSize;
-    }) => React.ReactNode;
-};
+import { CollectionSize, Entity, FireCMSContext, ResolvedProperty, SelectedCellProps } from "../../../types";
 export type EntityCollectionTableController<M extends Record<string, any>> = {
     selectedCell?: SelectedCellProps<any>;
     select: (cell?: SelectedCellProps<M>) => void;

package/dist/core/components/VirtualTable/VirtualTableProps.d.ts

@@ -83,7 +83,7 @@ export interface VirtualTableProps<T extends Record<string, any>> {
     /**
      * Message displayed when there is no data
      */
-    emptyMessage?: string;
+    emptyComponent?: React.ReactNode;
     /**
      * Is the table in a loading state
      */

package/dist/core/contexts/DialogsProvider.d.ts

@@ -0,0 +1,4 @@
+import React, { PropsWithChildren } from "react";
+import { DialogsController } from "../../types/dialogs_controller";
+export declare const DialogsControllerContext: React.Context<DialogsController>;
+export declare const DialogsProvider: React.FC<PropsWithChildren<{}>>;

package/dist/core/index.d.ts

@@ -12,6 +12,6 @@ export * from "./form_field_configs";
 export * from "./useBuildModeController";
 export * from "../components/util/useOutsideAlerter";
 export * from "./useBuildLocalConfigurationPersistence";
-export { SnackbarProvider } from "./contexts/SnackbarContext";
+export { SnackbarProvider } from "./contexts/SnackbarProvider";
 export { ModeControllerProvider } from "./contexts/ModeController";
 export * from "./contexts/AuthControllerContext";

package/dist/core/internal/useBuildNavigationContext.d.ts

@@ -1,14 +1,14 @@
 import { AuthController, CMSView, CMSViewsBuilder, DataSource, EntityCollection, EntityCollectionsBuilder, FireCMSPlugin, NavigationContext, User, UserConfigurationPersistence } from "../../types";
-type BuildNavigationContextProps<UserType extends User> = {
+type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
     basePath: string;
     baseCollectionPath: string;
     authController: AuthController<UserType>;
-    collections?: EntityCollection[] | EntityCollectionsBuilder;
+    collections?: EC[] | EntityCollectionsBuilder<EC>;
     views?: CMSView[] | CMSViewsBuilder;
     userConfigPersistence?: UserConfigurationPersistence;
     plugins?: FireCMSPlugin[];
     dataSource: DataSource;
 };
-export declare function useBuildNavigationContext<UserType extends User>({ basePath, baseCollectionPath, authController, collections: baseCollections, views: baseViews, userConfigPersistence, plugins, dataSource }: BuildNavigationContextProps<UserType>): NavigationContext;
+export declare function useBuildNavigationContext<EC extends EntityCollection, UserType extends User>({ basePath, baseCollectionPath, authController, collections: baseCollections, views: baseViews, userConfigPersistence, plugins, dataSource }: BuildNavigationContextProps<EC, UserType>): NavigationContext;
 export declare function getSidePanelKey(path: string, entityId?: string): string;
 export {};

package/dist/core/util/resolutions.d.ts

@@ -1,6 +1,6 @@
 import { ArrayProperty, CMSType, EntityCollection, EntityCustomView, EntityValues, EnumValueConfig, EnumValues, PropertyConfig, NumberProperty, PropertiesOrBuilders, PropertyOrBuilder, ResolvedArrayProperty, ResolvedEntityCollection, ResolvedNumberProperty, ResolvedProperties, ResolvedProperty, ResolvedStringProperty, StringProperty, UserConfigurationPersistence } from "../../types";
 export declare const resolveCollection: <M extends Record<string, any>>({ collection, path, entityId, values, previousValues, userConfigPersistence, fields }: {
-    collection: EntityCollection<M, string, import("../../types").User> | ResolvedEntityCollection<M>;
+    collection: EntityCollection<M, import("../../types").User> | ResolvedEntityCollection<M>;
     path: string;
     entityId?: string | undefined;
     values?: Partial<M> | undefined;

package/dist/hooks/useDialogsController.d.ts

@@ -0,0 +1,11 @@
+import { DialogsController } from "../types/dialogs_controller";
+/**
+ * Use this hook to open a dialog imperatively.
+ * Alternatively, you can use dialogs declaratively using the `Dialog` component.
+ *
+ * Consider that in order to use this hook you need to have a parent
+ * `FireCMS`
+ *
+ * @category Hooks and utilities
+ */
+export declare const useDialogsController: () => DialogsController;