feat: Add getControlForField for EditorInterface

now you can get the representation for a specific field from a contentType editor interface

Author: Khaledgarbaya

lib/entities/editor-interface.js

@@ -12,6 +12,16 @@ import errorHandler from '../error-handler'
 
 function createEditorInterfaceApi (http) {
   return {
+    /**
+     * Sends an update to the server with any changes made to the object's properties
+     * @memberof EditorInterface
+     * @func update
+     * @return {Promise<EditorInterface>} Object returned from the server with updated changes.
+     * @example
+     * editorInterface.controls[0] = { "fieldId": "title", "widgetId": "singleLine"}
+     * editorInterface.update()
+     * .then(editorInterface => console.log(editorInterface.controls))
+     */
     update: function () {
       const raw = this.toPlainObject()
       const data = omit(raw, ['sys'])
@@ -26,6 +36,21 @@ function createEditorInterfaceApi (http) {
         }
       )
       .then((response) => wrapEditorInterface(http, response.data), errorHandler)
+    },
+    /**
+     * gets a control for a specific field
+     * @memberof EditorInterface
+     * @func getControlForField
+     * @return {Object} control object for specific field.
+     * @example
+     * const control = editorInterface.getControlForField('fieldId')
+     * console.log(control)
+     */
+    getControlForField: function (fieldId) {
+      const result = this.controls.filter((control) => {
+        return control.fieldId === fieldId
+      })
+      return (result && result.length > 0) ? result[0] : null
     }
   }
 }

test/unit/entities/editor-interface-test.js

@@ -3,7 +3,8 @@ import {cloneMock} from '../mocks/entities'
 import setupHttpMock from '../mocks/http'
 import {wrapEditorInterface} from '../../../lib/entities/editor-interface'
 import {
-  entityWrappedTest
+  entityWrappedTest,
+  entityUpdateTest
 } from '../test-creators/instance-entity-methods'
 
 function setup (promise) {
@@ -18,3 +19,29 @@ test('Editor Interface is wrapped', (t) => {
     wrapperMethod: wrapEditorInterface
   })
 })
+
+test('ContentType update', (t) => {
+  return entityUpdateTest(t, setup, {
+    wrapperMethod: wrapEditorInterface
+  })
+})
+
+test('EditorInterface getControlForField with an existing fieldId', (t) => {
+  t.plan(5)
+  const {httpMock, entityMock} = setup()
+  const editorInterface = wrapEditorInterface(httpMock, entityMock)
+  const control = editorInterface.getControlForField('fieldId')
+  t.ok(control, 'control object sould be there')
+  t.ok(control.fieldId, 'should have a fieldId')
+  t.ok(control.widgetId, 'should have a widgetId')
+  t.equals(control.fieldId, 'fieldId')
+  t.equals(control.widgetId, 'singleLine')
+})
+
+test('EditorInterface getControlForField without an existing fieldId', (t) => {
+  t.plan(1)
+  const {httpMock, entityMock} = setup()
+  const editorInterface = wrapEditorInterface(httpMock, entityMock)
+  const control = editorInterface.getControlForField('notThere')
+  t.equals(control, null)
+})

test/unit/mocks/entities.js

@@ -60,7 +60,7 @@ const editorInterfaceMock = {
   }),
   controls: [
     {
-      'fieldId': 'fieldid',
+      'fieldId': 'fieldId',
       'widgetId': 'singleLine'
     }
   ]