@firecms/core 3.0.0-alpha.8 → 3.0.0-alpha.80

package/dist/types/datasource.d.ts

@@ -0,0 +1,262 @@
+import { Entity, EntityReference, EntityStatus, EntityValues, GeoPoint } from "./entities";
+import { EntityCollection, FilterValues } from "./collections";
+import { ResolvedEntityCollection } from "./resolved_entities";
+/**
+ * @group Datasource
+ */
+export interface FetchEntityProps<M extends Record<string, any> = any> {
+    path: string;
+    entityId: string;
+    collection?: EntityCollection<M>;
+}
+/**
+ * @group Datasource
+ */
+export type ListenEntityProps<M extends Record<string, any> = any> = FetchEntityProps<M> & {
+    onUpdate: (entity: Entity<M>) => void;
+    onError?: (error: Error) => void;
+};
+/**
+ * @group Datasource
+ */
+export interface FetchCollectionProps<M extends Record<string, any> = any> {
+    path: string;
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
+    filter?: FilterValues<Extract<keyof M, string>>;
+    limit?: number;
+    startAfter?: any[];
+    orderBy?: string;
+    searchString?: string;
+    order?: "desc" | "asc";
+}
+/**
+ * @group Datasource
+ */
+export type ListenCollectionProps<M extends Record<string, any> = any> = FetchCollectionProps<M> & {
+    onUpdate: (entities: Entity<M>[]) => void;
+    onError?: (error: Error) => void;
+};
+/**
+ * @group Datasource
+ */
+export interface SaveEntityProps<M extends Record<string, any> = any> {
+    path: string;
+    values: Partial<EntityValues<M>>;
+    entityId?: string;
+    previousValues?: Partial<EntityValues<M>>;
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
+    status: EntityStatus;
+}
+/**
+ * @group Datasource
+ */
+export interface DeleteEntityProps<M extends Record<string, any> = any> {
+    entity: Entity<M>;
+}
+/**
+ * Implement this interface and pass it to a {@link FireCMS}
+ * to connect it to your data source.
+ * A Firestore implementation of this interface can be found in {@link useFirestoreDataSource}
+ * @group Datasource
+ */
+export interface DataSource {
+    /**
+     * Fetch data from a collection
+     * @param path
+     * @param collection
+     * @param filter
+     * @param limit
+     * @param startAfter
+     * @param orderBy
+     * @param order
+     * @param searchString
+     * @return Function to cancel subscription
+     * @see useCollectionFetch if you need this functionality implemented as a hook
+     */
+    fetchCollection<M extends Record<string, any> = any>({ path, collection, filter, limit, startAfter, orderBy, order, searchString }: FetchCollectionProps<M>): Promise<Entity<M>[]>;
+    /**
+     * Listen to a collection in a given path. If you don't implement this method
+     * `fetchCollection` will be used instead, with no real time updates.
+     * @param path
+     * @param collection
+     * @param onUpdate
+     * @param onError
+     * @param filter
+     * @param limit
+     * @param startAfter
+     * @param orderBy
+     * @param order
+     * @param searchString
+     * @return Function to cancel subscription
+     * @see useCollectionFetch if you need this functionality implemented as a hook
+     */
+    listenCollection?<M extends Record<string, any> = any>({ path, collection, filter, limit, startAfter, searchString, orderBy, order, onUpdate, onError }: ListenCollectionProps<M>): () => void;
+    /**
+     * Retrieve an entity given a path and a collection
+     * @param path
+     * @param entityId
+     * @param collection
+     */
+    fetchEntity<M extends Record<string, any> = any>({ path, entityId, collection }: FetchEntityProps<M>): Promise<Entity<M> | undefined>;
+    /**
+     * Get realtime updates on one entity.
+     * @param path
+     * @param entityId
+     * @param collection
+     * @param onUpdate
+     * @param onError
+     * @return Function to cancel subscription
+     */
+    listenEntity?<M extends Record<string, any> = any>({ path, entityId, collection, onUpdate, onError }: ListenEntityProps<M>): () => void;
+    /**
+     * Save entity to the specified path
+     * @param path
+     * @param id
+     * @param collection
+     * @param status
+     */
+    saveEntity<M extends Record<string, any> = any>({ path, entityId, values, collection, status }: SaveEntityProps<M>): Promise<Entity<M>>;
+    /**
+     * Delete an entity
+     * @param entity
+     * @return was the whole deletion flow successful
+     */
+    deleteEntity<M extends Record<string, any> = any>({ entity }: DeleteEntityProps<M>): Promise<void>;
+    /**
+     * Check if the given property is unique in the given collection
+     * @param path Collection path
+     * @param name of the property
+     * @param value
+     * @param property
+     * @param entityId
+     * @return `true` if there are no other fields besides the given entity
+     */
+    checkUniqueField(path: string, name: string, value: any, entityId?: string): Promise<boolean>;
+    /**
+     * Generate an id for a new entity
+     */
+    generateEntityId(path: string): string;
+    /**
+     * Count the number of entities in a collection
+     */
+    countEntities<M extends Record<string, any> = any>(props: FetchCollectionProps<M>): Promise<number>;
+    /**
+     * Check if the given filter combination is valid
+     * @param props
+     */
+    isFilterCombinationValid?(props: FilterCombinationValidProps): boolean;
+}
+export type FilterCombinationValidProps = {
+    path: string;
+    collection: EntityCollection<any>;
+    filterValues: FilterValues<any>;
+    sortBy?: [string, "asc" | "desc"];
+};
+export type SaveEntityDelegateProps<M extends Record<string, any> = any> = Omit<SaveEntityProps<M>, "collection">;
+export type FetchCollectionDelegateProps<M extends Record<string, any> = any> = Omit<FetchCollectionProps<M>, "collection"> & {
+    isCollectionGroup?: boolean;
+};
+export type ListenCollectionDelegateProps<M extends Record<string, any> = any> = ListenCollectionProps<M> & {
+    isCollectionGroup?: boolean;
+};
+export interface DataSourceDelegate {
+    /**
+     * Fetch data from a collection
+     * @param path
+     * @param filter
+     * @param limit
+     * @param startAfter
+     * @param orderBy
+     * @param order
+     * @param searchString
+     * @return Function to cancel subscription
+     * @see useCollectionFetch if you need this functionality implemented as a hook
+     */
+    fetchCollection<M extends Record<string, any> = any>({ path, filter, limit, startAfter, orderBy, order, searchString }: FetchCollectionDelegateProps<M>): Promise<Entity<M>[]>;
+    /**
+     * Listen to a collection in a given path. If you don't implement this method
+     * `fetchCollection` will be used instead, with no real time updates.
+     * @param path
+     * @param onUpdate
+     * @param onError
+     * @param filter
+     * @param limit
+     * @param startAfter
+     * @param orderBy
+     * @param order
+     * @param searchString
+     * @return Function to cancel subscription
+     * @see useCollectionFetch if you need this functionality implemented as a hook
+     */
+    listenCollection?<M extends Record<string, any> = any>({ path, filter, limit, startAfter, searchString, orderBy, order, onUpdate, onError }: ListenCollectionDelegateProps<M>): () => void;
+    /**
+     * Retrieve an entity given a path and a collection
+     * @param path
+     * @param entityId
+     */
+    fetchEntity<M extends Record<string, any> = any>({ path, entityId, }: Omit<FetchEntityProps<M>, "collection">): Promise<Entity<M> | undefined>;
+    /**
+     * Get realtime updates on one entity.
+     * @param path
+     * @param entityId
+     * @param collection
+     * @param onUpdate
+     * @param onError
+     * @return Function to cancel subscription
+     */
+    listenEntity?<M extends Record<string, any> = any>({ path, entityId, onUpdate, onError }: Omit<ListenEntityProps<M>, "collection">): () => void;
+    /**
+     * Save entity to the specified path
+     * @param path
+     * @param id
+     * @param collection
+     * @param status
+     */
+    saveEntity<M extends Record<string, any> = any>({ path, entityId, values, status }: SaveEntityDelegateProps<M>): Promise<Entity<M>>;
+    /**
+     * Delete an entity
+     * @param entity
+     * @return was the whole deletion flow successful
+     */
+    deleteEntity<M extends Record<string, any> = any>({ entity }: DeleteEntityProps<M>): Promise<void>;
+    /**
+     * Check if the given property is unique in the given collection
+     * @param path Collection path
+     * @param name of the property
+     * @param value
+     * @param entityId
+     * @return `true` if there are no other fields besides the given entity
+     */
+    checkUniqueField(path: string, name: string, value: any, entityId?: string): Promise<boolean>;
+    /**
+     * Generate an id for a new entity
+     */
+    generateEntityId(path: string): string;
+    /**
+     * Count the number of entities in a collection
+     */
+    countEntities<M extends Record<string, any> = any>(props: FetchCollectionDelegateProps<M>): Promise<number>;
+    /**
+     * Check if the given filter combination is valid
+     * @param props
+     */
+    isFilterCombinationValid?(props: Omit<FilterCombinationValidProps, "collection">): boolean;
+    /**
+     * Convert a FireCMS reference to a reference that can be used by the datasource
+     * @param reference
+     */
+    buildReference: (reference: EntityReference) => any;
+    /**
+     * Convert a FireCMS GeoPoint to a GeoPoint that can be used by the datasource
+     * @param geoPoint
+     */
+    buildGeoPoint: (geoPoint: GeoPoint) => any;
+    /**
+     * Get the object to generate the current time in the datasource
+     */
+    currentTime(): any;
+    buildDate: (date: Date) => any;
+    buildDeleteFieldValue: () => any;
+    delegateToCMSModel: (data: any) => any;
+    setDateToMidnight: (input?: any) => any;
+}

package/dist/types/dialogs_controller.d.ts

@@ -0,0 +1,32 @@
+import React from "react";
+/**
+ * Controller to open the side dialog
+ * @group Hooks and utilities
+ */
+export interface DialogsController {
+    /**
+     * Close the last dialog
+     */
+    close: () => void;
+    /**
+     * Open a dialog
+     * @param props
+     */
+    open: (props: DialogControllerEntryProps) => {
+        closeDialog: () => void;
+    };
+}
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface DialogControllerEntryProps {
+    key: string;
+    /**
+     * The component type that will be rendered
+     */
+    Component: React.ComponentType<{
+        open: boolean;
+        closeDialog: () => void;
+    }>;
+}

package/dist/types/entities.d.ts

@@ -0,0 +1,57 @@
+/**
+ * New or existing status
+ * @group Models
+ */
+export type EntityStatus = "new" | "existing" | "copy";
+/**
+ * Representation of an entity fetched from the datasource
+ * @group Models
+ */
+export interface Entity<M extends object> {
+    /**
+     * ID of the entity
+     */
+    id: string;
+    /**
+     * A string representing the path of the referenced document (relative
+     * to the root of the database).
+     */
+    path: string;
+    /**
+     * Current values
+     */
+    values: EntityValues<M>;
+}
+/**
+ * This type represents a record of key value pairs as described in an
+ * entity collection.
+ * @group Models
+ */
+export type EntityValues<M extends object> = M;
+/**
+ * Class used to create a reference to an entity in a different path
+ */
+export declare class EntityReference<M extends Record<string, any> = any> {
+    /**
+     * ID of the entity
+     */
+    readonly id: string;
+    /**
+     * A string representing the path of the referenced document (relative
+     * to the root of the database).
+     */
+    readonly path: string;
+    constructor(id: string, path: string);
+    get pathWithId(): string;
+}
+export declare class GeoPoint {
+    /**
+     * The latitude of this GeoPoint instance.
+     */
+    readonly latitude: number;
+    /**
+     * The longitude of this GeoPoint instance.
+     */
+    readonly longitude: number;
+    constructor(latitude: number, longitude: number);
+}

package/dist/types/entity_actions.d.ts

@@ -0,0 +1,35 @@
+import React from "react";
+import { FireCMSContext } from "./firecms_context";
+import { Entity } from "./entities";
+import { EntityCollection, SelectionController } from "./collections";
+import { User } from "./user";
+import { SideEntityController } from "./side_entity_controller";
+export type EntityAction<M extends object = any, UserType extends User = User> = {
+    name: string;
+    icon?: React.ReactElement;
+    onClick: (props: EntityActionClickProps<M, UserType>) => Promise<void> | void;
+    /**
+     * Show this action collapsed in the menu of the collection view.
+     * Defaults to true
+     * If false, the action will be shown in the menu
+     */
+    collapsed?: boolean;
+    /**
+     * Show this action in the form, defaults to true
+     */
+    includeInForm?: boolean;
+};
+export type EntityActionClickProps<M extends object, UserType extends User = User> = {
+    entity: Entity<M>;
+    context: FireCMSContext<UserType>;
+    fullPath?: string;
+    collection?: EntityCollection<M>;
+    selectionController?: SelectionController;
+    highlightEntity?: (entity: Entity<any>) => void;
+    unhighlightEntity?: (entity: Entity<any>) => void;
+    onCollectionChange?: () => void;
+    /**
+     * If this actions is being called from a side dialog
+     */
+    sideEntityController?: SideEntityController;
+};

package/dist/types/entity_callbacks.d.ts

@@ -0,0 +1,171 @@
+import { EntityCollection } from "./collections";
+import { Entity, EntityStatus, EntityValues } from "./entities";
+import { FireCMSContext } from "./firecms_context";
+import { ResolvedEntityCollection } from "./resolved_entities";
+import { User } from "./user";
+/**
+ * This interface defines all the callbacks that can be used when an entity
+ * is being created, updated or deleted.
+ * Useful for adding your own logic or blocking the execution of the operation.
+ * @group Models
+ */
+export type EntityCallbacks<M extends Record<string, any> = any, UserType extends User = User> = {
+    /**
+     * Callback used after fetching data
+     * @param entityFetchProps
+     */
+    onFetch?(entityFetchProps: EntityOnFetchProps<M, UserType>): Promise<Entity<M>> | Entity<M>;
+    /**
+     * Callback used when save is successful
+     * @param entitySaveProps
+     */
+    onSaveSuccess?(entitySaveProps: EntityOnSaveProps<M, UserType>): Promise<void> | void;
+    /**
+     * Callback used when saving fails
+     * @param entitySaveProps
+     */
+    onSaveFailure?(entitySaveProps: EntityOnSaveProps<M, UserType>): Promise<void> | void;
+    /**
+     * Callback used before saving, you need to return the values that will get
+     * saved. If you throw an error in this method the process stops, and an
+     * error snackbar gets displayed.
+     * @param entitySaveProps
+     */
+    onPreSave?(entitySaveProps: EntityOnSaveProps<M, UserType>): Promise<Partial<EntityValues<M>>> | Partial<EntityValues<M>>;
+    /**
+     * Callback used after the entity is deleted.
+     * If you throw an error in this method the process stops, and an
+     * error snackbar gets displayed.
+     *
+     * @param entityDeleteProps
+     */
+    onPreDelete?(entityDeleteProps: EntityOnDeleteProps<M, UserType>): void;
+    /**
+     * Callback used after the entity is deleted.
+     *
+     * @param entityDeleteProps
+     */
+    onDelete?(entityDeleteProps: EntityOnDeleteProps<M, UserType>): void;
+    /**
+     * Callback fired when any value in the form changes. You can use it
+     * to define the ID of a `new` entity based on the current values.
+     * The returned string will be used as the ID of the entity.
+     *
+     * @param idUpdateProps
+     */
+    onIdUpdate?(idUpdateProps: EntityIdUpdateProps<M>): string;
+};
+/**
+ * Parameters passed to hooks when an entity is fetched
+ * @group Models
+ */
+export interface EntityOnFetchProps<M extends Record<string, any> = any, UserType extends User = User> {
+    /**
+     * Collection of the entity
+     */
+    collection: EntityCollection<M>;
+    /**
+     * Full path of the CMS where this collection is being fetched.
+     * Might contain unresolved aliases.
+     */
+    path: string;
+    /**
+     * Fetched entity
+     */
+    entity: Entity<M>;
+    /**
+     * Context of the app status
+     */
+    context: FireCMSContext<UserType>;
+}
+/**
+ * Parameters passed to hooks when an entity is saved
+ * @group Models
+ */
+export interface EntityOnSaveProps<M extends Record<string, any> = any, UserType extends User = User> {
+    /**
+     * Resolved collection of the entity
+     */
+    collection: ResolvedEntityCollection<M>;
+    /**
+     * Full path of the CMS where this entity is being saved.
+     * Might contain unresolved aliases.
+     */
+    path: string;
+    /**
+     * Full path where this entity is being saved, with alias resolved
+     */
+    resolvedPath: string;
+    /**
+     * ID of the entity
+     */
+    entityId?: string;
+    /**
+     * Values being saved
+     */
+    values: Partial<EntityValues<M>>;
+    /**
+     * Previous values
+     */
+    previousValues?: Partial<EntityValues<M>>;
+    /**
+     * New or existing entity
+     */
+    status: EntityStatus;
+    /**
+     * Context of the app status
+     */
+    context: FireCMSContext<UserType>;
+}
+/**
+ * Parameters passed to hooks when an entity is deleted
+ * @group Models
+ */
+export interface EntityOnDeleteProps<M extends Record<string, any> = any, UserType extends User = User> {
+    /**
+     * collection of the entity being deleted
+     */
+    collection: ResolvedEntityCollection<M>;
+    /**
+     * Path of the parent collection
+     */
+    path: string;
+    /**
+     * Deleted entity id
+     */
+    entityId: string;
+    /**
+     * Deleted entity
+     */
+    entity: Entity<M>;
+    /**
+     * Context of the app status
+     */
+    context: FireCMSContext;
+}
+/**
+ * Parameters passed to hooks when an entity is deleted
+ * @group Models
+ */
+export interface EntityIdUpdateProps<M extends Record<string, any> = any> {
+    /**
+     * collection of the entity being deleted
+     */
+    collection: ResolvedEntityCollection<M>;
+    /**
+     * Path of the parent collection
+     */
+    path: string;
+    /**
+     * Current entity id
+     */
+    entityId?: string;
+    /**
+     * Entity values
+     */
+    values: EntityValues<M>;
+    /**
+     * Context of the app status
+     */
+    context: FireCMSContext;
+}

package/dist/types/entity_link_builder.d.ts

@@ -0,0 +1,7 @@
+import { Entity } from "./entities";
+/**
+ * @group Models
+ */
+export type EntityLinkBuilder<M extends Record<string, any> = any> = ({ entity }: {
+    entity: Entity<M>;
+}) => string;

package/dist/types/export_import.d.ts

@@ -0,0 +1,21 @@
+import { User } from "./user";
+import { Entity } from "./entities";
+import { FireCMSContext } from "./firecms_context";
+/**
+ * You can use this configuration to add additional fields to the data
+ * exports
+ * @group Models
+ */
+export interface ExportConfig<UserType extends User = User> {
+    additionalFields: ExportMappingFunction<UserType>[];
+}
+/**
+ * @group Models
+ */
+export interface ExportMappingFunction<UserType extends User = User> {
+    key: string;
+    builder: ({ entity, context }: {
+        entity: Entity<any>;
+        context: FireCMSContext<UserType>;
+    }) => Promise<string> | string;
+}