contentful-migration 4.8.1 → 4.9.2

package/index.d.ts

@@ -19,6 +19,15 @@ export interface Movement {
   afterField(field: string): void
 }
 
+export interface EditorLayoutMovement {
+  toTheTopOfFieldGroup(groupId?: string): void
+  toTheBottomOfFieldGroup(groupId?: string): void
+  beforeField(field: string): void
+  afterField(field: string): void
+  beforeFieldGroup(groupId?: string): void
+  afterFieldGroup(groupId?: string): void
+}
+
 type FieldType =
   | 'Symbol'
   | 'Text'
@@ -91,6 +100,12 @@ export interface Field {
 
   /** Sets the default value for the field. */
   defaultValue(defaultValue: { [locale: string]: any }): Field
+
+  /** Set annotations associated with the field */
+  setAnnotations(annotationsIds: string[]): Field
+
+  /** Removes all annotaions associated with the field */
+  clearAnnotations(): Field
 }
 
 type LinkMimetype =
@@ -167,6 +182,11 @@ export interface ISidebarWidgetSettings {
   [setting: string]: WidgetSettingsValue
 }
 
+export interface IFieldGroupWidgetSettings {
+  /** Instance settings for the field group widget as key-value pairs. */
+  [setting: string]: WidgetSettingsValue
+}
+
 export interface ContentType {
   id: string
   instanceId: string
@@ -178,6 +198,12 @@ export interface ContentType {
   /** ID of the field to use as the display field for the content type. */
   displayField(displayField: string): ContentType
 
+  /** Annotations associated with the content type */
+  setAnnotations(annotationIds: string[]): ContentType
+
+  /** Removes all annotaions associated with the field */
+  clearAnnotations(): ContentType
+
   /** Creates a field with provided id. */
   createField(id: string, init?: IFieldOptions): Field
 
@@ -300,6 +326,67 @@ export interface ContentType {
    * Resets the sidebar of the content type to default
    */
   resetSidebarToDefault(): void
+
+  /**
+   * Generates the default editor layout in the editor interface related to this content type.
+   */
+  createEditorLayout(): EditorLayout
+
+  /**
+   * Returns the editor layout related to this content type.
+   */
+  editEditorLayout(): EditorLayout
+
+  /**
+   * Removes editor layout and group controls from the editor interface of this content type.
+   */
+  deleteEditorLayout(): void
+}
+
+export interface InitFieldGroupOptions {
+  name: string
+}
+
+export type FieldGroupUpdateFunction = (groupId: string, init?: InitFieldGroupOptions) => FieldGroup
+export interface FieldGroup {
+  name: (name: string) => FieldGroup
+  /**
+   * Creates a field group nested to this one
+   */
+  createFieldGroup: FieldGroupUpdateFunction
+}
+
+export interface EditorLayout {
+  /**
+   * Creates a field group at the top level of editor layout
+   * A group control is automatically generated
+   */
+  createFieldGroup: FieldGroupUpdateFunction
+  /**
+   * Edits a field group
+   */
+  editFieldGroup: FieldGroupUpdateFunction
+  /**
+   * Changes the identifier of a field group
+   */
+  changeFieldGroupId: (currentId: string, newId: string) => void
+  /**
+   * Removes a field group from the editor layout
+   */
+  deleteFieldGroup: (groupId: string) => void
+  /**
+   * Allows movements of a field in the editor layout
+   */
+  moveField: (fieldId: string) => EditorLayoutMovement
+  /**
+   * Edits the field group control of a field group
+   */
+  changeFieldGroupControl: (
+    groupId: string,
+    widgetNameSpace: 'builtin',
+    widgetId: 'fieldset' | 'topLevelTab',
+    settings?: IFieldGroupWidgetSettings
+  ) => void
 }
 
 export interface IContentTypeOptions {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-migration",
-  "version": "4.8.1",
+  "version": "4.9.2",
   "description": "Migration tooling for contentful",
   "author": "Contentful GmbH",
   "license": "MIT",
@@ -87,7 +87,7 @@
     "eslint": "^7.7.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.20.2",
-    "eslint-plugin-mocha": "^9.0.0",
+    "eslint-plugin-mocha": "^10.0.4",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^6.0.0",
     "eslint-plugin-standard": "^5.0.0",
@@ -99,7 +99,7 @@
     "prettier": "^2.5.1",
     "rewire": "^5.0.0",
     "rimraf": "^3.0.2",
-    "semantic-release": "^18.0.0",
+    "semantic-release": "^19.0.3",
     "sinon": "^12.0.0",
     "sinon-chai": "^3.5.0",
     "source-map-support": "^0.5.16",