@financial-times/cp-content-pipeline-schema 2.15.0 → 3.0.0

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

@@ -6,14 +6,15 @@ This file contains type definitions for any node that are either specific to Cus
 or have yet to be modelled in the `content-tree` spec.
 */
 
-/*
-Bylines / Author links are not part of the body of an article, and so
-have not been modelled yet.
-*/
-export interface AuthorLink extends ContentTree.Parent {
-  type: 'author-link'
-  href: string
-  children: ContentTree.Text[]
+export interface Byline extends ContentTree.Parent {
+  type: 'byline'
+  children: (ContentTree.Text | Author)[]
+}
+
+export interface Author extends ContentTree.Parent {
+  type: 'author'
+  id: string
+  children: [ContentTree.Text]
 }
 
 export interface Cite extends ContentTree.Node {
@@ -45,7 +46,7 @@ export interface RawImage extends ContentTree.Node {
   width?: number
 }
 
-export interface ContentTreePullquote extends ContentTree.Pullquote {
+export interface Pullquote extends ContentTree.Pullquote {
   children: ContentTree.ImageSet[]
 }
 
@@ -70,14 +71,10 @@ export type MainImageRaw = Omit<RawImage, 'type'> & {
 export interface Video extends ContentTree.Node {
   type: 'video'
   id: string
+  title?: string
   embedded: boolean
 }
 
-export interface YoutubeVideo extends ContentTree.Node {
-  type: 'youtube-video'
-  url: string
-}
-
 export interface OldClip extends ContentTree.Node {
   type: 'clip'
   url: string
@@ -167,6 +164,27 @@ export interface Body extends ContentTree.Parent {
   children: BodyBlock[]
 }
 
+export type Image = Omit<ContentTree.Image, 'format'> & {
+  format:
+    | 'standard'
+    | 'standard-inline'
+    | 'desktop'
+    | 'mobile'
+    | 'wide'
+    | 'square'
+    | 'square-ftedit'
+    | 'portrait'
+    | 'landscape'
+}
+
+export type Flourish = Omit<
+  ContentTree.Flourish,
+  'layoutWidth' | 'fallbackImage'
+> & {
+  layoutWidth?: string
+  fallbackImage?: Image
+}
+
 export type BodyBlock =
   | ContentTree.Paragraph
   | ContentTree.Heading
@@ -176,14 +194,14 @@ export type BodyBlock =
   | ContentTree.Layout
   | ContentTree.List
   | ContentTree.Blockquote
-  | ContentTree.Pullquote
+  | Pullquote
   | ContentTree.ScrollyBlock
   | ContentTree.ThematicBreak
   | Table
   | Recommended
   | ContentTree.Tweet
   | Video
-  | YoutubeVideo
+  | ContentTree.YoutubeVideo
 
 export type AnyNode =
   | ContentTree.Text
@@ -198,7 +216,7 @@ export type AnyNode =
   | ContentTree.List
   | ContentTree.ListItem
   | ContentTree.Blockquote
-  | ContentTree.Pullquote
+  | Pullquote
   | ContentTree.ImageSet
   | ContentTree.CustomCodeComponent
   | ContentTree.Root
@@ -207,7 +225,7 @@ export type AnyNode =
   | OldClip
   | Recommended
   | ContentTree.Tweet
-  | ContentTree.Flourish
+  | Flourish
   | ContentTree.BigNumber
   | ContentTree.ScrollyBlock
   | ContentTree.ScrollySection
@@ -224,9 +242,10 @@ export type AnyNode =
   | TableRow
   | TableCell
   | Video
-  | YoutubeVideo
+  | ContentTree.YoutubeVideo
   | MainImage
   | MainImageRaw
   | RawImage
-  | AuthorLink
+  | Byline
+  | Author
   | Cite

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

@@ -0,0 +1,18 @@
+import { AuthorReferenceResolvers } from '../../../generated'
+import { predicates } from '../../../model/Concept'
+
+export const Author = {
+  type: (parent) => parent.reference.type,
+  concept: (parent) => {
+    const authorAnnotations =
+      parent.contentApiData?.annotations({
+        byPredicate: predicates.hasAuthor,
+      }) ?? []
+
+    return (
+      authorAnnotations.find(
+        (concept) => concept.uuid() === parent.reference.id
+      ) ?? null
+    )
+  },
+} satisfies AuthorReferenceResolvers

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

@@ -1,4 +1,3 @@
-import type { ClipSet as CAPIClipSet } from '../../../types/internal-content'
 import type {
   ClipSet as ClipSetWorkaroundContentTree,
   OldClip as OldClipContentTree,
@@ -20,20 +19,19 @@ function getClipSet(
 ) {
   const clipSets = parent.contentApiData
     ?.embeds()
-    ?.filter((embedded) => embedded.type?.includes('ClipSet')) as
-    | CAPIClipSet[]
-    | []
+    ?.filter(
+      (embedded) =>
+        embedded.type === 'http://www.ft.com/ontology/content/ClipSet'
+    )
 
   const uuid = uuidFromUrl(
     parent.reference.type === 'clip-set'
       ? parent.reference.id
       : parent.reference.url
   )
-  const clipSet = clipSets?.find(
-    (embed: CAPIClipSet) => uuidFromUrl(embed.id) === uuid
-  )
+  const clipSet = clipSets?.find((embed) => uuidFromUrl(embed.id) === uuid)
 
-  return clipSet as CAPIClipSet
+  return clipSet
 }
 
 export const ClipSet = {

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

@@ -1,4 +1,4 @@
-import type { ImageSet as CAPIImageSet } from '../../../types/internal-content'
+import type { ImageSet as CAPIImageSet } from '../../../model/schemas/capi/internal-content'
 import { uuidFromUrl } from '../../../helpers/metadata'
 import { Picture } from '../../../model/Picture'
 import { ImageSetResolvers } from '../../../generated'

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

@@ -1,4 +1,4 @@
-import type { ImageSet as CAPIImageSet } from '../../../types/internal-content'
+import type { ImageSet as CAPIImageSet } from '../../../model/schemas/capi/internal-content'
 import { uuidFromUrl } from '../../../helpers/metadata'
 import { Picture } from '../../../model/Picture'
 import { ScrollyImageResolvers } from '../../../generated'

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

@@ -26,8 +26,10 @@ import {
   CaptionResolvers,
   AccessibilityResolvers,
   FlourishFallbackResolvers,
+  AuthorReferenceResolvers,
 } from '../../../generated'
 import { AnyNode } from '../Workarounds'
+import { Author } from './Author'
 
 export type ReferenceWithCAPIData<ReferenceType = ContentTree.Node> = {
   reference: ReferenceType
@@ -49,6 +51,7 @@ export const resolvers: {
   Caption: CaptionResolvers
   Accessibility: AccessibilityResolvers
   FlourishFallback: FlourishFallbackResolvers
+  AuthorReference: AuthorReferenceResolvers
 } = {
   Reference,
   Tweet,
@@ -64,6 +67,7 @@ export const resolvers: {
   Caption,
   Accessibility,
   FlourishFallback,
+  AuthorReference: Author,
 }
 
 export const mapNodeToReference = {
@@ -77,6 +81,7 @@ export const mapNodeToReference = {
   'layout-image': 'LayoutImage',
   'scrolly-image': 'ScrollyImage',
   'raw-image': 'RawImage',
-  'main-image': 'ImageSet',
+  'main-image': 'MainImage',
   'main-image-raw': 'RawImage',
+  author: 'AuthorReference',
 } as const satisfies Partial<Record<AnyNode['type'], keyof typeof resolvers>>

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

@@ -1,7 +1,6 @@
 import { ContentTree } from '@financial-times/content-tree'
 import { CapiResponse } from '../../model/CapiResponse'
 import { ReferenceWithCAPIData, mapNodeToReference } from './references'
-import { AnyNode, Body } from './Workarounds'
 
 function isParent(node: ContentTree.Node): node is ContentTree.Parent {
   return 'children' in node
@@ -12,26 +11,25 @@ const isValidReferenceType = (
 ): type is keyof typeof mapNodeToReference => type in mapNodeToReference
 
 export default function updateTreeWithReferenceIds(
-  tree: Body,
+  tree: ContentTree.Parent,
   contentApiData?: CapiResponse
 ): {
-  tree: Body
+  tree: ContentTree.Parent
   references: ReferenceWithCAPIData[]
 } {
   const references: ReferenceWithCAPIData[] = []
-  let index = 0
 
-  function traverse(node: AnyNode) {
+  function traverse(node: ContentTree.Node) {
     if (isValidReferenceType(node.type)) {
-      references.push({
+      const referencesLength = references.push({
         reference: node,
         contentApiData,
       })
       node.data = node.data || {}
-      node.data.referenceIndex = index++
+      node.data.referenceIndex = referencesLength - 1
     }
     if (isParent(node)) {
-      node.children.forEach((node) => traverse(node as AnyNode))
+      node.children.forEach((node) => traverse(node))
     }
   }
 

package/src/resolvers/content.ts

@@ -20,7 +20,7 @@ const contentResolvers: ContentResolvers = {
   accessLevel: (parent) => parent.accessLevel(),
   altStandfirst: (parent) => parent.alternativeStandfirst(),
   altTitle: (parent) => parent.alternativeTitle(),
-  annotations: (parent) => parent.annotations(),
+  annotations: (parent, args) => parent.annotations(args),
   body: (parent) => parent.body(),
   bodyXML: (parent) => parent.bodyXML(),
   byline: (parent, args) => parent.byline(args),
@@ -36,6 +36,7 @@ const contentResolvers: ContentResolvers = {
   originatingParty: (parent) => parent.originatingParty(),
   publishedDate: (parent) => parent.publishedDate(),
   publishedTimestamp: (parent) => parent.publishedTimestamp(),
+  modifiedTimestamp: (parent) => parent.modifiedTimestamp(),
   standfirst: (parent) => parent.standfirst(),
   teaser: (parent) => parent.teaser(),
   title: (parent) => parent.title(),
@@ -77,6 +78,7 @@ const resolvers = {
     containedIn: (parent) => parent.containedIn(),
     indicators(parent) {
       return {
+        accessLevel: parent.accessLevel(),
         isOpinion: parent.isOpinion(),
       }
     },
@@ -124,7 +126,7 @@ const resolvers = {
   },
 
   Indicators: {
-    accessLevel: (parent) => parent.accessLevel ?? null,
+    accessLevel: (parent) => parent.accessLevel,
     isOpinion: (parent) => parent.isOpinion ?? null,
     isColumn: (parent) => parent.isColumn ?? null,
     isPodcast: (parent) => parent.isPodcast ?? null,

package/src/resolvers/leadFlourish.ts

@@ -8,6 +8,7 @@ const resolvers = {
     fallbackImage: (flourish) => flourish.fallbackImage(),
   },
   FlourishSource: {
+    id: (parent) => parent.id(),
     url: async (parent) => {
       const url = await parent.url()
       return url

package/src/resolvers/person.ts

@@ -1,7 +1,7 @@
 import { PersonResolvers } from '../generated'
 const resolvers = {
   Person: {
-    headshot: (parent) => parent.headshot(),
+    headshot: (parent, args) => parent.headshot(args),
     prefLabel: (parent) => parent.prefLabel(),
     streamPage: (parent) => parent.streamPage(),
   },

package/src/types/n-display-metadata.d.ts

@@ -13,7 +13,7 @@ declare module '@financial-times/n-display-metadata' {
 
   export interface TeaserMetadata<ConceptType, ContainedInType> {
     flags: FlagsMetadata
-    prefixText: string
+    prefixText?: string
     link: ConceptType | ContainedInType | null
     altLink: ConceptType | null
   }