fix: editorInterface methods do not reset custom sidebar anymore (#175)

`editorInterface` payload can have custom sidebar configuration saved. Currently all related methods just override `sidebar` configuration. This PR fixes the behavior, so if `sidebar` configuration isn't overwritten if present in the initial payload.

Author: suevalov

src/lib/entities/content-type.ts

@@ -1,4 +1,4 @@
-import { APIContentType, Field, APIEditorInterfaceControl, APIEditorInterfaces, APIEditorInterfaceSettings } from '../interfaces/content-type'
+import { APIContentType, Field, APIEditorInterfaceControl, APIEditorInterfaces, APIEditorInterfaceSettings, APIEditorInterfaceSidebar } from '../interfaces/content-type'
 import { cloneDeep, find, filter, findIndex, pull, forEach } from 'lodash'
 
 class Fields {
@@ -81,10 +81,12 @@ class Fields {
 class EditorInterfaces {
   private _version: number
   private _controls: APIEditorInterfaceControl[]
+  private _sidebar?: APIEditorInterfaceSidebar[]
 
   constructor (apiEditorInterfaces: APIEditorInterfaces) {
     this._version = apiEditorInterfaces.sys.version
     this._controls = apiEditorInterfaces.controls
+    this._sidebar = apiEditorInterfaces.sidebar || undefined
   }
 
   get version () {
@@ -146,6 +148,12 @@ class EditorInterfaces {
         settings: c.settings
       })
     })
+    if (this._sidebar) {
+      return {
+        controls: result,
+        sidebar: this._sidebar
+      }
+    }
     return {
       controls: result
     }

src/lib/interfaces/content-type.ts

@@ -40,15 +40,24 @@ interface APIEditorInterfaceSettings {
 
 interface APIEditorInterfaceControl {
   fieldId: string,
-  widgetId: string,
+  widgetId?: string,
+  widgetNamespace?: 'builtin' | 'extension',
   settings?: APIEditorInterfaceSettings
 }
 
+interface APIEditorInterfaceSidebar {
+  widgetId: string,
+  widgetNamespace: 'builtin' | 'extension',
+  disabled?: boolean,
+  settings?: { [key: string]: any }
+}
+
 interface APIEditorInterfaces {
   sys: {
     version: number
   }
   controls: APIEditorInterfaceControl[]
+  sidebar?: APIEditorInterfaceSidebar[]
 }
 
 export {
@@ -57,5 +66,6 @@ export {
   Field,
   APIEditorInterfaces,
   APIEditorInterfaceControl,
-  APIEditorInterfaceSettings
+  APIEditorInterfaceSettings,
+  APIEditorInterfaceSidebar
 }

test/unit/lib/offline-api/build-payloads.ts

@@ -16,7 +16,8 @@ const buildPayloads = async function (runMigration, contentTypes: APIContentType
     sys: {
       version: 1
     },
-    controls: []
+    controls: [],
+    sidebar: undefined
   })
   const editorInterfacesByContentType: Map<String, EditorInterfaces> = new Map()