feat: Add support for editor interface

Author: Khaledgarbaya

lib/create-space-api.js

@@ -67,6 +67,7 @@ export default function createSpaceApi ({
   const {wrapRole, wrapRoleCollection} = entities.role
   const {wrapSpaceMembership, wrapSpaceMembershipCollection} = entities.spaceMembership
   const {wrapApiKey, wrapApiKeyCollection} = entities.apiKey
+  const {wrapEditorInterface} = entities.editorInterface
 
   /**
    * Space instances.
@@ -122,6 +123,20 @@ export default function createSpaceApi ({
     .then((response) => wrapContentType(http, response.data), errorHandler)
   }
 
+  /**
+   * Gets an EditorInterface for a ContentType
+   * @memberof ContentfulSpaceAPI
+   * @param  {string} contentTypeId
+   * @return {Promise<EditorInterface.EditorInterface>} Promise for an EditorInterface
+   * @example
+   * space.getEditorInterfaceForContentType('contentTypeId')
+   * .then(editorInterface => console.log(editorInterface))
+   */
+  function getEditorInterfaceForContentType (contentTypeId) {
+    return http.get('content_types/' + contentTypeId + '/editor_interface')
+    .then((response) => wrapEditorInterface(http, response.data), errorHandler)
+  }
+
   /**
    * Gets a collection of Content Types
    * @memberof ContentfulSpaceAPI
@@ -622,6 +637,7 @@ export default function createSpaceApi ({
     getContentTypes: getContentTypes,
     createContentType: createContentType,
     createContentTypeWithId: createContentTypeWithId,
+    getEditorInterfaceForContentType: getEditorInterfaceForContentType,
     getEntry: getEntry,
     getEntries: getEntries,
     createEntry: createEntry,

lib/entities/content-type.js

@@ -15,6 +15,8 @@ import {
   createUpdatedChecker,
   createDraftChecker
 } from '../instance-actions'
+import {wrapEditorInterface} from './editor-interface'
+import errorHandler from '../error-handler'
 
 /**
  * @memberof ContentType
@@ -90,6 +92,19 @@ function createContentTypeApi (http) {
       wrapperMethod: wrapContentType
     }),
 
+    /**
+     * get the editor interface for the object
+     * @memberof ContentType
+     * @func getEditorInterface
+     * @return {Promise<EditorInterface>} Object returned from the server with the current editor interface.
+     * @example
+     * contentType.getEditorInterface()
+     * .then(editorInterface => console.log(editorInterface.controls))
+     */
+    getEditorInterface: function () {
+      return http.get('content_types/' + this.sys.id + '/editor_interface')
+      .then((response) => wrapEditorInterface(http, response.data), errorHandler)
+    },
     /**
      * Checks if the contentType is published. A published contentType might have unpublished changes (@see {ContentType.isUpdated})
      * @memberof ContentType

lib/entities/editor-interface.js

@@ -0,0 +1,43 @@
+/**
+ * Editor Interface instances
+ * @namespace EditorInterface
+ */
+
+import cloneDeep from 'lodash/cloneDeep'
+import freezeSys from 'contentful-sdk-core/freeze-sys'
+import enhanceWithMethods from '../enhance-with-methods'
+import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
+import omit from 'lodash/omit'
+import errorHandler from '../error-handler'
+
+function createEditorInterfaceApi (http) {
+  return {
+    update: function () {
+      const raw = this.toPlainObject()
+      const data = omit(raw, ['sys'])
+      return http.put('content_types' + '/' +
+       this.sys.contentType.id +
+       '/editor_interface',
+       data,
+        {
+          headers: {
+            'X-Contentful-Version': this.sys.version
+          }
+        }
+      )
+      .then((response) => wrapEditorInterface(http, response.data), errorHandler)
+    }
+  }
+}
+
+/**
+* @private
+* @param {Object} http - HTTP client instance
+* @param {Object} data - Raw editor-interface data
+* @return {EditorInterface} Wrapped editor-interface data
+*/
+export function wrapEditorInterface (http, data) {
+  const editorInterface = mixinToPlainObject(cloneDeep(data))
+  enhanceWithMethods(editorInterface, createEditorInterfaceApi(http))
+  return freezeSys(editorInterface)
+}

lib/entities/index.js

@@ -2,6 +2,7 @@ import * as space from './space'
 import * as entry from './entry'
 import * as asset from './asset'
 import * as contentType from './content-type'
+import * as editorInterface from './editor-interface'
 import * as locale from './locale'
 import * as webhook from './webhook'
 import * as spaceMembership from './space-membership'
@@ -13,6 +14,7 @@ export default {
   entry,
   asset,
   contentType,
+  editorInterface,
   locale,
   webhook,
   spaceMembership,

test/unit/create-space-api-test.js

@@ -4,6 +4,7 @@ import mixinToPlainObject from 'contentful-sdk-core/mixins/to-plain-object'
 import createSpaceApi, {__RewireAPI__ as createSpaceApiRewireApi} from '../../lib/create-space-api'
 import {
   contentTypeMock,
+  editorInterfaceMock,
   assetMock,
   entryMock,
   localeMock,
@@ -157,6 +158,20 @@ test('API call createContentTypeWithId fails', (t) => {
   })
 })
 
+test('API call getEditorInterfaceForContentType', (t) => {
+  makeGetEntityTest(t, setup, teardown, {
+    entityType: 'editorInterface',
+    mockToReturn: editorInterfaceMock,
+    methodToTest: 'getEditorInterfaceForContentType'
+  })
+})
+
+test('API call getEditorInterfaceForContentType fails', (t) => {
+  makeEntityMethodFailingTest(t, setup, teardown, {
+    methodToTest: 'getEditorInterfaceForContentType'
+  })
+})
+
 test('API call getEntry', (t) => {
   makeGetEntityTest(t, setup, teardown, {
     entityType: 'entry',

test/unit/entities/content-type-test.js

@@ -88,6 +88,20 @@ test('ContentType unpublish fails', (t) => {
   })
 })
 
+test('ContentType getEditorInterface', (t) => {
+  return entityActionTest(t, setup, {
+    wrapperMethod: wrapContentType,
+    actionMethod: 'getEditorInterface'
+  })
+})
+
+test('ContentType getEditorInterface fails', (t) => {
+  return failingActionTest(t, setup, {
+    wrapperMethod: wrapContentType,
+    actionMethod: 'getEditorInterface'
+  })
+})
+
 test('ContentType isPublished', (t) => {
   isPublishedTest(t, setup, {wrapperMethod: wrapContentType})
 })

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

@@ -0,0 +1,20 @@
+import test from 'tape'
+import {cloneMock} from '../mocks/entities'
+import setupHttpMock from '../mocks/http'
+import {wrapEditorInterface} from '../../../lib/entities/editor-interface'
+import {
+  entityWrappedTest
+} from '../test-creators/instance-entity-methods'
+
+function setup (promise) {
+  return {
+    httpMock: setupHttpMock(promise),
+    entityMock: cloneMock('editorInterface')
+  }
+}
+
+test('Editor Interface is wrapped', (t) => {
+  return entityWrappedTest(t, setup, {
+    wrapperMethod: wrapEditorInterface
+  })
+})

test/unit/mocks/entities.js

@@ -52,7 +52,19 @@ const entryMock = {
     field1: 'str'
   }
 }
-
+const editorInterfaceMock = {
+  sys: assign(cloneDeep(sysMock), {
+    type: 'EditorInterface',
+    contentType: assign(cloneDeep(linkMock), {linkType: 'ContentType'}),
+    space: assign(cloneDeep(linkMock), {linkType: 'Space'})
+  }),
+  controls: [
+    {
+      'fieldId': 'fieldid',
+      'widgetId': 'singleLine'
+    }
+  ]
+}
 const assetMock = {
   sys: assign(cloneDeep(sysMock), {
     type: 'Asset',
@@ -112,6 +124,7 @@ const mocks = {
   link: linkMock,
   sys: sysMock,
   contentType: contentTypeMock,
+  editorInterface: editorInterfaceMock,
   entry: entryMock,
   asset: assetMock,
   locale: localeMock,
@@ -172,6 +185,9 @@ function setupEntitiesMock (rewiredModuleApi) {
     apiKey: {
       wrapApiKey: sinon.stub(),
       wrapApiKeyCollection: sinon.stub()
+    },
+    editorInterface: {
+      wrapEditorInterface: sinon.stub()
     }
   }
   rewiredModuleApi.__Rewire__('entities', entitiesMock)
@@ -184,6 +200,7 @@ export {
   sysMock,
   spaceMock,
   contentTypeMock,
+  editorInterfaceMock,
   entryMock,
   assetMock,
   localeMock,