@firecms/collection_editor 3.0.0-beta.2-pre.2 → 3.0.0-beta.2-pre.3

package/src/form/README.md

@@ -0,0 +1,165 @@
+# Formex - React Form Library
+
+Formex is a lightweight, flexible library designed to simplify form handling within React applications. By leveraging React's powerful context and hooks features, Formex allows for efficient form state management with minimal boilerplate code.
+
+## Features
+
+- Lightweight and easy to integrate
+- Supports custom field components
+- Built-in validation handling
+- Provides both field-level and form-level state management
+
+## Installation
+
+To install Formex, you can use either npm or yarn:
+
+```sh
+npm install your-formex-package-name
+
+# or if you're using yarn
+
+yarn add your-formex-package-name
+```
+
+## Quick Start
+
+To get started with Formex, you first need to create your form context and form controller using the `useCreateFormex` hook. Then, you can structure your form using the `<Field />` components provided by Formex.
+
+### Step 1: Create your form controller
+
+```jsx
+import React from 'react';
+import { useCreateFormex } from 'formex-library';
+
+const MyForm = () => {
+  const formController = useCreateFormex({
+    initialValues: {
+      name: '',
+      email: '',
+    },
+    // Optionally add a validation function
+    // validation: values => {
+    //   const errors = {};
+    //   if (!values.name) errors.name = 'Name is required';
+    //   return errors;
+    // },
+    onSubmit: (values) => {
+      console.log('Form Submitted:', values);
+    },
+  });
+
+  return (
+    <form onSubmit={formController.submitForm}>
+      {/* Field components go here */}
+    </form>
+  );
+};
+```
+
+### Step 2: Use the `<Field />` component
+
+```jsx
+import { Field } from 'formex-library';
+
+// Inside your form component
+<Field name="name">
+  {({ field }) => (
+    <input
+      {...field}
+      placeholder="Your name"
+    />
+  )}
+</Field>
+
+<Field name="email">
+  {({ field }) => (
+    <input
+      {...field}
+      type="email"
+      placeholder="Your email"
+    />
+  )}
+</Field>
+
+<button type="submit">Submit</button>
+```
+
+### Handling Submissions
+
+Wrap your form inputs and submit button within a form element and pass the `submitForm` method from your form controller to the form's `onSubmit` event:
+
+```jsx
+<form onSubmit={formController.submitForm}>
+  {/* Fields and submit button */}
+</form>
+```
+
+## API Reference
+
+### `useCreateFormex`
+
+Hook to create a form controller.
+
+**Parameters**
+
+- `initialValues`: An object with your form's initial values.
+- `initialErrors` (optional): An object for any initial validation errors.
+- `validation` (optional): A function for validating form data.
+- `validateOnChange` (optional): If `true`, validates fields whenever they change.
+- `onSubmit`: A function that fires when the form is submitted.
+
+
+### `<Field />`
+
+A component used to render individual form fields.
+
+**Props**
+
+- `name`: The name of the form field.
+- `as` (optional): The component or HTML tag that should be rendered. Defaults to `"input"`.
+- `children`: A function that returns the field input component. Receives field props as its parameter.
+
+**Example**
+
+```jsx
+<Field name="username">
+  {({ field }) => <input {...field} />}
+</Field>
+```
+
+## Customization
+
+Formex is designed to be flexible. You can create custom field components, use any validation library, or integrate with UI component libraries.
+
+### Using with UI Libraries
+
+```jsx
+import { Field } from 'formex-library';
+import { TextField } from 'some-ui-library';
+
+<Field name="username">
+  {({ field }) => (
+    <TextField {...field} label="Username" />
+  )}
+</Field>
+```
+
+### Custom Validation
+
+Leverage the `validation` function in `useCreateFormex` to integrate any validation logic or library.
+
+```jsx
+const validate = values => {
+  const errors = {};
+  if (!values.email.includes('@')) {
+    errors.email = 'Invalid email';
+  }
+  return errors;
+};
+```
+
+## Conclusion
+
+Formex provides a simple yet powerful way to manage forms in React applications. It reduces the amount of boilerplate code needed and offers flexibility to work with custom components and validation strategies. Whether you are building simple or complex forms, Formex can help streamline your form management process.
+
+For further examples and advanced usage, refer to the Formex documentation or source code.

package/src/form/index.ts

@@ -0,0 +1,5 @@
+export * from "./Field";
+export * from "./Formex";
+export * from "./types";
+export * from "./utils";
+export * from "./useCreateFormex";

package/src/form/types.ts

@@ -0,0 +1,27 @@
+import React, { FormEvent } from "react";
+
+export type FormexController<T extends object> = {
+    values: T;
+    setValues: (values: T) => void;
+    setFieldValue: (key: string, value: any, shouldValidate?: boolean) => void;
+    touched: Record<string, boolean>;
+    setFieldTouched: (key: string, touched: boolean, shouldValidate?: boolean) => void;
+    dirty: boolean;
+    setDirty: (dirty: boolean) => void;
+    setSubmitCount: (submitCount: number) => void;
+    errors: Record<string, string>;
+    setFieldError: (key: string, error?: string) => void;
+    handleChange: (event: React.SyntheticEvent) => void,
+    handleBlur: (event: React.FocusEvent) => void,
+    submitForm: (event?: FormEvent<HTMLFormElement>) => void;
+    validate: () => void;
+    resetForm: (props?: FormexResetProps<T>) => void;
+    submitCount: number;
+    isSubmitting: boolean;
+}
+
+export type FormexResetProps<T extends object> = {
+    values?: T;
+    errors?: Record<string, string>;
+    touched?: Record<string, boolean>;
+};

package/src/form/useCreateFormex.tsx

@@ -0,0 +1,137 @@
+import React, { FormEvent, useEffect, useState } from "react";
+import { setIn } from "./utils";
+import { FormexController, FormexResetProps } from "./types";
+
+export function useCreateFormex<T extends object>({ initialValues, initialErrors, validation, validateOnChange = false, onSubmit, validateOnInitialRender = false }: {
+    initialValues: T,
+    initialErrors?: Record<string, string>,
+    validateOnChange?: boolean,
+    validateOnInitialRender?: boolean,
+    validation?: (values: T) => Record<string, string>,
+    onSubmit?: (values: T, controller: FormexController<T>) => void | Promise<void>
+}): FormexController<T> {
+
+    const valuesRef = React.useRef<T>(initialValues);
+
+    const [values, setValuesInner] = useState<T>(initialValues);
+    const [touchedState, setTouchedState] = useState<Record<string, boolean>>({});
+    const [errors, setErrors] = useState<Record<string, string>>(initialErrors ?? {});
+    const [dirty, setDirty] = useState(false);
+    const [submitCount, setSubmitCount] = useState(0);
+    const [isSubmitting, setIsSubmitting] = useState(false);
+
+    useEffect(() => {
+        if (validateOnInitialRender) {
+            validate();
+        }
+    }, []);
+
+    const setValues = (newValues: T) => {
+        valuesRef.current = newValues;
+        setValuesInner(newValues);
+    }
+
+    const validate = () => {
+        const values = valuesRef.current;
+        const validationErrors = validation?.(values);
+        setErrors(validationErrors ?? {});
+        return validationErrors;
+    }
+
+    const setFieldValue = (key: string, value: any, shouldValidate?: boolean) => {
+        const newValues = setIn(valuesRef.current, key, value);
+        valuesRef.current = newValues;
+        setValues(newValues);
+        if (shouldValidate) {
+            validate();
+        }
+    }
+
+    const setFieldError = (key: string, error: string | undefined) => {
+        console.log("setFieldError", {key, error, errors })
+        const newErrors = { ...errors };
+        if (error) {
+            newErrors[key] = error;
+        } else {
+            delete newErrors[key];
+        }
+        setErrors(newErrors);
+    }
+
+    const setFieldTouched = (key: string, touched: boolean, shouldValidate?: boolean | undefined) => {
+        const newTouched = { ...touchedState };
+        newTouched[key] = touched;
+        setTouchedState(newTouched);
+        if (shouldValidate) {
+            validate();
+        }
+    }
+
+    const handleChange = (event: React.SyntheticEvent) => {
+        const target = event.target as HTMLInputElement;
+        const value = target.type === "checkbox" ? target.checked : target.value;
+        const name = target.name;
+        setFieldValue(name, value, validateOnChange);
+        setFieldTouched(name, true);
+    }
+
+    const handleBlur = (event: React.FocusEvent) => {
+        console.log("handleBlur")
+        const target = event.target as HTMLInputElement;
+        const name = target.name;
+        setFieldTouched(name, true);
+    }
+
+    const submit = async (e?: FormEvent<HTMLFormElement>) => {
+        e?.preventDefault();
+        e?.stopPropagation();
+        setIsSubmitting(true);
+        setSubmitCount(submitCount + 1);
+        const validationErrors = validation?.(valuesRef.current);
+        if (validationErrors && Object.keys(validationErrors).length > 0) {
+            setErrors(validationErrors);
+        } else {
+            setErrors({});
+            await onSubmit?.(valuesRef.current, controllerRef.current);
+        }
+        setIsSubmitting(false);
+    }
+
+    const resetForm = (props?: FormexResetProps<T>) => {
+        const {
+            values: valuesProp,
+            errors: errorsProp,
+            touched: touchedProp
+        } = props ?? {};
+        valuesRef.current = valuesProp ?? initialValues;
+        setValues(valuesProp ?? initialValues);
+        setErrors(errorsProp ?? {});
+        setTouchedState(touchedProp ?? {});
+        setDirty(false);
+        setSubmitCount(0);
+    }
+
+    const controller: FormexController<T> = {
+        values,
+        handleChange,
+        isSubmitting,
+        setValues,
+        setFieldValue,
+        errors,
+        setFieldError,
+        touched: touchedState,
+        setFieldTouched,
+        dirty,
+        setDirty,
+        submitForm: submit,
+        submitCount,
+        setSubmitCount,
+        handleBlur,
+        validate,
+        resetForm
+    };
+
+    const controllerRef = React.useRef<FormexController<T>>(controller);
+    controllerRef.current = controller;
+    return controller
+}

package/src/form/utils.ts

@@ -0,0 +1,169 @@
+import * as React from "react";
+
+/** @private is the value an empty array? */
+export const isEmptyArray = (value?: any) =>
+    Array.isArray(value) && value.length === 0;
+
+/** @private is the given object a Function? */
+export const isFunction = (obj: any): obj is Function =>
+    typeof obj === "function";
+
+/** @private is the given object an Object? */
+export const isObject = (obj: any): obj is Object =>
+    obj !== null && typeof obj === "object";
+
+/** @private is the given object an integer? */
+export const isInteger = (obj: any): boolean =>
+    String(Math.floor(Number(obj))) === obj;
+
+/** @private is the given object a string? */
+export const isString = (obj: any): obj is string =>
+    Object.prototype.toString.call(obj) === "[object String]";
+
+/** @private is the given object a NaN? */
+// eslint-disable-next-line no-self-compare
+export const isNaN = (obj: any): boolean => obj !== obj;
+
+/** @private Does a React component have exactly 0 children? */
+export const isEmptyChildren = (children: any): boolean =>
+    React.Children.count(children) === 0;
+
+/** @private is the given object/value a promise? */
+export const isPromise = (value: any): value is PromiseLike<any> =>
+    isObject(value) && isFunction(value.then);
+
+/** @private is the given object/value a type of synthetic event? */
+export const isInputEvent = (value: any): value is React.SyntheticEvent<any> =>
+    value && isObject(value) && isObject(value.target);
+
+/**
+ * Same as document.activeElement but wraps in a try-catch block. In IE it is
+ * not safe to call document.activeElement if there is nothing focused.
+ *
+ * The activeElement will be null only if the document or document body is not
+ * yet defined.
+ *
+ * @param {?Document} doc Defaults to current document.
+ * @return {Element | null}
+ * @see https://github.com/facebook/fbjs/blob/master/packages/fbjs/src/core/dom/getActiveElement.js
+ */
+export function getActiveElement(doc?: Document): Element | null {
+    doc = doc || (typeof document !== "undefined" ? document : undefined);
+    if (typeof doc === "undefined") {
+        return null;
+    }
+    try {
+        return doc.activeElement || doc.body;
+    } catch (e) {
+        return doc.body;
+    }
+}
+
+/**
+ * Deeply get a value from an object via its path.
+ */
+export function getIn(
+    obj: any,
+    key: string | string[],
+    def?: any,
+    p = 0
+) {
+    const path = toPath(key);
+    while (obj && p < path.length) {
+        obj = obj[path[p++]];
+    }
+
+    // check if path is not in the end
+    if (p !== path.length && !obj) {
+        return def;
+    }
+
+    return obj === undefined ? def : obj;
+}
+
+export function setIn(obj: any, path: string, value: any): any {
+    const res: any = clone(obj); // this keeps inheritance when obj is a class
+    let resVal: any = res;
+    let i = 0;
+    const pathArray = toPath(path);
+
+    for (; i < pathArray.length - 1; i++) {
+        const currentPath: string = pathArray[i];
+        const currentObj: any = getIn(obj, pathArray.slice(0, i + 1));
+
+        if (currentObj && (isObject(currentObj) || Array.isArray(currentObj))) {
+            resVal = resVal[currentPath] = clone(currentObj);
+        } else {
+            const nextPath: string = pathArray[i + 1];
+            resVal = resVal[currentPath] =
+                isInteger(nextPath) && Number(nextPath) >= 0 ? [] : {};
+        }
+    }
+
+    // Return original object if new value is the same as current
+    if ((i === 0 ? obj : resVal)[pathArray[i]] === value) {
+        return obj;
+    }
+
+    if (value === undefined) {
+        delete resVal[pathArray[i]];
+    } else {
+        resVal[pathArray[i]] = value;
+    }
+
+    // If the path array has a single element, the loop did not run.
+    // Deleting on `resVal` had no effect in this scenario, so we delete on the result instead.
+    if (i === 0 && value === undefined) {
+        delete res[pathArray[i]];
+    }
+
+    return res;
+}
+
+/**
+ * Recursively a set the same value for all keys and arrays nested object, cloning
+ * @param object
+ * @param value
+ * @param visited
+ * @param response
+ */
+export function setNestedObjectValues<T>(
+    object: any,
+    value: any,
+    visited: any = new WeakMap(),
+    response: any = {}
+): T {
+    for (const k of Object.keys(object)) {
+        const val = object[k];
+        if (isObject(val)) {
+            if (!visited.get(val)) {
+                visited.set(val, true);
+                // In order to keep array values consistent for both dot path  and
+                // bracket syntax, we need to check if this is an array so that
+                // this will output  { friends: [true] } and not { friends: { "0": true } }
+                response[k] = Array.isArray(val) ? [] : {};
+                setNestedObjectValues(val, value, visited, response[k]);
+            }
+        } else {
+            response[k] = value;
+        }
+    }
+
+    return response;
+}
+
+function clone(value: any) {
+    if (Array.isArray(value)) {
+        return [...value];
+    } else if (typeof value === "object" && value !== null) {
+        return { ...value };
+    } else {
+        return value; // This is for primitive types which do not need cloning.
+    }
+}
+
+function toPath(value: string | string[]) {
+    if (Array.isArray(value)) return value; // Already in path array form.
+    // Replace brackets with dots, remove leading/trailing dots, then split by dot.
+    return value.replace(/\[(\d+)]/g, ".$1").replace(/^\./, "").replace(/\.$/, "").split(".");
+}

package/src/types/collection_editor_controller.tsx

@@ -9,7 +9,7 @@ import { PersistedCollection } from "./persisted_collection";
 export interface CollectionEditorController {
 
     editCollection: (props: {
-        path?: string,
+        id?: string,
         fullPath?: string,
         parentCollectionIds: string[],
         parentCollection?: PersistedCollection
@@ -23,14 +23,15 @@ export interface CollectionEditorController {
         },
         parentCollectionIds: string[],
         parentCollection?: PersistedCollection,
-        redirect: boolean
+        redirect: boolean,
+        sourceClick?: string
     }) => void;
 
     editProperty: (props: {
         propertyKey?: string,
         property?: Property,
         currentPropertiesOrder?: string[],
-        editedCollectionPath: string,
+        editedCollectionId: string,
         parentCollectionIds: string[],
         collection: PersistedCollection
     }) => void;

package/src/types/config_controller.tsx

@@ -26,14 +26,14 @@ export interface CollectionsConfigController {
 export type UpdateCollectionParams<M extends Record<string, any>> = {
     id: string,
     collectionData: Partial<PersistedCollection<M>>,
-    previousPath?: string,
+    previousId?: string,
     parentCollectionIds?: string[]
 }
 
 export type SaveCollectionParams<M extends Record<string, any>> = {
     id: string,
     collectionData: PersistedCollection<M>,
-    previousPath?: string,
+    previousId?: string,
     parentCollectionIds?: string[]
 }
 
@@ -55,6 +55,6 @@ export type DeletePropertyParams = {
 }
 
 export type DeleteCollectionParams = {
-    path: string,
+    id: string,
     parentCollectionIds?: string[]
 }

package/src/ui/CollectionViewHeaderAction.tsx

@@ -30,7 +30,7 @@ export function CollectionViewHeaderAction({
                     collectionEditorController.editProperty({
                         propertyKey,
                         property,
-                        editedCollectionPath: fullPath,
+                        editedCollectionId: collection.id,
                         parentCollectionIds,
                         collection
                     });

package/src/ui/EditorCollectionAction.tsx

@@ -39,7 +39,7 @@ export function EditorCollectionAction({
     if (!equal(getObjectOrNull(tableController.filterValues), getObjectOrNull(collection.initialFilter)) ||
         !equal(getObjectOrNull(tableController.sortBy), getObjectOrNull(collection.initialSort))) {
         saveDefaultFilterButton = <>
-            {collection.initialFilter || collection.initialSort && <Tooltip
+            {(collection.initialFilter || collection.initialSort) && <Tooltip
                 title={"Reset to default filter and sort"}>
                 <Button
                     color={"primary"}
@@ -64,7 +64,7 @@ export function EditorCollectionAction({
                     variant={"outlined"}
                     onClick={() => configController
                         ?.saveCollection({
-                            id: collection.path,
+                            id: collection.id,
                             parentCollectionIds,
                             collectionData: mergeDeep(collection as PersistedCollection,
                                 {
@@ -89,7 +89,7 @@ export function EditorCollectionAction({
             color={"primary"}
             disabled={!canEditCollection}
             onClick={canEditCollection
-                ? () => collectionEditorController?.editCollection({ path: collection.path, fullPath, parentCollectionIds, parentCollection: parentCollection as PersistedCollection })
+                ? () => collectionEditorController?.editCollection({ id: collection.id, fullPath, parentCollectionIds, parentCollection: parentCollection as PersistedCollection })
                 : undefined}>
             <SettingsIcon/>
         </IconButton>

package/src/ui/HomePageEditorCollectionAction.tsx

@@ -25,13 +25,13 @@ export function HomePageEditorCollectionAction({
     });
 
     const onEditCollectionClicked = useCallback(() => {
-        collectionEditorController?.editCollection({ path, parentCollectionIds: [] });
+        collectionEditorController?.editCollection({ id: collection.id, parentCollectionIds: [] });
     }, [collectionEditorController, path]);
 
     const [deleteRequested, setDeleteRequested] = useState(false);
 
     const deleteCollection = useCallback(() => {
-        configController?.deleteCollection({ path }).then(() => {
+        configController?.deleteCollection({ id: collection.id }).then(() => {
             setDeleteRequested(false);
             snackbarController.open({
                 message: "Collection deleted",

package/src/ui/MissingReferenceWidget.tsx

@@ -16,7 +16,8 @@ export function MissingReferenceWidget({ path: pathProp }: {
                     collectionEditor.createCollection({
                         initialValues: { path, name: unslugify(path) },
                         parentCollectionIds,
-                        redirect: false
+                        redirect: false,
+                        sourceClick: "missing_reference"
                     });
                 }}>
             Create

package/src/ui/NewCollectionButton.tsx

@@ -7,9 +7,9 @@ export function NewCollectionButton() {
                    variant={"outlined"}
                    onClick={() => collectionEditorController.createCollection({
                        parentCollectionIds: [],
-                       redirect: true
-                   })
-                   }>
+                       redirect: true,
+                       sourceClick: "new_collection_button"
+                   })}>
         <AddIcon/>
         New collection
     </Button>

package/src/ui/NewCollectionCard.tsx

@@ -25,7 +25,8 @@ export function NewCollectionCard({
                   ? () => collectionEditorController.createCollection({
                       initialValues: group ? { group } : undefined,
                       parentCollectionIds: [],
-                      redirect: true
+                      redirect: true,
+                      sourceClick: "new_collection_card"
                   })
                   : undefined}>
 

package/src/ui/PropertyAddColumnComponent.tsx

@@ -29,7 +29,7 @@ export function PropertyAddColumnComponent({
                 // className={onHover ? "bg-white dark:bg-gray-950" : undefined}
                 onClick={() => {
                     collectionEditorController.editProperty({
-                        editedCollectionPath: fullPath,
+                        editedCollectionId: collection.id,
                         parentCollectionIds,
                         currentPropertiesOrder: getDefaultPropertiesOrder(collection),
                         collection

package/src/ui/RootCollectionSuggestions.tsx

@@ -40,7 +40,8 @@ export function RootCollectionSuggestions() {
                                     ? () => collectionEditorController.createCollection({
                                         initialValues: { path, name: unslugify(path) },
                                         parentCollectionIds: [],
-                                        redirect: true
+                                        redirect: true,
+                                        sourceClick: "root_collection_suggestion"
                                     })
                                     : undefined}
                                 size="small">