@firecms/core 3.0.0-alpha.71 → 3.0.0-alpha.73

package/src/types/permissions.d.ts

@@ -1,63 +0,0 @@
-import { User } from "./user";
-import { AuthController } from "./auth";
-import { EntityCollection, InferCollectionType } from "./collections";
-import { Entity } from "./entities";
-/**
- * Define the operations that can be performed in a collection.
- * @group Models
- */
-export interface Permissions {
-    /**
-     * Can the user see this collection.
-     * If `false` it will not show in the user's navigation
-     * Defaults to `true`
-     */
-    read?: boolean;
-    /**
-     * Can the user add new entities. Defaults to `true`
-     */
-    create?: boolean;
-    /**
-     * Can the elements in this collection be edited. Defaults to `true`
-     */
-    edit?: boolean;
-    /**
-     * Can the user delete entities. Defaults to `true`
-     */
-    delete?: boolean;
-}
-/**
- * Props passed to a {@link PermissionsBuilder}
- * @group Models
- */
-export interface PermissionsBuilderProps<EC extends EntityCollection = EntityCollection, UserType extends User = User, M extends object = InferCollectionType<EC>> {
-    /**
-     * Entity being edited, might be null in some cases, when the operation
-     * refers to the collection.
-     * For example, when deciding whether a user can create a new entity
-     * in a collection, the entity will be null.
-     */
-    entity: Entity<M> | null;
-    /**
-     * Path segments of the collection e.g. ['products', 'locales']
-     */
-    pathSegments: string[];
-    /**
-     * Logged in user
-     */
-    user: UserType | null;
-    /**
-     * Collection these permissions apply to
-     */
-    collection: EC;
-    /**
-     * Auth controller
-     */
-    authController: AuthController<UserType>;
-}
-/**
- * Builder used to assign permissions to entities,
- * based on the logged user or collection.
- * @group Models
- */
-export type PermissionsBuilder<EC extends EntityCollection = EntityCollection, UserType extends User = User, M extends object = InferCollectionType<EC>> = (({ pathSegments, user, collection, authController }: PermissionsBuilderProps<EC, UserType, M>) => Permissions);

package/src/types/plugins.d.ts

@@ -1,179 +0,0 @@
-import React, { PropsWithChildren } from "react";
-import { FireCMSContext } from "./firecms_context";
-import { CollectionActionsProps, EntityCollection } from "./collections";
-import { User } from "./user";
-import { FieldProps, FormContext } from "./fields";
-import { CMSType, Property } from "./properties";
-import { EntityStatus } from "./entities";
-import { ResolvedProperty } from "./resolved_entities";
-/**
- * Interface used to define plugins for FireCMS.
- * NOTE: This is a work in progress and the API is not stable yet.
- * @group Core
- */
-export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollection = EntityCollection, COL_ACTIONS_PROPS = any> = {
-    /**
-     * Name of the plugin
-     */
-    name: string;
-    /**
-     * If this flag is set to true, no content will be shown in the CMS
-     * until the plugin is fully loaded.
-     */
-    loading?: boolean;
-    collections?: {
-        /**
-         * Use this method to inject collections to the CMS.
-         * You receive the current collections as a parameter, and you can return
-         * a new list of collections.
-         * @see {@link joinCollectionLists}
-         * @param collections
-         */
-        injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
-        /**
-         * Use this component to add custom actions to the entity collections
-         * toolbar.
-         */
-        CollectionActions?: React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_PROPS> | React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_PROPS>[];
-        collectionActionsProps?: COL_ACTIONS_PROPS;
-    };
-    form?: {
-        provider?: {
-            Component: React.ComponentType<PropsWithChildren<FORM_PROPS & PluginFormActionProps<any, EC>>>;
-            props?: FORM_PROPS;
-        };
-        Actions?: React.ComponentType<PluginFormActionProps<any, EC>>;
-        fieldBuilder?: <T extends CMSType = CMSType>(props: PluginFieldBuilderParams<T, any, EC>) => React.ComponentType<FieldProps<T>> | null;
-        fieldBuilderEnabled?: <T extends CMSType = CMSType>(props: PluginFieldBuilderParams<T>) => boolean;
-    };
-    /**
-     * You can use this prop to add higher order components to the CMS.
-     * The components will be added to the root of the CMS, so any component
-     * rendered underneath by this plugin will have access to the context
-     * provided by this HOC.
-     * Anyhow, this is rendered below the {@link FireCMSContext} provider, so
-     * you can use the hooks provided by the CMS.
-     * @param props
-     */
-    provider?: {
-        Component: React.ComponentType<PropsWithChildren<PROPS & {
-            context: FireCMSContext;
-        }>>;
-        props?: PROPS;
-    };
-    homePage?: {
-        /**
-         * Additional actions to be rendered in the home page, close to the search bar.
-         */
-        additionalActions?: React.ReactNode;
-        /**
-         * Additional children to be rendered in the beginning of the home page.
-         */
-        additionalChildrenStart?: React.ReactNode;
-        /**
-         * Additional children to be rendered at the end of the home page.
-         */
-        additionalChildrenEnd?: React.ReactNode;
-        /**
-         * Use this component to add custom actions to the navigation card
-         * in the home page.
-         */
-        CollectionActions?: React.ComponentType<PluginHomePageActionsProps>;
-        /**
-         * Additional props passed to `CollectionActions`
-         */
-        extraProps?: any;
-        /**
-         * Add additional cards to each collection group in the home page.
-         */
-        AdditionalCards?: React.ComponentType<PluginHomePageAdditionalCardsProps> | React.ComponentType<PluginHomePageAdditionalCardsProps>[];
-        /**
-         * Include a section in the home page with a custom component and title.
-         * @param props
-         */
-        includeSection?: (props: PluginGenericProps) => {
-            title: string;
-            children: React.ReactNode;
-        };
-    };
-    collectionView?: {
-        showTextSearchBar?: (props: {
-            context: FireCMSContext;
-            path: string;
-            collection: EC;
-        }) => boolean;
-        onTextSearchClick?: (props: {
-            context: FireCMSContext;
-            path: string;
-            collection: EC;
-        }) => Promise<boolean>;
-        /**
-         * Use this method to inject widgets to the entity collections header
-         * @param props
-         */
-        HeaderAction?: React.ComponentType<{
-            property: ResolvedProperty;
-            propertyKey: string;
-            fullPath: string;
-            parentCollectionIds: string[];
-            onHover: boolean;
-            collection: EC;
-        }>;
-        /**
-         * If you add this callback to your plugin, an add button will be added to the collection table.
-         * TODO: Only the first plugin that defines this callback will be used, at the moment.
-         */
-        AddColumnComponent?: React.ComponentType<{
-            fullPath: string;
-            parentCollectionIds: string[];
-            collection: EC;
-        }>;
-    };
-};
-/**
- * Props passed to the {@link FireCMSPlugin.homePage.CollectionActions} method.
- * You can use it to add custom actions to the navigation card of each collection.
- *
- * @group Models
- */
-export interface PluginHomePageActionsProps<EP extends object = object, M extends Record<string, any> = any, UserType extends User = User, EC extends EntityCollection<M> = EntityCollection<M>> {
-    /**
-     * Collection path of this entity. This is the full path, like
-     * `users/1234/addresses`
-     */
-    path: string;
-    /**
-     * The collection configuration
-     */
-    collection: EC;
-    /**
-     * Context of the app status
-     */
-    context: FireCMSContext<UserType>;
-    extraProps?: EP;
-}
-export interface PluginFormActionProps<UserType extends User = User, EC extends EntityCollection = EntityCollection> {
-    entityId?: string;
-    path: string;
-    status: EntityStatus;
-    collection: EC;
-    formContext?: FormContext<any>;
-    context: FireCMSContext<UserType>;
-    currentEntityId?: string;
-}
-export type PluginFieldBuilderParams<T extends CMSType = CMSType, M extends Record<string, any> = any, EC extends EntityCollection<M> = EntityCollection<M>> = {
-    fieldConfigId: string;
-    propertyKey: string;
-    property: Property<T> | ResolvedProperty<T>;
-    Field: React.ComponentType<FieldProps<T, any, M>>;
-    plugin: FireCMSPlugin;
-    path: string;
-    collection: EC;
-};
-export interface PluginGenericProps<UserType extends User = User> {
-    context: FireCMSContext<UserType>;
-}
-export interface PluginHomePageAdditionalCardsProps<UserType extends User = User> {
-    group?: string;
-    context: FireCMSContext<UserType>;
-}