Release Notes > 5.40.0
Removed APIs
Learn about the removed APIs in the 5.40.0 release and their replacements.
Overview
As mentioned in the changelog, with this release, we’ve removed a couple of frontend and backend JavaScript APIs that were marked as deprecated in previous releases.
In this guide, we’ll go through the list of deprecated APIs and their replacements.
Headless CMS
Removed Methods Related to Checking Security Permissions (Performing Authorization)
We’ve removed a set of methods related to checking security permissions (performing authorization) that were accessible via the context.cms.permissions
object. To provide more context, here’s an example of how the object could’ve been used in a simple CmsGraphQLSchemaPlugin
plugin:
In the example above, the context.cms.permissions.entries.ensure
method is used to check if the current user has the required permissions to read entries.
With this release, the context.cms.permissions
object has been removed. Instead, you should use the context.cms.accessControl
object to perform the same checks.
With this 5.39.2 release, we’ve introduced a new property on the CMS context object, called accessControl
. Essentially, this property is a reference to the AccessControl class instance, which is used to perform authorization checks on content model groups, models, and entries.
If we were to rewrite the previous example using the new context.cms.accessControl
object, it would look like this:
RenamedcreateCmsModel
andcreateCmsGroup
Plugin Factory Functions
We’ve renamed the createCmsModel
and createCmsGroup
plugin factory functions to createCmsModelPlugin
and createCmsGroupPlugin
. By having a more explicit name of the function, we’re making it more clear what the function actually does.
With the 5.40.0 release, the old functions will be still available, but do note that they will be removed in the upcoming quarterly (5.41.0) release.
Page Builder
Multiple legacy methods used for subscribing to Page Builder application’s lifecycle events have been removed.
Learn more about lifecycle events in the Lifecycle Events article.
Pages
Deprecated API | Description | Replacement API |
---|---|---|
onBeforePageCreate | Triggered before a page is created | onPageBeforeCreate |
onAfterPageCreate | Triggered after a page is created | onPageAfterCreate |
onBeforePageCreateFrom | Triggered before a page is created from a page revision | onPageBeforeCreateFrom |
onAfterPageCreateFrom | Triggered after a page is created from a page revision | onPageAfterCreateFrom |
onBeforePageUpdate | Triggered before a page is updated | onPageBeforeUpdate |
onAfterPageUpdate | Triggered after a page is updated | onPageAfterUpdate |
onBeforePageDelete | Triggered before a page is deleted | onPageBeforeDelete |
onAfterPageDelete | Triggered after a page is deleted | onPageAfterDelete |
onBeforePagePublish | Triggered before a page is published | onPageBeforePublish |
onAfterPagePublish | Triggered after a page is published | onPageAfterPublish |
onBeforePageUnpublish | Triggered before a page is unpublished | onPageBeforeUnpublish |
onAfterPageUnpublish | Triggered after a page is unpublished | onPageAfterUnpublish |
Menus
Deprecated API | Description | Replacement API |
---|---|---|
onBeforeMenuCreate | Triggered before a menu is created | onMenuBeforeCreate |
onAfterMenuCreate | Triggered after a menu is created | onMenuAfterCreate |
onBeforeMenuUpdate | Triggered before a menu is updated | onMenuBeforeUpdate |
onAfterMenuUpdate | Triggered after a menu is updated | onMenuAfterUpdate |
onBeforeMenuDelete | Triggered before a menu is deleted | onMenuBeforeDelete |
onAfterMenuDelete | Triggered after a menu is deleted | onMenuAfterDelete |
Page Categories
Deprecated API | Description | Replacement API |
---|---|---|
onBeforeCategoryCreate | Triggered before a category is created | onCategoryBeforeCreate |
onAfterCategoryCreate | Triggered after a category is created | onCategoryAfterCreate |
onBeforeCategoryUpdate | Triggered before a category is updated | onCategoryBeforeUpdate |
onAfterCategoryUpdate | Triggered after a category is updated | onCategoryAfterUpdate |
onBeforeCategoryDelete | Triggered before a category is deleted | onCategoryBeforeDelete |
onAfterCategoryDelete | Triggered after a category is deleted | onCategoryAfterDelete |
Page Builder Settings
Deprecated API | Description | Replacement API |
---|---|---|
onBeforeSettingsUpdate | Triggered before Page Builder settings are updated | onSettingsBeforeUpdate |
onAfterSettingsUpdate | Triggered after Page Builder settings are updated | onSettingsAfterUpdate |
Page Builder Installation
Deprecated API | Description | Replacement API |
---|---|---|
onBeforeInstall | Triggered before Page Builder is installed | onSystemBeforeInstall |
onAfterInstall | Triggered after Page Builder is installed | onSystemAfterInstall |
AppPbWebsiteSettings
Replaced WithWebsiteSettingsConfig
AddPbWebsiteSettings
component to add website settings was replaced by WebsiteSettingsConfig
. This was done to enable more features, and more control over the website settings view.
Until this release, you would use AddPbWebsiteSettings
like this:
If we were to rewrite the previous example using WebsiteSettingsConfig
, it would look like this:
Notice how, besides the code itself, the import changed; the WebsiteSettingsConfig
is now imported from @webiny/app-page-builder
.
I18N
Multiple legacy methods used for subscribing to I18N application’s lifecycle events have been removed.
Locales
Deprecated API | Description | Replacement API |
---|---|---|
onBeforeLocaleCreate | Triggered before a locale is created | onLocaleBeforeCreate |
onAfterLocaleCreate | Triggered after a locale is created | onLocaleAfterCreate |
onBeforeLocaleUpdate | Triggered before a locale is updated | onLocaleBeforeUpdate |
onAfterLocaleUpdate | Triggered after a locale is updated | onLocaleAfterUpdate |
onBeforeLocaleDelete | Triggered before a locale is deleted | onLocaleBeforeDelete |
onAfterLocaleDelete | Triggered after a locale is deleted | onLocaleAfterDelete |
Installation
Deprecated API | Description | Replacement API |
---|---|---|
onBeforeInstall | Triggered before Page Builder is installed | onSystemBeforeInstall |
onAfterInstall | Triggered after Page Builder is installed | onSystemAfterInstall |
File Manager
RemovedFileManagerFileTypePlugin
Class
We’ve removed the FileManagerFileTypePlugin
class, which was used to define custom file types in File Manager. More specifically, the class enabled developers to introduce custom file preview and custom file actions for all files of a specific type.
With this release, instead of using the FileManagerFileTypePlugin
class, developers are encouraged to implement custom file preview and custom file actions using the new React components, both of which is covered in the following guides:
Forms
Removed theform
Object FromBind
Component anduseBind
Hook
A reference to form
was removed from the <Bind>
component render prop, and useBind
hook. You should now use the useForm
hook to get a reference to the parent Form object. This was done to optimize re-rendering, and also make a clear separation between the form itself, and bindings to the UI.
Until this release, you could get a reference to the form
instance from Bind’s render prop, like this:
From 5.40.0 on, you will have to write this differently. More often than not, you’re adding new inputs to existing forms via plugins, so you’re just mounting <Bind>
elements, or use the useBind
hook. To get access to the form object, you’ll need to use the useForm
hook, like this: