@firecms/collection_editor 3.0.1 → 3.1.0-canary.7d91b7c

package/src/ui/collection_editor/GeneralSettingsForm.tsx

@@ -0,0 +1,337 @@
+import React, { useState } from "react";
+import {
+    EntityCollection,
+    FieldCaption,
+    IconForView,
+    SearchIconsView,
+    singular,
+    toSnakeCase,
+    useAuthController,
+    useCustomizationController
+} from "@firecms/core";
+import {
+    BooleanSwitchWithLabel,
+    Chip,
+    cls,
+    Container,
+    DebouncedTextField,
+    Dialog,
+    ExpandablePanel,
+    HistoryIcon,
+    IconButton,
+    SearchIcon,
+    Select,
+    SelectItem,
+    TextField,
+    Tooltip,
+    Typography
+} from "@firecms/ui";
+
+import { Field, getIn, useFormex } from "@firecms/formex";
+
+export function GeneralSettingsForm({
+    isNewCollection,
+    existingPaths,
+    existingIds,
+    parentCollection
+}: {
+    isNewCollection: boolean;
+    existingPaths?: string[];
+    existingIds?: string[];
+    parentCollection?: EntityCollection;
+}) {
+
+    const {
+        values,
+        setFieldValue,
+        handleChange,
+        touched,
+        errors,
+        setFieldTouched,
+        submitCount
+    } = useFormex<EntityCollection>();
+
+    const [iconDialogOpen, setIconDialogOpen] = useState(false);
+
+    const authController = useAuthController();
+    const customizationController = useCustomizationController();
+
+    const updateDatabaseId = (databaseId: string) => {
+        setFieldValue("databaseId", databaseId ?? undefined);
+    }
+
+    const updateName = (name: string) => {
+        setFieldValue("name", name);
+
+        const pathTouched = getIn(touched, "path");
+        if (!pathTouched && isNewCollection && name) {
+            setFieldValue("path", toSnakeCase(name));
+        }
+
+        const idTouched = getIn(touched, "id");
+        if (!idTouched && isNewCollection && name) {
+            setFieldValue("id", toSnakeCase(name));
+        }
+
+        const singularNameTouched = getIn(touched, "singularName");
+        if (!singularNameTouched && isNewCollection && name) {
+            setFieldValue("singularName", singular(name));
+        }
+    };
+
+    const collectionIcon = <IconForView collectionOrView={values} />;
+    const isSubcollection = !!parentCollection;
+    const showErrors = submitCount > 0;
+
+    return (
+        <div className={"overflow-auto my-auto"}>
+            <Container maxWidth={"4xl"} className={"flex flex-col gap-4 p-8 m-auto"}>
+
+                <div>
+                    <div className="flex flex-row gap-2 py-2 pt-3 items-center">
+                        <Typography variant={!isNewCollection ? "h5" : "h4"} className={"flex-grow"}>
+                            {isNewCollection ? "New collection" : `${values?.name} collection`}
+                        </Typography>
+                        <DefaultDatabaseField databaseId={values.databaseId}
+                            onDatabaseIdUpdate={updateDatabaseId} />
+
+                        <Tooltip title={"Change icon"}
+                            asChild={true}>
+                            <IconButton
+                                shape={"square"}
+                                onClick={() => setIconDialogOpen(true)}>
+                                {collectionIcon}
+                            </IconButton>
+                        </Tooltip>
+                    </div>
+
+                    {parentCollection && <Chip colorScheme={"tealDarker"}>
+                        <Typography variant={"caption"}>
+                            This is a subcollection of <b>{parentCollection.name}</b>
+                        </Typography>
+                    </Chip>}
+
+                </div>
+
+                <div className={"grid grid-cols-12 gap-4"}>
+
+                    {/* Name */}
+                    <div className={"col-span-12"}>
+                        <TextField
+                            value={values.name ?? ""}
+                            onChange={(e: any) => updateName(e.target.value)}
+                            label={"Name"}
+                            autoFocus={true}
+                            required
+                            error={showErrors && Boolean(errors.name)} />
+                        <FieldCaption error={touched.name && Boolean(errors.name)}>
+                            {touched.name && Boolean(errors.name) ? errors.name : "Name of this collection, usually a plural name (e.g. Products)"}
+                        </FieldCaption>
+                    </div>
+
+                    {/* Path */}
+                    <div className={cls("col-span-12")}>
+                        <Field name={"path"}
+                            as={DebouncedTextField}
+                            label={"Path"}
+                            required
+                            error={showErrors && Boolean(errors.path)} />
+
+                        <FieldCaption error={touched.path && Boolean(errors.path)}>
+                            {touched.path && Boolean(errors.path)
+                                ? errors.path
+                                : isSubcollection ? "Relative path to the parent (no need to include the parent path)" : "Path that this collection is stored in, in the database"}
+                        </FieldCaption>
+                    </div>
+
+                    {/* Singular Name */}
+                    <div className={"col-span-12"}>
+                        <TextField
+                            error={showErrors && Boolean(errors.singularName)}
+                            name={"singularName"}
+                            aria-describedby={"singularName-helper"}
+                            onChange={(e) => {
+                                setFieldTouched("singularName", true);
+                                return handleChange(e);
+                            }}
+                            value={values.singularName ?? ""}
+                            label={"Singular name"} />
+                        <FieldCaption error={showErrors && Boolean(errors.singularName)}>
+                            {showErrors && Boolean(errors.singularName) ? errors.singularName : "Optionally define a singular name for your entities"}
+                        </FieldCaption>
+                    </div>
+
+                    {/* Description */}
+                    <div className={"col-span-12"}>
+                        <TextField
+                            error={showErrors && Boolean(errors.description)}
+                            name="description"
+                            value={values.description ?? ""}
+                            onChange={handleChange}
+                            multiline
+                            minRows={2}
+                            aria-describedby="description-helper-text"
+                            label="Description"
+                        />
+                        <FieldCaption error={showErrors && Boolean(errors.description)}>
+                            {showErrors && Boolean(errors.description) ? errors.description : "Description of the collection, you can use markdown"}
+                        </FieldCaption>
+                    </div>
+
+                    {/* Collection ID */}
+                    <div className={"col-span-12"}>
+                        <Field name={"id"}
+                            as={DebouncedTextField}
+                            disabled={!isNewCollection}
+                            label={"Collection ID"}
+                            error={showErrors && Boolean(errors.id)} />
+                        <FieldCaption error={touched.id && Boolean(errors.id)}>
+                            {touched.id && Boolean(errors.id) ? errors.id : "This ID identifies this collection. Typically the same as the path."}
+                        </FieldCaption>
+                    </div>
+
+                    {/* Collection Group */}
+                    <div className={"col-span-12"}>
+                        <BooleanSwitchWithLabel
+                            position={"start"}
+                            size={"large"}
+                            label="Collection group"
+                            onValueChange={(v) => setFieldValue("collectionGroup", v)}
+                            value={values.collectionGroup ?? false}
+                        />
+                        <FieldCaption>
+                            A collection group consists of all collections with the same path. This allows
+                            you to query over multiple collections at once.
+                        </FieldCaption>
+                    </div>
+
+                </div>
+
+                {/* Advanced Settings */}
+                <ExpandablePanel
+                    title={<Typography variant="subtitle2">Advanced settings</Typography>}
+                    initiallyExpanded={false}
+                    className="mt-4"
+                    innerClassName="p-4 flex flex-col gap-4"
+                >
+                    {/* History revisions */}
+                    <div>
+                        <BooleanSwitchWithLabel
+                            position={"start"}
+                            size={"large"}
+                            allowIndeterminate={true}
+                            label={<span className="flex items-center gap-2"><HistoryIcon size={"smallest"} />{values.history === null || values.history === undefined ? "Document history revisions enabled if enabled globally" : (
+                                values.history ? "Document history revisions ENABLED" : "Document history revisions NOT enabled"
+                            )}</span>}
+                            onValueChange={(v) => setFieldValue("history", v)}
+                            value={values.history === undefined ? null : values.history}
+                        />
+                        <FieldCaption>
+                            When enabled, each document in this collection will have a history of changes.
+                            This is useful for auditing purposes. The data is stored in a subcollection of the document
+                            in your database, called <b>__history</b>.
+                        </FieldCaption>
+                    </div>
+
+                    {/* Document ID generation */}
+                    <div>
+                        <Select
+                            name="customId"
+                            label="Document IDs generation"
+                            position={"item-aligned"}
+                            size={"large"}
+                            fullWidth={true}
+                            disabled={typeof values.customId === "object"}
+                            onValueChange={(v) => {
+                                if (v === "code_defined")
+                                    throw new Error("This should not happen");
+                                if (v === "false") setFieldValue("customId", false);
+                                else if (v === "true") setFieldValue("customId", true);
+                                else if (v === "optional") setFieldValue("customId", "optional");
+                            }}
+                            value={
+                                typeof values.customId === "object" ? "code_defined" :
+                                    values.customId === true ? "true" :
+                                        values.customId === "optional" ? "optional" : "false"
+                            }
+                            renderValue={(value: any) => {
+                                if (value === "code_defined")
+                                    return "Code defined";
+                                else if (value === "true")
+                                    return "Users must define an ID";
+                                else if (value === "optional")
+                                    return "Users can define an ID, but it is not required";
+                                else
+                                    return "Document ID is generated automatically";
+                            }}
+                        >
+                            <SelectItem value={"false"}>
+                                Document ID is generated automatically
+                            </SelectItem>
+                            <SelectItem value={"true"}>
+                                Users must define an ID
+                            </SelectItem>
+                            <SelectItem value={"optional"}>
+                                Users can define an ID, but it is not required
+                            </SelectItem>
+                        </Select>
+                        <FieldCaption>
+                            Configure how document IDs are generated when creating new entities.
+                        </FieldCaption>
+                    </div>
+
+                    {/* Text search */}
+                    <div>
+                        <BooleanSwitchWithLabel
+                            position={"start"}
+                            size={"large"}
+                            label={<span className="flex items-center gap-2"><SearchIcon size={"smallest"} />Enable text search for this collection</span>}
+                            onValueChange={(v) => setFieldValue("textSearchEnabled", v)}
+                            value={values.textSearchEnabled ?? false}
+                        />
+                        <FieldCaption>
+                            Allow text search for this collection. If you have not specified a text search
+                            delegate, this will use the built-in local text search. This is not recommended
+                            for large collections, as it may incur in performance and cost issues.
+                        </FieldCaption>
+                    </div>
+                </ExpandablePanel>
+
+                <div style={{ height: "52px" }} />
+
+                <Dialog
+                    open={iconDialogOpen}
+                    onOpenChange={setIconDialogOpen}
+                    maxWidth={"xl"}
+                    fullWidth
+                >
+                    <div className={"p-4 overflow-auto min-h-[200px]"}>
+                        <SearchIconsView selectedIcon={typeof values.icon === "string" ? values.icon : undefined}
+                            onIconSelected={(icon: string) => {
+                                setIconDialogOpen(false);
+                                setFieldValue("icon", icon);
+                            }} />
+                    </div>
+                </Dialog>
+
+            </Container>
+        </div>
+    );
+}
+
+function DefaultDatabaseField({
+    databaseId,
+    onDatabaseIdUpdate
+}: { databaseId?: string, onDatabaseIdUpdate: (databaseId: string) => void }) {
+
+    return <Tooltip title={"Database ID"}
+        side={"top"}
+        align={"start"}>
+        <TextField size={"small"}
+            invisible={true}
+            inputClassName={"text-end"}
+            value={databaseId ?? ""}
+            onChange={(e: any) => onDatabaseIdUpdate(e.target.value)}
+            placeholder={"(default)"}></TextField>
+    </Tooltip>
+}

package/src/ui/collection_editor/GetCodeDialog.tsx

@@ -1,56 +1,76 @@
 import { EntityCollection, isEmptyObject, useSnackbarController } from "@firecms/core";
-import { Button, ContentCopyIcon, Dialog, DialogActions, DialogContent, DialogTitle, Typography } from "@firecms/ui";
-import React from "react";
+import { Button, ContentCopyIcon, Dialog, DialogActions, DialogContent, DialogTitle, Tab, Tabs, Typography } from "@firecms/ui";
+import React, { useState } from "react";
 import JSON5 from "json5";
 import { Highlight, themes } from "prism-react-renderer"
 import { camelCase } from "./utils/strings";
 import { clone } from "@firecms/formex";
 
 export function GetCodeDialog({
-                                  collection,
-                                  onOpenChange,
-                                  open
-                              }: { onOpenChange: (open: boolean) => void, collection: any, open: any }) {
+    collection,
+    onOpenChange,
+    open
+}: { onOpenChange: (open: boolean) => void, collection: any, open: any }) {
 
     const snackbarController = useSnackbarController();
+    const [format, setFormat] = useState<"ts" | "json">("json");
 
-    const code = collection
-        ? "import { EntityCollection } from \"@firecms/core\";\n\nconst " + (collection?.name ? camelCase(collection.name) : "my") + "Collection:EntityCollection = " + JSON5.stringify(collectionToCode({ ...collection }), null, "\t")
+    const collectionData = collectionToCode({ ...collection });
+
+    const tsCode = collection
+        ? "import { EntityCollection } from \"@firecms/core\";\n\nconst " + (collection?.name ? camelCase(collection.name) : "my") + "Collection:EntityCollection = " + JSON5.stringify(collectionData, null, "\t")
+        : "No collection selected";
+
+    const jsonCode = collection
+        ? JSON.stringify(collectionData, null, 2)
         : "No collection selected";
+
+    const code = format === "ts" ? tsCode : jsonCode;
+
     return <Dialog open={open}
-                   onOpenChange={onOpenChange}
-                   maxWidth={"4xl"}>
-        <DialogTitle variant={"h6"}>Code for {collection.name}</DialogTitle>
+        onOpenChange={onOpenChange}
+        maxWidth={"4xl"}>
+        <div className="flex items-center justify-between pr-6">
+            <DialogTitle variant={"h6"}>Code for {collection.name}</DialogTitle>
+            <Tabs value={format} onValueChange={(v) => setFormat(v as "ts" | "json")}>
+                <Tab value="ts">TypeScript</Tab>
+                <Tab value="json">JSON</Tab>
+            </Tabs>
+        </div>
         <DialogContent>
 
-            <Typography variant={"body2"} className={"my-4 mb-8"}>
-                If you want to customise the collection in code, you can add this collection code to your CMS
-                app configuration.
-                More info in the <a
-                rel="noopener noreferrer"
-                href={"https://firecms.co/docs/cloud/quickstart"}>docs</a>.
+            <Typography variant={"body2"} className={"mb-4"}>
+                {format === "json"
+                    ? "Use this config to define the collection in JSON format."
+                    : <>
+                        If you want to customise the collection in code, you can add this collection code to your CMS
+                        app configuration.
+                        More info in the <a
+                            rel="noopener noreferrer"
+                            href={"https://firecms.co/docs/cloud/quickstart"}>docs</a>.
+                    </>}
             </Typography>
             <Highlight
                 theme={themes.vsDark}
                 code={code}
-                language="typescript"
+                language={format === "ts" ? "typescript" : "json"}
             >
                 {({
-                      className,
-                      style,
-                      tokens,
-                      getLineProps,
-                      getTokenProps
-                  }) => (
+                    className,
+                    style,
+                    tokens,
+                    getLineProps,
+                    getTokenProps
+                }) => (
                     <pre style={style} className={"p-4 rounded text-sm"}>
-        {tokens.map((line, i) => (
-            <div key={i} {...getLineProps({ line })}>
-                {line.map((token, key) => (
-                    <span key={key} {...getTokenProps({ token })} />
-                ))}
-            </div>
-        ))}
-      </pre>
+                        {tokens.map((line, i) => (
+                            <div key={i} {...getLineProps({ line })}>
+                                {line.map((token, key) => (
+                                    <span key={key} {...getTokenProps({ token })} />
+                                ))}
+                            </div>
+                        ))}
+                    </pre>
                 )}
             </Highlight>
 
@@ -59,7 +79,6 @@ export function GetCodeDialog({
             <Button
                 variant={"text"}
                 size={"small"}
-                color={"primary"}
                 onClick={(e) => {
                     e.stopPropagation();
                     e.preventDefault();
@@ -69,7 +88,7 @@ export function GetCodeDialog({
                     })
                     return navigator.clipboard.writeText(code);
                 }}>
-                <ContentCopyIcon size={"small"}/>
+                <ContentCopyIcon size={"small"} />
                 Copy to clipboard
             </Button>
             <Button onClick={() => onOpenChange(false)}>Close</Button>
@@ -134,8 +153,10 @@ function collectionToCode(collection: EntityCollection): object {
             .map(([key, value]) => ({
                 [key]: propertyCleanup(value)
             }))
-            .reduce((a, b) => ({ ...a,
-...b }), {}),
+            .reduce((a, b) => ({
+                ...a,
+                ...b
+            }), {}),
         subcollections: (collection.subcollections ?? []).map(collectionToCode)
     }