feat: narrow sys.type to a string literal type for better type safety

lib/adapters/REST/endpoints/usage.ts

@@ -8,7 +8,7 @@ export const getManyForSpace: RestEndpoint<'Usage', 'getManyForSpace'> = (
   http: AxiosInstance,
   params: { organizationId: string } & QueryParams
 ) => {
-  return raw.get<CollectionProp<UsageProps>>(
+  return raw.get<CollectionProp<UsageProps<'SpacePeriodicUsage'>>>(
     http,
     `/organizations/${params.organizationId}/space_periodic_usages`,
     {
@@ -21,7 +21,7 @@ export const getManyForOrganization: RestEndpoint<'Usage', 'getManyForOrganizati
   http: AxiosInstance,
   params: { organizationId: string } & QueryParams
 ) => {
-  return raw.get<CollectionProp<UsageProps>>(
+  return raw.get<CollectionProp<UsageProps<'OrganizationPeriodicUsage'>>>(
     http,
     `/organizations/${params.organizationId}/organization_periodic_usages`,
     {

lib/common-types.ts

@@ -248,8 +248,8 @@ export interface SpaceQueryOptions extends PaginationQueryOptions {
   spaceId?: string
 }
 
-export interface BasicMetaSysProps<TSubject extends string = string> {
-  type: string
+export interface BasicMetaSysProps<TType extends string, TSubject extends string = string> {
+  type: TType
   id: string
   version: number
   createdBy?: { [Subject in TSubject]: Link<Subject> }[TSubject]
@@ -258,8 +258,8 @@ export interface BasicMetaSysProps<TSubject extends string = string> {
   updatedAt: string
 }
 
-export interface MetaSysProps<TSubject extends string = string>
-  extends BasicMetaSysProps<TSubject> {
+export interface MetaSysProps<TType extends string, TSubject extends string = string>
+  extends BasicMetaSysProps<TType, TSubject> {
   space?: Link<'Space'>
   /**
    * @deprecated `status` only exists on entities. Please refactor to use a

lib/entities/access-token.ts

@@ -10,7 +10,7 @@ type Application = {
   sys: Link<'Application'>
 }
 
-type AccessTokenSysProps = BasicMetaSysProps<'User'> & {
+type AccessTokenSysProps = BasicMetaSysProps<'PersonalAccessToken', 'User'> & {
   application: Application | null
   expiresAt: string | null
   lastUsedAt: string | null

lib/entities/ai-action.ts

@@ -78,7 +78,7 @@ export interface AiActionQueryOptions {
 }
 
 export type AiActionProps = {
-  sys: MetaSysProps<'User' | 'AppDefinition'> & {
+  sys: MetaSysProps<'AiAction', 'User' | 'AppDefinition'> & {
     type: 'AiAction'
     space: Link<'Space'>
     publishedBy?: Link<'User'> | Link<'AppDefinition'>

lib/entities/app-access-token.ts

@@ -3,7 +3,7 @@ import { freezeSys, toPlainObject } from 'contentful-sdk-core'
 import type { Except } from 'type-fest'
 import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types'
 
-type AppAccessTokenSys = Except<BasicMetaSysProps<'User'>, 'version' | 'id'> & {
+type AppAccessTokenSys = Except<BasicMetaSysProps<'AppAccessToken', 'User'>, 'version' | 'id'> & {
   space: Link<'Space'>
   environment: Link<'Environment'>
   appDefinition: Link<'AppDefinition'>

lib/entities/app-action-call.ts

@@ -11,7 +11,7 @@ import type {
 import type { WebhookCallDetailsProps } from './webhook'
 import enhanceWithMethods from '../enhance-with-methods'
 
-type AppActionCallSys = Except<BasicMetaSysProps<'User'>, 'version'> & {
+type AppActionCallSys = Except<BasicMetaSysProps<'AppActionCall', 'User'>, 'version'> & {
   appDefinition: Link<'AppDefinition'>
   space: Link<'Space'>
   environment: Link<'Environment'>

lib/entities/app-action.ts

@@ -6,7 +6,7 @@ import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../c
 import type { ParameterDefinition } from './widget-parameters'
 import enhanceWithMethods from '../enhance-with-methods'
 
-type AppActionSys = Except<BasicMetaSysProps<'User'>, 'version'> & {
+type AppActionSys = Except<BasicMetaSysProps<'AppAction', 'User'>, 'version'> & {
   appDefinition: Link<'AppDefinition'>
   organization: Link<'Organization'>
 }

lib/entities/app-bundle.ts

@@ -5,7 +5,7 @@ import { wrapCollection } from '../common-utils'
 import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types'
 import enhanceWithMethods from '../enhance-with-methods'
 
-type AppBundleSys = Except<BasicMetaSysProps<'User'>, 'version'> & {
+type AppBundleSys = Except<BasicMetaSysProps<'AppBundle', 'User'>, 'version'> & {
   appDefinition: Link<'AppDefinition'>
   organization: Link<'Organization'>
 }

lib/entities/app-definition.ts

@@ -38,7 +38,7 @@ export type AppDefinitionProps = {
   /**
    * System metadata
    */
-  sys: BasicMetaSysProps<'User'> & {
+  sys: BasicMetaSysProps<'AppDefinition', 'User'> & {
     organization: Link<'Organization'>
     shared: boolean
   }

lib/entities/app-details.ts

@@ -4,7 +4,7 @@ import type { Except } from 'type-fest'
 import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types'
 import enhanceWithMethods from '../enhance-with-methods'
 
-type AppDetailsSys = Except<BasicMetaSysProps<'User'>, 'version' | 'id'> & {
+type AppDetailsSys = Except<BasicMetaSysProps<'AppDetails', 'User'>, 'version' | 'id'> & {
   appDefinition: Link<'AppDefinition'>
   organization: Link<'Organization'>
 }

lib/entities/app-event-subscription.ts

@@ -4,7 +4,10 @@ import type { Except } from 'type-fest'
 import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types'
 import enhanceWithMethods from '../enhance-with-methods'
 
-type AppEventSubscriptionSys = Except<BasicMetaSysProps<'User'>, 'version' | 'id'> & {
+type AppEventSubscriptionSys = Except<
+  BasicMetaSysProps<'AppEventSubscription', 'User'>,
+  'version' | 'id'
+> & {
   appDefinition: Link<'AppDefinition'>
   organization: Link<'Organization'>
 }

lib/entities/app-installation.ts

@@ -7,7 +7,7 @@ import type { Except } from 'type-fest'
 import type { FreeFormParameters } from './widget-parameters'
 
 export type AppInstallationProps = {
-  sys: Omit<BasicMetaSysProps<'User'>, 'id'> & {
+  sys: Omit<BasicMetaSysProps<'AppInstallation', 'User'>, 'id'> & {
     appDefinition: Link<'AppDefinition'>
     environment: Link<'Environment'>
     space: Link<'Space'>

lib/entities/app-key.ts

@@ -5,7 +5,7 @@ import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../c
 import enhanceWithMethods from '../enhance-with-methods'
 import { wrapCollection } from '../common-utils'
 
-type AppKeySys = Except<BasicMetaSysProps<'User'>, 'version'> & {
+type AppKeySys = Except<BasicMetaSysProps<'AppKey', 'User'>, 'version'> & {
   appDefinition: Link<'AppDefinition'>
   organization: Link<'Organization'>
 }

lib/entities/app-signed-request.ts

@@ -3,7 +3,10 @@ import { toPlainObject } from 'contentful-sdk-core'
 import type { Except } from 'type-fest'
 import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types'
 
-type AppSignedRequestSys = Except<BasicMetaSysProps<'User'>, 'version' | 'id'> & {
+type AppSignedRequestSys = Except<
+  BasicMetaSysProps<'AppSignedRequest', 'User'>,
+  'version' | 'id'
+> & {
   appDefinition: Link<'AppDefinition'>
   space: Link<'Space'>
   environment: Link<'Environment'>

lib/entities/app-signing-secret.ts

@@ -4,7 +4,10 @@ import type { Except } from 'type-fest'
 import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types'
 import enhanceWithMethods from '../enhance-with-methods'
 
-type AppSigningSecretSys = Except<BasicMetaSysProps<'User'>, 'version' | 'id'> & {
+type AppSigningSecretSys = Except<
+  BasicMetaSysProps<'AppSigningSecret', 'User'>,
+  'version' | 'id'
+> & {
   appDefinition: Link<'AppDefinition'>
   organization: Link<'Organization'>
 }

lib/entities/app-upload.ts

@@ -5,7 +5,7 @@ import type { BasicMetaSysProps, DefaultElements, MakeRequest, Link } from '../c
 import { wrapCollection } from '../common-utils'
 import enhanceWithMethods from '../enhance-with-methods'
 
-type AppUploadSys = Except<BasicMetaSysProps<'User'>, 'version'>
+type AppUploadSys = Except<BasicMetaSysProps<'AppUpload', 'User'>, 'version'>
 
 export type AppUploadProps = {
   sys: AppUploadSys & {

lib/entities/comment.ts

@@ -23,7 +23,7 @@ interface LinkWithReference<T extends string> extends Link<T> {
 }
 
 export type CommentSysProps = Pick<
-  BasicMetaSysProps<'User'>,
+  BasicMetaSysProps<'Comment', 'User'>,
   'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'
 > & {
   type: 'Comment'

lib/entities/content-type.ts

@@ -38,7 +38,7 @@ export type AnnotationAssignment = Link<'Annotation'> & {
 }
 
 export type ContentTypeProps = {
-  sys: BasicMetaSysProps<'User' | 'AppDefinition'> & {
+  sys: BasicMetaSysProps<'ContentType', 'User' | 'AppDefinition'> & {
     space: Link<'Space'>
     environment: Link<'Environment'>
     firstPublishedAt?: string

lib/entities/environment-alias.ts

@@ -8,7 +8,7 @@ export type EnvironmentAliasProps = {
   /**
    * System meta data
    */
-  sys: BasicMetaSysProps<'User'> & { space: Link<'Space'> }
+  sys: BasicMetaSysProps<'EnvironmentAlias', 'User'> & { space: Link<'Space'> }
   environment: Link<'Environment'>
 }
 

lib/entities/environment-template-installation.ts

@@ -27,7 +27,7 @@ export type EnvironmentTemplateInstallationStatus =
   keyof typeof EnvironmentTemplateInstallationStatuses
 
 export type EnvironmentTemplateInstallationProps = {
-  sys: BasicMetaSysProps<'User'> & {
+  sys: BasicMetaSysProps<'EnvironmentTemplateInstallation', 'User'> & {
     type: 'EnvironmentTemplateInstallation'
     space: Link<'Space'>
     template: VersionedLink<'Template'>

lib/entities/environment-template.ts

@@ -29,7 +29,10 @@ export interface ContentTypeTemplateProps extends Omit<ContentTypeProps, 'sys'>
 }
 
 export type EnvironmentTemplateProps = {
-  sys: BasicMetaSysProps<'User'> & { version: number; organization: Link<'Organization'> }
+  sys: BasicMetaSysProps<'EnvironmentTemplate', 'User'> & {
+    version: number
+    organization: Link<'Organization'>
+  }
   name: string
   description?: string
   versionName: string

lib/entities/environment.ts

@@ -6,7 +6,7 @@ import createEnvironmentApi from '../create-environment-api'
 import { wrapCollection } from '../common-utils'
 import type { DefaultElements, BasicMetaSysProps, MakeRequest, Link } from '../common-types'
 
-type EnvironmentMetaSys = BasicMetaSysProps<'User'> & {
+type EnvironmentMetaSys = BasicMetaSysProps<'EnvironmentMeta', 'User'> & {
   status: Link<'Status'>
   space: Link<'Space'>
   aliases?: Array<Link<'EnvironmentAlias'>>

lib/entities/extension.ts

@@ -11,7 +11,7 @@ import { wrapCollection } from '../common-utils'
 import type { DefaultElements, BasicMetaSysProps, MakeRequest, Link } from '../common-types'
 import type { SetRequired, RequireExactlyOne } from 'type-fest'
 
-type ExtensionSysProps = BasicMetaSysProps<'User'> & {
+type ExtensionSysProps = BasicMetaSysProps<'Extension', 'User'> & {
   space: Link<'Space'>
   environment: Link<'Environment'>
   srcdocSha256?: string

lib/entities/locale.ts

@@ -6,7 +6,7 @@ import { wrapCollection } from '../common-utils'
 import type { BasicMetaSysProps, DefaultElements, MakeRequest, Link } from '../common-types'
 
 export type LocaleProps = {
-  sys: BasicMetaSysProps<'User' | 'AppDefinition'> & {
+  sys: BasicMetaSysProps<'Locale', 'User' | 'AppDefinition'> & {
     space: Link<'Space'>
     environment: Link<'Environment'>
   }

lib/entities/oauth-application.ts

@@ -4,7 +4,7 @@ import enhanceWithMethods from '../enhance-with-methods'
 import copy from 'fast-copy'
 import { wrapCursorPaginatedCollection } from '../common-utils'
 
-type OAuthApplicationSysProps = BasicMetaSysProps<'User'> & {
+type OAuthApplicationSysProps = BasicMetaSysProps<'Application', 'User'> & {
   lastUsedAt: string | null
 }
 

lib/entities/resource-provider.ts

@@ -15,7 +15,7 @@ export type ResourceProviderProps = {
   /**
    * System metadata
    */
-  sys: Omit<BasicMetaSysProps<'User'>, 'version'> & {
+  sys: Omit<BasicMetaSysProps<'ResourceProvider', 'User'>, 'version'> & {
     organization: Link<'Organization'>
     appDefinition: Link<'AppDefinition'>
   }

lib/entities/resource-type.ts

@@ -15,7 +15,7 @@ export type ResourceTypeProps = {
   /**
    * System metadata
    */
-  sys: Omit<BasicMetaSysProps<'User'>, 'version'> & {
+  sys: Omit<BasicMetaSysProps<'ResourceType', 'User'>, 'version'> & {
     appDefinition: Link<'AppDefinition'>
     resourceProvider: Link<'ResourceProvider'>
     organization: Link<'Organization'>

lib/entities/role.ts

@@ -20,7 +20,7 @@ export type ConstraintType = {
 }
 
 export type RoleProps = {
-  sys: BasicMetaSysProps<'User'> & { space: Link<'Space'> }
+  sys: BasicMetaSysProps<'Role', 'User'> & { space: Link<'Space'> }
   name: string
   description?: string
   /**

lib/entities/space.ts

@@ -7,7 +7,10 @@ import createSpaceApi from '../create-space-api'
 import enhanceWithMethods from '../enhance-with-methods'
 
 export type SpaceProps = {
-  sys: BasicMetaSysProps<'User'> & { organization: { sys: { id: string } }; archivedAt?: string }
+  sys: BasicMetaSysProps<'Space', 'User'> & {
+    organization: { sys: { id: string } }
+    archivedAt?: string
+  }
   name: string
 }
 

lib/entities/task.ts

@@ -14,7 +14,7 @@ import enhanceWithMethods from '../enhance-with-methods'
 export type TaskStatus = 'active' | 'resolved'
 
 export type TaskSysProps = Pick<
-  BasicMetaSysProps<'User' | 'AppDefinition'>,
+  BasicMetaSysProps<'Task', 'User' | 'AppDefinition'>,
   'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'
 > & {
   type: 'Task'

lib/entities/ui-config.ts

@@ -17,7 +17,7 @@ export type UIConfigProps = {
   publish?: { publishMode: 'entryPublishing' | 'localePublishing' }
 }
 
-export interface UIConfigSysProps extends BasicMetaSysProps<'User' | 'AppDefinition'> {
+export interface UIConfigSysProps extends BasicMetaSysProps<'UIConfig', 'User' | 'AppDefinition'> {
   space: Link<'Space'>
   environment: Link<'Environment'>
 }

lib/entities/usage.ts

@@ -12,13 +12,17 @@ export interface UsageQuery extends QueryOptions {
   'dateRange.endAt'?: string
 }
 
-export type UsageProps = {
+export type UsageProps<
+  TType extends 'SpacePeriodicUsage' | 'OrganizationPeriodicUsage' =
+    | 'SpacePeriodicUsage'
+    | 'OrganizationPeriodicUsage'
+> = {
   /**
    * System metadata
    */
   sys: {
     id: string
-    type: string
+    type: TType
     organization?: Link<'Organization'>
   }
 

lib/entities/user-ui-config.ts

@@ -14,7 +14,8 @@ export type UserUIConfigProps = {
   entryListViews: ViewFolder[]
 }
 
-export interface UserUIConfigSysProps extends BasicMetaSysProps<'User' | 'AppDefinition'> {
+export interface UserUIConfigSysProps
+  extends BasicMetaSysProps<'UserUIConfig', 'User' | 'AppDefinition'> {
   space: Link<'Space'>
   environment: Link<'Environment'>
 }

lib/entities/user.ts

@@ -8,7 +8,7 @@ export type UserProps = {
   /**
    * System metadata
    */
-  sys: BasicMetaSysProps<'User'>
+  sys: BasicMetaSysProps<'User', 'User'>
 
   /**
    * First name of the user