Changelog

Plugins version 3.0 enables entirely new functionality within CMS Plugins with a new set of APIs for modifying and adding to existing Collections that weren’t created by your Plugin (known as UnmanagedCollection). Along with this, we’ve made a few changes to the core CMS APIs to add stronger typing and set us up for additional features coming soon.

Breaking Changes

The following CMS functions now require their fieldData to be an object, with value and type properties. Which enforces stronger types across CMS APIs.

• Collection.getFields() now returns Field[].

• BooleanField, StringField, etc. are classes now.

• SupportedCollectionField type has been removed.

• CollectionField type has been removed.

• Collection.getItems() returns typed fieldData.

• CollectionItem.setAttributes() requires typed fieldData.

• ManagedCollection.addItems() requires typed fieldData.

// Before 
managedCollection.addItems([
  { [fieldID]: "Your Value" }
])

// After
managedCollection.addItems([
  { [fieldID]: {
      type: "string",
      value:  "Your Value"
  }
}])

Collections

• Plugins can now write to Collections.

• Added Collection.addItems().

• Added Collection.setItemOrder().

• Added Collection.setFieldOrder().

Collection Fields

• Collection.addFields() lets you create new fields.

• Field.setAttributes() allows you to update the field.

• Field.remove() removes the field from the Collection.

• Collection.removeFields() removes fields in bulk.

The 2.2.0 release brings some updates to the CMS API, with a focus on improving the experience around having multiple Managed Collections created by the same Plugin.

Managed Collections

• Added new ⁠getManagedCollections() method to get all Collections managed by your Plugin.

• Added ⁠setAsActive() method to select the active Collection in the Editor

• Deprecated ⁠getManagedCollection() in favor of ⁠getActiveManagedCollection().

• Fixed a bug where setting Plugin Data on a CollectionItemNode was throwing a Node not found error.

Collections

• Added support for ⁠FieldDivider type in collection fields.

• Added ⁠setAsActive() method to make a collection the active one.

• Added ⁠removeFields() method to remove fields by their ID.

• Added ⁠setFieldOrder() method to arrange fields in a specific order.

• Added ⁠slugFieldName property to Collection interface.

The 2.0 release contains a single breaking change to the id field of the APIs below. Our hashing algorithm for the id had a higher potential for ID collisions than expected. The id field will now be a different hashed value for the same user/project compared to 1.x.x. Logic that stores and compares these values will need updating. To migrate from the old value to the new value, you can reference the apiVersion1Id field.

• getProjectInfo()

• getCurrentUser()

• Resolution support has been added to all image APIs.

• Collection item draft status is now exposed in the API.

• Plugin windows now support maximum width/height.

Plugins initial public release.