@evoke-platform/ui-components 1.4.0-testing.1 → 1.4.0-testing.3

package/dist/published/components/custom/Form/tests/Form.test.js

@@ -0,0 +1,112 @@
+import { ApiServices } from '@evoke-platform/context';
+import { render, screen, waitFor, within } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
+import axios from 'axios';
+import { isEqual } from 'lodash';
+import { http, HttpResponse } from 'msw';
+import { setupServer } from 'msw/node';
+import React from 'react';
+import { it } from 'vitest';
+import Form from '../Common/Form';
+import { licenseObject, npLicense, npSpecialtyType1, npSpecialtyType2, rnLicense, rnSpecialtyType1, rnSpecialtyType2, specialtyObject, specialtyTypeObject, } from './test-data';
+const removePoppers = () => {
+    const portalSelectors = ['.MuiAutocomplete-popper'];
+    portalSelectors.forEach((selector) => {
+        // eslint-disable-next-line testing-library/no-node-access
+        document.querySelectorAll(selector).forEach((el) => el.remove());
+    });
+};
+describe('Form component', () => {
+    let server;
+    let apiServices;
+    beforeAll(() => {
+        server = setupServer(http.get('/data/objects/specialtyType/effective', () => HttpResponse.json(specialtyTypeObject)), http.get('/data/objects/license/effective', () => HttpResponse.json(licenseObject)), http.get('/data/objects/license/instances', () => {
+            return HttpResponse.json([rnLicense, npLicense]);
+        }), http.get('/data/objects/specialtyType/instances', (req) => {
+            const filter = new URL(req.request.url).searchParams.get('filter');
+            if (filter) {
+                const whereFilter = JSON.parse(filter).where;
+                // The two objects in the array of conditions in the "where" filter represent the potential filters that can be applied when retrieving "specialty" instances.
+                // The first object is for the the validation criteria, but it is empty if the "license" field, which is referenced in the validation criteria, hasn't been filled out yet.
+                // The second object is for the search criteria which the user enters in the "specialty" field, but it is empty if no search text has been entered.
+                if (isEqual(whereFilter, { and: [{}, {}] }))
+                    return HttpResponse.json([
+                        rnSpecialtyType1,
+                        rnSpecialtyType2,
+                        npSpecialtyType1,
+                        npSpecialtyType2,
+                    ]);
+                else if (isEqual(whereFilter, { and: [{ 'licenseType.id': 'rnLicenseType' }, {}] }))
+                    return HttpResponse.json([rnSpecialtyType1, rnSpecialtyType2]);
+                else if (isEqual(whereFilter, { and: [{ 'licenseType.id': 'npLicenseType' }, {}] }))
+                    return HttpResponse.json([npSpecialtyType1, npSpecialtyType2]);
+            }
+        }));
+        server.listen();
+    });
+    beforeEach(() => {
+        apiServices = new ApiServices(axios.create());
+    });
+    afterAll(() => {
+        server.close();
+    });
+    afterEach(() => {
+        server.resetHandlers();
+        removePoppers();
+    });
+    describe('validation criteria', () => {
+        it(`filters related object field with validation criteria that references a related object's nested data`, async () => {
+            const user = userEvent.setup();
+            server.use(http.get('/data/objects/license/instances/rnLicense', (req) => {
+                const expand = new URL(req.request.url).searchParams.get('expand');
+                if (expand === 'licenseType.id') {
+                    return HttpResponse.json(rnLicense);
+                }
+            }));
+            render(React.createElement(Form, { actionId: '_create', actionType: 'create', object: specialtyObject, apiServices: apiServices }));
+            const license = await screen.findByRole('combobox', { name: 'License' });
+            // Validate that specialty type dropdown is rendering all options
+            let specialtyType = await screen.findByRole('combobox', { name: 'Specialty Type' });
+            await user.click(specialtyType);
+            let openAutocomplete = await screen.findByRole('listbox');
+            await within(openAutocomplete).findByRole('option', { name: 'RN Specialty Type #1' });
+            await within(openAutocomplete).findByRole('option', { name: 'RN Specialty Type #2' });
+            await within(openAutocomplete).findByRole('option', { name: 'NP Specialty Type #1' });
+            await within(openAutocomplete).findByRole('option', { name: 'NP Specialty Type #2' });
+            // Close the specialty type dropdown
+            removePoppers();
+            // Select a license from the dropdown
+            await user.click(license);
+            const rnLicenseOption = await screen.findByRole('option', { name: 'RN License' });
+            await user.click(rnLicenseOption);
+            // Validate that specialty type dropdown is only rendering specialty types that are associated with the selected license.
+            specialtyType = await screen.findByRole('combobox', { name: 'Specialty Type' });
+            await user.click(specialtyType);
+            openAutocomplete = await screen.findByRole('listbox');
+            await within(openAutocomplete).findByRole('option', { name: 'RN Specialty Type #1' });
+            await within(openAutocomplete).findByRole('option', { name: 'RN Specialty Type #2' });
+            await waitFor(() => expect(within(openAutocomplete).queryByRole('option', { name: 'NP Specialty Type #1' })).to.be.null);
+            await waitFor(() => expect(within(openAutocomplete).queryByRole('option', { name: 'NP Specialty Type #2' })).to.be.null);
+        });
+        it(`filters related object field with validation criteria that references a defaulted related object's nested data`, async () => {
+            const user = userEvent.setup();
+            server.use(http.get('/data/objects/license/instances/rnLicense', (req) => {
+                const expand = new URL(req.request.url).searchParams.get('expand');
+                if (expand === 'licenseType.id') {
+                    return HttpResponse.json(rnLicense);
+                }
+            }));
+            render(React.createElement(Form, { actionId: '_create', actionType: 'create', object: specialtyObject, apiServices: apiServices, associatedObject: { propertyId: 'license', instanceId: 'rnLicense' } }));
+            // Validate that the license field is hidden
+            await waitFor(() => expect(screen.queryByRole('combobox', { name: 'License' })).to.be.null);
+            // Validate that specialty type dropdown is only rendering specialty types that are associated with the selected license.
+            const specialtyType = await screen.findByRole('combobox', { name: 'Specialty Type' });
+            await user.click(specialtyType);
+            const openAutocomplete = await screen.findByRole('listbox');
+            await within(openAutocomplete).findByRole('option', { name: 'RN Specialty Type #1' });
+            await within(openAutocomplete).findByRole('option', { name: 'RN Specialty Type #2' });
+            await waitFor(() => expect(within(openAutocomplete).queryByRole('option', { name: 'NP Specialty Type #1' })).to.be.null);
+            await waitFor(() => expect(within(openAutocomplete).queryByRole('option', { name: 'NP Specialty Type #2' })).to.be.null);
+        });
+    });
+});

package/dist/published/components/custom/Form/tests/test-data.d.ts

@@ -0,0 +1,13 @@
+import { Obj, ObjectInstance } from '@evoke-platform/context';
+export declare const licenseObject: Obj;
+export declare const licenseTypeObject: Obj;
+export declare const specialtyObject: Obj;
+export declare const specialtyTypeObject: Obj;
+export declare const rnLicense: ObjectInstance;
+export declare const npLicense: ObjectInstance;
+export declare const rnLicenseType: ObjectInstance;
+export declare const npLicesneType: ObjectInstance;
+export declare const rnSpecialtyType1: ObjectInstance;
+export declare const rnSpecialtyType2: ObjectInstance;
+export declare const npSpecialtyType1: ObjectInstance;
+export declare const npSpecialtyType2: ObjectInstance;

package/dist/published/components/custom/Form/tests/test-data.js

@@ -0,0 +1,282 @@
+// Objects
+export const licenseObject = {
+    id: 'license',
+    name: 'License',
+    properties: [
+        {
+            id: 'name',
+            name: 'License Number',
+            type: 'string',
+        },
+        {
+            id: 'status',
+            name: 'Status',
+            type: 'string',
+            enum: ['Active', 'Inactive'],
+        },
+        {
+            id: 'licenseType',
+            name: 'License Type',
+            type: 'object',
+            objectId: 'licenseType',
+        },
+    ],
+    actions: [
+        {
+            id: '_update',
+            name: 'Update',
+            type: 'update',
+            outputEvent: 'License Updated',
+        },
+        {
+            id: '_delete',
+            name: 'Delete',
+            type: 'delete',
+            outputEvent: 'License Deleted',
+        },
+        {
+            id: '_create',
+            name: 'Create',
+            type: 'create',
+            outputEvent: 'License Created',
+        },
+    ],
+};
+export const licenseTypeObject = {
+    id: 'licenseType',
+    name: 'License Type',
+    properties: [
+        {
+            id: 'name',
+            name: 'Name',
+            type: 'string',
+        },
+        {
+            id: 'licenseNumberPrefix',
+            name: 'License Number Prefix',
+            type: 'string',
+        },
+    ],
+    actions: [
+        {
+            id: '_update',
+            name: 'Update',
+            type: 'update',
+            outputEvent: 'License Type Updated',
+        },
+        {
+            id: '_delete',
+            name: 'Delete',
+            type: 'delete',
+            outputEvent: 'License Type Deleted',
+        },
+        {
+            id: '_create',
+            name: 'Create',
+            type: 'create',
+            outputEvent: 'License Type Created',
+        },
+    ],
+};
+export const specialtyObject = {
+    id: 'specialty',
+    name: 'Specialty',
+    properties: [
+        {
+            id: 'name',
+            name: 'Name',
+            type: 'string',
+        },
+        {
+            id: 'specialtyType',
+            name: 'Specialty Type',
+            type: 'object',
+            objectId: 'specialtyType',
+        },
+        {
+            id: 'license',
+            name: 'License',
+            type: 'object',
+            objectId: 'license',
+        },
+    ],
+    actions: [
+        {
+            id: '_update',
+            name: 'Update',
+            type: 'update',
+            outputEvent: 'Specialty Updated',
+        },
+        {
+            id: '_delete',
+            name: 'Delete',
+            type: 'delete',
+            outputEvent: 'Specialty Deleted',
+        },
+        {
+            id: '_create',
+            name: 'Create',
+            type: 'create',
+            outputEvent: 'Specialty Created',
+            parameters: [
+                {
+                    id: 'name',
+                    name: 'Name',
+                    type: 'string',
+                },
+                {
+                    id: 'specialtyType',
+                    name: 'Specialty Type',
+                    type: 'object',
+                    objectId: 'specialtyType',
+                    validation: {
+                        criteria: {
+                            $and: [{ 'licenseType.id': '{{{input.license.licenseType.id}}}' }],
+                        },
+                    },
+                },
+                {
+                    id: 'license',
+                    name: 'License',
+                    type: 'object',
+                    objectId: 'license',
+                },
+            ],
+            form: {
+                entries: [
+                    {
+                        parameterId: 'name',
+                        type: 'input',
+                        display: {
+                            label: 'Name',
+                        },
+                    },
+                    {
+                        parameterId: 'specialtyType',
+                        type: 'input',
+                        display: {
+                            label: 'Specialty Type',
+                            relatedObjectDisplay: 'dropdown',
+                        },
+                    },
+                    {
+                        parameterId: 'license',
+                        type: 'input',
+                        display: {
+                            label: 'License',
+                            relatedObjectDisplay: 'dropdown',
+                        },
+                    },
+                ],
+            },
+        },
+    ],
+};
+export const specialtyTypeObject = {
+    id: 'specialtyType',
+    name: 'Specialty Type',
+    properties: [
+        {
+            id: 'name',
+            name: 'Name',
+            type: 'string',
+        },
+        {
+            id: 'licenseType',
+            name: 'License Type',
+            type: 'object',
+            objectId: 'licenseType',
+        },
+    ],
+    actions: [
+        {
+            id: '_update',
+            name: 'Update',
+            type: 'update',
+            outputEvent: 'Specialty Type Updated',
+        },
+        {
+            id: '_delete',
+            name: 'Delete',
+            type: 'delete',
+            outputEvent: 'Specialty Type Deleted',
+        },
+        {
+            id: '_create',
+            name: 'Create',
+            type: 'create',
+            outputEvent: 'Specialty Type Created',
+        },
+    ],
+};
+// Instances
+export const rnLicense = {
+    id: 'rnLicense',
+    objectId: 'license',
+    name: 'RN License',
+    licenseType: {
+        id: 'rnLicenseType',
+        name: 'RN License Type',
+    },
+    status: 'Active',
+};
+export const npLicense = {
+    id: 'npLicense',
+    objectId: 'license',
+    name: 'NP License',
+    licenseType: {
+        id: 'npLicenseType',
+        name: 'NP License Type',
+    },
+    status: 'Active',
+};
+export const rnLicenseType = {
+    id: 'rnLicenseType',
+    objectId: 'licenseType',
+    name: 'RN License Type',
+    licenseNumberPrefix: 'RN',
+};
+export const npLicesneType = {
+    id: 'npLicenseType',
+    objectId: 'licenseType',
+    name: 'NP License Type',
+    licenseNumberPrefix: 'NP',
+};
+export const rnSpecialtyType1 = {
+    id: 'specialtyType1',
+    objectId: 'specialtyType',
+    name: 'RN Specialty Type #1',
+    int: 1,
+    licenseType: {
+        id: 'rnLicenseType',
+        name: 'RN License Type',
+    },
+};
+export const rnSpecialtyType2 = {
+    id: 'specialtyType2',
+    objectId: 'specialtyType',
+    name: 'RN Specialty Type #2',
+    int: 1,
+    licenseType: {
+        id: 'rnLicenseType',
+        name: 'RN License Type',
+    },
+};
+export const npSpecialtyType1 = {
+    id: 'specialtyType3',
+    objectId: 'specialtyType',
+    name: 'NP Specialty Type #1',
+    licenseType: {
+        id: 'npLicenseType',
+        name: 'NP License Type',
+    },
+};
+export const npSpecialtyType2 = {
+    id: 'specialtyType4',
+    objectId: 'specialtyType',
+    name: 'NP Specialty Type #2',
+    licenseType: {
+        id: 'npLicenseType',
+        name: 'NP License Type',
+    },
+};

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

@@ -1,4 +1,4 @@
-import { ActionInput, ActionInputType, ApiServices, FormEntry, InputParameter, InputParameterReference, Obj, ObjectInstance, Property, PropertyType } from '@evoke-platform/context';
+import { ActionInput, ActionInputType, ApiServices, FormEntry, InputParameter, InputParameterReference, Obj, ObjectInstance, Property, PropertyType, UserAccount } from '@evoke-platform/context';
 import { ReactComponent } from '@formio/react';
 import { LocalDateTime } from '@js-joda/core';
 import { AutocompleteOption } from '../../core';
@@ -21,7 +21,11 @@ export declare function getMiddleObject(instance: ObjectInstance, property: Prop
 } | undefined;
 export declare function getMiddleInstance(instanceId: string, property: Property, middleObjectInstances: ObjectInstance[]): ObjectInstance | undefined;
 export declare function getPrefixedUrl(url: string): string;
-export declare function addObjectPropertiesToComponentProps(properties: Property[], formComponents: any[], instance?: ObjectInstance, objectPropertyInputProps?: ObjectPropertyInputProps, autoSave?: (data: Record<string, unknown>) => void, readOnly?: boolean, defaultPages?: Record<string, string>, navigateTo?: (path: string) => void, queryAddresses?: (query: string) => Promise<Address[]>, apiServices?: ApiServices, isModal?: boolean, fieldHeight?: 'small' | 'medium', richTextEditor?: typeof ReactComponent): Promise<ActionInput[]>;
+export declare function flattenFormComponents(components?: ActionInput[]): ActionInput[];
+export declare function addObjectPropertiesToComponentProps(properties: Property[], formComponents: any[], allCriteriaInputs?: string[], instance?: ObjectInstance, objectPropertyInputProps?: ObjectPropertyInputProps, associatedObject?: {
+    instanceId?: string;
+    propertyId?: string;
+}, autoSave?: (data: Record<string, unknown>) => void, readOnly?: boolean, defaultPages?: Record<string, string>, navigateTo?: (path: string) => void, queryAddresses?: (query: string) => Promise<Address[]>, apiServices?: ApiServices, isModal?: boolean, fieldHeight?: 'small' | 'medium', richTextEditor?: typeof ReactComponent): Promise<ActionInput[]>;
 export declare function getDefaultValue(initialValue: unknown, selectOptions?: AutocompleteOption[]): unknown;
 export declare const buildComponentPropsFromObjectProperties: (properties: Property[], objectId: string, instance?: ObjectInstance, objectPropertyInputProps?: ObjectPropertyInputProps, hasActionPermissions?: boolean, autoSave?: ((data: Record<string, unknown>) => void) | undefined, readOnly?: boolean, queryAddresses?: ((query: string) => Promise<Address[]>) | undefined, isModal?: boolean, fieldHeight?: 'small' | 'medium', richTextEditor?: typeof ReactComponent) => unknown[];
 export declare const buildComponentPropsFromDocumentProperties: (documentProperties: [string, unknown][], readOnly?: boolean, autoSave?: ((data: Record<string, unknown>) => void) | undefined, fieldHeight?: 'small' | 'medium') => {
@@ -35,8 +39,10 @@ export declare const buildComponentPropsFromDocumentProperties: (documentPropert
 }[];
 export declare const OPERATOR_MAP: Record<string, string>;
 export declare function transformToWhere(mongoQuery: object): Record<string, unknown>;
-export declare function updateCriteriaInputs(criteria: Record<string, unknown>, field: string, fieldValue: string, isInputField?: boolean): void;
-export declare function getAllCriteriaInputs(criteria: Record<string, unknown>): string[];
+export declare function updateCriteriaInputs(criteria: Record<string, unknown>, data: Record<string, unknown>, user?: UserAccount): Record<string, unknown>;
+export declare function getCriteriaInputs(criteria?: Record<string, unknown>): string[];
+export declare function getAllCriteriaInputs(components: ActionInput[] | InputParameter[]): string[];
+export declare function populateInstanceWithNestedData(instanceId: string, objectId: string, paths: string[], apiServices: ApiServices): Promise<ObjectInstance>;
 export declare function isPropertyVisible(conditional: {
     when: string;
     show: boolean;