@financial-times/cp-content-pipeline-schema 3.7.2 → 3.8.0

package/src/model/{CapiResponse.test.ts → Content.test.ts}

@@ -1,13 +1,13 @@
-import { CapiResponse } from './CapiResponse'
+import { Content } from './Content'
 import { baseCapiObject } from '../fixtures/capiObject'
 import cloneDeep from 'clone-deep'
 import context from '../fixtures/dummyContext'
 
-describe('CAPI response', () => {
+describe('Content', () => {
   describe('Content ID', () => {
     test('returns the UUID', () => {
       const article = cloneDeep(baseCapiObject)
-      const capiResponse = new CapiResponse(article, context)
+      const capiResponse = new Content(article, context)
 
       expect(capiResponse.id()).toEqual('3071cae8-a27c-4ab4-a0d4-7bb00df1d477')
     })
@@ -17,7 +17,7 @@ describe('CAPI response', () => {
     test(`uses first entry in types if there's no type`, () => {
       const article = cloneDeep(baseCapiObject)
       delete article.type
-      const capiResponseArticle = new CapiResponse(article, context)
+      const capiResponseArticle = new Content(article, context)
 
       expect(capiResponseArticle.type()).toEqual('Article')
     })
@@ -28,11 +28,8 @@ describe('CAPI response', () => {
         ...baseCapiObject,
         type: 'http://www.ft.com/ontology/content/LiveBlogPackage',
       })
-      const capiResponseArticle = new CapiResponse(article, context)
-      const capiResponseLiveBlogPackage = new CapiResponse(
-        liveBlogPackage,
-        context
-      )
+      const capiResponseArticle = new Content(article, context)
+      const capiResponseLiveBlogPackage = new Content(liveBlogPackage, context)
 
       expect(capiResponseArticle.type()).toEqual('Article')
       expect(capiResponseLiveBlogPackage.type()).toEqual('LiveBlogPackage')
@@ -43,7 +40,7 @@ describe('CAPI response', () => {
         ...baseCapiObject,
         type: 'http://www.ft.com/ontology/content/Unknown',
       })
-      const capiResponse = new CapiResponse(unknown, context)
+      const capiResponse = new Content(unknown, context)
       expect(() => capiResponse.type()).toThrowError(
         'Content type is invalid: http://www.ft.com/ontology/content/Unknown'
       )
@@ -53,7 +50,7 @@ describe('CAPI response', () => {
   describe('Publish timestamp', () => {
     test('generates a timestamp from the published date', () => {
       const article = cloneDeep(baseCapiObject)
-      const capiResponse = new CapiResponse(article, context)
+      const capiResponse = new Content(article, context)
 
       expect(capiResponse.publishedTimestamp()).toEqual(1712052009935)
     })
@@ -62,7 +59,7 @@ describe('CAPI response', () => {
   describe('Modified timestamp', () => {
     test('generates a timestamp from the last modified date', () => {
       const article = cloneDeep(baseCapiObject)
-      const capiResponse = new CapiResponse(article, context)
+      const capiResponse = new Content(article, context)
 
       expect(capiResponse.modifiedTimestamp()).toEqual(1712061296789)
     })
@@ -92,7 +89,7 @@ describe('CAPI response', () => {
         ],
       })
 
-      const capiResponse = new CapiResponse(liveBlogPackage, context)
+      const capiResponse = new Content(liveBlogPackage, context)
       const liveBlogPosts = await capiResponse.liveBlogPosts()
       expect(liveBlogPosts[0]?.id()).toEqual(
         '00000000-0000-0000-0000-000000000002'
@@ -122,7 +119,7 @@ describe('CAPI response', () => {
         }
       }),
     })
-    const capiResponse = new CapiResponse(liveBlogPackage, context)
+    const capiResponse = new Content(liveBlogPackage, context)
 
     test('returns all posts when no argument specified', async () => {
       const liveBlogPostsConnection =
@@ -245,7 +242,7 @@ describe('CAPI response', () => {
           'http://www.ft.com/thing/724b5e36-6d45-4cf1-b1c2-3f676b21f21b',
         ],
       })
-      const capiResponse = new CapiResponse(article, context)
+      const capiResponse = new Content(article, context)
 
       expect(capiResponse.isPartnerContent()).toBe(true)
     })
@@ -254,7 +251,7 @@ describe('CAPI response', () => {
         ...baseCapiObject,
         publication: null,
       })
-      const capiResponse = new CapiResponse(article, context)
+      const capiResponse = new Content(article, context)
 
       expect(capiResponse.isPartnerContent()).toBe(false)
     })
@@ -268,7 +265,7 @@ describe('CAPI response', () => {
       const timingOutContext = cloneDeep(context)
       timingOutContext.dataSources.capi.getPerson = () =>
         Promise.reject(new DOMException(undefined, 'TimeoutError'))
-      const capiResponse = new CapiResponse(article, timingOutContext)
+      const capiResponse = new Content(article, timingOutContext)
 
       const authors = await capiResponse.authors()
       const primaryAuthor = await capiResponse.primaryAuthor()
@@ -277,4 +274,55 @@ describe('CAPI response', () => {
       expect(primaryAuthor?.['person'].id).toBe(authorAnnotation.id)
     })
   })
+
+  describe('isFTEdit', () => {
+    test('identifies articles that are part of an FT Edit edition', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'ftedit',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isFTEdit()).toBe(true)
+    })
+
+    test('identifies articles that are not part of an FT Edit edition', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'test',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isFTEdit()).toBe(false)
+    })
+
+    test('ignores typos', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'ft edit',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isFTEdit()).toBe(false)
+    })
+
+    test('handles multiple values', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'test,ftedit,test2',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isFTEdit()).toBe(true)
+    })
+
+    test('handles missing `internalAnalyticsTags` property', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isFTEdit()).toBe(false)
+    })
+  })
 })

package/src/model/{CapiResponse.ts → Content.ts}

@@ -100,18 +100,18 @@ const baselineContentSchema = z.object({
 
 type BaselineContent = z.infer<typeof baselineContentSchema>
 
-export class CapiResponse {
+export class Content {
   constructor(
     private capiData: ContentTypeSchemas,
     private context: QueryContext,
-    private packageContainer?: CapiResponse
+    private packageContainer?: Content
   ) {}
 
   static fromJSON(
     content: unknown,
     context: QueryContext,
-    packageContainer?: CapiResponse
-  ): CapiResponse {
+    packageContainer?: Content
+  ): Content {
     // if the content doesn't meet the baseline schema, something's gone
     // unexpectedly very wrong. throwing an non-operational error is the
     // right thing to do in that case, so we call .parse not .safeParse
@@ -160,11 +160,7 @@ export class CapiResponse {
 
     // we can "safely" cast content to the schema return types here. if the type is
     // incorrect, we've at least logged that error.
-    return new CapiResponse(
-      content as ContentTypeSchemas,
-      context,
-      packageContainer
-    )
+    return new Content(content as ContentTypeSchemas, context, packageContainer)
   }
 
   body() {
@@ -456,7 +452,7 @@ export class CapiResponse {
     if ('title' in this.capiData) {
       const clone = cloneDeep(this.capiData)
       clone.title = title
-      return new CapiResponse(clone, this.context, this.packageContainer)
+      return new Content(clone, this.context, this.packageContainer)
     }
     return this
   }
@@ -540,7 +536,7 @@ export class CapiResponse {
 
   teaser() {
     const clone = cloneDeep(this.capiData)
-    return new CapiResponse(clone, this.context, this.packageContainer)
+    return new Content(clone, this.context, this.packageContainer)
   }
 
   isEditorsChoice() {
@@ -710,7 +706,7 @@ export class CapiResponse {
   async contains({
     surroundingArticles,
     fromId,
-  }: Partial<ContentPackageContainsArgs> = {}): Promise<CapiResponse[] | null> {
+  }: Partial<ContentPackageContainsArgs> = {}): Promise<Content[] | null> {
     let edges
     if (fromId && surroundingArticles) {
       const afterId = await this.containsConnection({
@@ -734,7 +730,7 @@ export class CapiResponse {
     transformer?: (
       contains: LiveBlogPackage['contains']
     ) => LiveBlogPackage['contains']
-  ): Promise<Connection<CapiResponse>> {
+  ): Promise<Connection<Content>> {
     if ('contains' in this.capiData) {
       const { contains: containsUntransformed } = this.capiData
       const contains = transformer
@@ -790,7 +786,7 @@ export class CapiResponse {
 
       const edges = results
         .filter(
-          (result): result is PromiseFulfilledResult<CapiResponse> =>
+          (result): result is PromiseFulfilledResult<Content> =>
             result.status === 'fulfilled'
         )
         .map((result) => {
@@ -849,7 +845,7 @@ export class CapiResponse {
 
   async liveBlogPosts(
     args?: LiveBlogPackageLiveBlogPostsArgs
-  ): Promise<CapiResponse[] | []> {
+  ): Promise<Content[] | []> {
     const containsConnections = await this.containsConnection(
       {
         first: args?.count ?? undefined,
@@ -865,7 +861,7 @@ export class CapiResponse {
 
   async liveBlogPostsConnection(
     args: ConnectionArguments
-  ): Promise<Connection<CapiResponse>> {
+  ): Promise<Connection<Content>> {
     return this.containsConnection(args, this.handleLiveBlogPosts.bind(this))
   }
 
@@ -881,7 +877,7 @@ export class CapiResponse {
     return false
   }
 
-  async pinnedPost(): Promise<CapiResponse | null> {
+  async pinnedPost(): Promise<Content | null> {
     if ('pinnedPosts' in this.capiData) {
       const pinnedPosts = this.capiData.pinnedPosts
       const pinnedPostId = pinnedPosts[0]
@@ -934,6 +930,17 @@ export class CapiResponse {
     return false
   }
 
+  isFTEdit(): boolean {
+    if (
+      'internalAnalyticsTags' in this.capiData &&
+      this.capiData.internalAnalyticsTags
+    ) {
+      return this.capiData.internalAnalyticsTags.includes('ftedit')
+    }
+
+    return false
+  }
+
   design(): Design {
     if ('design' in this.capiData && this.capiData.design.theme) {
       return { theme: this.capiData.design.theme }

package/src/model/LeadFlourish.test.ts

@@ -1,6 +1,6 @@
 import { LeadFlourish } from './LeadFlourish'
 import { FlourishSource } from './FlourishSource'
-import { CapiResponse } from './CapiResponse'
+import { Content } from './Content'
 import { baseCapiObject } from '../fixtures/capiObject'
 import type { QueryContext } from '..'
 import cloneDeep from 'clone-deep'
@@ -13,7 +13,6 @@ const leadFlourishData = {
   type: 'test-type',
 }
 
-
 describe('LeadFlourish', () => {
   let leadFlourish: LeadFlourish
 
@@ -27,15 +26,17 @@ describe('LeadFlourish', () => {
     }
     jest.spyOn(FlourishSource, 'getImageMetadata').mockResolvedValue({
       width: 800,
-      height: 600
+      height: 600,
     })
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     leadFlourish = new LeadFlourish(capiResponse, context)
   })
 
   describe('fallbackImage', () => {
     it('should instantiate a new FlourishSource', async () => {
-      await expect(leadFlourish.fallbackImage()).resolves.toBeInstanceOf(FlourishSource)
+      await expect(leadFlourish.fallbackImage()).resolves.toBeInstanceOf(
+        FlourishSource
+      )
     })
   })
 

package/src/model/LeadFlourish.ts

@@ -1,13 +1,10 @@
-import { CapiResponse } from './CapiResponse'
+import { Content } from './Content'
 import type { QueryContext } from '..'
 import { FlourishSource } from './FlourishSource'
 
 export class LeadFlourish {
   #systemCode: string
-  constructor(
-    private capiResponse: CapiResponse,
-    private context: QueryContext
-  ) {
+  constructor(private capiResponse: Content, private context: QueryContext) {
     this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
   }
 

package/src/model/{CapiList.ts → List.ts}

@@ -1,11 +1,11 @@
 import { BaseError, OperationalError } from '@dotcom-reliability-kit/errors'
 import { QueryContext } from '..'
 import { uuidFromUrl } from '../helpers/metadata'
-import { List, listSchema } from './schemas/capi/list'
+import { List as ListSchema, listSchema } from './schemas/capi/list'
 import flattenFormattedZodIssues from '../helpers/flatten-formatted-zod-errors'
 
-export class CapiList {
-  static fromJSON(list: unknown, context: QueryContext): CapiList {
+export class List {
+  static fromJSON(list: unknown, context: QueryContext): List {
     const result = listSchema.safeParse(list)
 
     if (!result.success) {
@@ -31,10 +31,10 @@ export class CapiList {
       )
     }
 
-    return new CapiList(list as List, context)
+    return new List(list as ListSchema, context)
   }
 
-  constructor(private list: List, private context: QueryContext) {}
+  constructor(private list: ListSchema, private context: QueryContext) {}
 
   async items() {
     if (!this.list.items) return []

package/src/model/RichText.ts

@@ -3,7 +3,7 @@ import extractText from '../resolvers/content-tree/extractText'
 import updateTreeWithReferenceIds from '../resolvers/content-tree/updateTreeWithReferenceIds'
 import { LiteralUnionScalarValues } from '../resolvers/literal-union'
 import { RichTextSource } from '../resolvers/scalars'
-import { CapiResponse } from './CapiResponse'
+import { Content } from './Content'
 import {
   commonTagMappings,
   articleTagMappings,
@@ -16,7 +16,7 @@ export class RichText {
   constructor(
     public source: LiteralUnionScalarValues<typeof RichTextSource>,
     private value: string | null,
-    private contentApiData?: CapiResponse
+    private contentApiData?: Content
   ) {}
 
   raw() {

package/src/model/Topper.test.ts

@@ -1,7 +1,7 @@
 import { Topper } from './Topper'
 import { Person } from './Person'
 import { baseCapiObject } from '../fixtures/capiObject'
-import { CapiResponse } from './CapiResponse'
+import { Content } from './Content'
 import { predicates } from './Concept'
 import cloneDeep from 'clone-deep'
 import conceptIds from '@financial-times/n-concept-ids'
@@ -18,7 +18,7 @@ const context = {} as unknown as QueryContext
 describe('produces the correct types', () => {
   it('defaults when there is no topper, is normal headline, is paper background', () => {
     const clonedBase = cloneDeep(baseCapiObject)
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = 'BasicTopper'
@@ -47,7 +47,7 @@ describe('produces the correct types', () => {
 
     const clonedBase = cloneDeep(baseCapiObject)
     clonedBase.topper = splitTopper
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desiredType = 'SplitTextTopper'
@@ -76,7 +76,7 @@ describe('produces the correct types', () => {
 
     const clonedBase = cloneDeep(baseCapiObject)
     clonedBase.topper = splitTopper
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = 'FullBleedTopper'
@@ -105,7 +105,7 @@ describe('produces the correct types', () => {
 
     const clonedBase = cloneDeep(baseCapiObject)
     clonedBase.topper = splitTopper
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = 'FullBleedTopper'
@@ -125,7 +125,7 @@ describe('produces the correct types', () => {
       type: '',
       types: [],
     })
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = 'OpinionTopper'
@@ -155,7 +155,7 @@ describe('produces the correct types', () => {
       type: '',
       types: [],
     })
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = 'BrandedTopper'
@@ -186,7 +186,7 @@ describe('produces the correct types', () => {
       layoutWidth: 'full-width',
       backgroundColour: 'paper',
     }
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = 'TopperWithFlourish'
@@ -204,7 +204,7 @@ describe('produces the correct types', () => {
   it('live blog topper, is full bleed, large headline, paper background', () => {
     const clonedBase = cloneDeep(baseCapiObject)
     clonedBase.type = 'http://www.ft.com/ontology/content/LiveBlogPackage'
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = 'FullBleedTopper'
@@ -235,7 +235,7 @@ describe('it retrieves the correct headline', () => {
     }
     clonedBase.topper = topperData
 
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = topperData.headline
@@ -247,7 +247,7 @@ describe('it retrieves the correct headline', () => {
   it('when there is one headline', () => {
     const clonedBase = cloneDeep(baseCapiObject)
 
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = clonedBase.title
@@ -268,7 +268,7 @@ describe('produces the correct intro', () => {
     clonedBase.standfirst =
       'Decision follows 10 days of pressure in wake of controversial mini-Budget'
 
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = {
@@ -286,7 +286,7 @@ describe('produces the correct intro', () => {
       'Decision follows 10 days of pressure in wake of controversial mini-Budget'
     clonedBase.standfirst = standfirst
 
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     const desired = {
@@ -302,7 +302,7 @@ describe('produces the correct intro', () => {
 describe('produces the correct layout', () => {
   it('defaults to branded if there is no layout', () => {
     const clonedBase = cloneDeep(baseCapiObject)
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
     const desired = 'branded'
     const actual = topper.layout()
@@ -335,7 +335,7 @@ describe('produces the correct background colour', () => {
 
     const clonedBase = cloneDeep(baseCapiObject)
     clonedBase.topper = splitTopper
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
 
     expect(topper.backgroundColour()).toEqual(expected)
@@ -371,10 +371,7 @@ describe('produces correct images', () => {
         },
       ],
     }
-    const capiResponse = new CapiResponse(
-      withLeadImagesAndDisplayMainImage,
-      context
-    )
+    const capiResponse = new Content(withLeadImagesAndDisplayMainImage, context)
     const topper = new Topper(capiResponse, context)
     const fallback = topper.fallbackImage()
     expect(fallback?.url()).toEqual(
@@ -383,7 +380,7 @@ describe('produces correct images', () => {
   })
   it('uses the main image as fallback if no lead images', () => {
     const clonedBase = cloneDeep(baseCapiObject)
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
     const fallback = topper.fallbackImage()
     expect(fallback?.url()).toEqual(
@@ -428,7 +425,7 @@ describe('produces the correct metadata tags', () => {
 
   it('uses the annotation with the predicate hasDisplayTag for the displayConcept', () => {
     const clonedBase = cloneDeep(baseCapiObject)
-    const capiResponse = new CapiResponse(clonedBase, context)
+    const capiResponse = new Content(clonedBase, context)
     const topper = new Topper(capiResponse, context)
     const displayConcept = topper.displayConcept()
     expect(displayConcept?.prefLabel()).toEqual('UK politics & policy')
@@ -442,7 +439,7 @@ describe('produces the correct metadata tags', () => {
       ...clonedBase,
       annotations: [...clonedBase.annotations, opinionGenre, lexBrand],
     }
-    const capiResponse = new CapiResponse(lexArticle, context)
+    const capiResponse = new Content(lexArticle, context)
     const topper = new Topper(capiResponse, context)
     const displayConcept = topper.displayConcept()
     expect(displayConcept?.prefLabel()).toEqual('Lex')
@@ -456,7 +453,7 @@ describe('produces the correct metadata tags', () => {
       ...clonedBase,
       annotations: [...clonedBase.annotations, opinionGenre],
     }
-    const capiResponse = new CapiResponse(opinionArticle, context)
+    const capiResponse = new Content(opinionArticle, context)
     const topper = new Topper(capiResponse, context)
     const displayConcept = topper.displayConcept()
     expect(displayConcept?.prefLabel()).toEqual('UK politics & policy')
@@ -470,7 +467,7 @@ describe('produces the correct metadata tags', () => {
       ...clonedBase,
       annotations: [...clonedBase.annotations, lexBrand],
     }
-    const capiResponse = new CapiResponse(opinionArticle, context)
+    const capiResponse = new Content(opinionArticle, context)
     const topper = new Topper(capiResponse, context)
     const displayConcept = topper.displayConcept()
     expect(displayConcept?.prefLabel()).toEqual('UK politics & policy')
@@ -481,11 +478,11 @@ describe('produces the correct metadata tags', () => {
 
 describe('headshot method', () => {
   let topper: Topper
-  let capiResponse: CapiResponse
+  let capiResponse: Content
 
   beforeEach(() => {
     const clonedBase = cloneDeep(baseCapiObject)
-    capiResponse = new CapiResponse(clonedBase, context)
+    capiResponse = new Content(clonedBase, context)
     topper = new Topper(capiResponse, context)
   })
 

package/src/model/Topper.ts

@@ -1,4 +1,4 @@
-import { CapiResponse } from './CapiResponse'
+import { Content } from './Content'
 import { CAPIImage } from './Image'
 import type { QueryContext } from '..'
 import {
@@ -44,10 +44,7 @@ function isDarkBackground(backgroundColour: string): boolean {
 export class Topper {
   #systemCode: string
 
-  constructor(
-    private capiResponse: CapiResponse,
-    private context: QueryContext
-  ) {
+  constructor(private capiResponse: Content, private context: QueryContext) {
     this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
   }
 

package/src/model/schemas/capi/article.ts

@@ -34,6 +34,7 @@ const articleMetadataSchema = baseMetadataSchema.pick({
   containedIn: true,
   publication: true,
   clientName: true,
+  internalAnalyticsTags: true,
 })
 
 const articleMediaSchema = baseMediaSchema.pick({

package/src/model/schemas/capi/audio.ts

@@ -24,6 +24,7 @@ const audioMetadataSchema = baseMetadataSchema.pick({
   editorialDesk: true,
   canBeSyndicated: true,
   canBeDistributed: true,
+  internalAnalyticsTags: true,
 })
 
 const audioMediaSchema = baseMediaSchema.pick({

package/src/model/schemas/capi/base-schema.ts

@@ -235,6 +235,7 @@ export const baseMetadataSchema = z.object({
     .optional(),
   publication: z.array(z.string()).optional(),
   clientName: z.string().optional(),
+  internalAnalyticsTags: z.string().optional(),
 })
 
 export const baseContentSchema = z.object({

package/src/model/schemas/capi/content-package.ts

@@ -41,6 +41,7 @@ const contentPackageMetadataSchema = baseMetadataSchema.pick({
   topper: true,
   comments: true,
   tableOfContents: true,
+  internalAnalyticsTags: true,
 })
 
 const contentPackageMediaSchema = baseMediaSchema.pick({

package/src/model/schemas/capi/live-blog-package.ts

@@ -31,6 +31,7 @@ const liveBlogPackageMetadataSchema = baseMetadataSchema.pick({
   canBeDistributed: true,
   topper: true,
   comments: true,
+  internalAnalyticsTags: true,
 })
 
 const liveBlogPackageMediaSchema = baseMediaSchema.pick({

package/src/model/schemas/capi/placeholder.ts

@@ -32,6 +32,7 @@ const placeholderMetadataSchema = baseMetadataSchema.pick({
   topper: true,
   comments: true,
   containedIn: true,
+  internalAnalyticsTags: true,
 })
 
 const placeholderMediaSchema = baseMediaSchema.pick({

package/src/model/schemas/capi/video.ts

@@ -25,6 +25,7 @@ const videoMetadataSchema = baseMetadataSchema.pick({
   editorialDesk: true,
   canBeSyndicated: true,
   canBeDistributed: true,
+  internalAnalyticsTags: true,
 })
 
 const videoMediaSchema = baseMediaSchema.pick({