@financial-times/cp-content-pipeline-schema 2.5.2 → 2.5.4

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/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

@@ -203,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() {

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/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

@@ -5,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'
@@ -23,6 +23,9 @@ import {
   ScrollyImageResolvers,
   TweetResolvers,
   VideoReferenceResolvers,
+  CaptionResolvers,
+  AccessibilityResolvers,
+  FlourishFallbackResolvers,
 } from '../../../generated'
 import { AnyNode } from '../Workarounds'
 
@@ -42,6 +45,10 @@ export const resolvers: {
   LayoutImage: LayoutImageResolvers
   RawImage: RawImageResolvers
   ScrollyImage: ScrollyImageResolvers
+  MainImage: ImageSetResolvers
+  Caption: CaptionResolvers
+  Accessibility: AccessibilityResolvers
+  FlourishFallback: FlourishFallbackResolvers
 } = {
   Reference,
   Tweet,
@@ -53,6 +60,10 @@ export const resolvers: {
   LayoutImage,
   RawImage,
   ScrollyImage,
+  MainImage: ImageSet,
+  Caption,
+  Accessibility,
+  FlourishFallback,
 }
 
 export const mapNodeToReference = {

package/src/resolvers/content.ts

@@ -1,5 +1,4 @@
 import { Topper } from '../model/Topper'
-import { Byline } from '../model/Byline'
 import {
   ArticleResolvers,
   PlaceholderResolvers,
@@ -8,8 +7,40 @@ import {
   ContentResolvers,
   LiveBlogPackageResolvers,
   LiveBlogPostResolvers,
+  VideoResolvers,
+  TableOfContentsResolvers,
+  AltStandfirstResolvers,
+  AltTitleResolvers,
+  DesignResolvers,
+  IndicatorsResolvers,
+  MediaResolvers,
 } from '../generated'
-import { RichText } from '../model/RichText'
+
+const contentResolvers: ContentResolvers = {
+  accessLevel: (parent) => parent.accessLevel(),
+  altStandfirst: (parent) => parent.alternativeStandfirst(),
+  altTitle: (parent) => parent.alternativeTitle(),
+  annotations: (parent) => parent.annotations(),
+  body: (parent) => parent.body(),
+  bodyXML: (parent) => parent.bodyXML(),
+  byline: (parent, args) => parent.byline(args),
+  canBeSyndicated: (parent) => parent.canBeSyndicated(),
+  commentsEnabled: (parent) => parent.commentsEnabled(),
+  design: (parent) => parent.design(),
+  editorialDesk: (parent) => parent.editorialDesk(),
+  firstPublishedDate: (parent) => parent.firstPublishedDate(),
+  id: (parent) => parent.id(),
+  instantAlertConcept: (parent) => parent.instantAlertConcept(),
+  mainImage: (parent) => parent.mainImage(),
+  originatingParty: (parent) => parent.originatingParty(),
+  publishedDate: (parent) => parent.publishedDate(),
+  standfirst: (parent) => parent.standfirst(),
+  teaser: (parent) => parent.teaser(),
+  title: (parent) => parent.title(),
+  topper: (parent, _, context) => new Topper(parent, context),
+  type: (parent) => parent.type(),
+  url: (parent, args) => parent.url(args),
+}
 
 const resolvers = {
   Content: {
@@ -26,78 +57,90 @@ const resolvers = {
 
       return type
     },
-    body(parent) {
-      return new RichText('bodyXML', parent.bodyXML(), parent)
-    },
-    topper: (parent, _, context) => new Topper(parent, context),
-    byline(parent, args, context) {
-      const vanity = Boolean(args.vanity)
-      const bylineText = parent.byline()
-
-      if (!bylineText) return null
-      const authorUrlMapping = parent.getAuthorUrlMapping()
-
-      return new Byline(
-        bylineText,
-        vanity,
-        authorUrlMapping,
-        context
-      ).buildBylineTree()
-    },
-    url: (parent, args) =>
-      args.relative
-        ? parent.relativeUrl(args?.vanity)
-        : parent.url(args?.vanity),
-    type: (parent) => parent.type(),
-    mainImage: (parent) => parent.mainImage(),
-    altTitle: (parent) => parent.alternativeTitle(),
-    altStandfirst: (parent) => parent.alternativeStandfirst(),
-    publishedDate: (parent) => parent.publishedDate(),
-    annotations: (parent) => parent.annotations(),
-    accessLevel: (parent) => parent.accessLevel(),
-    editorialDesk: (parent) => parent.editorialDesk(),
-    canBeSyndicated: (parent) => parent.canBeSyndicated(),
-    instantAlertConcept: (parent) => parent.instantAlertConcept(),
-    originatingParty: (parent) => parent.originatingParty(),
-    commentsEnabled: (parent) => parent.commentsEnabled(),
-    design: (parent) => parent.design(),
+    ...contentResolvers,
   },
 
   Article: {
+    ...contentResolvers,
     containedIn: (parent) => parent.containedIn(),
   },
 
   Placeholder: {
+    ...contentResolvers,
     containedIn: (parent) => parent.containedIn(),
   },
 
   LiveBlogPost: {
+    ...contentResolvers,
     containedIn: (parent) => parent.containedIn(),
-    isPinned: (parent) => parent.isPinned(),
     indicators(parent) {
       return {
         isOpinion: parent.isOpinion(),
       }
     },
+    isPinned: (parent) => parent.isPinned(),
   },
 
   LiveBlogPackage: {
+    ...contentResolvers,
     liveBlogPosts: (parent) => parent.liveBlogPosts(),
     pinnedPost: (parent) => parent.pinnedPost(),
     realtime: (parent) => parent.realtime(),
   },
 
   ContentPackage: {
+    ...contentResolvers,
     contains: (parent, args) => parent.contains(args),
+    tableOfContents: (parent) => parent.tableOfContents(),
     containsLength: (parent) => parent.containsLength(),
   },
 
   Audio: {
+    ...contentResolvers,
     media: (parent) =>
       // TODO:20230712:IM should probably return captions too
       parent.media()?.filter(({ mediaType }) => mediaType === 'audio/mpeg') ??
       null,
   },
+
+  Video: {
+    ...contentResolvers,
+  },
+
+  AltStandfirst: {
+    promotionalStandfirst: (parent) => parent.promotionalStandfirst ?? null,
+  },
+
+  AltTitle: {
+    promotionalTitle: (parent) => parent.promotionalTitle ?? null,
+  },
+
+  Design: {
+    layout: (parent) => parent.layout ?? null,
+    theme: (parent) => parent.theme ?? null,
+  },
+
+  Indicators: {
+    accessLevel: (parent) => parent.accessLevel ?? null,
+    isOpinion: (parent) => parent.isOpinion ?? null,
+    isColumn: (parent) => parent.isColumn ?? null,
+    isPodcast: (parent) => parent.isPodcast ?? null,
+    isEditorsChoice: (parent) => parent.isEditorsChoice ?? null,
+    isExclusive: (parent) => parent.isExclusive ?? null,
+    isScoop: (parent) => parent.isScoop ?? null,
+  },
+
+  Media: {
+    url: (parent) => parent.url ?? null,
+    duration: (parent) => parent.duration ?? null,
+    filesize: (parent) => parent.filesize ?? null,
+    mediaType: (parent) => parent.mediaType ?? null,
+  },
+
+  TableOfContents: {
+    labelType: (parent) => parent.labelType ?? null,
+    sequence: (parent) => parent.sequence ?? null,
+  },
 } satisfies {
   Article: ArticleResolvers
   Placeholder: PlaceholderResolvers
@@ -106,6 +149,13 @@ const resolvers = {
   LiveBlogPackage: LiveBlogPackageResolvers
   ContentPackage: ContentPackageResolvers
   Audio: AudioResolvers
+  Video: VideoResolvers
+  AltStandfirst: AltStandfirstResolvers
+  AltTitle: AltTitleResolvers
+  Design: DesignResolvers
+  Indicators: IndicatorsResolvers
+  TableOfContents: TableOfContentsResolvers
+  Media: MediaResolvers
 }
 
 export default resolvers

package/src/resolvers/image.ts

@@ -1,4 +1,16 @@
-import { ImageResolvers } from '../generated'
+import {
+  ImageDesktopResolvers,
+  ImageLandscapeResolvers,
+  ImageMobileResolvers,
+  ImagePortraitResolvers,
+  ImageResolvers,
+  ImageSourceResolvers,
+  ImageSquareFtEditResolvers,
+  ImageSquareResolvers,
+  ImageStandardInlineResolvers,
+  ImageStandardResolvers,
+  ImageWideResolvers,
+} from '../generated'
 import { LiteralUnionScalarValues } from './literal-union'
 import { ImageFormat } from './scalars'
 
@@ -47,9 +59,7 @@ const resolveImageTypeFromTree = (
   return 'ImageStandard'
 }
 
-const resolvers = {
-  Image: {
-    __resolveType: (image) => resolveImageTypeFromTree(image.format()),
+const imageResolvers: ImageResolvers = {
     type: (image) => image.type(),
     format: (image) => image.format(),
     caption: (image) => image.caption(),
@@ -60,7 +70,67 @@ const resolvers = {
     height: async (image) => (await image.dimensions())?.height ?? null,
     sourceSet: (image, args) => image.sourceSet(args),
     altText: (image) => image.alt(),
+}
+
+const resolvers = {
+  Image: {
+    __resolveType: (image) => resolveImageTypeFromTree(image.format()),
+    ...imageResolvers,
   },
-} satisfies { Image: ImageResolvers }
+
+  ImageDesktop: {
+    ...imageResolvers,
+  },
+
+  ImageMobile: {
+    ...imageResolvers,
+  },
+
+  ImagePortrait: {
+    ...imageResolvers,
+  },
+
+  ImageLandscape: {
+    ...imageResolvers,
+  },
+
+  ImageSquare: {
+    ...imageResolvers,
+  },
+
+  ImageSquareFTEdit: {
+    ...imageResolvers,
+  },
+
+  ImageStandard: {
+    ...imageResolvers,
+  },
+
+  ImageStandardInline: {
+    ...imageResolvers,
+  },
+
+  ImageWide: {
+    ...imageResolvers,
+  },
+
+  ImageSource: {
+    url: (image) => image.url,
+    width: (image) => image.width ?? null,
+    dpr: (image) => image.dpr ?? null,
+  },
+} satisfies {
+  Image: ImageResolvers
+  ImageDesktop: ImageDesktopResolvers
+  ImageMobile: ImageMobileResolvers
+  ImagePortrait: ImagePortraitResolvers
+  ImageLandscape: ImageLandscapeResolvers
+  ImageSquare: ImageSquareResolvers
+  ImageSquareFTEdit: ImageSquareFtEditResolvers
+  ImageStandard: ImageStandardResolvers
+  ImageStandardInline: ImageStandardInlineResolvers
+  ImageWide: ImageWideResolvers
+  ImageSource: ImageSourceResolvers
+}
 
 export default resolvers