@evoke-platform/ui-components 1.8.0-dev.1 → 1.8.0-dev.11

package/dist/published/components/custom/FormV2/components/FormFieldTypes/relatedObjectFiles/ObjectPropertyInput.js

@@ -1,16 +1,16 @@
 import { useApiServices, useApp, useNavigate, } from '@evoke-platform/context';
 import cleanDeep from 'clean-deep';
-import { cloneDeep, debounce, isEmpty, isNil } from 'lodash';
+import { cloneDeep, debounce, isEmpty, isEqual, isNil } from 'lodash';
 import Handlebars from 'no-eval-handlebars';
-import React, { useCallback, useEffect, useState } from 'react';
+import React, { useCallback, useEffect, useMemo, useState } from 'react';
 import { Close } from '../../../../../../icons';
 import { useFormContext } from '../../../../../../theme/hooks';
-import { Autocomplete, Button, Dialog, IconButton, Link, Paper, Snackbar, TextField, Tooltip, Typography, } from '../../../../../core';
+import { Autocomplete, Button, Dialog, DialogContent, DialogTitle, IconButton, Link, Paper, Snackbar, TextField, Tooltip, Typography, } from '../../../../../core';
 import { Box } from '../../../../../layout';
 import { encodePageSlug, getDefaultPages, getPrefixedUrl, transformToWhere } from '../../utils';
 import RelatedObjectInstance from './RelatedObjectInstance';
 const ObjectPropertyInput = (props) => {
-    const { id, fieldDefinition, nestedFieldsView, readOnly, error, mode, displayOption, filter, defaultValueCriteria, sortBy, orderBy, isModal, initialValue, viewLayout, hasDescription, } = props;
+    const { id, fieldDefinition, nestedFieldsView, readOnly, error, mode, displayOption, filter, defaultValueCriteria, sortBy, orderBy, isModal, initialValue, viewLayout, hasDescription, createActionId, formId, } = props;
     const { fetchedOptions, setFetchedOptions, parameters, fieldHeight, handleChange: handleChangeObjectField, instance, } = useFormContext();
     const { defaultPages, findDefaultPageSlugFor } = useApp();
     const [selectedInstance, setSelectedInstance] = useState(initialValue || undefined);
@@ -30,15 +30,12 @@ const ObjectPropertyInput = (props) => {
         showAlert: false,
         isError: true,
     });
-    const DEFAULT_CREATE_ACTION = '_create';
-    const action = relatedObject?.actions?.find((action) => action.id === DEFAULT_CREATE_ACTION);
+    const action = relatedObject?.actions?.find((action) => action.id === createActionId);
     const apiServices = useApiServices();
     const navigateTo = useNavigate();
-    const updatedCriteria = filter
-        ? {
-            where: transformToWhere(filter),
-        }
-        : undefined;
+    const updatedCriteria = useMemo(() => {
+        return filter ? { where: transformToWhere(filter) } : undefined;
+    }, [filter]);
     useEffect(() => {
         if (relatedObject) {
             let defaultViewLayout;
@@ -94,10 +91,12 @@ const ObjectPropertyInput = (props) => {
         }
     }, [fieldDefinition, defaultValueCriteria, sortBy, orderBy]);
     const getDropdownOptions = useCallback((name) => {
-        if ((!fetchedOptions[`${id}Options`] ||
-            fetchedOptions[`${id}Options`].length === 0) &&
-            !hasFetched) {
+        if (((!fetchedOptions?.[`${id}Options`] ||
+            (fetchedOptions?.[`${id}Options`]).length === 0) &&
+            !hasFetched) ||
+            !isEqual(fetchedOptions?.[`${id}UpdatedCriteria`], updatedCriteria)) {
             setLoadingOptions(true);
+            setFetchedOptions && setFetchedOptions({ [`${id}UpdatedCriteria`]: updatedCriteria });
             const updatedFilter = cloneDeep(updatedCriteria) || {};
             updatedFilter.limit = 100;
             const { propertyId, direction } = layout?.sort ?? {
@@ -146,17 +145,38 @@ const ObjectPropertyInput = (props) => {
         return () => debouncedGetDropdownOptions.cancel();
     }, [dropdownInput]);
     useEffect(() => {
-        if (action?.defaultFormId) {
+        if (formId || action?.defaultFormId) {
             apiServices
-                .get(getPrefixedUrl(`data/forms/${action.defaultFormId}`))
+                .get(getPrefixedUrl(`/forms/${formId || action?.defaultFormId}`))
                 .then((evokeForm) => {
                 setForm(evokeForm);
             })
                 .catch((error) => {
-                console.error('Error fetching form:', error);
+                console.error(error);
+            });
+        }
+        else if (action) {
+            apiServices
+                .get(getPrefixedUrl('/forms'), {
+                params: {
+                    filter: {
+                        where: {
+                            actionId: action.id,
+                            objectId: fieldDefinition.objectId,
+                        },
+                    },
+                },
+            })
+                .then((matchingForms) => {
+                if (matchingForms.length === 1) {
+                    setForm(matchingForms[0]);
+                }
+            })
+                .catch((error) => {
+                console.error(error);
             });
         }
-    }, [action]);
+    }, [action, formId]);
     useEffect(() => {
         if (!fetchedOptions[`${id}RelatedObject`]) {
             apiServices.get(getPrefixedUrl(`/objects/${fieldDefinition.objectId}/effective?sanitizedVersion=true`), (error, object) => {
@@ -254,7 +274,7 @@ const ObjectPropertyInput = (props) => {
                             },
                         } },
                         mode !== 'newOnly' && children,
-                        mode !== 'existingOnly' && form && (React.createElement(Button, { fullWidth: true, sx: {
+                        mode !== 'existingOnly' && createActionId && (React.createElement(Button, { fullWidth: true, sx: {
                                 justifyContent: 'flex-start',
                                 pl: 2,
                                 minHeight: '48px',
@@ -422,15 +442,19 @@ const ObjectPropertyInput = (props) => {
                     event.stopPropagation();
                     setOpenCreateDialog(true);
                 }, "aria-label": `Add` }, "Add")))),
-        openCreateDialog && (React.createElement(React.Fragment, null, nestedFieldsView ? (React.createElement(RelatedObjectInstance, { id: id, handleClose: handleClose, setSelectedInstance: setSelectedInstance, relatedObject: relatedObject, nestedFieldsView: nestedFieldsView, mode: mode, displayOption: displayOption, setOptions: setOptions, options: options, filter: updatedCriteria, layout: layout, form: form, action: action, setSnackbarError: setSnackbarError, selectedInstance: selectedInstance })) : (React.createElement(Dialog, { fullWidth: true, maxWidth: "md", open: openCreateDialog, onClose: (e, reason) => reason !== 'backdropClick' && handleClose },
-            React.createElement(Typography, { sx: {
-                    marginTop: '28px',
-                    fontSize: '22px',
+        openCreateDialog && (React.createElement(React.Fragment, null, nestedFieldsView ? (React.createElement(RelatedObjectInstance, { id: id, handleClose: handleClose, setSelectedInstance: setSelectedInstance, relatedObject: relatedObject, nestedFieldsView: nestedFieldsView, mode: mode, displayOption: displayOption, setOptions: setOptions, options: options, filter: updatedCriteria, layout: layout, formId: form?.id, actionId: createActionId, setSnackbarError: setSnackbarError, fieldDefinition: fieldDefinition })) : (React.createElement(Dialog, { fullWidth: true, maxWidth: "md", open: openCreateDialog, onClose: (e, reason) => reason !== 'backdropClick' && handleClose },
+            React.createElement(DialogTitle, { sx: {
+                    fontSize: '18px',
                     fontWeight: 700,
-                    marginLeft: '24px',
-                    marginBottom: '10px',
-                } }, `Add ${fieldDefinition.name}`),
-            React.createElement(RelatedObjectInstance, { handleClose: handleClose, setSelectedInstance: setSelectedInstance, nestedFieldsView: nestedFieldsView, relatedObject: relatedObject, id: id, mode: mode, displayOption: displayOption, setOptions: setOptions, options: options, filter: updatedCriteria, layout: layout, form: form, action: action, setSnackbarError: setSnackbarError, selectedInstance: selectedInstance }))))),
+                    paddingTop: '35px',
+                    paddingBottom: '20px',
+                    borderBottom: '1px solid #e9ecef',
+                } },
+                React.createElement(IconButton, { sx: { position: 'absolute', right: '17px', top: '22px' }, onClick: handleClose },
+                    React.createElement(Close, { fontSize: "small" })),
+                form?.name ?? `Add ${fieldDefinition.name}`),
+            React.createElement(DialogContent, { sx: { padding: '0px' } },
+                React.createElement(RelatedObjectInstance, { handleClose: handleClose, setSelectedInstance: setSelectedInstance, nestedFieldsView: nestedFieldsView, relatedObject: relatedObject, id: id, mode: mode, displayOption: displayOption, setOptions: setOptions, options: options, filter: updatedCriteria, layout: layout, formId: formId ?? form?.id, actionId: createActionId, setSnackbarError: setSnackbarError, fieldDefinition: fieldDefinition })))))),
         React.createElement(Snackbar, { open: snackbarError.showAlert, handleClose: () => setSnackbarError({
                 isError: snackbarError.isError,
                 showAlert: false,

package/dist/published/components/custom/FormV2/components/FormFieldTypes/relatedObjectFiles/RelatedObjectInstance.d.ts

@@ -1,9 +1,9 @@
-import { Action, EvokeForm, Obj, ObjectInstance, TableViewLayout } from '@evoke-platform/context';
+import { InputParameter, Obj, ObjectInstance, TableViewLayout } from '@evoke-platform/context';
 import React from 'react';
 import { BaseProps } from '../../types';
 export type RelatedObjectInstanceProps = BaseProps & {
-    relatedObject: Obj | undefined;
     id: string;
+    relatedObject: Obj | undefined;
     setSelectedInstance: (selectedInstance: ObjectInstance) => void;
     handleClose: () => void;
     mode: 'default' | 'existingOnly' | 'newOnly';
@@ -18,9 +18,9 @@ export type RelatedObjectInstanceProps = BaseProps & {
     options: ObjectInstance[];
     filter?: Record<string, unknown>;
     layout?: TableViewLayout;
-    form?: EvokeForm;
-    action?: Action;
-    selectedInstance?: ObjectInstance;
+    formId?: string;
+    actionId?: string;
+    fieldDefinition: InputParameter;
 };
 declare const RelatedObjectInstance: (props: RelatedObjectInstanceProps) => React.JSX.Element;
 export default RelatedObjectInstance;

package/dist/published/components/custom/FormV2/components/FormFieldTypes/relatedObjectFiles/RelatedObjectInstance.js

@@ -1,8 +1,11 @@
+import { useApiServices } from '@evoke-platform/context';
 import { InfoRounded } from '@mui/icons-material';
 import React, { useState } from 'react';
 import { useFormContext } from '../../../../../../theme/hooks';
 import { Alert, Button, FormControlLabel, Radio, RadioGroup } from '../../../../../core';
 import { Box, Grid } from '../../../../../layout';
+import FormRendererContainer from '../../../FormRendererContainer';
+import { formatSubmission, getPrefixedUrl } from '../../utils';
 import InstanceLookup from './InstanceLookup';
 const styles = {
     actionButtons: {
@@ -14,11 +17,12 @@ const styles = {
     },
 };
 const RelatedObjectInstance = (props) => {
-    const { relatedObject, id, setSelectedInstance, handleClose, nestedFieldsView, mode, displayOption, filter, layout, form, } = props;
-    const { handleChange: handleChangeObjectField } = useFormContext();
+    const { relatedObject, id, setSelectedInstance, handleClose, nestedFieldsView, mode, displayOption, filter, layout, formId, actionId, fieldDefinition, setSnackbarError, setOptions, options, } = props;
+    const { handleChange: handleChangeObjectField, richTextEditor, stickyFooter, fieldHeight } = useFormContext();
     const [errors, setErrors] = useState([]);
     const [selectedRow, setSelectedRow] = useState();
     const [relationType, setRelationType] = useState(displayOption === 'dropdown' ? 'new' : 'existing');
+    const apiServices = useApiServices();
     const linkExistingInstance = async () => {
         if (selectedRow) {
             setSelectedInstance(selectedRow);
@@ -30,19 +34,53 @@ const RelatedObjectInstance = (props) => {
         handleClose();
         setErrors([]);
     };
+    const createNewInstance = async (submission) => {
+        if (!relatedObject) {
+            // Handle the case where relatedObject is undefined
+            return;
+        }
+        submission = await formatSubmission(submission, apiServices, relatedObject.id);
+        try {
+            await apiServices
+                .post(getPrefixedUrl(`/objects/${relatedObject.id}/instances/actions`), {
+                actionId: actionId,
+                input: submission,
+            })
+                .then((response) => {
+                handleChangeObjectField(id, response);
+                setSelectedInstance(response);
+                setSnackbarError({
+                    showAlert: true,
+                    message: 'New instance created',
+                    isError: false,
+                });
+                setOptions(options.concat([response]));
+                onClose();
+            });
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        }
+        catch (err) {
+            setSnackbarError({
+                showAlert: true,
+                message: err.response?.data?.error?.details?.[0]?.message ??
+                    err.response?.data?.error?.message ??
+                    `An error occurred. The new instance was not created.`,
+                isError: true,
+            });
+        }
+    };
     return (React.createElement(Box, { sx: {
             background: nestedFieldsView ? '#F4F6F8' : 'none',
             borderRadius: '8px',
         } },
         React.createElement(Box, { sx: {
-                padding: '8px 24px 0px',
                 '.MuiInputBase-root': { background: '#FFFF', borderRadius: '8px' },
             } },
             !nestedFieldsView &&
                 displayOption !== 'dropdown' &&
                 mode !== 'existingOnly' &&
                 mode !== 'newOnly' &&
-                form && (React.createElement(Grid, { container: true },
+                actionId && (React.createElement(Grid, { container: true, sx: { paddingX: '24px' } },
                 React.createElement(Grid, { container: true, item: true },
                     React.createElement(RadioGroup, { row: true, "aria-labelledby": "related-object-link-type", onChange: (event) => {
                             event.target.value === 'existing' && setErrors([]);
@@ -57,9 +95,9 @@ const RelatedObjectInstance = (props) => {
                 "There are ",
                 React.createElement("strong", null, errors.length),
                 " errors")))) : undefined,
-            (relationType === 'new' || mode === 'newOnly') && form ? (React.createElement(Box, { id: 'related-object-wrapper', sx: { width: '100%' } })) : (relatedObject &&
-                mode !== 'newOnly' && (React.createElement(React.Fragment, null,
-                React.createElement(InstanceLookup, { colspan: 12, nestedFieldsView: nestedFieldsView, setRelationType: setRelationType, object: relatedObject, setSelectedInstance: setSelectedRow, mode: mode, filter: filter, layout: layout }))))),
+            relationType === 'new' || mode === 'newOnly' ? (React.createElement(Box, { sx: { width: '100%' } },
+                React.createElement(FormRendererContainer, { formId: formId, display: { fieldHeight: fieldHeight ?? 'medium' }, actionId: actionId, stickyFooter: stickyFooter, objectId: fieldDefinition.objectId, onClose: onClose, onSubmit: createNewInstance, richTextEditor: richTextEditor }))) : ((mode === 'default' || mode === 'existingOnly') &&
+                relatedObject && (React.createElement(InstanceLookup, { colspan: 12, nestedFieldsView: nestedFieldsView, setRelationType: setRelationType, object: relatedObject, setSelectedInstance: setSelectedRow, mode: mode, filter: filter, layout: layout })))),
         relationType !== 'new' && mode !== 'newOnly' && (React.createElement(Box, { sx: styles.actionButtons },
             React.createElement(Button, { onClick: onClose, color: 'inherit', sx: {
                     border: '1px solid #ced4da',

package/dist/published/components/custom/FormV2/components/RecursiveEntryRenderer.js

@@ -1,6 +1,5 @@
 import { useApiServices, useAuthenticationContext, } from '@evoke-platform/context';
 import { WarningRounded } from '@mui/icons-material';
-import { cloneDeep } from 'lodash';
 import React, { useEffect, useMemo } from 'react';
 import { useResponsive } from '../../../../theme';
 import { useFormContext } from '../../../../theme/hooks';
@@ -38,7 +37,7 @@ function getFieldWrapperProps(fieldDefinition, entry, entryId, fieldValue, displ
 }
 export function RecursiveEntryRenderer(props) {
     const { entry, isDocument } = props;
-    const { fetchedOptions, setFetchedOptions, object, getValues, errors, instance, richTextEditor, parameters, handleChange, fieldHeight, triggerFieldReset, } = useFormContext();
+    const { fetchedOptions, setFetchedOptions, object, getValues, errors, instance, richTextEditor, parameters, handleChange, fieldHeight, triggerFieldReset, associatedObject, } = useFormContext();
     // If the entry is hidden, clear its value and any nested values, and skip rendering
     if (!entryIsVisible(entry, getValues(), instance)) {
         return null;
@@ -70,7 +69,7 @@ export function RecursiveEntryRenderer(props) {
             return undefined;
         }
         if (def?.enum && def.type === 'string') {
-            const cloned = cloneDeep(def);
+            const cloned = structuredClone(def);
             // single select must be made to be type choices for label and error handling
             cloned.type = 'choices';
             return cloned;
@@ -78,6 +77,8 @@ export function RecursiveEntryRenderer(props) {
         return def;
     }, [entry, parameters, object]);
     const validation = fieldDefinition?.validation || {};
+    if (associatedObject?.propertyId === entryId)
+        return null;
     useEffect(() => {
         if (fieldDefinition?.type === 'collection' && fieldDefinition?.manyToManyPropertyId && instance) {
             fetchCollectionData(apiServices, fieldDefinition, setFetchedOptions, instance.id, fetchedOptions, initialMiddleObjectInstances);
@@ -107,7 +108,9 @@ export function RecursiveEntryRenderer(props) {
                         ? display?.defaultValue.orderBy
                         : undefined, defaultValueCriteria: typeof display?.defaultValue === 'object' && 'criteria' in display.defaultValue
                         ? display?.defaultValue?.criteria
-                        : undefined, viewLayout: display?.viewLayout, hasDescription: !!display?.description })));
+                        : undefined, viewLayout: display?.viewLayout, hasDescription: !!display?.description, 
+                    // formId={display?.createFormId}  // TODO: this should be added as part of the builder update
+                    createActionId: '_create' })));
         }
         else if (fieldDefinition.type === 'user') {
             return (React.createElement(FieldWrapper, { ...getFieldWrapperProps(fieldDefinition, entry, entryId, fieldValue, display, errors) },
@@ -116,7 +119,7 @@ export function RecursiveEntryRenderer(props) {
         else if (fieldDefinition.type === 'collection') {
             return fieldDefinition?.manyToManyPropertyId ? (middleObject && initialMiddleObjectInstances && (React.createElement(FieldWrapper, { ...getFieldWrapperProps(fieldDefinition, entry, entryId, fieldValue, display, errors) },
                 React.createElement(DropdownRepeatableField, { initialMiddleObjectInstances: fetchedOptions[`${entryId}MiddleObjectInstances`] || initialMiddleObjectInstances, fieldDefinition: fieldDefinition, id: entryId, middleObject: middleObject, readOnly: entry.type === 'readonlyField', criteria: validation?.criteria, hasDescription: !!display?.description })))) : (React.createElement(FieldWrapper, { ...getFieldWrapperProps(fieldDefinition, entry, entryId, fieldValue, display, errors) },
-                React.createElement(RepeatableField, { fieldDefinition: fieldDefinition, canUpdateProperty: entry.type !== 'readonlyField', criteria: validation?.criteria, viewLayout: display?.viewLayout })));
+                React.createElement(RepeatableField, { fieldDefinition: fieldDefinition, canUpdateProperty: entry.type !== 'readonlyField', criteria: validation?.criteria, viewLayout: display?.viewLayout, entry: entry, createActionId: '_create', updateActionId: '_update', deleteActionId: '_delete' })));
         }
         else if (fieldDefinition.type === 'richText') {
             return (React.createElement(FieldWrapper, { ...getFieldWrapperProps(fieldDefinition, entry, entryId, fieldValue, display, errors) }, richTextEditor ? (React.createElement(richTextEditor, {
@@ -140,7 +143,6 @@ export function RecursiveEntryRenderer(props) {
         else {
             // Add `aria-describedby` to ensure screen readers read the description
             // when the input is tabbed into.
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             const additionalProps = {};
             if (fieldDefinition.enum && display?.description) {
                 additionalProps.renderInput = (params) => (React.createElement(TextField, { ...params, inputProps: {

package/dist/published/components/custom/FormV2/components/ValidationFiles/ValidationErrorDisplay.d.ts

@@ -1,7 +1,10 @@
 import React from 'react';
+import { FieldErrors } from 'react-hook-form';
 export type ValidationErrorDisplayProps = {
     formId: string;
     title?: string;
+    errors?: FieldErrors;
+    showSubmitError?: boolean;
 };
 declare function ValidationErrorDisplay(props: ValidationErrorDisplayProps): React.JSX.Element | null;
 export default ValidationErrorDisplay;

package/dist/published/components/custom/FormV2/components/ValidationFiles/ValidationErrorDisplay.js

@@ -1,11 +1,9 @@
 import React from 'react';
 import { useResponsive } from '../../../../../theme';
-import { useFormContext } from '../../../../../theme/hooks';
 import { List, ListItem, Typography } from '../../../../core';
 import { Box } from '../../../../layout';
 function ValidationErrorDisplay(props) {
-    const { formId, title } = props;
-    const { errors, showSubmitError } = useFormContext();
+    const { formId, title, errors, showSubmitError } = props;
     const { isSm, isXs } = useResponsive();
     function extractErrorMessages(errors) {
         const messages = [];

package/dist/published/components/custom/FormV2/components/types.d.ts

@@ -38,7 +38,7 @@ export type SimpleEditorProps = {
 };
 export type ObjectPropertyInputProps = {
     id: string;
-    fieldDefinition: InputParameter;
+    fieldDefinition: InputParameter | Property;
     mode: 'default' | 'existingOnly' | 'newOnly';
     nestedFieldsView?: boolean;
     readOnly?: boolean;
@@ -53,6 +53,8 @@ export type ObjectPropertyInputProps = {
     initialValue?: ObjectInstance | null;
     viewLayout?: ViewLayoutEntityReference;
     hasDescription?: boolean;
+    createActionId?: string;
+    formId?: string;
 };
 export type Page = {
     id: string;
@@ -85,6 +87,10 @@ export type ExpandedSection = Section & {
 export type EntryRendererProps = BaseProps & {
     entry: FormEntry;
     isDocument?: boolean;
+    associatedObject?: {
+        instanceId?: string;
+        propertyId?: string;
+    };
 };
 export type SectionsProps = {
     entry: Sections;

package/dist/published/components/custom/FormV2/components/utils.d.ts

@@ -1,8 +1,9 @@
-import { ApiServices, Column, Columns, FormEntry, InputField, InputParameter, InputParameterReference, Obj, ObjectInstance, Property, Section, Sections, UserAccount } from '@evoke-platform/context';
+/// <reference types="react" />
+import { Action, ApiServices, Column, Columns, FormEntry, InputField, InputParameter, InputParameterReference, Obj, ObjectInstance, Property, Section, Sections, UserAccount } from '@evoke-platform/context';
 import { LocalDateTime } from '@js-joda/core';
 import { FieldErrors, FieldValues } from 'react-hook-form';
 import { AutocompleteOption } from '../../../core';
-import { Document, DocumentData } from './types';
+import { Document, DocumentData, SavedDocumentReference } from './types';
 export declare const scrollIntoViewWithOffset: (el: HTMLElement, offset: number, container?: HTMLElement) => void;
 export declare const normalizeDateTime: (dateTime: LocalDateTime) => string;
 export declare function isAddressProperty(key: string): boolean;
@@ -61,3 +62,27 @@ export declare function formatDataToDoc(data: DocumentData): {
 export declare function getUnnestedEntries(entries: FormEntry[]): FormEntry[];
 export declare const isEmptyWithDefault: (fieldValue: unknown, entry: InputParameterReference | InputField, instance: Record<string, unknown> | object) => boolean | "" | 0 | undefined;
 export declare const docProperties: Property[];
+export declare const uploadDocuments: (files: (File | SavedDocumentReference)[], metadata: Record<string, string>, apiServices: ApiServices, instanceId: string, objectId: string) => Promise<SavedDocumentReference[]>;
+export declare const deleteDocuments: (submittedFields: FieldValues, requestSuccess: boolean, apiServices: ApiServices, object: Obj, instance: FieldValues, action?: Action, setSnackbarError?: React.Dispatch<React.SetStateAction<{
+    showAlert: boolean;
+    message?: string;
+    isError: boolean;
+}>>) => Promise<void>;
+/**
+ * Transforms a form submission into a format safe for API submission.
+ *
+ * Responsibilities:
+ * - Uploads any files found in submission fields.
+ * - Normalizes related objects (keeping only id and name not the whole instance).
+ * - Converts an object of undefined address fields to undefined instead of an empty object.
+ * - Normalizes LocalDateTime values to API-friendly format.
+ * - Converts empty strings or undefined values to null.
+ * - Optionally reports file upload errors via snackbar.
+ *
+ * Returns the cleaned submission ready for submitting.
+ */
+export declare function formatSubmission(submission: FieldValues, apiServices?: ApiServices, objectId?: string, instanceId?: string, setSnackbarError?: React.Dispatch<React.SetStateAction<{
+    showAlert: boolean;
+    message?: string;
+    isError: boolean;
+}>>): Promise<FieldValues>;

package/dist/published/components/custom/FormV2/components/utils.js

@@ -1,6 +1,6 @@
 import { LocalDateTime } from '@js-joda/core';
 import jsonLogic from 'json-logic-js';
-import { get, isArray, isEmpty, isObject, omit, startCase, transform } from 'lodash';
+import { get, isArray, isEmpty, isObject, omit, pick, startCase, transform } from 'lodash';
 import { DateTime } from 'luxon';
 import Handlebars from 'no-eval-handlebars';
 import { defaultRuleProcessorMongoDB, formatQuery, parseMongoDB } from 'react-querybuilder';
@@ -116,7 +116,7 @@ export const getEntryId = (entry) => {
 };
 export function getPrefixedUrl(url) {
     const wcsMatchers = ['/apps', '/pages', '/widgets'];
-    const dataMatchers = ['/objects', '/correspondenceTemplates', '/documents', '/payments', '/locations'];
+    const dataMatchers = ['/objects', '/correspondenceTemplates', '/documents', '/payments', '/forms', '/locations'];
     const signalrMatchers = ['/hubs'];
     const accessManagementMatchers = ['/users'];
     const workflowMatchers = ['/workflows'];
@@ -562,3 +562,109 @@ export const docProperties = [
         type: 'string',
     },
 ];
+export const uploadDocuments = async (files, metadata, apiServices, instanceId, objectId) => {
+    const allDocuments = [];
+    const formData = new FormData();
+    for (const [index, file] of files.entries()) {
+        if ('size' in file) {
+            formData.append(`files[${index}]`, file);
+        }
+        else {
+            allDocuments.push(file);
+        }
+    }
+    if (metadata) {
+        for (const [key, value] of Object.entries(metadata)) {
+            formData.append(key, value);
+        }
+    }
+    const docs = await apiServices.post(getPrefixedUrl(`/objects/${objectId}/instances/${instanceId}/documents`), formData);
+    return allDocuments.concat(docs?.map((doc) => ({
+        id: doc.id,
+        name: doc.name,
+    })) ?? []);
+};
+export const deleteDocuments = async (submittedFields, requestSuccess, apiServices, object, instance, action, setSnackbarError) => {
+    const documentProperties = action?.parameters
+        ? action.parameters.filter((param) => param.type === 'document')
+        : object?.properties?.filter((prop) => prop.type === 'document');
+    for (const docProperty of documentProperties ?? []) {
+        const savedValue = submittedFields[docProperty.id];
+        const originalValue = instance?.[docProperty.id];
+        const documentsToRemove = requestSuccess
+            ? (originalValue?.filter((file) => !savedValue?.some((f) => f.id === file.id)) ?? [])
+            : (savedValue?.filter((file) => !originalValue?.some((f) => f.id === file.id)) ?? []);
+        for (const doc of documentsToRemove) {
+            try {
+                await apiServices?.delete(getPrefixedUrl(`/objects/${object.id}/instances/${instance.id}/documents/${doc.id}`));
+            }
+            catch (error) {
+                if (error) {
+                    setSnackbarError &&
+                        setSnackbarError({
+                            showAlert: true,
+                            message: `An error occurred while removing document '${doc.name}'`,
+                            isError: true,
+                        });
+                }
+            }
+        }
+    }
+};
+/**
+ * Transforms a form submission into a format safe for API submission.
+ *
+ * Responsibilities:
+ * - Uploads any files found in submission fields.
+ * - Normalizes related objects (keeping only id and name not the whole instance).
+ * - Converts an object of undefined address fields to undefined instead of an empty object.
+ * - Normalizes LocalDateTime values to API-friendly format.
+ * - Converts empty strings or undefined values to null.
+ * - Optionally reports file upload errors via snackbar.
+ *
+ * Returns the cleaned submission ready for submitting.
+ */
+export async function formatSubmission(submission, apiServices, objectId, instanceId, setSnackbarError) {
+    for (const [key, value] of Object.entries(submission)) {
+        if (isArray(value)) {
+            const fileInArray = value.some((item) => item instanceof File);
+            if (fileInArray && instanceId && apiServices && objectId) {
+                try {
+                    const uploadedDocuments = await uploadDocuments(value, {
+                        type: '',
+                        view_permission: '',
+                    }, apiServices, instanceId, objectId);
+                    submission[key] = uploadedDocuments;
+                }
+                catch (err) {
+                    if (err) {
+                        setSnackbarError &&
+                            setSnackbarError({
+                                showAlert: true,
+                                message: `An error occurred while uploading associated documents`,
+                                isError: true,
+                            });
+                    }
+                    return submission;
+                }
+            }
+            // if there are address fields with no value address needs to be set to undefined to be able to submit
+        }
+        else if (typeof value === 'object' && value !== null) {
+            if (Object.values(value).every((v) => v === undefined)) {
+                submission[key] = undefined;
+                // only submit the name and id of a related object
+            }
+            else if ('id' in value && 'name' in value) {
+                submission[key] = pick(value, 'id', 'name');
+            }
+            else if (value instanceof LocalDateTime) {
+                submission[key] = normalizeDateTime(value);
+            }
+        }
+        else if (value === '' || value === undefined) {
+            submission[key] = null;
+        }
+    }
+    return submission;
+}

package/dist/published/components/custom/FormV2/tests/FormRenderer.test.d.ts

@@ -0,0 +1 @@
+export {};