@financial-times/cp-content-pipeline-schema 2.5.1 → 2.5.3

package/src/helpers/imageService.ts

@@ -2,7 +2,7 @@ const DEFAULT_IMAGE_SERVICE_WIDTH = 700
 const DEFAULT_IMAGE_SERVICE_DPR = 1
 export const MAX_IMAGE_WIDTH = 3840
 
-export type ImageServiceUrlArguments = {
+type ImageServiceUrlArguments = {
   url: string
   systemCode: string
   width?: number

package/src/model/Byline.ts

@@ -17,7 +17,7 @@ export class Byline {
     const split = this.#splitBylineByName(bylineWithCorrectApostrophes, [
       ...this.authorUrlMapping.keys(),
     ])
-    return await this.#buildUrlTree(this.authorUrlMapping, split)
+    return this.#buildUrlTree(this.authorUrlMapping, split)
   }
 
   #splitBylineByName(byline: string, names: string[]) {

package/src/model/CapiResponse.ts

@@ -28,9 +28,16 @@ import {
   validLiteralUnionValue,
 } from '../resolvers/literal-union'
 
-import { ContentPackageContainsArgs, Media } from '../generated'
+import {
+  ContentPackageContainsArgs,
+  ContentUrlArgs,
+  Media,
+  TableOfContents,
+} from '../generated'
 import { Topper } from './Topper'
 import { z } from 'zod'
+import { Byline } from './Byline'
+import { RichText } from './RichText'
 
 function isPlainObject(object: unknown): object is Record<string, unknown> {
   if (object && typeof object === 'object') {
@@ -214,7 +221,9 @@ export class CapiResponse {
       packageContainer
     )
   }
-
+  body() {
+    return new RichText('bodyXML', this.bodyXML(), this)
+  }
   bodyXML(): string | null {
     if ('bodyXML' in this.capiData) {
       return this.capiData.bodyXML
@@ -226,7 +235,20 @@ export class CapiResponse {
       return this.capiData.embeds
     return []
   }
-  byline(): string | null {
+  byline({ vanity }: Partial<ContentUrlArgs>) {
+    const bylineText = this.rawByline()
+
+    if (!bylineText) return null
+    const authorUrlMapping = this.getAuthorUrlMapping()
+
+    return new Byline(
+      bylineText,
+      Boolean(vanity),
+      authorUrlMapping,
+      this.context
+    ).buildBylineTree()
+  }
+  rawByline(): string | null {
     if ('byline' in this.capiData && this.capiData.byline) {
       return this.capiData.byline
     }
@@ -245,7 +267,10 @@ export class CapiResponse {
   types() {
     return this.capiData.types
   }
-  async url(vanity?: boolean | null) {
+  url({ relative, vanity }: Partial<ContentUrlArgs>) {
+    return relative ? this.relativeUrl(vanity) : this.absoluteUrl(vanity)
+  }
+  async absoluteUrl(vanity?: boolean | null) {
     const url =
       this.capiData.webUrl ??
       this.capiData.canonicalWebUrl ??
@@ -449,7 +474,7 @@ export class CapiResponse {
 
   async relativeUrl(vanity?: boolean | null) {
     const RELATIVE_URL_REGEX = /https?:\/\/www.ft.com/
-    const url = await this.url(vanity)
+    const url = await this.absoluteUrl(vanity)
     return url.replace(RELATIVE_URL_REGEX, '')
   }
 
@@ -635,9 +660,9 @@ export class CapiResponse {
     return null
   }
 
-  async tableOfContents() {
+  async tableOfContents(): Promise<TableOfContents | null> {
     return 'tableOfContents' in this.capiData
-      ? this.capiData.tableOfContents
+      ? this.capiData.tableOfContents ?? null
       : null
   }
 

package/src/model/Clip.ts

@@ -7,7 +7,7 @@ import {
 import { ClipFormat } from '../resolvers/scalars'
 import imageServiceUrl from '../helpers/imageService'
 
-export type ClipSource = {
+type ClipSource = {
   binaryUrl: string
   mediaType: string
   audioCodec?: string
@@ -17,7 +17,7 @@ export type ClipSource = {
   videoCodec?: string
 }
 
-export interface ClipVideo {
+interface ClipVideo {
   id(): string
   type(): string
   format(): LiteralUnionScalarValues<typeof ClipFormat>
@@ -79,11 +79,14 @@ export class Clip implements ClipVideo {
       'full-grid': 1200,
     }
 
-    const url = this.clip.poster?.members[0].binaryUrl;
-    return url  ? imageServiceUrl({
-      url,
-      systemCode: 'cp-content-pipeline',
-      width: this.layout && mapSizes[this.layout] ? mapSizes[this.layout] : 700,
-    }) : ''
+    const url = this.clip.poster?.members[0].binaryUrl
+    return url
+      ? imageServiceUrl({
+          url,
+          systemCode: 'cp-content-pipeline',
+          width:
+            this.layout && mapSizes[this.layout] ? mapSizes[this.layout] : 700,
+        })
+      : ''
   }
 }

package/src/model/Concept.ts

@@ -5,21 +5,17 @@ import imageServiceUrl from '../helpers/imageService'
 import isError from '../helpers/isError'
 import conceptIds from '@financial-times/n-concept-ids'
 import decorateHeadshotUrl, { UUID_REGEX } from '../helpers/decorateHeadshotUrl'
+import type { TopperWithHeadshotHeadshotArgs } from '../generated'
 
 const CAPI_ID_PREFIX = /^https?:\/\/(?:www|api)\.ft\.com\/things?\//
 const BASE_URL = 'https://www.ft.com/stream/'
 const FT_URL = 'https://www.ft.com'
 
-export type URLArguments = {
+type URLArguments = {
   vanity?: boolean | null
   relative?: boolean | null
 }
 
-export type HeadshotArguments = {
-  width?: number | null
-  dpr?: number | null
-}
-
 export const predicates = {
   hasAuthor: 'http://www.ft.com/ontology/annotation/hasAuthor',
   isClassifiedBy: 'http://www.ft.com/ontology/classification/isClassifiedBy',
@@ -30,14 +26,14 @@ export const predicates = {
   about: 'http://www.ft.com/ontology/annotation/about',
 } as const
 
-export const types = {
+const types = {
   brand: 'http://www.ft.com/ontology/product/Brand',
   genre: 'http://www.ft.com/ontology/Genre',
   organisation: 'http://www.ft.com/ontology/organisation/Organisation',
   publicCompany: 'http://www.ft.com/ontology/company/PublicCompany',
 }
 
-export const packageBrands = [
+const packageBrands = [
   'specialReport',
   'ftSeries',
   'ftGuides',
@@ -175,7 +171,7 @@ export class Concept {
     return url
   }
 
-  async headshot(args?: HeadshotArguments) {
+  async headshot(args?: TopperWithHeadshotHeadshotArgs) {
     const uuid = this.apiUrl().match(UUID_REGEX)?.[0]
 
     if (!this.isAuthor() || !uuid) return null

package/src/model/Image.test.ts

@@ -4,12 +4,7 @@ import type { QueryContext } from '..'
 import { Image } from '../types/internal-content'
 import { OrigamiImageDataSource } from '../datasources/origami-image'
 import { MAX_IMAGE_WIDTH } from '../helpers/imageService'
-//TODO:AG:20220908 Replace this with generated schema types
-type ImageSource = {
-  url: string
-  width?: number
-  dpr?: number
-}
+import type { ImageSource } from '../generated'
 
 describe('Image', () => {
   const mockImage = {

package/src/model/Image.ts

@@ -13,12 +13,7 @@ import {
 import { ImageFormat, ImageType } from '../resolvers/scalars'
 import isError from '../helpers/isError'
 import { BaseError } from '@dotcom-reliability-kit/errors'
-
-export type ImageSource = {
-  url: string
-  width?: number
-  dpr?: number
-}
+import type { ImageSource } from '../generated'
 
 export type ImageSourceArgs = {
   width?: number | null

package/src/model/RichText.ts

@@ -14,7 +14,7 @@ import { QueryContext } from '..'
 
 export class RichText {
   constructor(
-    private source: LiteralUnionScalarValues<typeof RichTextSource>,
+    public source: LiteralUnionScalarValues<typeof RichTextSource>,
     private value: string | null,
     private contentApiData?: CapiResponse
   ) {}

package/src/model/Topper.ts

@@ -8,6 +8,7 @@ import {
 import { TopperBackgroundColour } from '../resolvers/scalars'
 import { RichText } from './RichText'
 import imageServiceUrl from '../helpers/imageService'
+import type { TopperWithHeadshotHeadshotArgs } from '../generated'
 
 type TopperType =
   | 'DeepPortraitTopper'
@@ -19,11 +20,6 @@ type TopperType =
   | 'BrandedTopper'
   | 'BasicTopper'
 
-export type HeadshotArguments = {
-  width?: number | null
-  dpr?: number | null
-}
-
 type TopperBackgroundColourValues = LiteralUnionScalarValues<
   typeof TopperBackgroundColour
 >
@@ -207,11 +203,11 @@ export class Topper {
   }
 
   backgroundBox() {
-    return this.capiResponse.topper()?.backgroundBox
+    return this.capiResponse.topper()?.backgroundBox ?? null
   }
 
   textShadow() {
-    return this.capiResponse.topper()?.textShadow
+    return this.capiResponse.topper()?.textShadow ?? null
   }
 
   displayConcept() {
@@ -303,7 +299,7 @@ export class Topper {
     return this.capiResponse.design()
   }
 
-  async headshot(args: HeadshotArguments) {
+  async headshot(args: TopperWithHeadshotHeadshotArgs) {
     let headshotUrl: string | undefined
 
     if (this.capiResponse.isPodcast()) {
@@ -313,7 +309,7 @@ export class Topper {
     if (this.capiResponse.isOpinion()) {
       const authors = this.capiResponse.getAuthors()
       const headshotUrls: (string | null)[] = await Promise.all(
-        authors.map(async (author) => await author.headshot(args))
+        authors.map(async (author) => author.headshot(args))
       ).then((res) => res.filter(Boolean))
 
       headshotUrl = headshotUrls[0] ?? undefined

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

@@ -14,7 +14,7 @@ export const Annotation = Concept.extend({
   predicate: z.string(),
 })
 
-export const Topper = z.object({
+const Topper = z.object({
   headline: z.string().optional(),
   standfirst: z.string().optional(),
   backgroundColour: z.string(),
@@ -84,7 +84,7 @@ export const LeadImage = z.object({
   image: Image,
 })
 
-export const AlternativeImage = z.object({
+const AlternativeImage = z.object({
   promotionalImage: BaseImage,
 })
 
@@ -136,7 +136,7 @@ export const ClipSet = z.object({
     .optional(),
 })
 
-export const DataSource = z.object({
+const DataSource = z.object({
   binaryUrl: z.string(),
   duration: z.number(),
   filesize: z.number(),

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

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

package/src/resolvers/clip.ts

@@ -1,4 +1,4 @@
-import { ClipResolvers } from '../generated'
+import { ClipResolvers, ClipSourceResolvers } from '../generated'
 
 const resolvers = {
   Clip: {
@@ -7,7 +7,18 @@ const resolvers = {
     type: (clip) => clip.type(),
     format: (clip) => clip.format(),
     poster: (clip) => clip.poster(),
+    id: (clip) => clip.id(),
   },
-} satisfies { Clip: ClipResolvers }
+
+  ClipSource: {
+    audioCodec: (parent) => parent.audioCodec ?? null,
+    binaryUrl: (parent) => parent.binaryUrl,
+    duration: (parent) => parent.duration ?? null,
+    mediaType: (parent) => parent.mediaType,
+    pixelWidth: (parent) => parent.pixelWidth ?? null,
+    pixelHeight: (parent) => parent.pixelHeight ?? null,
+    videoCodec: (parent) => parent.videoCodec ?? null,
+  },
+} satisfies { Clip: ClipResolvers; ClipSource: ClipSourceResolvers }
 
 export default resolvers

package/src/resolvers/content-tree/nodePredicates.ts

@@ -6,10 +6,6 @@ type ValuesOfTuple<Tuple extends readonly string[]> = Tuple[number]
 
 type NodeOfType<Type extends AnyNode['type']> = Extract<AnyNode, { type: Type }>
 
-type NodesOfTypes<Types extends readonly AnyNode['type'][]> = {
-  -readonly [key in keyof Types]: NodeOfType<Types[key]>
-}
-
 export const phrasingTypes = [
   'text',
   'break',
@@ -91,41 +87,3 @@ export const childrenOfTypes = <Types extends readonly AnyNode['type'][]>(
 
   return nodes as NodeOfType<ValuesOfTuple<Types>>[]
 }
-
-export const nodesAreOrderedTypes = <Types extends readonly AnyNode['type'][]>(
-  types: Types,
-  nodes: readonly AnyNode[]
-): nodes is NodesOfTypes<Types> => {
-  for (const [index, node] of nodes.entries()) {
-    if (node.type !== types[index]) {
-      return false
-    }
-  }
-
-  return true
-}
-
-export const childrenOfOrderedTypes = <
-  Types extends readonly AnyNode['type'][]
->(
-  types: Types,
-  nodes: AnyNode[],
-  parentType: AnyNode['type'],
-  context?: QueryContext
-): NodesOfTypes<Types> => {
-  if (nodesAreOrderedTypes(types, nodes)) {
-    return nodes
-  }
-
-  context?.logger.error({
-    event: 'RECOVERABLE_ERROR',
-    error: new OperationalError({
-      code: 'BODY_XML_UNEXPECTED_STRUCTURE',
-      message: `Unexpected children types for ${parentType}`,
-      expected: types,
-      actual: nodes.map((node) => node.type),
-    }),
-  })
-
-  return nodes as unknown as NodesOfTypes<Types>
-}

package/src/resolvers/content-tree/references/ClipSet.ts

@@ -6,7 +6,11 @@ import type {
 import { uuidFromUrl } from '../../../helpers/metadata'
 import { Clip } from '../../../model/Clip'
 import { RichText } from '../../../model/RichText'
-import { ClipSetResolvers } from '../../../generated'
+import {
+  AccessibilityResolvers,
+  CaptionResolvers,
+  ClipSetResolvers,
+} from '../../../generated'
 import { ReferenceWithCAPIData } from '.'
 
 function getClipSet(
@@ -73,7 +77,23 @@ export const ClipSet = {
     const clipSet = getClipSet(parent)
 
     return clipSet && clipSet.members && clipSet.members.length > 0
-      ? clipSet.members.map((clip) => new Clip(clip, parent.reference.dataLayout))
+      ? clipSet.members.map(
+          (clip) => new Clip(clip, parent.reference.dataLayout)
+        )
       : null
   },
+
+  type() {
+    return 'clip-set'
+  },
 } satisfies ClipSetResolvers
+
+export const Accessibility = {
+  captions: (parent) => parent.captions ?? null,
+  transcript: (parent) => parent.transcript,
+} satisfies AccessibilityResolvers
+
+export const Caption = {
+  mediaType: (parent) => parent.mediaType ?? null,
+  url: (parent) => parent.url ?? null,
+} satisfies CaptionResolvers

package/src/resolvers/content-tree/references/Flourish.ts

@@ -1,5 +1,8 @@
 import imageServiceUrl from '../../../helpers/imageService'
-import { FlourishResolvers } from '../../../generated'
+import {
+  FlourishFallbackResolvers,
+  FlourishResolvers,
+} from '../../../generated'
 import { QueryContext } from '../../..'
 import isError from '../../../helpers/isError'
 
@@ -35,8 +38,24 @@ export const Flourish = {
       height,
     }
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies FlourishResolvers
 
+export const FlourishFallback = {
+  async height(parent) {
+    return parent.height ?? null
+  },
+  async width(parent) {
+    return parent.width ?? null
+  },
+  async url(parent) {
+    return parent.url ?? null
+  },
+} satisfies FlourishFallbackResolvers
+
 type ImageMetadata = {
   width: number
   height: number

package/src/resolvers/content-tree/references/ImageSet.ts

@@ -22,4 +22,8 @@ export const ImageSet = {
       ? new Picture(imageSet, isLiveBlog, context)
       : null
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies ImageSetResolvers

package/src/resolvers/content-tree/references/LayoutImage.ts

@@ -27,4 +27,8 @@ export const LayoutImage = {
       context
     )
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies LayoutImageResolvers

package/src/resolvers/content-tree/references/RawImage.ts

@@ -96,4 +96,8 @@ export const RawImage = {
   image(parent, _args, context): Image {
     return new RawImageModel(parent.reference, context)
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies RawImageResolvers

package/src/resolvers/content-tree/references/Recommended.ts

@@ -28,4 +28,8 @@ export const Recommended = {
       return null
     }
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies RecommendedResolvers

package/src/resolvers/content-tree/references/Reference.ts

@@ -18,7 +18,5 @@ export const Reference = {
       validNodes: Object.keys(mapNodeToReference),
     })
   },
-  type(parent) {
-    return parent.reference.type
-  },
+  type: (parent) => parent.reference.type,
 } satisfies ReferenceResolvers

package/src/resolvers/content-tree/references/ScrollyImage.ts

@@ -20,4 +20,8 @@ export const ScrollyImage = {
 
     return imageSet ? new Picture(imageSet, isLiveBlog, context) : null
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies ScrollyImageResolvers

package/src/resolvers/content-tree/references/Tweet.ts

@@ -18,4 +18,8 @@ export const Tweet = {
       return null
     }
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies TweetResolvers

package/src/resolvers/content-tree/references/Video.ts

@@ -3,9 +3,7 @@ import { VideoReferenceResolvers } from '../../../generated'
 
 export const Video = {
   // This will override the original id from the parent that is a URL.
-  id(parent) {
-    return uuidFromUrl(parent.reference.id)
-  },
+  id: (parent) => uuidFromUrl(parent.reference.id),
 
   async title(parent, _args, context) {
     const capiResponse = await context.dataSources.capi.getContent(
@@ -13,4 +11,8 @@ export const Video = {
     )
     return capiResponse.title()
   },
+
+  type(parent) {
+    return parent.reference.type
+  },
 } satisfies VideoReferenceResolvers

package/src/resolvers/content-tree/references/index.ts

@@ -1,5 +1,3 @@
-import { IResolvers } from '@graphql-tools/utils'
-
 import type { ContentTree } from '@financial-times/content-tree'
 import type { CapiResponse } from '../../../model/CapiResponse'
 
@@ -7,9 +5,9 @@ import { Reference } from './Reference'
 
 import { Tweet } from './Tweet'
 import { ImageSet } from './ImageSet'
-import { ClipSet } from './ClipSet'
+import { ClipSet, Accessibility, Caption } from './ClipSet'
 import { Video } from './Video'
-import { Flourish } from './Flourish'
+import { Flourish, FlourishFallback } from './Flourish'
 import { Recommended } from './Recommended'
 import { LayoutImage } from './LayoutImage'
 import { RawImage } from './RawImage'
@@ -25,6 +23,9 @@ import {
   ScrollyImageResolvers,
   TweetResolvers,
   VideoReferenceResolvers,
+  CaptionResolvers,
+  AccessibilityResolvers,
+  FlourishFallbackResolvers,
 } from '../../../generated'
 import { AnyNode } from '../Workarounds'
 
@@ -44,6 +45,10 @@ export const resolvers: {
   LayoutImage: LayoutImageResolvers
   RawImage: RawImageResolvers
   ScrollyImage: ScrollyImageResolvers
+  MainImage: ImageSetResolvers
+  Caption: CaptionResolvers
+  Accessibility: AccessibilityResolvers
+  FlourishFallback: FlourishFallbackResolvers
 } = {
   Reference,
   Tweet,
@@ -55,6 +60,10 @@ export const resolvers: {
   LayoutImage,
   RawImage,
   ScrollyImage,
+  MainImage: ImageSet,
+  Caption,
+  Accessibility,
+  FlourishFallback,
 }
 
 export const mapNodeToReference = {

package/src/resolvers/content-tree/tagMappings.test.ts

@@ -1,6 +1,6 @@
 import { AnyNode, OldClip } from './Workarounds'
 import tagMappings, { getBooleanAttributeValue } from './tagMappings'
-import cheerio from 'cheerio'
+import { load } from 'cheerio'
 
 function expectNotArray<T>(thing: T | T[]): asserts thing is T {
   expect(thing).not.toBeInstanceOf(Array)
@@ -16,17 +16,13 @@ function expectNodeType<T extends AnyNode>(
 
 describe('tagMappings test', () => {
   it('getBooleanAttributeValue attrubute', () => {
-    let $el = cheerio.load('<ft-content autoplay></ft-content>')('ft-content')
+    let $el = load('<ft-content autoplay></ft-content>')('ft-content')
     expect(getBooleanAttributeValue($el, 'autoplay')).toBe(true)
-    $el = cheerio.load('<ft-content autoplay="true"></ft-content>')(
-      'ft-content'
-    )
+    $el = load('<ft-content autoplay="true"></ft-content>')('ft-content')
     expect(getBooleanAttributeValue($el, 'autoplay')).toBe(true)
-    $el = cheerio.load('<ft-content autoplay="false"></ft-content>')(
-      'ft-content'
-    )
+    $el = load('<ft-content autoplay="false"></ft-content>')('ft-content')
     expect(getBooleanAttributeValue($el, 'autoplay')).toBe(false)
-    $el = cheerio.load('<ft-content></ft-content>')('ft-content')
+    $el = load('<ft-content></ft-content>')('ft-content')
     expect(getBooleanAttributeValue($el, 'autoplay')).toBe(false)
   })
 
@@ -43,7 +39,7 @@ describe('tagMappings test', () => {
     <body>`
     const selector =
       'ft-content[type="http://www.ft.com/ontology/content/clip"]'
-    const $el = cheerio.load(bodyXML)(selector)
+    const $el = load(bodyXML)(selector)
     const mapping = tagMappings[selector]($el, () => [])
 
     expectNodeType<OldClip>(mapping, 'clip')