@tsed/react-formio 1.10.11 → 1.10.14

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@tsed/react-formio",
-  "version": "1.10.11",
+  "version": "1.10.14",
+  "description": "Provide a react formio wrapper. Written in TypeScript.",
   "main": "dist/index.js",
   "module": "dist/index.modern.js",
   "source": "src/index.ts",
@@ -13,23 +14,23 @@
     "prettier": "prettier '{src,test}/**/*.{ts,tsx}' --write"
   },
   "dependencies": {
-    "@tsed/redux-utils": "1.10.11",
+    "@tsed/redux-utils": "1.10.14",
     "eventemitter2": "^6.4.3",
     "prop-types": "^15.7.2"
   },
   "peerDependencies": {
-    "choices.js": "^9.0.1",
-    "formiojs": "^4.12.7",
-    "lodash": "4.17.20",
-    "prop-types": "^15.7.2",
-    "react": "^16.14.0",
-    "react-is": "^17.0.1",
-    "react-table": "^7.6.3",
-    "tooltip.js": "^1.3.3"
+    "choices.js": ">=9.0.1",
+    "formiojs": ">=4.0.0",
+    "lodash": ">=4.17.20",
+    "prop-types": ">=15.7.2",
+    "react": ">=16.14.0",
+    "react-dom": ">=16.14.0",
+    "react-table": ">=7.6.3",
+    "tooltip.js": ">=1.3.3"
   },
   "devDependencies": {
-    "@tsed/tailwind": "1.10.11",
-    "@tsed/tailwind-formio": "1.10.11",
+    "@tsed/tailwind": "1.10.14",
+    "@tsed/tailwind-formio": "1.10.14",
     "eslint-plugin-jsx-a11y": "^6.5.1"
   },
   "repository": "https://github.com/TypedProject/tsed-formio",

package/readme.md

@@ -64,7 +64,7 @@ npm install formiojs choices.js --save // Install formiojs since it is a peerDep
 
 ## Usage
 
-```typescript
+```tsx
 import React from "react";
 import {FormBuilder} from "@tsed/react-formio";
 
@@ -88,47 +88,78 @@ The form component is the primary component of the system. It is what takes the
 
 #### Props
 
-| Name | Type | Default | Description |
-|---|---|---|---|
-| `src`  | url  |   | The url of the form definition. This is commonly from a form.io server. When using src, the form will automatically submit the data to that url as well.  |
-| `url` | url  |   | The url of the form definition. The form will not be loaded from this url and the submission will not be saved here either. This is used for file upload, oauth and other components or actions that need to know where the server is. Use this in connection with `form`  |
-| `form` | object |   | Instead of loading a form from the `src` url, you can preload the form definition and pass it in with the `form` prop. You should also set `url` if you are using any advanced components like file upload or oauth. |
-| `submission` | object | | Submission data to fill the form. You can either load a previous submission or create a submission with some pre-filled data. If you do not provide a submissions the form will initialize an empty submission using default values from the form. |
-| `options` | object | | an options object that can pass options to the formio.js Form that is rendered. You can set options such as `readOnly`, `noAlerts` or `hide`. There are [many options to be found in the formio.js library](https://github.com/formio/formio.js/wiki/Form-Renderer#options). |
+| Name         | Type   | Default | Description                                                                                                                                                                                                                                                                  |
+|--------------|--------|---------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `src`        | url    |         | The url of the form definition. This is commonly from a form.io server. When using src, the form will automatically submit the data to that url as well.                                                                                                                     |
+| `url`        | url    |         | The url of the form definition. The form will not be loaded from this url and the submission will not be saved here either. This is used for file upload, oauth and other components or actions that need to know where the server is. Use this in connection with `form`    |
+| `form`       | object |         | Instead of loading a form from the `src` url, you can preload the form definition and pass it in with the `form` prop. You should also set `url` if you are using any advanced components like file upload or oauth.                                                         |
+| `submission` | object |         | Submission data to fill the form. You can either load a previous submission or create a submission with some pre-filled data. If you do not provide a submissions the form will initialize an empty submission using default values from the form.                           |
+| `options`    | object |         | an options object that can pass options to the formio.js Form that is rendered. You can set options such as `readOnly`, `noAlerts` or `hide`. There are [many options to be found in the formio.js library](https://github.com/formio/formio.js/wiki/Form-Renderer#options). |
 
 #### Event Props
 
 You can respond to various events in the form. Simply pass in a prop with a function for one of these events.
 
-| Name | Parameters | Description |
-|---|---|---|
-| `onSubmit`  | `submission`: object | When the submit button is pressed and the submission has started. If `src` is not provided, this will be the final submit event.|
-| `onSubmitDone` | `submission`: object | When the submission has successfully been made to the server. This will only fire if `src` is set. |
-| `onChange` | `submission`: object, `submission.changed`: object of what changed, `submission.isValid`: boolean - if the submission passes validations. | A value in the submission has changed. |
-| `onError` | `errors`: array or string or boolean | Called when an error occurs during submission such as a validation issue. |
-| `onRender` | | Triggers when the form is finished rendering. |
-| `onCustomEvent` | { `type`: string - event type, `component`: object - triggering component, `data`: object - data for component, `event`: string - raw event } | Event that is triggered from a button configured with "Event" type. | 
-| `onPrevPage` | { `page`: integer - new page number, `submission`: object - submission data } | Triggered for wizards when "Previous" button is pressed |
-| `onNextPage` | { `page`: integer - new page number, `submission`: object - submission data } | Triggered for wizards when "Next" button is pressed |
-| `onFormReady` | `formInstance`: Webform/Wizard - form class instance | Called when the form gets ready state |
+| Name            | Parameters                                                                                                                                    | Description                                                                                                                      |
+|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|
+| `onSubmit`      | `submission`: object                                                                                                                          | When the submit button is pressed and the submission has started. If `src` is not provided, this will be the final submit event. |
+| `onSubmitDone`  | `submission`: object                                                                                                                          | When the submission has successfully been made to the server. This will only fire if `src` is set.                               |
+| `onChange`      | `submission`: object, `submission.changed`: object of what changed, `submission.isValid`: boolean - if the submission passes validations.     | A value in the submission has changed.                                                                                           |
+| `onError`       | `errors`: array or string or boolean                                                                                                          | Called when an error occurs during submission such as a validation issue.                                                        |
+| `onRender`      |                                                                                                                                               | Triggers when the form is finished rendering.                                                                                    |
+| `onCustomEvent` | { `type`: string - event type, `component`: object - triggering component, `data`: object - data for component, `event`: string - raw event } | Event that is triggered from a button configured with "Event" type.                                                              | 
+| `onPrevPage`    | { `page`: integer - new page number, `submission`: object - submission data }                                                                 | Triggered for wizards when "Previous" button is pressed                                                                          |
+| `onNextPage`    | { `page`: integer - new page number, `submission`: object - submission data }                                                                 | Triggered for wizards when "Next" button is pressed                                                                              |
+| `onFormReady`   | `formInstance`: Webform/Wizard - form class instance                                                                                          | Called when the form gets ready state                                                                                            |
 
 #### Example
 
+##### With src/url
+
 Give `Form` a `src` property and render:
 
-```javascript
+```tsx
 import React from 'react';
 import ReactDOM from 'react-dom';
 import {Form} from '@tsed/react-formio';
-```
 
-```javascript
 ReactDOM.render(
   <Form src="https://example.form.io/example" onSubmit={console.log} />
   , document.getElementById('example')
 );
 ```
 
+##### With form
+
+Give `Form` a `src` property and render:
+
+```tsx
+import React from 'react';
+import ReactDOM from 'react-dom';
+import {Form} from '@tsed/react-formio';
+ 
+interface MyFormData {
+  title: string;
+} 
+
+const form = {
+  display: 'form', 
+  components: [
+    {
+      key: 'title', 
+      type: 'textfield'
+    }
+  ]
+}
+
+ReactDOM.render(
+  <Form<MyFormData> form={form} onSubmit={(submission) => {
+    console.log(submission)
+  }} />
+  , document.getElementById('example')
+);
+```
+
 ### FormBuilder
 
 The [FormBuilder]([FormsTable](https://formio.tsed.io/?path=/story/reactformio-formbuilder--sandbox)) class can be used 
@@ -141,31 +172,29 @@ the [FormEdit](https://formio.tsed.io/?path=/story/reactformio-formedit--sandbox
 
 #### Props
 
-| Name | Type | Default | Description |
-|---|---|---|---|
-| `form` | object |   | This is the form definition object. It should at least have a `display` property set to form, wizard or pdf. |
-| `options` | object | | an options object that can pass options to the formio.js Form that is rendered. There are many options to be found in the formio.js library. |
+| Name      | Type   | Default | Description                                                                                                                                  |
+|-----------|--------|---------|----------------------------------------------------------------------------------------------------------------------------------------------|
+| `form`    | object |         | This is the form definition object. It should at least have a `display` property set to form, wizard or pdf.                                 |
+| `options` | object |         | an options object that can pass options to the formio.js Form that is rendered. There are many options to be found in the formio.js library. |
 
 #### Event Props
 
-| Name | Parameters | Description |
-|---|---|---|
-| `onChange`  | `schema`: object | Triggered any time the form definition changes |
-| `onEditComponent` | `component`: object | Triggered when the component settings dialog is opened |
-| `onSaveComponent` | `component`: object | Triggered when the component settings dialog is saved and closed |
-| `onCancelComponent` | `component`: object | Triggered when the component settings dialog is cancelled |
-| `onDeleteComponent` | `component`: object | Triggered when a component is removed from the form |
-| `onUpdateComponent` | `component`: object | Triggered when a component is added or moved in the form |
+| Name                | Parameters          | Description                                                      |
+|---------------------|---------------------|------------------------------------------------------------------|
+| `onChange`          | `schema`: object    | Triggered any time the form definition changes                   |
+| `onEditComponent`   | `component`: object | Triggered when the component settings dialog is opened           |
+| `onSaveComponent`   | `component`: object | Triggered when the component settings dialog is saved and closed |
+| `onCancelComponent` | `component`: object | Triggered when the component settings dialog is cancelled        |
+| `onDeleteComponent` | `component`: object | Triggered when a component is removed from the form              |
+| `onUpdateComponent` | `component`: object | Triggered when a component is added or moved in the form         |
 
 #### Example
 
-```javascript
+```tsx
 import React from 'react';
 import ReactDOM from 'react-dom';
 import {FormBuilder} from '@tsed/react-formio';
-```
 
-```javascript
 ReactDOM.render(
   <FormBuilder form={{display: 'form'}} onChange={(schema) => console.log(schema)} />
   , document.getElementById('builder')
@@ -179,17 +208,17 @@ the [FormBuilder]([FormsTable](https://formio.tsed.io/?path=/story/reactformio-f
 
 #### Props
 
-| Name | Type | Default | Description |
-|---|---|---|---|
-| `form` | object | {display: 'form' \| 'wizard'} | The form definition of the exiting form that is to be modified. |
-| `options` | object | {} | The options to be passed to FormBuilder |
-| `saveText` | string | '' | The string that will be displayed in the save-button |
+| Name       | Type   | Default            | Description                                          |
+|------------|--------|--------------------|------------------------------------------------------|
+| `form`     | object | {display: 'form' \ | 'wizard'}                                            | The form definition of the exiting form that is to be modified. |
+| `options`  | object | {}                 | The options to be passed to FormBuilder              |
+| `saveText` | string | ''                 | The string that will be displayed in the save-button |
 
 #### Event Props
 
-| Name | Parameters | Description |
-|---|---|---|
-| `onSubmit` | form | Called when the save button is pressed. Will pass the form definition to the callback. |
+| Name       | Parameters | Description                                                                            |
+|------------|------------|----------------------------------------------------------------------------------------|
+| `onSubmit` | form       | Called when the save button is pressed. Will pass the form definition to the callback. |
 
 ### FormsTable
 
@@ -197,9 +226,9 @@ The [FormsTable](https://formio.tsed.io/?path=/story/reactformio-formstable--san
 
 #### Props
 
-| Name | Type | Default | Description |
-|---|---|---|---|
-| `data` | array of forms | [] | A list of forms to be rendered in the grid. 
+| Name   | Type           | Default | Description                                 |
+|--------|----------------|---------|---------------------------------------------|
+| `data` | array of forms | []      | A list of forms to be rendered in the grid. |
 
 ### SubmissionsTable
 
@@ -207,10 +236,10 @@ The submisison grid will render a list of submissions and allow clicking on one
 
 #### Props
 
-| Name | Type | Default | Description |
-|---|---|---|---|
-| `data` | array of submissions | [] | A list of submissions to be rendered in the grid. |
-| `form` | object | {} | The form definition for the submissions. This is used to render the submissions. |
+| Name   | Type                 | Default | Description                                                                      |
+|--------|----------------------|---------|----------------------------------------------------------------------------------|
+| `data` | array of submissions | []      | A list of submissions to be rendered in the grid.                                |
+| `form` | object               | {}      | The form definition for the submissions. This is used to render the submissions. |
 
 ## Redux
 
@@ -297,6 +326,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-[travis]: https://travis-ci.org/
-

package/src/components/form/form.component.tsx

@@ -1,61 +1,17 @@
 import AllComponents from "formiojs/components";
-import Components from "formiojs/components/Components";
+import { Components } from "formiojs";
 import PropTypes from "prop-types";
 import React from "react";
-import { FormOptions, FormSchema, Submission } from "../../interfaces";
-import { useForm } from "./useForm.hook";
+import { useForm, UseFormHookProps } from "./useForm.hook";
 
 Components.setComponents(AllComponents);
 
-export interface ChangedSubmission<T = any> extends Submission<T> {
-  changed: any;
-  isValid: boolean;
-}
-
-export interface FormProps {
+export interface FormProps<Data = any> extends UseFormHookProps<Data> {
   name?: string;
   /**
    *
    */
   className?: string;
-  /**
-   *
-   */
-  src?: string;
-  /**
-   * url to fetch form
-   */
-  url?: string;
-  /**
-   * Raw form object
-   */
-  form: Partial<FormSchema>;
-  /**
-   * Data submission
-   */
-  submission?: Submission;
-  /**
-   * Configuration option
-   */
-  options?: FormOptions;
-  onPrevPage?: Function;
-  onNextPage?: Function;
-  onCancel?: Function;
-  onChange?: (submission: ChangedSubmission) => void;
-  onCustomEvent?: Function;
-  onComponentChange?: Function;
-  onSubmit?: Function;
-  onSubmitDone?: Function;
-  onFormLoad?: Function;
-  onError?: Function;
-  onRender?: Function;
-  onAttach?: Function;
-  onBuild?: Function;
-  onFocus?: Function;
-  onBlur?: Function;
-  onInitialized?: Function;
-  onFormReady?: (formio: any) => void;
-  formioform?: any;
 }
 
 export function Form(props: Partial<FormProps>) {

package/src/components/form/useForm.hook.ts

@@ -1,15 +1,69 @@
-import FormioForm from "formiojs/Form";
+import { ExtendedComponentSchema, Form } from "formiojs";
 import { get } from "lodash";
 import cloneDeep from "lodash/cloneDeep";
 import isEqual from "lodash/isEqual";
 import { useEffect, useRef } from "react";
 import { callLast } from "../../utils/callLast";
-
-export const useForm = (props: any): any => {
+import { FormOptions, FormSchema, Submission } from "../../interfaces";
+
+export interface ChangedSubmission<T = any> extends Submission<T> {
+  changed: any;
+  isValid: boolean;
+}
+
+export interface FormPageChangeProps<Data = any> {
+  page: number;
+  submission: Submission<Data>;
+}
+
+export interface UseFormHookProps<Data = any> extends Record<string, any> {
+  src?: string;
+  /**
+   * url to fetch form
+   */
+  url?: string;
+  /**
+   * Raw form object
+   */
+  form?: Partial<FormSchema>;
+  /**
+   * Configuration option
+   */
+  options?: FormOptions;
+  /**
+   * Data submission
+   */
+  submission?: Submission<Data>;
+  onPrevPage?: (obj: FormPageChangeProps<Data>) => void;
+  onNextPage?: (obj: FormPageChangeProps<Data>) => void;
+  onCancel?: Function;
+  onChange?: (submission: ChangedSubmission) => void;
+  onCustomEvent?: (obj: {
+    type: string;
+    event: string;
+    component: ExtendedComponentSchema;
+    data: any;
+  }) => void;
+  onComponentChange?: (component: ExtendedComponentSchema) => void;
+  onSubmit?: (submission: Submission<Data>) => void;
+  onSubmitDone?: (submission: Submission<Data>) => void;
+  onFormLoad?: Function;
+  onError?: (errors: any) => void;
+  onRender?: () => void;
+  onAttach?: Function;
+  onBuild?: Function;
+  onFocus?: Function;
+  onBlur?: Function;
+  onInitialized?: Function;
+  onFormReady?: (formio: Form) => void;
+  formioform?: any;
+}
+
+export function useForm<Data = any>(props: UseFormHookProps<Data>) {
   const { src, form, options = {}, submission, url, ...funcs } = props;
   const element = useRef<any>();
   const isLoaded = useRef<boolean>();
-  const instance = useRef<any>();
+  const instance = useRef<Form>();
   const events = useRef<Map<string, any>>(new Map());
 
   const createWebForm = (srcOrForm: any, options: any) => {
@@ -19,7 +73,7 @@ export const useForm = (props: any): any => {
 
     if (!instance.current) {
       isLoaded.current = false;
-      instance.current = new FormioForm(element.current, srcOrForm, options);
+      instance.current = new Form(element.current, srcOrForm, options);
 
       instance.current.onAny((event: string, ...args: any[]): void => {
         if (!instance.current) {
@@ -88,7 +142,7 @@ export const useForm = (props: any): any => {
     if (src) {
       if (instance.current) {
         isLoaded.current = false;
-        instance.current.destroy(true);
+        (instance.current as any).destroy(true);
       }
 
       createWebForm(src, options);
@@ -102,7 +156,7 @@ export const useForm = (props: any): any => {
 
     return () => {
       isLoaded.current = false;
-      instance.current && instance.current.destroy(true);
+      instance.current && (instance.current as any).destroy(true);
     };
   }, []);
 
@@ -118,4 +172,4 @@ export const useForm = (props: any): any => {
   return {
     element
   };
-};
+}

package/src/components/form-access/formAccess.component.tsx

@@ -9,7 +9,7 @@ import React, {
 } from "react";
 import { FormOptions, FormSchema, Submission } from "../../interfaces";
 import { Card } from "../card/card.component";
-import { ChangedSubmission, Form } from "../form/form.component";
+import { Form } from "../form/form.component";
 import {
   AccessRoles,
   dataAccessToSubmissions,
@@ -20,6 +20,7 @@ import {
   submissionsToDataAccess,
   updateSubmissions
 } from "./formAccess.utils";
+import { ChangedSubmission } from "../form/useForm.hook";
 
 export interface FormAccessProps {
   form: Partial<FormSchema>;

package/src/components/form-action/formAction.component.tsx

@@ -38,7 +38,7 @@ function mapSettingsForm({ action, ...settingsForm }: any): any {
 export interface FormActionProps {
   actionInfo: Partial<ActionSchema>;
   submission?: Partial<Submission>;
-  onSubmit?: Function;
+  onSubmit?: (submission: Submission<ActionSchema>) => void;
   options: FormOptions;
 }
 

package/src/components/form-edit/formEdit.component.tsx

@@ -1,20 +1,14 @@
 import PropTypes from "prop-types";
 import React from "react";
-import { FormOptions, FormSchema } from "../../interfaces";
+import { FormOptions } from "../../interfaces/FormOptions";
 import { FormBuilder } from "../form-builder/formBuilder.component";
 import { FormEditCTAs } from "./formCtas.component";
 import { FormParameters } from "./formParameters.component";
-import { useForm } from "./useForm.hook";
+import { useFormEdit, UseFormEditHookProps } from "./useFormEdit.hook";
 
-export interface FormEditProps extends Record<string, unknown> {
-  form?: Partial<FormSchema>;
-  options?: FormOptions;
-  typeChoices?: { label: string; value: any }[];
-  displayChoices?: { label: string; value: any }[];
-  enableTags?: boolean;
-  onSubmit?: (form: FormSchema) => void;
-  onCopy?: (form: FormSchema) => void;
+export interface FormEditProps extends UseFormEditHookProps {
   builder?: any;
+  options?: FormOptions;
 }
 
 export function FormEdit(props: FormEditProps) {
@@ -30,7 +24,7 @@ export function FormEdit(props: FormEditProps) {
     reset,
     onSubmit,
     onCopy
-  } = useForm(props);
+  } = useFormEdit(props);
   const { options = {}, builder } = props;
 
   return (

package/src/components/form-edit/{useForm.hook.ts → useFormEdit.hook.ts}

@@ -2,22 +2,16 @@ import { useEffect, useReducer } from "react";
 import { FormSchema } from "../../interfaces/FormSchema";
 import { createInitialState, hasChanged, reducer } from "./formEdit.reducer";
 
-export interface UseFormHookProps {
-  form: Partial<FormSchema>;
-  redo: Function;
-  undo: Function;
-  reset: Function;
-  hasChanged: boolean;
-  isValid: boolean;
-  hasUndo: boolean;
-  hasRedo: boolean;
-  onSubmit: () => void;
-  onCopy: () => void;
-  formChange: (newForm: Partial<FormSchema>) => void;
-  setChange: (path: string, value: any) => void;
+export interface UseFormEditHookProps extends Record<string, unknown> {
+  form?: Partial<FormSchema>;
+  typeChoices?: { label: string; value: any }[];
+  displayChoices?: { label: string; value: any }[];
+  enableTags?: boolean;
+  onSubmit?: (form: Partial<FormSchema>) => void;
+  onCopy?: (form: Partial<FormSchema>) => void;
 }
 
-export function useForm(props: any): UseFormHookProps {
+export function useFormEdit(props: UseFormEditHookProps) {
   const [{ current, future, past }, dispatchFormAction] = useReducer(
     reducer,
     createInitialState(props)

package/src/components/form-settings/formSettings.component.tsx

@@ -1,7 +1,7 @@
 import React, { useCallback, useEffect, useState } from "react";
 import { FormOptions, FormSchema } from "../../interfaces";
 import { getFormSettingsSchema } from "./formSettings.schema";
-import { ChangedSubmission, Form } from "../form/form.component";
+import { Form } from "../form/form.component";
 import {
   FormSettingsSchema,
   formSettingsToSubmission,
@@ -9,6 +9,7 @@ import {
 } from "./formSettings.utils";
 import isEqual from "lodash/isEqual";
 import noop from "lodash/noop";
+import { ChangedSubmission } from "../form/useForm.hook";
 
 export interface FormSettingsProps {
   form: Partial<FormSchema>;

package/dist/components/form-edit/useForm.hook.d.ts

@@ -1,16 +0,0 @@
-import { FormSchema } from "../../interfaces/FormSchema";
-export interface UseFormHookProps {
-    form: Partial<FormSchema>;
-    redo: Function;
-    undo: Function;
-    reset: Function;
-    hasChanged: boolean;
-    isValid: boolean;
-    hasUndo: boolean;
-    hasRedo: boolean;
-    onSubmit: () => void;
-    onCopy: () => void;
-    formChange: (newForm: Partial<FormSchema>) => void;
-    setChange: (path: string, value: any) => void;
-}
-export declare function useForm(props: any): UseFormHookProps;