@evoke-platform/ui-components 1.6.0-testing.9 → 1.6.0

package/dist/published/components/custom/FormV2/components/FormFieldTypes/CollectionFiles/DropdownRepeatableField.js

@@ -0,0 +1,233 @@
+import { useApiServices, useNotification, } from '@evoke-platform/context';
+import { debounce, isArray, isEmpty, isEqual } from 'lodash';
+import React, { useCallback, useEffect, useState } from 'react';
+import { useFormContext } from '../../../../../../theme/hooks';
+import { Skeleton } from '../../../../../core';
+import { retrieveCustomErrorMessage } from '../../../../Form/utils';
+import { getMiddleObject, getMiddleObjectFilter, getPrefixedUrl, transformToWhere } from '../../utils';
+import { DropdownRepeatableFieldInput } from './DropdownRepeatableFieldInput';
+const DropdownRepeatableField = (props) => {
+    const { id, fieldDefinition, criteria, instance, readOnly, initialMiddleObjectInstances, middleObject, fieldHeight, hasDescription, viewLayout, } = props;
+    const { fetchedOptions, setFetchedOptions } = useFormContext();
+    const [layout, setLayout] = useState();
+    const [loading, setLoading] = useState(false);
+    const [layoutLoaded, setLayoutLoaded] = useState(false);
+    const [searchValue, setSearchValue] = useState('');
+    const [middleObjectInstances, setMiddleObjectInstances] = useState(initialMiddleObjectInstances);
+    const [endObject, setEndObject] = useState(fetchedOptions[`${fieldDefinition.id}EndObject`]);
+    const [endObjectInstances, setEndObjectInstances] = useState(fetchedOptions[`${fieldDefinition.id}EndObjectInstances`] || []);
+    const [initialLoading, setInitialLoading] = useState(endObjectInstances ? false : true);
+    const [selectedOptions, setSelectedOptions] = useState([]);
+    const [hasFetched, setHasFetched] = useState(!!fetchedOptions[`${fieldDefinition.id}EndObjectInstancesHaveFetched`] || false);
+    const [snackbarError, setSnackbarError] = useState({
+        showAlert: false,
+        isError: true,
+    });
+    const { instanceChanges } = useNotification();
+    const apiServices = useApiServices();
+    const getMiddleObjectInstances = async () => {
+        const filter = instance ? getMiddleObjectFilter(fieldDefinition, instance.id) : {};
+        try {
+            return await apiServices.get(getPrefixedUrl(`/objects/${fieldDefinition.objectId}/instances`), {
+                params: { filter: JSON.stringify(filter) },
+            });
+        }
+        catch (err) {
+            console.error(err);
+            return [];
+        }
+    };
+    const fetchMiddleObjectInstances = async () => {
+        const newInstances = await getMiddleObjectInstances();
+        setMiddleObjectInstances(newInstances);
+    };
+    const setDropDownSelections = (instances) => {
+        setSelectedOptions(instances
+            .filter((currInstance) => fieldDefinition.manyToManyPropertyId in currInstance)
+            .map((currInstance) => ({
+            label: currInstance[fieldDefinition.manyToManyPropertyId]?.name,
+            endObjectId: currInstance[fieldDefinition.manyToManyPropertyId].id,
+            middleObjectId: currInstance.id,
+        }))
+            .sort((instanceA, instanceB) => instanceA.label.localeCompare(instanceB.label)));
+    };
+    useEffect(() => {
+        const endObjectProperty = middleObject?.properties?.find((currProperty) => fieldDefinition.manyToManyPropertyId === currProperty.id);
+        if (endObjectProperty && endObjectProperty.objectId && !fetchedOptions[`${fieldDefinition.id}EndObject`]) {
+            setLayoutLoaded(false);
+            apiServices.get(getPrefixedUrl(`/objects/${endObjectProperty.objectId}/effective`), { params: { filter: { fields: ['id', 'name', 'properties', 'viewLayout'] } } }, (error, effectiveObject) => {
+                if (error) {
+                    console.error(error);
+                }
+                else {
+                    // If there's no error then the effective object is defined.
+                    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                    const endObject = effectiveObject;
+                    setEndObject(endObject);
+                    let defaultLayout;
+                    if (endObject.viewLayout?.dropdown) {
+                        defaultLayout = {
+                            id: 'default',
+                            name: 'Default',
+                            objectId: endObject.id,
+                            ...endObject.viewLayout.dropdown,
+                        };
+                    }
+                    if (viewLayout) {
+                        apiServices
+                            .get(getPrefixedUrl(`/objects/${viewLayout.objectId}/dropdownLayouts/${viewLayout.id}`))
+                            .then(setLayout)
+                            .catch(() => setLayout(defaultLayout))
+                            .finally(() => setLayoutLoaded(true));
+                    }
+                    else {
+                        setLayout(defaultLayout);
+                        setLayoutLoaded(true);
+                    }
+                }
+            });
+        }
+    }, [middleObject, viewLayout]);
+    useEffect(() => {
+        instanceChanges?.subscribe(middleObject.rootObjectId, () => {
+            fetchMiddleObjectInstances();
+        });
+        return () => instanceChanges?.unsubscribe(middleObject.rootObjectId);
+    }, [instanceChanges, fetchMiddleObjectInstances]);
+    const fetchEndObjectInstances = useCallback((searchedName) => {
+        if ((fieldDefinition.objectId &&
+            fieldDefinition.manyToManyPropertyId &&
+            endObjectInstances.length === 0 &&
+            !hasFetched) ||
+            (searchedName !== undefined && searchedName !== '')) {
+            setLoading(true);
+            const endObjectProperty = middleObject.properties?.find((currProperty) => fieldDefinition.manyToManyPropertyId === currProperty.id);
+            if (endObjectProperty?.objectId) {
+                const { propertyId, direction } = layout?.sort ?? {
+                    propertyId: 'name',
+                    direction: 'asc',
+                };
+                const filter = {
+                    limit: 100,
+                    order: `${propertyId} ${direction}`,
+                };
+                let searchCriteria = criteria && !isEmpty(criteria) ? transformToWhere(criteria) : {};
+                if (searchedName?.length) {
+                    const nameCriteria = transformToWhere({
+                        name: {
+                            like: searchedName,
+                            options: 'i',
+                        },
+                    });
+                    searchCriteria = !isEmpty(criteria)
+                        ? {
+                            and: [searchCriteria, nameCriteria],
+                        }
+                        : nameCriteria;
+                }
+                filter.where = searchCriteria;
+                apiServices.get(getPrefixedUrl(`/objects/${endObjectProperty.objectId}/instances`), { params: { filter: JSON.stringify(filter) } }, (error, instances) => {
+                    if (!error && instances) {
+                        setEndObjectInstances(instances);
+                        setHasFetched(true);
+                    }
+                    setInitialLoading(false);
+                    setLoading(false);
+                });
+            }
+        }
+        else if (endObjectInstances.length !== 0) {
+            setInitialLoading(false);
+        }
+    }, [fieldDefinition.objectId, fieldDefinition.manyToManyPropertyId, middleObject]);
+    const debouncedEndObjectSearch = useCallback(debounce(fetchEndObjectInstances, 500), [fetchEndObjectInstances]);
+    useEffect(() => {
+        if (!fetchedOptions[`${fieldDefinition.id}EndObjectInstances`] ||
+            (isArray(fetchedOptions[`${fieldDefinition.id}EndObjectInstances`]) &&
+                fetchedOptions[`${fieldDefinition.id}EndObjectInstances`].length === 0)) {
+            setFetchedOptions({
+                [`${fieldDefinition.id}EndObjectInstances`]: endObjectInstances,
+                [`${fieldDefinition.id}EndObjectInstancesHaveFetched`]: hasFetched,
+            });
+        }
+        if (!fetchedOptions[`${fieldDefinition.id}EndObject`]) {
+            setFetchedOptions({
+                [`${fieldDefinition.id}EndObject`]: endObject,
+            });
+        }
+        if (!isEqual(middleObjectInstances, initialMiddleObjectInstances)) {
+            setFetchedOptions({
+                [`${fieldDefinition.id}MiddleObjectInstances`]: middleObjectInstances,
+            });
+        }
+    }, [endObjectInstances, endObject, middleObjectInstances]);
+    useEffect(() => {
+        const updateFetchedOptions = (key, value) => {
+            if (!fetchedOptions[key]) {
+                setFetchedOptions({ [key]: value });
+            }
+        };
+        updateFetchedOptions(`${fieldDefinition.id}EndObjectInstances`, endObjectInstances);
+        updateFetchedOptions(`${fieldDefinition.id}EndObjectInstancesHaveFetched`, hasFetched);
+        updateFetchedOptions(`${fieldDefinition.id}EndObject`, endObject);
+        if (!isEqual(middleObjectInstances, initialMiddleObjectInstances)) {
+            setFetchedOptions({ [`${fieldDefinition.id}MiddleObjectInstances`]: middleObjectInstances });
+        }
+    }, [
+        endObjectInstances,
+        endObject,
+        middleObjectInstances,
+        fetchedOptions,
+        fieldDefinition.id,
+        hasFetched,
+        initialMiddleObjectInstances,
+        setFetchedOptions,
+    ]);
+    useEffect(() => {
+        debouncedEndObjectSearch(searchValue);
+        return () => debouncedEndObjectSearch.cancel();
+    }, [searchValue, debouncedEndObjectSearch]);
+    useEffect(() => {
+        if (layoutLoaded) {
+            fetchEndObjectInstances();
+        }
+    }, [fetchEndObjectInstances, layoutLoaded]);
+    const saveMiddleInstance = async (endObjectId, endObjectName) => {
+        if (fieldDefinition.objectId) {
+            const middleObject = getMiddleObject(fieldDefinition, endObjectId, endObjectName, instance);
+            try {
+                const newInstance = await apiServices.post(getPrefixedUrl(`/objects/${fieldDefinition.objectId}/instances/actions`), { actionId: `_create`, input: middleObject });
+                setMiddleObjectInstances((prevObjectInstances) => [
+                    ...prevObjectInstances,
+                    newInstance,
+                ]);
+            }
+            catch (err) {
+                setSnackbarError({
+                    showAlert: true,
+                    message: retrieveCustomErrorMessage(err) ??
+                        'An error occurred while adding an instance',
+                    isError: true,
+                });
+                setDropDownSelections(middleObjectInstances);
+            }
+        }
+    };
+    const removeMiddleInstance = async (instanceId) => {
+        try {
+            await apiServices.post(getPrefixedUrl(`/objects/${fieldDefinition.objectId}/instances/${instanceId}/actions`), { actionId: '_delete' });
+            setMiddleObjectInstances((prevInstances) => prevInstances.filter((curr) => curr.id !== instanceId));
+        }
+        catch (err) {
+            setDropDownSelections(middleObjectInstances);
+            setSnackbarError({
+                showAlert: true,
+                message: retrieveCustomErrorMessage(err) ??
+                    'An error occurred while deleting the instance',
+                isError: true,
+            });
+        }
+    };
+    return initialLoading || !middleObject || !middleObjectInstances || !endObjectInstances || !endObject ? (React.createElement(Skeleton, null)) : (React.createElement(React.Fragment, null, middleObjectInstances && endObject && (React.createElement(DropdownRepeatableFieldInput, { id: id, fieldDefinition: fieldDefinition, readOnly: readOnly || !middleObject.actions?.some((action) => action.id === '_create'), layout: layout, middleObjectInstances: middleObjectInstances, endObjectInstances: endObjectInstances ?? [], endObject: endObject, searchValue: searchValue, loading: loading, handleSaveMiddleInstance: saveMiddleInstance, handleRemoveMiddleInstance: removeMiddleInstance, setSearchValue: setSearchValue, setSnackbarError: setSnackbarError, snackbarError: snackbarError, selectedOptions: selectedOptions, setSelectedOptions: setSelectedOptions, setDropdownSelections: setDropDownSelections, fieldHeight: fieldHeight, hasDescription: hasDescription }))));
+};
+export default DropdownRepeatableField;

package/dist/published/components/custom/FormV2/components/FormFieldTypes/CollectionFiles/DropdownRepeatableFieldInput.d.ts

@@ -0,0 +1,40 @@
+import { DropdownViewLayout, InputParameter, Obj, ObjectInstance, Property } from '@evoke-platform/context';
+import React from 'react';
+import { AutocompleteOption } from '../../../../../core';
+type DropdownRepeatableFieldInputProps = {
+    id: string;
+    fieldDefinition: InputParameter | Property;
+    readOnly: boolean;
+    layout?: DropdownViewLayout;
+    middleObjectInstances: ObjectInstance[];
+    endObjectInstances: ObjectInstance[];
+    endObject: Pick<Obj, 'id' | 'name' | 'properties'>;
+    searchValue: string;
+    loading: boolean;
+    fieldHeight?: 'small' | 'medium';
+    handleSaveMiddleInstance: (endObjectId: string, endObjectName: string) => void;
+    handleRemoveMiddleInstance: (instanceId: string) => void;
+    setSearchValue: (value: string) => void;
+    setSelectedOptions: (selectedOptions: DropdownRepeatableFieldInputOption[]) => void;
+    selectedOptions: DropdownRepeatableFieldInputOption[];
+    setSnackbarError: (snackbarError: {
+        showAlert: boolean;
+        message?: string;
+        isError: boolean;
+    }) => void;
+    snackbarError: {
+        showAlert: boolean;
+        message?: string;
+        isError: boolean;
+    };
+    setDropdownSelections?: (middleObjectInstances: ObjectInstance[]) => void;
+    hasDescription?: boolean;
+};
+export type DropdownRepeatableFieldInputOption = AutocompleteOption & {
+    endObjectId: string;
+    middleObjectId?: string;
+    subLabel?: string;
+    hidden?: boolean;
+};
+export declare const DropdownRepeatableFieldInput: (props: DropdownRepeatableFieldInputProps) => React.JSX.Element;
+export default DropdownRepeatableFieldInput;

package/dist/published/components/custom/FormV2/components/FormFieldTypes/CollectionFiles/DropdownRepeatableFieldInput.js

@@ -0,0 +1,95 @@
+import { difference, isEmpty, isObject } from 'lodash';
+import Handlebars from 'no-eval-handlebars';
+import React, { useEffect, useState } from 'react';
+import { Snackbar, TextField, Typography } from '../../../../../core';
+import FormField from '../../../../FormField';
+import { normalizeDates } from '../../utils';
+const isDropdownRepeatableFieldInputOption = (option) => isObject(option) && 'label' in option && 'endObjectId' in option;
+export const DropdownRepeatableFieldInput = (props) => {
+    const { id, fieldDefinition, readOnly, layout, middleObjectInstances, endObjectInstances, endObject, searchValue, loading, handleSaveMiddleInstance, handleRemoveMiddleInstance, setSearchValue, selectedOptions, setSnackbarError, snackbarError, setDropdownSelections, fieldHeight, hasDescription, } = props;
+    const [selectOptions, setSelectOptions] = useState([]);
+    useEffect(() => {
+        setDropdownSelections && setDropdownSelections(middleObjectInstances);
+    }, [middleObjectInstances]);
+    useEffect(() => {
+        const manyToManyPropertyId = fieldDefinition.manyToManyPropertyId;
+        if (manyToManyPropertyId) {
+            const enums = endObjectInstances.map((endObjectInstance) => {
+                const normalizedInstance = normalizeDates(endObjectInstance, endObject);
+                return {
+                    label: normalizedInstance.name,
+                    subLabel: layout?.secondaryTextExpression
+                        ? compileExpression(normalizedInstance, layout.secondaryTextExpression)
+                        : undefined,
+                    endObjectId: normalizedInstance.id,
+                    value: undefined,
+                };
+            });
+            setSelectOptions([
+                ...enums,
+                ...selectedOptions
+                    .filter((selectedOption) => !enums.find((availableOption) => availableOption.endObjectId === selectedOption.endObjectId))
+                    .map((option) => ({ ...option, hidden: true })),
+            ]);
+        }
+    }, [endObjectInstances, layout]);
+    const handleChange = (key, newSelectedOptions) => {
+        // Delete middle objects that have been removed
+        // Add middle objects that have been added
+        // You can only really add or remove one value at a time
+        const addedValues = difference(newSelectedOptions, selectedOptions);
+        if (!isEmpty(addedValues)) {
+            addedValues.forEach((newValue) => {
+                if (isDropdownRepeatableFieldInputOption(newValue) &&
+                    fieldDefinition.relatedPropertyId &&
+                    fieldDefinition.manyToManyPropertyId) {
+                    handleSaveMiddleInstance(newValue.endObjectId, newValue.label);
+                }
+            });
+        }
+        const removedValues = difference(selectedOptions, newSelectedOptions);
+        if (!isEmpty(removedValues)) {
+            removedValues.forEach((removedValue) => {
+                if (isObject(removedValue) && removedValue.middleObjectId) {
+                    handleRemoveMiddleInstance(removedValue.middleObjectId);
+                }
+            });
+        }
+    };
+    const compileExpression = (instance, expression) => {
+        const template = Handlebars.compileAST(expression);
+        return template(instance);
+    };
+    return (React.createElement(React.Fragment, null, !readOnly ? (fieldDefinition && (React.createElement(React.Fragment, null,
+        React.createElement(FormField, { id: id, property: {
+                ...fieldDefinition,
+                type: 'array',
+                // eslint-disable-next-line @typescript-eslint/no-explicit-any
+                enum: selectOptions,
+            }, onChange: handleChange, defaultValue: selectedOptions, isOptionEqualToValue: (option, value) => isDropdownRepeatableFieldInputOption(value) &&
+                isDropdownRepeatableFieldInputOption(option) &&
+                option.endObjectId === value.endObjectId, size: fieldHeight, renderOption: (props, option) => {
+                return isObject(props) && isDropdownRepeatableFieldInputOption(option) ? (React.createElement("li", { ...props, key: option.endObjectId },
+                    React.createElement(Typography, null,
+                        option.label,
+                        React.createElement("br", null),
+                        React.createElement(Typography, { variant: "caption", color: "#586069" }, option.subLabel ? option.subLabel : '')))) : null;
+            }, disableCloseOnSelect: true, additionalProps: {
+                filterOptions: (options) => {
+                    return options.filter((option) => !option.hidden);
+                },
+                inputValue: searchValue,
+                renderInput: (params) => (React.createElement(TextField, { ...params, inputProps: {
+                        ...params.inputProps,
+                        ...(hasDescription
+                            ? { 'aria-describedby': `${id}-description` }
+                            : undefined),
+                    }, onChange: (event) => {
+                        setSearchValue(event.target.value);
+                    } })),
+                loading,
+                sortBy: 'NONE',
+            } }),
+        React.createElement(Snackbar, { open: snackbarError.showAlert, handleClose: () => setSnackbarError({ isError: snackbarError.isError, showAlert: false }), message: snackbarError.message, error: snackbarError.isError })))) : (React.createElement(Typography, null, selectedOptions && selectedOptions.map((option) => option.label).join(', ')))));
+};
+export default DropdownRepeatableFieldInput;

package/dist/published/components/custom/FormV2/components/FormFieldTypes/CollectionFiles/RepeatableField.d.ts

@@ -0,0 +1,12 @@
+import { InputParameter, Property, ViewLayoutEntityReference } from '@evoke-platform/context';
+import React from 'react';
+import { FieldValues } from 'react-hook-form';
+export type ObjectPropertyInputProps = {
+    fieldDefinition: InputParameter | Property;
+    instance?: FieldValues;
+    canUpdateProperty: boolean;
+    criteria?: object;
+    viewLayout?: ViewLayoutEntityReference;
+};
+declare const RepeatableField: (props: ObjectPropertyInputProps) => React.JSX.Element;
+export default RepeatableField;