Feat DF-662: Allows new component to be added with minimal effort

[jbarnsley10]

A new component can be added with minimal effort.
Originally, around 25 files needed to be change.
Now, only 6 files need to be changed.

There is also a small PR in forms-runner to handle components not yet setup in the preview DEFRA/forms-engine-plugin#274

Changes required in forms-designer to add a new component (this example uses 'UnicornField'):

model/src/components/enums.ts:

	UnicornField = ‘UnicornField’

model/src/components/types.ts:

	export interface UnicornFieldComponent extends FormFieldBase {
            type: ComponentType.UnicornField
            options: FormFieldBase['options'] & {
                condition?: string
            }
         }

       . . .

	export type InputFieldsComponentsDef =
  	| TextFieldComponent
  	. . .
  	| UnicornFieldComponent

model/src/components/component-types.ts:

	{
    		name: 'UnicornField',
    		title: 'Unicorn field',
    		type: ComponentType.UnicornField,
    		hint: '',
    		options: {},
    		schema: {}
  	}

client/src/i18n/translations/en.translation.json:

	fieldTypeToName: {
		. . .
		"UnicornField": "Unicorn field",
    		"UnicornField_info": "For internal processing"

model/src/form/form-editor/index.ts:

export const questionTypeSchema = Joi.string()
. . .
ComponentType.UnicornField
)
. . .

designer/server/src/models/forms/editor-v2/question-type.js:

const questionTypeRadioItems = /** @type {FormEditorCheckbox[]} */ ([
. . .
{
    text: 'Unicorn',
    hint: {
      text: 'Rainbows and stuff'
    },
    value: ComponentType.UnicornField
  },
. . .

[github-actions]

🧪 Acceptance Test Results

❌ Some acceptance tests failed

View Details

[alexluckett]

What an improvement! Nice work.

Can you put an updated step-by-step guide together?

[alexluckett]

enum here?

SetupPreview(PreviewTypes.ListSortable)

[jbarnsley10]

This is from Chris' original implementation (and the 'Question' too).
Will see if it's easy to enum them both

[jbarnsley10]

Ah, it's because he was using ComponentType for most apart from these two. Obvs we don;t want to add these two to ComponentType. I'll create a PreviewComponentType

[alexluckett]

enum here?

SetupPreview(PreviewTypes.Question)

[sonarqubecloud]

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
91.7% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud