fix: add back and deprecate removed types (#2460)

contentful · Nov 6, 2024 · e27e01a · e27e01a
1 parent 9f950e1
commit e27e01a
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 2 deletions.
diff --git a/lib/common-types.ts b/lib/common-types.ts
@@ -256,6 +256,11 @@ export interface MetaSysProps extends BasicMetaSysProps {
 }
 
 export interface EntityMetaSysProps extends MetaSysProps {
+  /**
+   * @deprecated `contentType` only exists on entries. Please refactor to use a
+   * type guard to get the correct `EntryMetaSysProps` type with this property.
+   */
+  contentType: SysLink
   space: SysLink
   status?: SysLink
   environment: SysLink

diff --git a/lib/entities/access-token.ts b/lib/entities/access-token.ts
@@ -25,6 +25,11 @@ export type AccessTokenProps = {
   token?: string
 }
 
+/**
+ * @deprecated Use `AccessTokenProps` instead.
+ */
+export type AccessTokenProp = AccessTokenProps
+
 export type CreatePersonalAccessTokenProps = Pick<AccessToken, 'name' | 'scopes'> & {
   expiresIn: number
 }

diff --git a/lib/entities/organization.ts b/lib/entities/organization.ts
@@ -21,6 +21,11 @@ export type OrganizationProps = {
   name: string
 }
 
+/**
+ * @deprecated Use `OrganizationProps` instead.
+ */
+export type OrganizationProp = OrganizationProps
+
 /**
  * This method creates the API for the given organization with all the methods for
  * reading and creating other entities. It also passes down a clone of the

diff --git a/lib/entities/personal-access-token.ts b/lib/entities/personal-access-token.ts
@@ -12,6 +12,11 @@ export type PersonalAccessTokenProps = {
   token?: string
 }
 
+/**
+ * @deprecated Use `PersonalAccessTokenProps` instead.
+ */
+export type PersonalAccessTokenProp = PersonalAccessTokenProps
+
 export type CreatePersonalAccessTokenProps = Pick<PersonalAccessToken, 'name' | 'scopes'> & {
   expiresIn?: number
 }

diff --git a/lib/export-types.ts b/lib/export-types.ts
@@ -144,7 +144,7 @@ export type {
 } from './entities/extension'
 export type { FieldType } from './entities/field-type'
 export type { CreateLocaleProps, Locale, LocaleProps } from './entities/locale'
-export type { Organization, OrganizationProps } from './entities/organization'
+export type { Organization, OrganizationProp, OrganizationProps } from './entities/organization'
 export type {
   CreateOrganizationInvitationProps,
   OrganizationInvitation,
@@ -157,7 +157,8 @@ export type {
 export type {
   CreatePersonalAccessTokenProps,
   PersonalAccessToken,
-  PersonalAccessTokenProps as PersonalAccessTokenProp,
+  PersonalAccessTokenProp,
+  PersonalAccessTokenProps,
 } from './entities/personal-access-token'
 export type {
   CreatePersonalAccessTokenProps as CreatePATProps,