@firecms/core 3.0.0-beta.11 → 3.0.0-beta.13

package/src/util/resolutions.ts

@@ -1,6 +1,8 @@
 import {
     ArrayProperty,
+    AuthController,
     CMSType,
+    CustomizationController,
     EntityCollection,
     EntityCustomView,
     EntityValues,
@@ -26,9 +28,7 @@ import { getDefaultValuesFor, isPropertyBuilder } from "./entities";
 import { DEFAULT_ONE_OF_TYPE } from "./common";
 import { getIn } from "@firecms/formex";
 import { enumToObjectEntries } from "./enums";
-import { isDefaultFieldConfigId } from "../core/field_configs";
-
-// import util from "util";
+import { isDefaultFieldConfigId } from "../core";
 
 export const resolveCollection = <M extends Record<string, any>, >
 ({
@@ -39,7 +39,8 @@ export const resolveCollection = <M extends Record<string, any>, >
      previousValues,
      userConfigPersistence,
      propertyConfigs,
-     ignoreMissingFields = false
+     ignoreMissingFields = false,
+     authController
  }: {
     collection: EntityCollection<M> | ResolvedEntityCollection<M>;
     path: string,
@@ -49,6 +50,7 @@ export const resolveCollection = <M extends Record<string, any>, >
     userConfigPersistence?: UserConfigurationPersistence;
     propertyConfigs?: Record<string, PropertyConfig>;
     ignoreMissingFields?: boolean;
+    authController: AuthController;
 }): ResolvedEntityCollection<M> => {
 
     const collectionOverride = userConfigPersistence?.getCollectionConfig<M>(path);
@@ -68,7 +70,8 @@ export const resolveCollection = <M extends Record<string, any>, >
                 path,
                 entityId,
                 propertyConfigs: propertyConfigs,
-                ignoreMissingFields
+                ignoreMissingFields,
+                authController
             });
             if (!childResolvedProperty) return {};
             return ({
@@ -113,6 +116,7 @@ export function resolveProperty<T extends CMSType = CMSType, M extends Record<st
     fromBuilder?: boolean;
     propertyConfigs?: Record<string, PropertyConfig<any>>;
     ignoreMissingFields?: boolean;
+    authController: AuthController;
 }): ResolvedProperty<T> | null {
 
     if (typeof propertyOrBuilder === "object" && "resolved" in propertyOrBuilder) {
@@ -218,11 +222,11 @@ export function resolveProperty<T extends CMSType = CMSType, M extends Record<st
 }
 
 export function getArrayResolvedProperties<M>({
-                                           propertyKey,
-                                           propertyValue,
-                                           property,
-                                           ...props
-                                       }: {
+                                                  propertyKey,
+                                                  propertyValue,
+                                                  property,
+                                                  ...props
+                                              }: {
     propertyValue: any,
     propertyKey?: string,
     property: ArrayProperty<any> | ResolvedArrayProperty<any>,
@@ -233,7 +237,8 @@ export function getArrayResolvedProperties<M>({
     entityId?: string;
     index?: number;
     fromBuilder?: boolean;
-    propertyConfigs?: Record<string, PropertyConfig>
+    propertyConfigs?: Record<string, PropertyConfig>;
+    authController: AuthController;
 }) {
 
     const of = property.of;
@@ -265,6 +270,7 @@ export function resolveArrayProperty<T extends any[], M>({
     fromBuilder?: boolean;
     propertyConfigs?: Record<string, PropertyConfig>;
     ignoreMissingFields?: boolean;
+    authController: AuthController;
 }): ResolvedArrayProperty {
     const propertyValue = propertyKey ? getIn(props.values, propertyKey) : undefined;
 
@@ -280,7 +286,7 @@ export function resolveArrayProperty<T extends any[], M>({
                         propertyOrBuilder: p as Property<any>,
                         ignoreMissingFields,
                         ...props,
-                        index
+                        index,
                     });
                 })
             } as ResolvedArrayProperty;
@@ -372,6 +378,7 @@ export function resolveProperties<M extends Record<string, any>>({
     fromBuilder?: boolean;
     propertyConfigs?: Record<string, PropertyConfig>;
     ignoreMissingFields?: boolean;
+    authController: AuthController;
 }): ResolvedProperties<M> {
     return Object.entries<PropertyOrBuilder>(properties as Record<string, PropertyOrBuilder>)
         .map(([key, property]) => {
@@ -430,3 +437,25 @@ export function resolveEntityView(entityView: string | EntityCustomView<any>, co
         return entityView;
     }
 }
+
+export function resolvedSelectedEntityView<M extends Record<string, any>>(
+    customViews: (string | EntityCustomView<M>)[] | undefined,
+    customizationController: CustomizationController,
+    selectedTab?: string,
+    canEdit?: boolean,
+) {
+    const resolvedEntityViews = customViews ? customViews
+            .map(e => resolveEntityView(e, customizationController.entityViews))
+            .filter((e): e is EntityCustomView<M> => Boolean(e))
+            // .filter((e) => canEdit || !e.includeActions)
+        : [];
+
+    const selectedEntityView = resolvedEntityViews.find(e => e.key === selectedTab);
+    const selectedSecondaryForm = customViews
+        && resolvedEntityViews.filter(e => e.includeActions).find(e => e.key === selectedTab);
+    return {
+        resolvedEntityViews,
+        selectedEntityView,
+        selectedSecondaryForm
+    };
+}

package/src/util/useStorageUploadController.tsx

@@ -18,6 +18,7 @@ import { PreviewSize } from "../preview";
 import { randomString } from "./strings";
 import { resolveStorageFilenameString, resolveStoragePathString } from "./storage";
 import { resolveProperty } from "./resolutions";
+import { useAuthController } from "../hooks";
 
 /**
  * Internal representation of an item in the storage
@@ -45,18 +46,19 @@ export function useStorageUploadController<M extends object>({
                                                                  disabled,
                                                                  onChange
                                                              }:
-                                                                 {
-                                                                     entityId: string,
-                                                                     entityValues: EntityValues<M>,
-                                                                     value: string | string[] | null;
-                                                                     path?: string,
-                                                                     propertyKey: string,
-                                                                     property: StringProperty | ArrayProperty<string[]> | ResolvedStringProperty | ResolvedArrayProperty<string[]>,
-                                                                     storageSource: StorageSource,
-                                                                     disabled: boolean,
-                                                                     onChange: (value: string | string[] | null) => void
-                                                                 }) {
-
+                                                             {
+                                                                 entityId: string,
+                                                                 entityValues: EntityValues<M>,
+                                                                 value: string | string[] | null;
+                                                                 path?: string,
+                                                                 propertyKey: string,
+                                                                 property: StringProperty | ArrayProperty<string[]> | ResolvedStringProperty | ResolvedArrayProperty<string[]>,
+                                                                 storageSource: StorageSource,
+                                                                 disabled: boolean,
+                                                                 onChange: (value: string | string[] | null) => void
+                                                             }) {
+
+    const authController = useAuthController();
     const storage: StorageConfig | undefined = property.dataType === "string"
         ? property.storage
         : property.dataType === "array" &&
@@ -69,22 +71,15 @@ export function useStorageUploadController<M extends object>({
     if (!storage)
         throw Error("Storage meta must be specified");
 
+    const processFile = storage?.processFile;
+
     const metadata: Record<string, any> | undefined = storage?.metadata;
     const size = multipleFilesSupported ? "medium" : "large";
 
     const compression: ImageCompression | undefined = storage?.imageCompression;
 
     const internalInitialValue: StorageFieldItem[] =
-        (multipleFilesSupported
-            ? (value ?? []) as string[]
-            : value ? [value as string] : []).map(entry => (
-            {
-                id: getRandomId(),
-                storagePathOrDownloadUrl: entry,
-                metadata,
-                size
-            }
-        ));
+        getInternalInitialValue(multipleFilesSupported, value, metadata, size);
 
     const [initialValue, setInitialValue] = useState<string | string[] | null>(value);
     const [internalValue, setInternalValue] = useState<StorageFieldItem[]>(internalInitialValue);
@@ -98,7 +93,8 @@ export function useStorageUploadController<M extends object>({
 
     const resolvedProperty = resolveProperty({
         propertyOrBuilder: property as PropertyOrBuilder,
-        values: entityValues
+        values: entityValues,
+        authController
     }) as ResolvedStringProperty | ResolvedArrayProperty<string[]>;
 
     const fileNameBuilder = useCallback(async (file: File) => {
@@ -178,7 +174,22 @@ export function useStorageUploadController<M extends object>({
         if (!acceptedFiles.length || disabled)
             return;
 
+        if (processFile) {
+            try {
+                acceptedFiles = await Promise.all(acceptedFiles.map(async file => {
+                    const processedFile = await processFile(file);
+                    if (!processedFile) {
+                        return file;
+                    }
+                    return processedFile;
+                }));
+            } catch (e) {
+                console.error("Error processing file with custom code. Attempting to continue uploading.", e);
+            }
+        }
+
         let newInternalValue: StorageFieldItem[];
+
         if (multipleFilesSupported) {
             newInternalValue = [...internalValue,
                 ...(await Promise.all(acceptedFiles.map(async file => {
@@ -226,6 +237,32 @@ export function useStorageUploadController<M extends object>({
     }
 }
 
+function getInternalInitialValue(multipleFilesSupported: boolean,
+                                 value: string | string[] | null,
+                                 metadata: Record<string, any> | undefined,
+                                 size: PreviewSize): StorageFieldItem[] {
+    let strings: string[] = [];
+    if (multipleFilesSupported) {
+        if (Array.isArray(value) && value.every((v) => typeof v === "string")) {
+            strings = (value ?? []) as string[];
+        }
+    } else {
+        if (typeof value === "string") {
+            strings = value ? [value as string] : [];
+        }
+    }
+
+    return strings
+        .map(entry => (
+            {
+                id: getRandomId(),
+                storagePathOrDownloadUrl: entry,
+                metadata,
+                size
+            }
+        ));
+}
+
 function removeDuplicates(items: StorageFieldItem[]) {
     return items.filter(
         (item, i) => {

package/src/components/common/useDataSourceEntityCollectionTableController.tsx

@@ -1,236 +0,0 @@
-import React, { useCallback, useEffect, useMemo, useState } from "react";
-
-import { useDataSource, useFireCMSContext, useNavigationController } from "../../hooks";
-import { useDataOrder } from "../../hooks/data/useDataOrder";
-import {
-    Entity,
-    EntityCollection,
-    EntityTableController,
-    FilterValues,
-    FireCMSContext,
-    SelectedCellProps,
-    User
-} from "../../types";
-import { useDebouncedData } from "./useDebouncedData";
-import equal from "react-fast-compare"
-
-const DEFAULT_PAGE_SIZE = 50;
-
-export type DataSourceEntityCollectionTableControllerProps<M extends Record<string, any> = any> = {
-    /**
-     * Full path where the data of this table is located
-     */
-    fullPath: string;
-    /**
-     * The collection that is represented by this config.
-     */
-    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>[];
-
-    lastDeleteTimestamp?: number;
-
-    /**
-     * Force filter to be applied to the table.
-     */
-    forceFilter?: FilterValues<string>;
-}
-
-/**
- * Use this hook to build a controller for the {@link EntityCollectionTable}.
- * This controller is bound to data in a path in your specified datasource.
- *
- * Note that you can build your own hook returning a {@link EntityTableController}
- * if you would like to display different data.
- *
- * @param fullPath
- * @param collection
- * @param entitiesDisplayedFirst
- * @param lastDeleteTimestamp
- * @param forceFilterFromProps
- */
-export function useDataSourceEntityCollectionTableController<M extends Record<string, any> = any, USER extends User = User>(
-    {
-        fullPath,
-        collection,
-        entitiesDisplayedFirst,
-        lastDeleteTimestamp,
-        forceFilter: forceFilterFromProps,
-    }: DataSourceEntityCollectionTableControllerProps<M>)
-    : EntityTableController<M> {
-
-    const {
-        initialFilter,
-        initialSort,
-        forceFilter: forceFilterFromCollection
-    } = collection;
-
-    const [popupCell, setPopupCell] = React.useState<SelectedCellProps<M> | undefined>(undefined);
-    const navigation = useNavigationController();
-    const dataSource = useDataSource(collection);
-    const resolvedPath = useMemo(() => navigation.resolveAliasesFrom(fullPath), [fullPath, navigation.resolveAliasesFrom]);
-
-    const forceFilter = forceFilterFromProps ?? forceFilterFromCollection;
-    const paginationEnabled = collection.pagination === undefined || Boolean(collection.pagination);
-    const pageSize = typeof collection.pagination === "number" ? collection.pagination : DEFAULT_PAGE_SIZE;
-
-    const [searchString, setSearchString] = React.useState<string | undefined>();
-    const [itemCount, setItemCount] = React.useState<number | undefined>(paginationEnabled ? pageSize : undefined);
-
-    const checkFilterCombination = useCallback((filterValues: FilterValues<any>,
-                                                sortBy?: [string, "asc" | "desc"]) => {
-        if (!dataSource.isFilterCombinationValid)
-            return true;
-        return dataSource.isFilterCombinationValid({
-            path: resolvedPath,
-            collection,
-            filterValues,
-            sortBy
-        })
-    }, []);
-
-    const initialSortInternal = useMemo(() => {
-        if (initialSort && forceFilter && !checkFilterCombination(forceFilter, initialSort)) {
-            console.warn("Initial sort is not compatible with the force filter. Ignoring initial sort");
-            return undefined;
-        }
-        return initialSort;
-    }, [initialSort, forceFilter]);
-
-    useEffect(() => {
-        if (!equal(forceFilter, filterValues)) {
-            setFilterValues(forceFilter)
-        }
-    }, [forceFilter]);
-
-    const [filterValues, setFilterValues] = React.useState<FilterValues<Extract<keyof M, string>> | undefined>(forceFilter ?? initialFilter ?? undefined);
-    const [sortBy, setSortBy] = React.useState<[Extract<keyof M, string>, "asc" | "desc"] | undefined>(initialSortInternal);
-
-    const sortByProperty = sortBy ? sortBy[0] : undefined;
-    const currentSort = sortBy ? sortBy[1] : undefined;
-
-    const context: FireCMSContext<USER> = useFireCMSContext();
-
-    const [rawData, setRawData] = useState<Entity<M>[]>([]);
-
-    const [dataLoading, setDataLoading] = useState<boolean>(false);
-    const [dataLoadingError, setDataLoadingError] = useState<Error | undefined>();
-    const [noMoreToLoad, setNoMoreToLoad] = useState<boolean>(false);
-
-    const clearFilter = useCallback(() => setFilterValues(forceFilter ?? undefined), [forceFilter]);
-
-    const updateFilterValues = useCallback((updatedFilter: FilterValues<Extract<keyof M, string>> | undefined) => {
-        if (forceFilter) {
-            console.warn("Filter is not compatible with the force filter. Ignoring filter");
-            return;
-        }
-        if (updatedFilter && Object.keys(updatedFilter).length === 0) {
-            setFilterValues(undefined);
-        } else {
-            setFilterValues(updatedFilter);
-        }
-    }, [forceFilter]);
-
-    useEffect(() => {
-
-        setDataLoading(true);
-
-        const onEntitiesUpdate = async (entities: Entity<M>[]) => {
-            if (collection.callbacks?.onFetch) {
-                try {
-                    entities = await Promise.all(
-                        entities.map((entity) =>
-                            collection.callbacks!.onFetch!({
-                                collection,
-                                path: resolvedPath,
-                                entity,
-                                context
-                            })));
-                } catch (e: any) {
-                    console.error(e);
-                }
-            }
-            setDataLoading(false);
-            setDataLoadingError(undefined);
-            setRawData(entities.map(e => ({
-                ...e,
-                // values: sanitizeData(e.values, resolvedCollection.properties)
-            })));
-            setNoMoreToLoad(!itemCount || entities.length < itemCount);
-        };
-
-        const onError = (error: Error) => {
-            console.error("ERROR", error);
-            setDataLoading(false);
-            setRawData([]);
-            setDataLoadingError(error);
-        };
-
-        if (dataSource.listenCollection) {
-            return dataSource.listenCollection<M>({
-                path: resolvedPath,
-                collection,
-                onUpdate: onEntitiesUpdate,
-                onError,
-                searchString,
-                filter: filterValues,
-                limit: itemCount,
-                startAfter: undefined,
-                orderBy: sortByProperty,
-                order: currentSort
-            });
-        } else {
-            dataSource.fetchCollection<M>({
-                path: resolvedPath,
-                collection,
-                searchString,
-                filter: filterValues,
-                limit: itemCount,
-                startAfter: undefined,
-                orderBy: sortByProperty,
-                order: currentSort
-            })
-                .then(onEntitiesUpdate)
-                .catch(onError);
-            return () => {
-            };
-        }
-    }, [resolvedPath, itemCount, currentSort, sortByProperty, filterValues, searchString]);
-
-    const orderedData = useDataOrder({
-        data: rawData,
-        entitiesDisplayedFirst
-    });
-
-    // hack to fix Firestore listeners firing with incomplete data
-    const data = useDebouncedData(orderedData, {
-        filterValues,
-        sortBy,
-        searchString,
-        lastDeleteTimestamp
-    });
-
-    return {
-        data,
-        dataLoading,
-        noMoreToLoad,
-        dataLoadingError,
-        filterValues,
-        setFilterValues: updateFilterValues,
-        sortBy,
-        setSortBy,
-        searchString,
-        setSearchString,
-        clearFilter,
-        itemCount,
-        setItemCount,
-        paginationEnabled,
-        pageSize,
-        checkFilterCombination,
-        popupCell,
-        setPopupCell
-    }
-}