@evoke-platform/ui-components 1.1.0-testing.10 → 1.1.0-testing.12

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

@@ -2,40 +2,77 @@ import { ApiServices, Obj, ObjectInstance, UserAccount } from '@evoke-platform/c
 import { ReactComponent } from '@formio/react';
 import React from 'react';
 import '../../../../styles/form-component.css';
-import { Document, ObjectPropertyInputProps } from '../types';
+import { Address, Document, ObjectPropertyInputProps } from '../types';
 type OnSaveResponse = {
     isSuccessful: boolean;
     error?: Record<string, unknown>;
 };
 export type FormProps = {
-    formKey?: number;
-    object?: Obj;
-    instance?: ObjectInstance;
-    document?: Document;
-    user?: UserAccount;
-    onSave?: (data: Record<string, unknown>, setSubmitting?: (value: boolean) => void) => Promise<OnSaveResponse>;
-    submitButtonLabel?: string;
-    isReadOnly?: boolean;
-    apiServices?: ApiServices | undefined;
-    navigateTo?: (path: string) => void;
-    closeModal?: () => void;
-    clearable?: boolean;
-    objectInputCommonProps?: ObjectPropertyInputProps;
+    /** An optional identifier for the action associated with the form. */
     actionId?: string;
-    onAutoSave?: (data: Record<string, unknown>) => Promise<{
-        isSuccessful: boolean;
-        error?: Record<string, unknown>;
-    }>;
+    /** The type of action associated with the form. */
     actionType?: string;
+    /** Optional API services for the form. */
+    apiServices?: ApiServices | undefined;
+    /** An object representing an associated object with optional `instanceId` and `propertyId` properties. */
     associatedObject?: {
         instanceId?: string;
         propertyId?: string;
     };
-    queryAddresses?: unknown;
+    /**
+     * Whether the form can be cleared.
+     * @default false
+     * */
+    clearable?: boolean;
+    /** An optional document related to the form. */
+    document?: Document;
+    /** Defines the height of the fields in the form. */
     fieldHeight?: 'small' | 'medium';
+    /** An optional unique identifier for the form instance. */
+    formKey?: number;
+    /**
+     * A reference to the form for direct manipulation.
+     * i.e: formRef.current.submit({data: formRef.current.data}, 'submit', (error?: Record<string, unknown>) => {...}, (value: boolean) => {...})
+     * */
+    formRef?: React.MutableRefObject<FormRef | undefined>;
+    /** A React component used as a rich text editor. */
     richTextEditor?: typeof ReactComponent;
+    /**
+     * Whether to hide the buttons in the form.
+     * @default false
+     * */
     hideButtons?: boolean;
-    formRef?: React.MutableRefObject<FormRef | undefined>;
+    /** An optional instance of an object associated with the form. */
+    instance?: ObjectInstance;
+    /**
+     * Whether the form is in read-only mode.
+     * @default false
+     * */
+    isReadOnly?: boolean;
+    /** An optional object associated with the form. */
+    object?: Obj;
+    /** Common properties for object input fields. */
+    objectInputCommonProps?: ObjectPropertyInputProps;
+    /** An optional user account associated with the form. */
+    user?: UserAccount;
+    /**
+     * The label for the submit button.
+     * @default Submit
+     * */
+    submitButtonLabel?: string;
+    /** A function to close a modal if the form is in one. */
+    closeModal?: () => void;
+    /** A function to navigate to a different path. */
+    navigateTo?: (path: string) => void;
+    /** A callback function to save draft the form data. */
+    onAutoSave?: (data: Record<string, unknown>) => Promise<{
+        isSuccessful: boolean;
+        error?: Record<string, unknown>;
+    }>;
+    /** A callback function to save the form data. It returns a promise with a response. */
+    onSave?: (data: Record<string, unknown>, setSubmitting?: (value: boolean) => void) => Promise<OnSaveResponse>;
+    /** A function to query addresses related to the form. */
+    queryAddresses?: (query: string) => Promise<Address[]>;
 };
 export type FormRef = {
     submit: (submission: Record<string, unknown>, type: 'submit' | 'draft', setError: (error?: Record<string, unknown>) => void, setSubmitting?: (value: boolean) => void) => void;

package/dist/published/components/custom/Form/Common/Form.js

@@ -445,7 +445,7 @@ export function Form(props) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         , { 
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            onChange: (e) => setFormData(e.data), key: closeModal ? undefined : formKey, form: {
+            onChange: (e) => !isEqual(e.data, formData) && setFormData(e.data), key: closeModal ? undefined : formKey, form: {
                 display: 'form',
                 components: componentProps,
             }, formReady: handleFormReady })) : (React.createElement(Box, null,

package/dist/published/components/custom/Form/FormComponents/ButtonComponent.d.ts

@@ -21,11 +21,10 @@ type ButtonProps = {
 };
 export declare class ButtonComponent extends ReactComponent {
     [x: string]: any;
-    component: ButtonComponentProps;
     componentRoot?: Root;
     constructor(component: ButtonComponentProps, options: any, data: any);
     setError(error?: Record<string, unknown>): void;
-    getButton: (buttonAction: 'cancel' | 'submit' | 'save-draft') => Button | undefined;
+    getButton: (buttonAction: 'cancel' | 'submit' | 'save-draft') => any;
     handleCancel: (event: any) => void;
     handleSaveDraft: (setSubmitting: (value: boolean) => void) => void;
     handleSubmit: (setSubmitting: (value: boolean) => void) => void;

package/dist/published/components/custom/Form/FormComponents/DocumentComponent/DocumentComponent.d.ts

@@ -1,10 +1,9 @@
 import { ReactComponent } from '@formio/react';
 import { Root } from 'react-dom/client';
-import { BaseFormComponentProps, SavedDocumentReference } from '../../types';
+import { SavedDocumentReference } from '../../types';
 export declare class DocumentComponent extends ReactComponent {
     [x: string]: any;
     static schema: any;
-    component: BaseFormComponentProps;
     errorDetails: any;
     componentRoot?: Root;
     constructor(component: any, options: any, data: any);

package/dist/published/components/custom/Form/FormComponents/FormFieldComponent.d.ts

@@ -15,7 +15,6 @@ type FormFieldComponentProps = Omit<BaseFormComponentProps, 'property'> & {
 export declare class FormFieldComponent extends ReactComponent {
     [x: string]: any;
     static schema: any;
-    component: FormFieldComponentProps;
     errorDetails: any;
     /**
      * Called when the component has been instantiated. This is useful to define

package/dist/published/components/custom/Form/FormComponents/ImageComponent/ImageComponent.d.ts

@@ -4,9 +4,6 @@ import { BaseFormComponentProps } from '../../types';
 export declare class ImageComponent extends ReactComponent {
     [x: string]: any;
     static schema: any;
-    component: BaseFormComponentProps & {
-        initialValue?: string;
-    };
     errorDetails: any;
     componentRoot?: Root;
     constructor(component: BaseFormComponentProps, options: any, data: any);

package/dist/published/components/custom/Form/FormComponents/ObjectComponent/ObjectComponent.d.ts

@@ -12,7 +12,6 @@ export declare class ObjectComponent extends ReactComponent {
     relatedObject?: Obj;
     [x: string]: any;
     static schema: any;
-    component: ObjectComponentProps;
     errorDetails: any;
     componentRoot?: Root;
     criteria?: Record<string, unknown>;

package/dist/published/components/custom/Form/FormComponents/RepeatableFieldComponent/ActionDialog.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 import { Action, ApiServices, Obj, Property, UserAccount } from '@evoke-platform/context';
-import { ObjectPropertyInputProps } from '../../types';
+import { Address, ObjectPropertyInputProps } from '../../types';
 export type ActionDialogProps = {
     open: boolean;
     onClose: () => void;
@@ -15,7 +15,7 @@ export type ActionDialogProps = {
     instanceId?: string;
     relatedProperty?: Property;
     apiServices: ApiServices;
-    queryAddresses?: unknown;
+    queryAddresses?: (query: string) => Promise<Address[]>;
     user?: UserAccount;
 };
 export declare const ActionDialog: (props: ActionDialogProps) => JSX.Element;

package/dist/published/components/custom/Form/FormComponents/RepeatableFieldComponent/RepeatableField.d.ts

@@ -1,11 +1,12 @@
 /// <reference types="react" />
 import { ApiServices, ObjectInstance, Property, UserAccount, ViewLayoutEntityReference } from '@evoke-platform/context';
+import { Address } from '../../types';
 export type ObjectPropertyInputProps = {
     property: Property;
     instance: ObjectInstance;
     canUpdateProperty: boolean;
     apiServices: ApiServices;
-    queryAddresses?: unknown;
+    queryAddresses?: (query: string) => Promise<Address[]>;
     user?: UserAccount;
     viewLayout?: ViewLayoutEntityReference;
 };

package/dist/published/components/custom/Form/FormComponents/RepeatableFieldComponent/RepeatableFieldComponent.d.ts

@@ -10,7 +10,6 @@ type RepeatableFieldComponentProps = BaseFormComponentProps & {
 export declare class RepeatableFieldComponent extends ReactComponent {
     [x: string]: any;
     static schema: any;
-    component: RepeatableFieldComponentProps;
     criteria: Record<string, any> | undefined;
     updatedCriteria: Record<string, any>;
     constructor(component: RepeatableFieldComponentProps, options: any, data: any);

package/dist/published/components/custom/Form/FormComponents/UserComponent/UserComponent.d.ts

@@ -6,9 +6,6 @@ export declare class UserComponent extends ReactComponent {
     [x: string]: any;
     static schema: any;
     errorDetails: any;
-    component: BaseFormComponentProps & {
-        initialValue?: string;
-    };
     componentRoot?: Root;
     criteria: Record<string, unknown> | undefined;
     updatedCriteria: Record<string, unknown>;

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

@@ -2,7 +2,7 @@ import { ActionInput, ActionInputType, ApiServices, FormEntry, InputParameter, I
 import { ReactComponent } from '@formio/react';
 import { LocalDateTime } from '@js-joda/core';
 import { AutocompleteOption } from '../../core';
-import { ObjectPropertyInputProps } from './types';
+import { Address, ObjectPropertyInputProps } from './types';
 export declare function determineComponentType(properties: Property[], parameter?: InputParameter): ActionInputType | undefined;
 export declare function determineParameterType(componentType: string): PropertyType;
 export declare function getFlattenEntries(entries: FormEntry[]): InputParameterReference[];
@@ -21,9 +21,9 @@ 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?: unknown, apiServices?: ApiServices, isModal?: boolean, fieldHeight?: 'small' | 'medium', richTextEditor?: typeof ReactComponent): Promise<ActionInput[]>;
+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 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?: unknown, isModal?: boolean, fieldHeight?: 'small' | 'medium', richTextEditor?: typeof ReactComponent) => 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') => {
     type: string;
     key: string;

package/dist/published/stories/CriteriaBuilder.stories.js

@@ -1,7 +1,7 @@
 import React from 'react';
 import { CriteriaBuilder as BuildCriteria } from '../index';
 export default {
-    title: 'Input/CriteriaBuilder',
+    title: 'Custom/CriteriaBuilder',
     component: BuildCriteria,
 };
 const defaultProperties = [

package/dist/published/stories/Form.stories.d.ts

@@ -0,0 +1,6 @@
+import { ComponentMeta, ComponentStory } from '@storybook/react';
+import { Form } from '../index';
+declare const _default: ComponentMeta<typeof Form>;
+export default _default;
+export declare const FormWithButtons: ComponentStory<typeof Form>;
+export declare const FormWithNoButtons: ComponentStory<typeof Form>;

package/dist/published/stories/Form.stories.js

@@ -0,0 +1,82 @@
+import React from 'react';
+import { Button, Form } from '../index';
+export default {
+    title: 'Custom/Form',
+    component: Form,
+};
+const object = {
+    id: 'test',
+    name: 'Test',
+    properties: [
+        {
+            id: 'name',
+            name: 'Name',
+            type: 'string',
+            required: true,
+        },
+        {
+            id: 'decimal',
+            name: 'Decimal',
+            type: 'number',
+        },
+        {
+            id: 'integer',
+            name: 'Integer',
+            type: 'integer',
+        },
+    ],
+    actions: [
+        {
+            id: '_create',
+            name: 'Create Test',
+            type: 'create',
+            outputEvent: 'Test Created',
+        },
+        {
+            id: '_update',
+            name: 'Update Test',
+            type: 'update',
+            outputEvent: 'Test Updated',
+        },
+        {
+            id: '_delete',
+            name: 'Delete Test',
+            type: 'delete',
+            inputProperties: [],
+            outputEvent: 'Test Deleted',
+        },
+    ],
+};
+const FormWithButtonsTemplate = (args) => {
+    return React.createElement(Form, { ...args });
+};
+export const FormWithButtons = FormWithButtonsTemplate.bind({});
+FormWithButtons.args = {
+    actionId: '_update',
+    actionType: 'update',
+    object: object,
+    instance: { id: 'id', objectId: 'test', name: 'test', integer: 12, decimal: 12.5 },
+};
+const FormWithNoButtonsTemplate = (args) => {
+    return (React.createElement("div", null,
+        React.createElement(Form, { ...args }),
+        React.createElement(Button, { onClick: () => {
+                console.log(args.formRef?.current?.data);
+                args.formRef?.current?.data &&
+                    args.formRef.current.submit({ data: args.formRef.current.data }, 'submit', (error) => {
+                        console.log(error);
+                    });
+            } },
+            ' ',
+            "Submit",
+            ' ')));
+};
+export const FormWithNoButtons = FormWithNoButtonsTemplate.bind({});
+FormWithNoButtons.args = {
+    actionId: '_update',
+    actionType: 'update',
+    object: object,
+    instance: { id: 'id', objectId: 'test', name: 'test', integer: 12, decimal: 12.5 },
+    hideButtons: true,
+    formRef: { current: {} },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@evoke-platform/ui-components",
-    "version": "1.1.0-testing.10",
+    "version": "1.1.0-testing.12",
     "description": "",
     "main": "dist/published/index.js",
     "module": "dist/published/index.js",