feat!: deprecate legacy client [NONE] - Githubissues

contentful / contentful-management.js

JavaScript library for Contentful's Management API (node & browser)

https://contentful.github.io/contentful-management.js

MIT License

263 stars 97 forks source link

feat!: deprecate legacy client [NONE] #2317

Open marcolink opened 3 weeks ago

marcolink commented 3 weeks ago

Summary

With the next major version (12.0.0) we finally will deprecate the old client shape.

Description

From now on, the old client type will be called legacy

Changes

All legacy client methods are marked as deprecated
The default client will be the plain client
Users can opt-in to the legacy client

Motivation and Context

The plain client comes with a list of advantages over the legacy client:

Same client API as within the APP SDK (already uses the plain client type)
No more waterfall calls
Maintainability and velocity as we only need to support a single client shape in the future

ToDo

[ ] Update Readme
[ ] Update Tests

Checklist (check all before merging)

[ ] Both unit and integration tests are passing
[ ] There are no breaking changes
[ ] Changes are reflected in the documentation

BREAKING CHANGE: The plain client will become the new default client