Allow default shortAnswer form input to be excluded with a different string form input as the default

Author: raymond-lam

example/src/JsonSchemaFormSuite.js

@@ -318,7 +318,7 @@ class JsonSchemaFormEditor extends React.Component<Props, State> {
                     <PredefinedGallery
                       schema={this.props.schema}
                       uischema={this.props.uischema}
-                      mods={{}}
+                      mods={this.props.mods}
                       onChange={(newSchema: string, newUiSchema: string) => {
                         if (this.props.onChange)
                           this.props.onChange(newSchema, newUiSchema);

src/formBuilder/FormBuilder.js

@@ -17,6 +17,7 @@ import {
   onDragEnd,
   countElementsFromSchema,
   generateCategoryHash,
+  excludeKeys,
 } from './utils';
 import DEFAULT_FORM_INPUTS from './defaults/defaultFormInputs';
 import type { Mods } from './types';
@@ -236,10 +237,14 @@ export default function FormBuilder({
   const schemaData = (parse(schema): { [string]: any }) || {};
   schemaData.type = 'object';
   const uiSchemaData = (parse(uischema): { [string]: any }) || {};
-  const allFormInputs = {
-    ...DEFAULT_FORM_INPUTS,
-    ...(mods && mods.customFormInputs),
-  };
+  const allFormInputs = excludeKeys(
+    {
+      ...DEFAULT_FORM_INPUTS,
+      ...(mods && mods.customFormInputs),
+    },
+    mods && mods.deactivatedFormInputs,
+  );
+
   const unsupportedFeatures = checkForUnsupportedFeatures(
     schemaData,
     uiSchemaData,

src/formBuilder/PredefinedGallery.js

@@ -7,6 +7,7 @@ import {
   stringify,
   propagateDefinitionChanges,
   generateCategoryHash,
+  excludeKeys,
 } from './utils';
 import { arrows as arrowsStyle } from './styles';
 import DEFAULT_FORM_INPUTS from './defaults/defaultFormInputs';
@@ -133,10 +134,13 @@ export default function PredefinedGallery({
   const classes = useStyles();
   const schemaData = (parse(schema): { [string]: any }) || {};
   const uiSchemaData = (parse(uischema): { [string]: any }) || {};
-  const allFormInputs = {
-    ...DEFAULT_FORM_INPUTS,
-    ...(mods && mods.customFormInputs),
-  };
+  const allFormInputs = excludeKeys(
+    {
+      ...DEFAULT_FORM_INPUTS,
+      ...(mods && mods.customFormInputs),
+    },
+    mods && mods.deactivatedFormInputs,
+  );
   const categoryHash = generateCategoryHash(allFormInputs);
 
   React.useEffect(() => {

src/formBuilder/utils.js

@@ -1614,6 +1614,23 @@ export function subtractArray(
   return array1.filter((v) => !keys[v]);
 }
 
+export function excludeKeys(
+  obj: { [string]: any },
+  keys: ?(string[]),
+): { [string]: any } {
+  if (!keys) return { ...obj };
+
+  const keysHash = keys.reduce((acc, curr) => {
+    acc[curr] = true;
+    return acc;
+  }, {});
+
+  return Object.keys(obj).reduce(
+    (acc, curr) => (keysHash[curr] ? acc : { ...acc, [curr]: obj[curr] }),
+    {},
+  );
+}
+
 export function getNewElementDefaultDataOptions(i: number, mods?: Mods) {
   if (mods && mods.newElementDefaultDataOptions !== undefined) {
     const title = `${mods.newElementDefaultDataOptions.title} ${i}`;

src/formBuilder/utils.test.js

@@ -13,6 +13,7 @@ import {
   generateCategoryHash,
   generateElementComponentsFromSchemas,
   subtractArray,
+  excludeKeys,
   getNewElementDefaultDataOptions,
 } from './utils';
 import DEFAULT_FORM_INPUTS from './defaults/defaultFormInputs';
@@ -569,6 +570,58 @@ describe('subtractArray', () => {
   });
 });
 
+describe('excludeKeys', () => {
+  it('returns the given object excluding the given keys', () => {
+    const obj = { foo: 'bar', biz: 'baz', boo: 'baa', bla: 'bee' };
+    const keys = ['biz', 'boo', 'extraKey'];
+
+    const expectedResult = { foo: 'bar', bla: 'bee' };
+    const actualResult = excludeKeys(obj, keys);
+
+    expect(actualResult).toEqual(expectedResult);
+  });
+
+  it('returns the given object if keys is empty', () => {
+    const obj = { foo: 'bar', biz: 'baz', boo: 'baa', bla: 'bee' };
+    const keys = [];
+
+    const expectedResult = { foo: 'bar', biz: 'baz', boo: 'baa', bla: 'bee' };
+    const actualResult = excludeKeys(obj, keys);
+
+    expect(actualResult).toEqual(expectedResult);
+  });
+
+  it('returns the given object if keys is undefined', () => {
+    const obj = { foo: 'bar', biz: 'baz', boo: 'baa', bla: 'bee' };
+    const keys = undefined;
+
+    const expectedResult = { foo: 'bar', biz: 'baz', boo: 'baa', bla: 'bee' };
+    const actualResult = excludeKeys(obj, keys);
+
+    expect(actualResult).toEqual(expectedResult);
+  });
+
+  it('returns the given object if keys is null', () => {
+    const obj = { foo: 'bar', biz: 'baz', boo: 'baa', bla: 'bee' };
+    const keys = null;
+
+    const expectedResult = { foo: 'bar', biz: 'baz', boo: 'baa', bla: 'bee' };
+    const actualResult = excludeKeys(obj, keys);
+
+    expect(actualResult).toEqual(expectedResult);
+  });
+
+  it('returns an empty object if both obj and keys are empty', () => {
+    const obj = {};
+    const keys = [];
+
+    const expectedResult = {};
+    const actualResult = excludeKeys(obj, keys);
+
+    expect(actualResult).toEqual(expectedResult);
+  });
+});
+
 describe('getNewElementDefaultDataOptions', () => {
   it('returns a default dataOptions when undefined mods are passed', () => {
     const i = 1;