@firecms/collection_editor 3.0.0-alpha.9 → 3.0.0-beta.10

package/src/ui/collection_editor/properties/DateTimePropertyField.tsx

@@ -0,0 +1,89 @@
+import React from "react";
+import { getIn, useFormex } from "@firecms/formex";
+import { FieldCaption, NumberProperty, StringProperty } from "@firecms/core";
+import { Select, SelectItem } from "@firecms/ui";
+import { GeneralPropertyValidation } from "./validation/GeneralPropertyValidation";
+import { ValidationPanel } from "./validation/ValidationPanel";
+
+export function DateTimePropertyField({ disabled }: {
+    disabled: boolean;
+}) {
+
+    const {
+        values,
+        errors,
+        touched,
+        setFieldValue
+    } = useFormex<StringProperty | NumberProperty>();
+
+    const modePath = "mode";
+    const modeValue: string | undefined = getIn(values, modePath);
+    const modeError: string | undefined = getIn(touched, modePath) && getIn(errors, modePath);
+
+    const autoValuePath = "autoValue";
+    const autoValueValue: string | undefined = getIn(values, autoValuePath);
+    const autoValueError: string | undefined = getIn(touched, autoValuePath) && getIn(errors, autoValuePath);
+
+    return (
+        <>
+            <div className={"flex flex-col col-span-12 gap-2"}>
+                <div>
+                    <Select name={modePath}
+                            value={modeValue ?? "date"}
+                            error={Boolean(modeError)}
+                            onValueChange={(v) => setFieldValue(modePath, v)}
+                            label={"Mode"}
+                            renderValue={(v) => {
+                                switch (v) {
+                                    case "date_time":
+                                        return "Date/Time";
+                                    case "date":
+                                        return "Date";
+                                    default:
+                                        return "";
+                                }
+                            }}
+                            disabled={disabled}>
+                        <SelectItem value={"date_time"}> Date/Time </SelectItem>
+                        <SelectItem value={"date"}> Date </SelectItem>
+                    </Select>
+                    <FieldCaption error={Boolean(modeError)}>
+                        {modeError}
+                    </FieldCaption>
+                </div>
+                <div>
+                    <Select name={autoValuePath}
+                            disabled={disabled}
+                            value={autoValueValue ?? ""}
+                            onValueChange={(v) => setFieldValue(autoValuePath, v === "none" ? null : v)}
+                            renderValue={(v) => {
+                                switch (v) {
+                                    case "on_create":
+                                        return "On create";
+                                    case "on_update":
+                                        return "On any update";
+                                    default:
+                                        return "None";
+                                }
+                            }}
+                            error={Boolean(autoValueError)}
+                            label={"Automatic value"}>
+                        <SelectItem value={"none"}> None </SelectItem>
+                        <SelectItem value={"on_create"}> On create </SelectItem>
+                        <SelectItem value={"on_update"}> On any update </SelectItem>
+                    </Select>
+                    <FieldCaption error={Boolean(autoValueError)}>
+                        {autoValueError ?? "Update this field automatically when creating or updating the entity"}
+                    </FieldCaption>
+                </div>
+
+            </div>
+
+            <div className={"col-span-12"}>
+                <ValidationPanel>
+                    <GeneralPropertyValidation disabled={disabled}/>
+                </ValidationPanel>
+            </div>
+        </>
+    );
+}

package/src/ui/collection_editor/properties/EnumPropertyField.tsx

@@ -0,0 +1,114 @@
+import React, { useMemo } from "react";
+import { getIn, useFormex } from "@firecms/formex";
+import { EnumValueConfig, resolveEnumValues, useSnackbarController } from "@firecms/core";
+import { Select, SelectItem } from "@firecms/ui";
+import { EnumForm } from "../EnumForm";
+import { StringPropertyValidation } from "./validation/StringPropertyValidation";
+import { ArrayPropertyValidation } from "./validation/ArrayPropertyValidation";
+import { ValidationPanel } from "./validation/ValidationPanel";
+import { PropertyWithId } from "../PropertyEditView";
+
+export function EnumPropertyField({
+                                      multiselect,
+                                      updateIds,
+                                      disabled,
+                                      showErrors,
+                                      allowDataInference,
+                                      getData
+                                  }: {
+    multiselect: boolean;
+    updateIds: boolean;
+    disabled: boolean;
+    showErrors: boolean;
+    allowDataInference?: boolean;
+    getData?: () => Promise<object[]>;
+}) {
+
+    const {
+        values,
+        setFieldError,
+        setFieldValue
+    } = useFormex<PropertyWithId>();
+
+    const snackbarContext = useSnackbarController();
+
+    const enumValuesPath = multiselect ? "of.enumValues" : "enumValues";
+
+    const defaultValue = getIn(values, "defaultValue");
+
+    const valuesEnumValues = getIn(values, enumValuesPath);
+    const enumValues: EnumValueConfig[] = useMemo(() => {
+        if (!valuesEnumValues || typeof valuesEnumValues === "boolean")
+            return [] as EnumValueConfig[];
+        return resolveEnumValues(valuesEnumValues) ?? [] as EnumValueConfig[];
+    }, [valuesEnumValues]);
+
+    const onValuesChanged = (value: EnumValueConfig[]) => {
+        if (!values)
+            return;
+        setFieldValue(enumValuesPath, value);
+        if (!multiselect) {
+            const enumIds = value.filter(v => Boolean(v?.id)).map((v: any) => v.id);
+            if (defaultValue && !enumIds.includes(defaultValue)) {
+                setFieldValue("defaultValue", undefined);
+                snackbarContext.open({
+                    type: "warning",
+                    message: "Default value was cleared"
+                })
+            }
+        }
+    };
+
+    return (
+        <>
+            <div className={"col-span-12"}>
+                <EnumForm enumValues={enumValues}
+                          updateIds={updateIds}
+                          disabled={disabled}
+                          allowDataInference={allowDataInference}
+                          onError={(hasError) => {
+                              setFieldError(enumValuesPath, hasError ? "This enum property is missing some values" : undefined);
+                          }}
+                          getData={getData
+                              ? () => getData()
+                                  .then(res => res.map(entry => values.id && getIn(entry, values.id)).filter(Boolean))
+                              : undefined}
+                          onValuesChanged={onValuesChanged}/>
+            </div>
+
+            <div className={"col-span-12"}>
+
+                <ValidationPanel>
+                    {!multiselect &&
+                        <StringPropertyValidation disabled={disabled}
+                                                  showErrors={showErrors}/>}
+                    {multiselect &&
+                        <ArrayPropertyValidation disabled={disabled}/>}
+                </ValidationPanel>
+
+            </div>
+
+            {!multiselect && <div className={"col-span-12"}>
+
+                <Select
+                    disabled={disabled}
+                    position={"item-aligned"}
+                    onValueChange={(value: string) => {
+                        setFieldValue("defaultValue", value);
+                    }}
+                    label={"Default value"}
+                    value={defaultValue ?? ""}>
+                    {enumValues
+                        .filter((enumValue) => Boolean(enumValue?.id))
+                        .map((enumValue) => (
+                            <SelectItem key={enumValue.id}
+                                        value={enumValue.id?.toString()}>
+                                {enumValue.label}
+                            </SelectItem>
+                        ))}
+                </Select>
+
+            </div>}
+        </>
+    );
+}

package/src/ui/collection_editor/properties/KeyValuePropertyField.tsx

@@ -0,0 +1,20 @@
+import React from "react";
+import { ValidationPanel } from "./validation/ValidationPanel";
+import { GeneralPropertyValidation } from "./validation/GeneralPropertyValidation";
+
+export function KeyValuePropertyField({ disabled }: {
+    disabled: boolean;
+}) {
+
+    return (
+        <>
+            <div className={"col-span-12"}>
+
+                <ValidationPanel>
+                    <GeneralPropertyValidation disabled={disabled}/>
+                </ValidationPanel>
+
+            </div>
+        </>
+    );
+}

package/src/ui/collection_editor/properties/MapPropertyField.tsx

@@ -0,0 +1,150 @@
+import React, { useState } from "react";
+import { FieldCaption, MapProperty, Property, PropertyConfig, } from "@firecms/core";
+import { AddIcon, BooleanSwitchWithLabel, Button, Paper, Typography } from "@firecms/ui";
+import { PropertyFormDialog } from "../PropertyEditView";
+import { getIn, useFormex } from "@firecms/formex";
+import { PropertyTree } from "../PropertyTree";
+import { getFullId, idToPropertiesPath, namespaceToPropertiesOrderPath, namespaceToPropertiesPath } from "../util";
+
+export function MapPropertyField({ disabled, getData, allowDataInference, propertyConfigs, collectionEditable }: {
+    disabled: boolean;
+    getData?: () => Promise<object[]>;
+    allowDataInference: boolean;
+    propertyConfigs: Record<string, PropertyConfig>,
+    collectionEditable: boolean;
+}) {
+
+    const {
+        values,
+        setFieldValue
+    } = useFormex<MapProperty>();
+
+    const [propertyDialogOpen, setPropertyDialogOpen] = useState<boolean>(false);
+    const [selectedPropertyKey, setSelectedPropertyKey] = useState<string | undefined>();
+    const [selectedPropertyNamespace, setSelectedPropertyNamespace] = useState<string | undefined>();
+
+    const propertiesOrder = values.propertiesOrder ?? Object.keys(values.properties ?? {});
+    const onPropertyCreated = ({
+                                   id,
+                                   property
+                               }: { id?: string, property: Property }) => {
+        if (!id)
+            throw Error();
+        setFieldValue("properties", {
+            ...(values.properties ?? {}),
+            [id]: property
+        }, false);
+
+        const currentPropertiesOrder = values.propertiesOrder ?? Object.keys(values.properties ?? {});
+        const newPropertiesOrder = currentPropertiesOrder.includes(id) ? currentPropertiesOrder : [...currentPropertiesOrder, id];
+        setFieldValue("propertiesOrder", newPropertiesOrder, false);
+
+        setPropertyDialogOpen(false);
+    };
+
+    const deleteProperty = (propertyKey?: string, namespace?: string) => {
+        const fullId = propertyKey ? getFullId(propertyKey, namespace) : undefined;
+        if (!fullId)
+            throw Error("collection editor miss config");
+
+        const propertiesPath = idToPropertiesPath(fullId);
+        const propertiesOrderPath = namespaceToPropertiesOrderPath(namespace);
+
+        const currentPropertiesOrder: string[] = getIn(values, propertiesOrderPath) ?? Object.keys(getIn(values, namespaceToPropertiesPath(namespace)));
+
+        setFieldValue(propertiesPath, undefined, false);
+        setFieldValue(propertiesOrderPath, currentPropertiesOrder.filter((p) => p !== propertyKey), false);
+
+        setPropertyDialogOpen(false);
+        setSelectedPropertyKey(undefined);
+        setSelectedPropertyNamespace(undefined);
+    };
+
+    const selectedPropertyFullId = selectedPropertyKey ? getFullId(selectedPropertyKey, selectedPropertyNamespace) : undefined;
+    const selectedProperty = selectedPropertyFullId ? getIn(values.properties, selectedPropertyFullId.replaceAll(".", ".properties.")) : undefined;
+
+    const empty = !propertiesOrder || propertiesOrder.length < 1;
+
+    const onPropertyMove = (propertiesOrder: string[], namespace?: string) => {
+        setFieldValue(namespaceToPropertiesOrderPath(namespace), propertiesOrder, false);
+    };
+
+    return (
+        <>
+            <div className={"col-span-12"}>
+                <div className="flex justify-between items-end my-4">
+                    <Typography variant={"subtitle2"}>Properties in this group</Typography>
+                    <Button
+                        color="primary"
+                        variant={"outlined"}
+                        onClick={() => setPropertyDialogOpen(true)}
+                        startIcon={<AddIcon/>}
+                    >
+                        Add property to {values.name ?? "this group"}
+                    </Button>
+                </div>
+                <Paper className="p-2 pl-8">
+                    <PropertyTree
+                        properties={values.properties ?? {}}
+                        propertiesOrder={propertiesOrder}
+                        errors={{}}
+                        collectionEditable={collectionEditable}
+                        onPropertyClick={(propertyKey, namespace) => {
+                            setSelectedPropertyKey(propertyKey);
+                            setSelectedPropertyNamespace(namespace);
+                            setPropertyDialogOpen(true);
+                        }}
+                        onPropertyMove={onPropertyMove}/>
+
+                    {empty &&
+                        <Typography variant={"label"}
+                                    className="h-full flex items-center justify-center p-4">
+                            Add the first property to this group
+                        </Typography>}
+                </Paper>
+            </div>
+
+            <div className={"col-span-12"}>
+                <BooleanSwitchWithLabel
+                    position={"start"}
+                    size={"small"}
+                    label="Spread children as columns"
+                    onValueChange={(v) => setFieldValue("spreadChildren", v)}
+                    value={values.spreadChildren ?? false}
+                />
+                <FieldCaption>
+                    Set this flag to true if you want to display the children of this group as individual columns.
+                </FieldCaption>
+            </div>
+
+            <PropertyFormDialog
+                inArray={false}
+                forceShowErrors={false}
+                open={propertyDialogOpen}
+                allowDataInference={allowDataInference}
+                collectionEditable={collectionEditable}
+                onCancel={() => {
+                    setPropertyDialogOpen(false);
+                    setSelectedPropertyKey(undefined);
+                    setSelectedPropertyNamespace(undefined);
+                }}
+                onOkClicked={() => {
+                    setPropertyDialogOpen(false);
+                    setSelectedPropertyKey(undefined);
+                    setSelectedPropertyNamespace(undefined);
+                }}
+                getData={getData}
+                onDelete={deleteProperty}
+                propertyKey={selectedPropertyKey}
+                propertyNamespace={selectedPropertyNamespace}
+                property={selectedProperty}
+                existingProperty={Boolean(selectedPropertyKey)}
+                autoUpdateId={!selectedPropertyKey}
+                autoOpenTypeSelect={!selectedPropertyKey}
+                onPropertyChanged={onPropertyCreated}
+                existingPropertyKeys={selectedPropertyKey ? undefined : propertiesOrder}
+                propertyConfigs={propertyConfigs}
+            />
+
+        </>);
+}

package/src/ui/collection_editor/properties/MarkdownPropertyField.tsx

@@ -0,0 +1,139 @@
+import React from "react";
+import { StringPropertyValidation } from "./validation/StringPropertyValidation";
+import { ValidationPanel } from "./validation/ValidationPanel";
+import { Field, getIn, useFormex } from "@firecms/formex";
+
+import { DebouncedTextField, ExpandablePanel, FileUploadIcon, TextField, Typography } from "@firecms/ui";
+
+export function MarkdownPropertyField({
+                                          disabled,
+                                          showErrors
+                                      }: {
+    disabled: boolean;
+    showErrors: boolean;
+}) {
+
+    const {
+        values,
+        setFieldValue
+    } = useFormex();
+
+    const baseStoragePath = "storage";
+
+    const metadata = `${baseStoragePath}.metadata`;
+    const fileName = `${baseStoragePath}.fileName`;
+    const maxSize = `${baseStoragePath}.maxSize`;
+    const storagePath = `${baseStoragePath}.storagePath`;
+
+    const fileNameValue = getIn(values, fileName) ?? "{rand}_{file}";
+    const storagePathValue = getIn(values, storagePath) ?? "/";
+    const maxSizeValue = getIn(values, maxSize);
+
+    const hasFilenameCallback = typeof fileNameValue === "function";
+    const hasStoragePathCallback = typeof storagePathValue === "function";
+
+    return (
+        <>
+            <div className={"col-span-12"}>
+
+                <ValidationPanel>
+
+                    <StringPropertyValidation disabled={disabled}
+                                              length={true}
+                                              lowercase={true}
+                                              max={true}
+                                              min={true}
+                                              trim={true}
+                                              uppercase={true}
+                                              showErrors={showErrors}/>
+
+                </ValidationPanel>
+
+            </div>
+
+            <div className={"col-span-12"}>
+                <ExpandablePanel
+                    title={
+                        <div className="flex flex-row text-gray-500">
+                            <FileUploadIcon/>
+                            <Typography variant={"subtitle2"}
+                                        className="ml-2">
+                                File upload config
+                            </Typography>
+                        </div>
+                    }>
+
+                    <div className={"grid grid-cols-12 gap-2 p-4"}>
+
+
+                        <div className={"col-span-12"}>
+                            <Field name={fileName}
+                                   as={DebouncedTextField}
+                                   label={"File name"}
+                                   size={"small"}
+                                   disabled={hasFilenameCallback || disabled}
+                                   value={hasFilenameCallback ? "-" : fileNameValue}
+                            />
+                        </div>
+                        <div className={"col-span-12"}>
+                            <Field name={storagePath}
+                                   as={DebouncedTextField}
+                                   label={"Storage path"}
+                                   disabled={hasStoragePathCallback || disabled}
+                                   size={"small"}
+                                   value={hasStoragePathCallback ? "-" : storagePathValue}
+                            />
+                            <Typography variant={"caption"} className={"ml-3.5 mt-1 mb-2"}>
+                                <p>You can use the following placeholders in
+                                    the file name
+                                    and storage path values:</p>
+                                <ul>
+                                    <li>{"{file} - Full name of the uploaded file"}</li>
+                                    <li>{"{file.name} - Name of the uploaded file without extension"}</li>
+                                    <li>{"{file.ext} - Extension of the uploaded file"}</li>
+                                    <li>{"{entityId} - ID of the entity"}</li>
+                                    <li>{"{propertyKey} - ID of this field"}</li>
+                                    <li>{"{path} - Path of this entity"}</li>
+                                    <li>{"{rand} - Random value used to avoid name collisions"}</li>
+                                </ul>
+                            </Typography>
+
+                            <Typography variant={"caption"} className={"ml-3.5 mt-1 mb-2"}>
+                                When using Markdown, the URL of the uploaded files are always saved in the text value
+                                (not
+                                the path).
+                            </Typography>
+                        </div>
+
+                        <div className={"col-span-12"}>
+                            <DebouncedTextField name={maxSize}
+                                                type={"number"}
+                                                label={"Max size (in bytes)"}
+                                                size={"small"}
+                                                value={maxSizeValue !== undefined && maxSizeValue !== null ? maxSizeValue.toString() : ""}
+                                                onChange={(e) => {
+                                                    const value = e.target.value;
+                                                    if (value === "") setFieldValue(maxSize, undefined);
+                                                    else setFieldValue(maxSize, parseInt(value));
+                                                }}
+                            />
+                        </div>
+
+                    </div>
+                </ExpandablePanel>
+            </div>
+
+            <div className={"col-span-12"}>
+
+                <TextField name={"defaultValue"}
+                           disabled={disabled}
+                           onChange={(e: any) => {
+                               setFieldValue("defaultValue", e.target.value === "" ? undefined : e.target.value);
+                           }}
+                           label={"Default value"}
+                           value={getIn(values, "defaultValue") ?? ""}/>
+
+            </div>
+        </>
+    );
+}

package/src/ui/collection_editor/properties/NumberPropertyField.tsx

@@ -0,0 +1,38 @@
+import React from "react";
+import { NumberPropertyValidation } from "./validation/NumberPropertyValidation";
+import { ValidationPanel } from "./validation/ValidationPanel";
+import { TextField } from "@firecms/ui";
+import { getIn, useFormex } from "@firecms/formex";
+
+export function NumberPropertyField({ disabled }: {
+    disabled: boolean;
+}) {
+
+    const { values, setFieldValue } = useFormex();
+
+    return (
+        <>
+
+            <div className={"col-span-12"}>
+
+                <ValidationPanel>
+                    <NumberPropertyValidation disabled={disabled}/>
+                </ValidationPanel>
+
+            </div>
+
+            <div className={"col-span-12"}>
+
+                <TextField name={"defaultValue"}
+                           disabled={disabled}
+                           type={"number"}
+                           onChange={(e: any) => {
+                               setFieldValue("defaultValue", e.target.value === "" ? undefined : parseFloat(e.target.value));
+                           }}
+                           label={"Default value"}
+                           value={getIn(values, "defaultValue") ?? ""}/>
+
+            </div>
+        </>
+    );
+}