@evoke-platform/ui-components 1.1.0-testing.11 → 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/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/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.js

@@ -1,7 +1,7 @@
 import React from 'react';
 import { Button, Form } from '../index';
 export default {
-    title: 'Input/Form',
+    title: 'Custom/Form',
     component: Form,
 };
 const object = {

package/package.json

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