feat: deprecate legacy client [NONE]

Author: marcolink

lib/contentful-management.ts

@@ -57,31 +57,20 @@ function createClient(params: ClientOptions): ClientAPI
 function createClient(
   params: ClientOptions,
   opts: {
-    type: 'plain'
+    // type: 'plain'
     defaults?: DefaultParams
   }
 ): PlainClientAPI
-// Usually, overloads with more specific signatures should come first but some IDEs are often not able to handle overloads with separate TSDocs correctly
-/**
- * @deprecated The `alphaFeatures` option is no longer supported. Please use the function without this option.
- */
-function createClient(
-  params: ClientOptions,
-  opts: {
-    type?: 'plain'
-    alphaFeatures: string[]
-    defaults?: DefaultParams
-  }
-): ClientAPI | PlainClientAPI
+
 function createClient(
   params: ClientOptions,
   opts: {
-    type?: 'plain'
+    type?: 'legacy'
     defaults?: DefaultParams
   } = {}
 ): ClientAPI | PlainClientAPI {
   const sdkMain =
-    opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js'
+    opts.type === 'legacy' ? 'contentful-management.js' : 'contentful-management-plain.js'
   const userAgent = getUserAgentHeader(
     // @ts-expect-error
     `${sdkMain}/${__VERSION__}`,
@@ -98,9 +87,9 @@ function createClient(
   const makeRequest: MakeRequest = (options: Parameters<MakeRequest>[0]): ReturnType<MakeRequest> =>
     adapter.makeRequest({ ...options, userAgent })
 
-  if (opts.type === 'plain') {
-    return createPlainClient(makeRequest, opts.defaults)
-  } else {
+  if (opts.type === 'legacy') {
     return createContentfulApi(makeRequest) as ClientAPI
+  } else {
+    return createPlainClient(makeRequest, opts.defaults)
   }
 }

lib/create-app-definition-api.ts

@@ -39,6 +39,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
      * .then((appDefinition) => console.log(`App Definition ${appDefinition.sys.id} updated.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     update: function update() {
       const data = this.toPlainObject() as AppDefinitionProps
@@ -67,6 +68,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
      * .then(() => console.log(`App Definition deleted.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     delete: function del() {
       const data = this.toPlainObject() as AppDefinitionProps
@@ -93,6 +95,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
      * .then((appBundle) => console.log(appBundle))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getAppBundle(id: string) {
       const raw = this.toPlainObject() as AppDefinitionProps
@@ -122,6 +125,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
      * .then((response) => console.log(response.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getAppBundles(query: QueryOptions = {}) {
       const raw = this.toPlainObject() as AppDefinitionProps
@@ -147,6 +151,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
      * .then((appBundle) => console.log(appBundle))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     createAppBundle(data: CreateAppBundleProps) {
       const raw = this.toPlainObject() as AppDefinitionProps
@@ -177,6 +182,7 @@ export default function createAppDefinitionApi(makeRequest: MakeRequest) {
      * .then((appInstallationsForOrg) => console.log(appInstallationsForOrg.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getInstallationsForOrg(query: SpaceQueryOptions = {}) {
       const raw = this.toPlainObject() as AppDefinitionProps

lib/create-contentful-api.ts

@@ -24,6 +24,9 @@ import {
 } from './entities/environment-template'
 import { RawAxiosRequestConfig } from 'axios'
 
+/**
+ * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
+ */
 export type ClientAPI = ReturnType<typeof createClientApi>
 type CreateSpaceProps = Omit<SpaceProps, 'sys'> & { defaultLocale?: string }
 
@@ -58,6 +61,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((response) => console.log(response.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getEnvironmentTemplates: function getEnvironmentTemplates(
       organizationId: string,
@@ -90,6 +94,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((space) => console.log(space))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getEnvironmentTemplate: function getEnvironmentTemplate({
       organizationId,
@@ -127,6 +132,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((environmentTemplate) => console.log(environmentTemplate))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     createEnvironmentTemplate: function createEnvironmentTemplate(
       organizationId: string,
@@ -153,6 +159,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((response) => console.log(response.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getSpaces: function getSpaces(
       query: QueryOptions = {}
@@ -179,6 +186,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((space) => console.log(space))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getSpace: function getSpace(spaceId: string): Promise<Space> {
       return makeRequest({
@@ -206,6 +214,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((space) => console.log(space))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     createSpace: function createSpace(
       spaceData: CreateSpaceProps,
@@ -234,6 +243,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((org) => console.log(org))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getOrganization: function getOrganization(id: string): Promise<Organization> {
       return makeRequest({
@@ -257,6 +267,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(result => console.log(result.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getOrganizations: function getOrganizations(
       query: PaginationQueryParams['query'] = {}
@@ -282,6 +293,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(user => console.log(user.firstName))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getCurrentUser: function getCurrentUser<T = UserProps>(params?: QueryParams): Promise<T> {
       return makeRequest({
@@ -307,8 +319,8 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(appDefinition => console.log(appDefinition.name))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
-
     getAppDefinition: function getAppDefinition(
       params: GetAppDefinitionParams
     ): Promise<AppDefinition> {
@@ -341,6 +353,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(personalAccessToken => console.log(personalAccessToken.token))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     createPersonalAccessToken: function createPersonalAccessToken(
       data: CreatePersonalAccessTokenProps
@@ -374,6 +387,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(token => console.log(token.token))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getPersonalAccessToken: function getPersonalAccessToken(tokenId: string) {
       return makeRequest({
@@ -399,6 +413,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(response => console.log(reponse.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getPersonalAccessTokens: function getPersonalAccessTokens() {
       return makeRequest({
@@ -423,6 +438,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(token => console.log(token.token))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getAccessToken: function getAccessToken(tokenId: string) {
       return makeRequest({
@@ -446,6 +462,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(response => console.log(reponse.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getAccessTokens: function getAccessTokens() {
       return makeRequest({
@@ -470,6 +487,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(response => console.log(reponse.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getOrganizationAccessTokens: function getOrganizationAccessTokens(
       organizationId: string,
@@ -505,6 +523,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(result => console.log(result.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getOrganizationUsage: function getOrganizationUsage(
       organizationId: string,
@@ -541,6 +560,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then(result => console.log(result.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getSpaceUsage: function getSpaceUsage(organizationId: string, query: UsageQuery = {}) {
       return makeRequest({
@@ -571,6 +591,7 @@ export default function createClientApi(makeRequest: MakeRequest) {
      * .then((responseData) => console.log(responseData))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     rawRequest: function rawRequest({ url, ...config }: RawAxiosRequestConfig & { url: string }) {
       return makeRequest({

lib/create-entry-api.ts

@@ -54,6 +54,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((entry) => console.log(`Entry ${entry.sys.id} updated.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     update: function update() {
       const { raw, params } = getParams(this)
@@ -89,6 +90,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((entry) => console.log(`Entry ${entry.sys.id} updated.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     patch: function patch(ops: OpPatch[]) {
       const { raw, params } = getParams(this)
@@ -145,6 +147,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((entry) => console.log(`Entry ${entry.sys.id} published.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     publish: function publish() {
       const { raw, params } = getParams(this)
@@ -174,6 +177,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((entry) => console.log(`Entry ${entry.sys.id} unpublished.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
 
     unpublish: function unpublish() {
@@ -203,6 +207,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((entry) => console.log(`Entry ${entry.sys.id} archived.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     archive: function archive() {
       const { params } = getParams(this)
@@ -231,6 +236,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((entry) => console.log(`Entry ${entry.sys.id} unarchived.`))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     unarchive: function unarchive() {
       const { params } = getParams(this)
@@ -258,6 +264,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((snapshots) => console.log(snapshots.items))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getSnapshots: function (query = {}) {
       const { params } = getParams(this)
@@ -286,6 +293,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((snapshot) => console.log(snapshot))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getSnapshot: function (snapshotId: string) {
       const { params } = getParams(this)
@@ -317,6 +325,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((comment) => console.log(comment))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     createComment: function (data: CreateCommentProps) {
       const { params } = getParams(this)
@@ -349,6 +358,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((comments) => console.log(comments))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getComments: function () {
       const { params } = getParams(this)
@@ -375,6 +385,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((comment) => console.log(comment))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getComment: function (id: string) {
       const { params } = getParams(this)
@@ -410,6 +421,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((task) => console.log(task))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     createTask: function (data: CreateTaskProps) {
       const { params } = getParams(this)
@@ -437,6 +449,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((tasks) => console.log(tasks))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getTasks: function (query = {}) {
       const { params } = getParams(this)
@@ -463,6 +476,7 @@ export default function createEntryApi(makeRequest: MakeRequest) {
      * .then((task) => console.log(task))
      * .catch(console.error)
      * ```
+     * @deprecated The `old` client is deprecated in favor of the `plain` client since version 12.0.0.
      */
     getTask: function (id: string) {
       const { params } = getParams(this)