@firecms/core 3.0.0-canary.5 → 3.0.0-canary.50

package/src/types/entity_actions.tsx

@@ -5,9 +5,25 @@ import { EntityCollection, SelectionController } from "./collections";
 import { User } from "./user";
 import { SideEntityController } from "./side_entity_controller";
 
+/**
+ * An entity action is a custom action that can be performed on an entity.
+ * They are displayed in the entity view and in the collection view.
+ */
 export type EntityAction<M extends object = any, UserType extends User = User> = {
+    /**
+     * Title of the action
+     */
     name: string;
+
+    /**
+     * Icon of the action
+     */
     icon?: React.ReactElement;
+
+    /**
+     * Callback when the action is clicked
+     * @param props
+     */
     onClick: (props: EntityActionClickProps<M, UserType>) => Promise<void> | void;
 
     /**
@@ -21,6 +37,7 @@ export type EntityAction<M extends object = any, UserType extends User = User> =
      * Show this action in the form, defaults to true
      */
     includeInForm?: boolean;
+
 }
 
 export type EntityActionClickProps<M extends object, UserType extends User = User> = {

package/src/types/entity_callbacks.ts

@@ -78,7 +78,7 @@ export interface EntityOnFetchProps<M extends Record<string, any> = any, UserTyp
     /**
      * Collection of the entity
      */
-    collection: EntityCollection<M>;
+    collection: EntityCollection<M, UserType>;
 
     /**
      * Full path of the CMS where this collection is being fetched.
@@ -193,7 +193,7 @@ export interface EntityOnDeleteProps<M extends Record<string, any> = any, UserTy
     /**
      * Context of the app status
      */
-    context: FireCMSContext;
+    context: FireCMSContext<UserType>;
 }
 
 /**

package/src/types/entity_overrides.tsx

@@ -0,0 +1,7 @@
+import { DataSource } from "./datasource";
+import { StorageSource } from "./storage";
+
+export type EntityOverrides = {
+    dataSource?: DataSource;
+    storageSource?: StorageSource;
+};

package/src/types/firecms.tsx

@@ -67,7 +67,6 @@ export type FireCMSProps<UserType extends User, EC extends EntityCollection> = {
         loading: boolean;
     }) => React.ReactNode;
 
-
     /**
      * Record of custom form fields to be used in the CMS.
      * You can use the key to reference the custom field in

package/src/types/index.ts

@@ -17,11 +17,12 @@ export * from "./side_entity_controller";
 export * from "./side_dialogs_controller";
 export * from "./firecms_context";
 export * from "./entity_callbacks";
+export * from "./entity_overrides";
 export * from "./local_config_persistence";
 export * from "./plugins";
 export * from "./analytics";
 export * from "./firecms";
-export * from "./appcheck";
+export * from "./roles";
 export * from "./export_import";
 export * from "./modify_collections";
 export * from "./analytics_controller";

package/src/types/navigation.ts

@@ -1,3 +1,4 @@
+import React from "react";
 import { EntityCollection } from "./collections";
 import { EntityReference } from "./entities";
 
@@ -6,7 +7,7 @@ import { EntityReference } from "./entities";
  * attributes.
  * @group Models
  */
-export type NavigationController = {
+export type NavigationController<EC extends EntityCollection = EntityCollection<any>> = {
 
     /**
      * List of the mapped collections in the CMS.
@@ -22,6 +23,12 @@ export type NavigationController = {
      */
     views?: CMSView[];
 
+    /**
+     * Custom additional views created by the developer, added to the admin
+     * navigation
+     */
+    adminViews?: CMSView[];
+
     /**
      * Configuration for the views that should be displayed at the top
      * level of the navigation (e.g. in the home page or the navigation
@@ -49,18 +56,18 @@ export type NavigationController = {
      * Get the collection configuration for a given path.
      * The collection is resolved from the given path or alias.
      */
-    getCollection: <EC extends EntityCollection = EntityCollection<any>>(pathOrAlias: string,
-                                                                         entityId?: string,
-                                                                         includeUserOverride?: boolean) => EC | undefined;
+    getCollection: (pathOrId: string,
+                    entityId?: string,
+                    includeUserOverride?: boolean) => EC | undefined;
     /**
      * Get the collection configuration from its parent path segments.
      */
-    getCollectionFromIds: <EC extends EntityCollection = EntityCollection<any>>(ids: string[]) => EC | undefined;
+    getCollectionFromIds: (ids: string[]) => EC | undefined;
 
     /**
      * Get the collection configuration from its parent path segments.
      */
-    getCollectionFromPaths: <EC extends EntityCollection = EntityCollection<any>>(pathSegments: string[]) => EC | undefined;
+    getCollectionFromPaths: (pathSegments: string[]) => EC | undefined;
 
     /**
      * Default path under the navigation routes of the CMS will be created
@@ -116,13 +123,6 @@ export type NavigationController = {
      */
     resolveAliasesFrom: (pathWithAliases: string) => string;
 
-    /**
-     * Location used as the base for routes.
-     * This is the location that will be used underneath, when the url changes while
-     * opening a side dialog
-     */
-    baseLocation: string;
-
     /**
      * Call this method to recalculate the navigation
      */
@@ -192,6 +192,7 @@ export interface CMSView {
     /**
      * Optional field used to group top level navigation entries under a
      * navigation view.
+     * This prop is ignored for admin views.
      */
     group?: string;
 
@@ -201,11 +202,11 @@ export interface TopNavigationEntry {
     url: string;
     name: string;
     path: string;
-    type: "collection" | "view";
+    type: "collection" | "view" | "admin";
     collection?: EntityCollection;
-    view: CMSView;
+    view?: CMSView;
     description?: string;
-    group?: string;
+    group: string;
 }
 
 export type TopNavigationResult = {

package/src/types/permissions.ts

@@ -41,6 +41,11 @@ export interface PermissionsBuilderProps<EC extends EntityCollection = EntityCol
      */
     entity: Entity<M> | null;
 
+    /**
+     * Path of the collection e.g. 'products/12345/locales'
+     */
+    path: string;
+
     /**
      * Path segments of the collection e.g. ['products', 'locales']
      */
@@ -73,4 +78,4 @@ export type PermissionsBuilder<EC extends EntityCollection = EntityCollection, U
           user,
           collection,
           authController
-      }: PermissionsBuilderProps<EC, UserType, M>) => Permissions);
+      }: PermissionsBuilderProps<EC, UserType, M>) => Permissions | undefined);

package/src/types/plugins.tsx

@@ -13,12 +13,12 @@ import { ResolvedProperty } from "./resolved_entities";
  * 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> = {
+export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollection = EntityCollection, COL_ACTIONS_PROPS = any, COL_ACTIONS_START__PROPS = any> = {
 
     /**
-     * Name of the plugin
+     * Key of the plugin. This is used to identify the plugin in the CMS.
      */
-    name: string;
+    key: string;
 
     /**
      * If this flag is set to true, no content will be shown in the CMS
@@ -26,31 +26,6 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
      */
     loading?: boolean;
 
-    collections?: {
-
-        /**
-         * 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
@@ -113,6 +88,16 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
 
     collectionView?: {
 
+        /**
+         * 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;
+
+        CollectionActionsStart?: React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_START__PROPS> | React.ComponentType<CollectionActionsProps<any, any, EC> & COL_ACTIONS_START__PROPS>[];
+        collectionActionsStartProps?: COL_ACTIONS_START__PROPS;
+
         showTextSearchBar?: (props: {
             context: FireCMSContext,
             path: string,
@@ -151,6 +136,19 @@ export type FireCMSPlugin<PROPS = any, FORM_PROPS = any, EC extends EntityCollec
         }>;
     }
 
+    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;
+    }
+
 }
 
 /**

package/src/types/properties.ts

@@ -1,7 +1,7 @@
 import React from "react";
 import { FieldProps } from "./fields";
 import { PropertyPreviewProps } from "../preview";
-import { EntityReference, EntityValues, GeoPoint } from "./entities";
+import { EntityReference, EntityValues, GeoPoint, Vector } from "./entities";
 import { ResolvedArrayProperty, ResolvedStringProperty } from "./resolved_entities";
 import { FilterValues } from "./collections";
 import { ChipColorKey, ChipColorScheme } from "@firecms/ui";
@@ -15,9 +15,10 @@ export type DataType<T extends CMSType = CMSType> =
             T extends boolean ? "boolean" :
                 T extends Date ? "date" :
                     T extends GeoPoint ? "geopoint" :
-                        T extends EntityReference ? "reference" :
-                            T extends Array<CMSType> ? "array" :
-                                T extends Record<string, any> ? "map" : never;
+                        T extends Vector ? "vector" :
+                            T extends EntityReference ? "reference" :
+                                T extends Array<CMSType> ? "array" :
+                                    T extends Record<string, any> ? "map" : never;
 
 /**
  * @group Entity properties
@@ -695,7 +696,7 @@ export interface ArrayPropertyValidationSchema extends PropertyValidationSchema
  * Additional configuration related to Storage related fields
  * @group Entity properties
  */
-export interface StorageConfig {
+export type StorageConfig = {
 
     /**
      * File MIME types that can be uploaded to this reference. Don't specify for
@@ -770,7 +771,8 @@ export interface StorageConfig {
      * Postprocess the saved value (storage path or URL)
      * after it has been resolved.
      */
-    postProcess?: (pathOrUrl: string) => Promise<string>
+    postProcess?: (pathOrUrl: string) => Promise<string>;
+
 }
 
 /**

package/src/types/property_config.tsx

@@ -11,7 +11,7 @@ export type PropertyConfig<T extends CMSType = any> = {
     /**
      * Key used to identify this property config.
      */
-    key: string,
+    key: PropertyConfigId | string;
 
     /**
      * Name of this field type.
@@ -48,7 +48,7 @@ export type PropertyConfig<T extends CMSType = any> = {
 
 }
 
-export type FieldConfigId =
+export type PropertyConfigId =
     "text_field" |
     "multiline" |
     "markdown" |

package/src/types/roles.ts

@@ -0,0 +1,41 @@
+import { Permissions } from "../index";
+
+export type Role = {
+
+    /**
+     * ID of the role
+     */
+    id: string;
+
+    /**
+     * Name of the role
+     */
+    name: string;
+
+    /**
+     * If this flag is true, the user can perform any action
+     */
+    isAdmin?: boolean;
+
+    /**
+     * Default permissions for all collections for this role.
+     * You can override this values at the collection level using
+     * {@link collectionPermissions}
+     */
+    defaultPermissions?: Permissions;
+
+    /**
+     * Record of stripped collection ids to their permissions.
+     * @see stripCollectionPath
+     */
+    collectionPermissions?: Record<string, Permissions>;
+
+    config?: {
+
+        createCollections?: boolean;
+
+        editCollections?: boolean | "own";
+
+        deleteCollections?: boolean | "own";
+    }
+}

package/src/types/side_entity_controller.tsx

@@ -1,6 +1,7 @@
 import { EntityCollection } from "./collections";
 import { ResolvedEntityCollection } from "./resolved_entities";
 import { Entity } from "./entities";
+import { EntityOverrides } from "./entity_overrides";
 
 /**
  * Props used to open a side dialog

package/src/types/storage.ts

@@ -6,6 +6,7 @@ export interface UploadFileProps {
     fileName?: string,
     path?: string,
     metadata?: any,
+    bucket?: string
 }
 
 /**
@@ -16,6 +17,10 @@ export interface UploadFileResult {
      * Storage path including the file name where the file was uploaded.
      */
     path: string;
+    /**
+     * Bucket where the file was uploaded
+     */
+    bucket: string;
 }
 
 /**
@@ -73,24 +78,28 @@ export interface StorageSource {
      * @param fileName
      * @param path
      * @param metadata
+     * @param bucket
      */
     uploadFile: ({
                      file,
                      fileName,
                      path,
-                     metadata
+                     metadata,
+                     bucket
                  }: UploadFileProps) => Promise<UploadFileResult>;
 
     /**
      * Convert a storage path or URL into a download configuration
      * @param path
+     * @param bucket
      */
-    getDownloadURL: (pathOrUrl: string) => Promise<DownloadConfig>;
+    getDownloadURL: (pathOrUrl: string, bucket?: string) => Promise<DownloadConfig>;
 
     /**
      * Get a file from a storage path.
      * It returns null if the file does not exist.
      * @param props
+     * @param bucket
      */
-    getFile: (path:string) => Promise<File | null>;
+    getFile: (path:string, bucket?: string) => Promise<File | null>;
 }

package/src/types/user.ts

@@ -1,3 +1,5 @@
+import { Role } from "./roles";
+
 /**
  * This interface represents a user.
  * It has some of the same fields as a Firebase User.
@@ -34,4 +36,9 @@ export type User = {
      */
     readonly isAnonymous: boolean;
 
+    /**
+     *
+     */
+    roles?: Role[];
+
 };

package/src/util/collections.ts

@@ -1,6 +1,8 @@
 import {
     DefaultSelectedViewBuilder,
     DefaultSelectedViewParams,
+    EntityCollection,
+    PermissionsBuilder,
     PropertiesOrBuilders,
     PropertyOrBuilder
 } from "../types";
@@ -48,3 +50,23 @@ export function resolveDefaultSelectedView(
         return defaultSelectedView(params);
     }
 }
+
+/**
+ * If a collection is not applying permissions, we apply the given permissionsBuilder.
+ * This is used to apply the role permissions to the collections, unless they are already
+ * applying permissions.
+ * @param collections
+ * @param permissionsBuilder
+ */
+export const applyPermissionsFunctionIfEmpty = (collections: EntityCollection[], permissionsBuilder?: PermissionsBuilder<any, any>): EntityCollection[] => {
+
+    return collections.map(collection => {
+        if (collection.permissions) {
+            return collection;
+        }
+        return ({
+            ...collection,
+            permissions: permissionsBuilder
+        });
+    });
+}

package/src/util/entities.ts

@@ -139,7 +139,7 @@ export function sanitizeData<M extends Record<string, any>>
     return result;
 }
 
-export function getReferenceFrom<M extends Record<string, any>>(entity: Entity<M>): EntityReference<M> {
+export function getReferenceFrom<M extends Record<string, any>>(entity: Entity<M>): EntityReference {
     return new EntityReference(entity.id, entity.path);
 }
 

package/src/util/icon_list.ts

@@ -1,4 +1,4 @@
-import { icon_synonyms } from "./icon_synonyms";
+import { iconSynonyms } from "./icon_synonyms";
 import { iconKeys } from "@firecms/ui";
 
 // @ts-ignore
@@ -12,6 +12,6 @@ iconsSearch.addDocuments(iconKeys
         return {
             key: importName,
             // @ts-ignore
-            synonyms: icon_synonyms[importName] ?? [],
+            synonyms: iconSynonyms[importName] ?? [],
         }
     }));

package/src/util/icon_synonyms.ts

@@ -1,4 +1,4 @@
-export const icon_synonyms = {
+export const iconSynonyms = {
     abc: "alphabet character font letter symbol text type",
     access_alarm: "clock time",
     access_alarms: "clock time",
@@ -84,7 +84,6 @@ export const icon_synonyms = {
     apartment: "accommodation architecture building city company estate flat home house office places real residence residential shelter units workplace",
     api: "developer development enterprise software",
     app_blocking: "Android applications cancel cell device hardware iOS mobile phone stopped tablet",
-    apple: "brand logo",
     app_registration: "apps edit pencil register",
     approval: "apply approvals approve certificate certification disapproval drive file impression ink mark postage stamp",
     apps: "all applications circles collection components dots grid homescreen icons interface squares ui ux",
@@ -527,7 +526,6 @@ export const icon_synonyms = {
     egg_alt: "breakfast brunch food",
     eighteen_mp: "camera digits font image letters megapixels numbers quality resolution symbol text type",
     eight_k: "8000 8K alphabet character digit display font letter number pixels resolution symbol text type video",
-    eight_k_plus: "+ 7000 8K alphabet character digit display font letter number pixels resolution symbol text type video",
     eight_mp: "camera digit font image letters megapixels number quality resolution symbol text type",
     eightteen_mp: "camera digits font image letters megapixels numbers quality resolution symbol text type",
     eject: "arrow disc drive dvd player remove triangle up usb",
@@ -722,7 +720,6 @@ export const icon_synonyms = {
     four_g_mobiledata: "alphabet cellular character digit font letter network number phone signal speed symbol text type wifi",
     four_g_plus_mobiledata: "alphabet cellular character digit font letter network number phone signal speed symbol text type wifi",
     four_k: "4000 4K alphabet character digit display font letter number pixels resolution symbol text type video",
-    four_k_plus: "+ 4000 4K alphabet character digit display font letter number pixels resolution symbol text type video",
     four_mp: "camera digit font image letters megapixels number quality resolution symbol text type",
     fourteen_mp: "camera digits font image letters megapixels numbers quality resolution symbol text type",
     free_breakfast: "beverage cafe coffee cup drink mug tea",

package/src/util/icons.tsx

@@ -1,5 +1,4 @@
 import React from "react";
-import { CMSView, EntityCollection } from "../types";
 import { hashString } from "./hash";
 import { coolIconKeys, Icon, iconKeys } from "@firecms/ui";
 import { slugify } from "./strings";
@@ -14,8 +13,17 @@ export function getIcon(iconKey?: string, className?: string): React.ReactElemen
     return iconKey in iconKeysMap ? <Icon iconKey={iconKey} size={"medium"} className={className}/> : undefined;
 }
 
+export type IconViewProps = {
+    path: string;
+    name: string;
+    singularName?: string;
+    group?: string;
+    icon?: string;
+}
+
 export const IconForView = React.memo(
-    function IconForView({ collectionOrView, className }: { collectionOrView: EntityCollection | CMSView, className?: string }): React.ReactElement {
+    function IconForView({ collectionOrView, className }: { collectionOrView?: IconViewProps, className?: string }): React.ReactElement {
+        if (!collectionOrView) return <></>;
         const icon = getIcon(collectionOrView.icon, className);
         if (collectionOrView?.icon && icon)
             return icon;
@@ -39,7 +47,7 @@ export const IconForView = React.memo(
 
         return <Icon iconKey={key} size={"medium"} className={className}/>;
     }, (prevProps, nextProps) => {
-        return equal(prevProps.collectionOrView.icon, nextProps.collectionOrView.icon);
+        return equal(prevProps.collectionOrView?.icon, nextProps.collectionOrView?.icon);
     });
 
 const iconKeysMap: Record<string, string> = iconKeys.reduce((acc: Record<string, string>, key) => {

package/src/util/navigation_utils.ts

@@ -60,14 +60,14 @@ export function resolveCollectionPathIds(path: string, allCollections: EntityCol
 /**
  * Find the corresponding view at any depth for a given path.
  * Note that path or segments of the paths can be collection aliases.
- * @param pathOrAlias
+ * @param pathOrId
  * @param collections
  */
-export function getCollectionByPathOrId(pathOrAlias: string, collections: EntityCollection[]): EntityCollection | undefined {
+export function getCollectionByPathOrId(pathOrId: string, collections: EntityCollection[]): EntityCollection | undefined {
 
-    const subpaths = removeInitialAndTrailingSlashes(pathOrAlias).split("/");
+    const subpaths = removeInitialAndTrailingSlashes(pathOrId).split("/");
     if (subpaths.length % 2 === 0) {
-        throw Error(`getCollectionByPathOrAlias: Collection paths must have an odd number of segments: ${pathOrAlias}`);
+        throw Error(`getCollectionByPathOrId: Collection paths must have an odd number of segments: ${pathOrId}`);
     }
 
     const subpathCombinations = getCollectionPathsCombinations(subpaths);
@@ -80,10 +80,10 @@ export function getCollectionByPathOrId(pathOrAlias: string, collections: Entity
 
         if (navigationEntry) {
 
-            if (subpathCombination === pathOrAlias) {
+            if (subpathCombination === pathOrId) {
                 result = navigationEntry;
             } else if (navigationEntry.subcollections) {
-                const newPath = pathOrAlias.replace(subpathCombination, "").split("/").slice(2).join("/");
+                const newPath = pathOrId.replace(subpathCombination, "").split("/").slice(2).join("/");
                 if (newPath.length > 0)
                     result = getCollectionByPathOrId(newPath, navigationEntry.subcollections);
             }

package/src/util/objects.ts

@@ -30,20 +30,6 @@ export function mergeDeep<T extends object>(target: T, source: any): T {
     return output;
 }
 
-// export function getValueInPath(o: object | undefined, path: string): any {
-//     if (!o) return undefined;
-//     if (typeof o === "object") {
-//         if (path in o) {
-//             return (o as any)[path];
-//         }
-//         if (path.includes(".")) {
-//             const pathSegments = path.split(".");
-//             return getValueInPath((o as any)[pathSegments[0]], pathSegments.slice(1).join("."))
-//         }
-//     }
-//     return undefined;
-// }
-
 export function getValueInPath(o: object | undefined, path: string): any {
     if (!o) return undefined;
     if (typeof o === "object") {