@evoke-platform/ui-components 1.8.0-testing.1 → 1.8.0-testing.10

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) {
+                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/index.d.ts

@@ -1,6 +1,7 @@
 export { BuilderGrid } from './BuilderGrid';
 export { CriteriaBuilder, getReadableQuery } from './CriteriaBuilder';
 export { DataGrid } from './DataGrid';
+export type { GridSortModel } from './DataGrid';
 export { ErrorComponent } from './ErrorComponent';
 export { Form } from './Form';
 export type { FormRef } from './Form';

package/dist/published/index.d.ts

@@ -3,7 +3,7 @@ export { CalendarPicker, DateTimePicker, MonthPicker, PickersDay, StaticDateTime
 export * from './colors';
 export * from './components/core';
 export { BuilderGrid, CriteriaBuilder, DataGrid, ErrorComponent, Form, FormContext, FormField, FormRenderer, FormRendererContainer, getReadableQuery, HistoryLog, MenuBar, MultiSelect, RecursiveEntryRenderer, RepeatableField, ResponsiveOverflow, RichTextViewer, UserAvatar, } from './components/custom';
-export type { FormRef } from './components/custom';
+export type { FormRef, GridSortModel } from './components/custom';
 export { NumericFormat } from './components/custom/FormField/InputFieldComponent';
 export { Box, Container, Grid, Stack } from './components/layout';
 export * from './theme';

package/dist/published/theme/hooks.d.ts

@@ -126,4 +126,8 @@ export declare function useFormContext(): {
     fieldHeight?: "medium" | "small" | undefined;
     triggerFieldReset?: boolean | undefined;
     showSubmitError?: boolean | undefined;
+    associatedObject?: {
+        instanceId?: string | undefined;
+        propertyId?: string | undefined;
+    } | undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evoke-platform/ui-components",
-    "version": "1.8.0-testing.1",
+    "version": "1.8.0-testing.10",
     "description": "",
     "main": "dist/published/index.js",
     "module": "dist/published/index.js",
@@ -9,6 +9,9 @@
         "icons.ts",
         "colors.ts"
     ],
+    "sideEffects": [
+        "*.css"
+    ],
     "exports": {
         ".": "./dist/published/index.js",
         "./colors": "./dist/published/colors/index.js",
@@ -87,7 +90,7 @@
         "yalc": "^1.0.0-pre.53"
     },
     "peerDependencies": {
-        "@evoke-platform/context": "^1.3.1-0",
+        "@evoke-platform/context": "^1.3.2-0",
         "react": "^18.1.0",
         "react-dom": "^18.1.0"
     },