@financial-times/cp-content-pipeline-schema 0.7.22 → 0.7.24

package/src/helpers/isError.ts

@@ -0,0 +1,3 @@
+export default function isError(error: unknown): error is Error {
+  return error instanceof Error
+}

package/src/model/CapiResponse.ts

@@ -18,6 +18,7 @@ import sortBy from 'lodash.sortby'
 
 import { CAPIImage } from './Image'
 import { Concept } from './Concept'
+import isError from '../helpers/isError'
 import { uuidFromUrl } from '../helpers/metadata'
 import { schemas } from './schemas/capi'
 import { AccessLevel, ContentType, PackageDesign } from '../resolvers/scalars'
@@ -195,8 +196,25 @@ export class CapiResponse {
   types() {
     return this.capiData.types
   }
-  url() {
-    return this.capiData.webUrl
+  async url(vanity?: boolean | null) {
+    const url = this.capiData.webUrl
+    if (vanity) {
+      try {
+        const vanityUrl = await this.context.dataSources.vanityUrls.get(url)
+        // IM: I don't _think_ vanityUrl will ever be nullish (instead
+        // returning the input URL if there is no vanity) but let's play it
+        // safe
+        return vanityUrl ?? url
+      } catch (error) {
+        if (isError(error)) {
+          logRecoverableError({
+            logger: this.context.logger,
+            error,
+          })
+        }
+      }
+    }
+    return url
   }
   leadImages() {
     if ('leadImages' in this.capiData) return this.capiData.leadImages
@@ -296,9 +314,10 @@ export class CapiResponse {
     return Boolean('standout' in this.capiData && this.capiData.standout?.scoop)
   }
 
-  relativeUrl() {
+  async relativeUrl(vanity?: boolean | null) {
     const RELATIVE_URL_REGEX = /https?:\/\/www.ft.com/
-    return this.url().replace(RELATIVE_URL_REGEX, '')
+    const url = await this.url(vanity)
+    return url.replace(RELATIVE_URL_REGEX, '')
   }
 
   type(validate?: true): LiteralUnionScalarValues<typeof ContentType>
@@ -359,6 +378,12 @@ export class CapiResponse {
     )
   }
 
+  getGenreConcept() {
+    return this.annotations().find((annotation: Concept) =>
+      annotation.isGenreType()
+    )
+  }
+
   getPodcastBrandConcept() {
     return this.annotations().find((annotation: Concept) =>
       annotation.isPodcastBrand()
@@ -421,6 +446,12 @@ export class CapiResponse {
     return null
   }
 
+  async tableOfContents() {
+    return 'tableOfContents' in this.capiData
+      ? this.capiData.tableOfContents
+      : null
+  }
+
   async liveBlogPosts(): Promise<CapiResponse[] | []> {
     const contains = await this.contains()
 
@@ -435,6 +466,17 @@ export class CapiResponse {
     return []
   }
 
+  containedIn() {
+    if (!('containedIn' in this.capiData)) {
+      return null
+    }
+    const containerId = this.capiData.containedIn?.[0]?.id
+    if (!containerId) {
+      return null
+    }
+    return this.context.dataSources.capi.getContent(uuidFromUrl(containerId))
+  }
+
   isContainedInPackage(): boolean {
     return 'containedIn' in this.capiData
       ? (this.capiData.containedIn?.length ?? 0) > 0

package/src/model/Concept.ts

@@ -1,8 +1,9 @@
 import type { Annotation } from '../types/internal-content'
 import type { QueryContext } from '..'
-import type { DataSources } from '../datasources'
 import { uuidFromUrl } from '../helpers/metadata'
 import imageServiceUrl from '../helpers/imageService'
+import isError from '../helpers/isError'
+import { logRecoverableError } from '@dotcom-reliability-kit/log-error'
 import conceptIds from '@financial-times/n-concept-ids'
 
 const CAPI_ID_PREFIX = /^https?:\/\/(?:www|api)\.ft\.com\/things?\//
@@ -30,6 +31,7 @@ export const predicates = {
 
 export const types = {
   brand: 'http://www.ft.com/ontology/product/Brand',
+  genre: 'http://www.ft.com/ontology/Genre',
 }
 
 export const packageBrands = [
@@ -53,11 +55,9 @@ type Genre =
   | 'recipe'
 
 export class Concept {
-  #dataSources: DataSources
   #systemCode: string
 
-  constructor(private capiConcept: Annotation, context: QueryContext) {
-    this.#dataSources = context.dataSources
+  constructor(private capiConcept: Annotation, private context: QueryContext) {
     this.#systemCode = context.systemCode ?? 'cp-content-pipeline'
   }
 
@@ -100,6 +100,13 @@ export class Concept {
     )
   }
 
+  isGenreType() {
+    return (
+      this.predicate() === predicates.isClassifiedBy &&
+      this.directType() === types.genre
+    )
+  }
+
   isPodcastBrand() {
     return (
       this.predicate() === predicates.implicitlyClassifiedBy &&
@@ -136,14 +143,18 @@ export class Concept {
 
     if (args?.vanity) {
       try {
-        const vanity: string | null = await this.#dataSources.vanityUrls.get(
-          url
-        )
+        const vanity: string | null =
+          await this.context.dataSources.vanityUrls.get(url)
         if (vanity !== null) {
           url = vanity
         }
-      } catch (err) {
-        //TODO:AG:26-09-2022 log error here, but fail gracefully to use non-vanity
+      } catch (error) {
+        if (isError(error)) {
+          logRecoverableError({
+            logger: this.context.logger,
+            error,
+          })
+        }
       }
     }
 
@@ -159,7 +170,9 @@ export class Concept {
     }
 
     try {
-      const peopleData = await this.#dataSources.capi.getPerson(this.uuid())
+      const peopleData = await this.context.dataSources.capi.getPerson(
+        this.uuid()
+      )
 
       if (!peopleData || !peopleData._imageUrl) return null
 

package/src/model/Image.ts

@@ -7,12 +7,12 @@ import type {
 } from '../types/internal-content'
 import type { QueryContext } from '..'
 import { logRecoverableError } from '@dotcom-reliability-kit/log-error/lib'
-import { ContentTree } from '@financial-times/content-tree'
 import {
   LiteralUnionScalarValues,
   validLiteralUnionValue,
 } from '../resolvers/literal-union'
 import { ImageFormat, ImageType } from '../resolvers/scalars'
+import isError from '../helpers/isError'
 
 export type ImageSource = {
   url: string
@@ -25,10 +25,6 @@ export type ImageSourceArgs = {
   maxDpr?: number | null
 }
 
-function isError(error: unknown): error is Error {
-  return error instanceof Error
-}
-
 export interface Image {
   type(): LiteralUnionScalarValues<typeof ImageType>
   caption(): string | null

package/src/model/RichText.test.ts

@@ -17,6 +17,7 @@ describe('RichText resolver', () => {
     expect(await model.structured()).toMatchInlineSnapshot(`
       Object {
         "references": Array [],
+        "text": "",
         "tree": Object {
           "children": Array [
             Object {
@@ -36,6 +37,7 @@ describe('RichText resolver', () => {
     expect(await model.structured()).toMatchInlineSnapshot(`
       Object {
         "references": Array [],
+        "text": "",
         "tree": Object {
           "children": Array [],
           "type": "body",

package/src/model/RichText.ts

@@ -1,4 +1,5 @@
 import bodyXMLToTree from '../resolvers/content-tree/bodyXMLToTree'
+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'
@@ -45,9 +46,11 @@ export class RichText {
       tree,
       this.contentApiData
     )
+    const text = extractText(tree)
 
     return {
       tree: treeWithReferences,
+      text,
       references,
     }
   }

package/src/model/Topper.ts

@@ -274,6 +274,10 @@ export class Topper {
     return this.capiResponse.getBrandConcept() ?? null
   }
 
+  genreConcept() {
+    return this.capiResponse.getGenreConcept() ?? null
+  }
+
   design() {
     return this.capiResponse.design()
   }

package/src/model/__snapshots__/RichText.test.ts.snap

@@ -97,6 +97,39 @@ Object {
       },
     },
   ],
+  "text": "Eliot After The Waste Land (Eliot Biographies, 2)by Robert Crawford, Jonathan Cape £25
+
+After a six-year wait, Robert Crawford follows up Young Eliot (2016) with his second (and final) volume on the life of TS Eliot in time for the centenary of “The Waste Land”. Here, he explores Eliot’s marriage, religious life and draws on the 1,131 letters written to American friend Emily Hale that were only released from embargo in 2020 to probe the poet’s later years with tact and empathy.
+
+All the Knowledge in the World: The Extraordinary History of the Encyclopaediaby Simon Garfield, Weidenfeld & Nicolson £18.99
+
+Simon Garfield, author of quirky histories on everything from fonts to maps, surveys the publishing phenomenon that is the encyclopedia. Tracing its origins from Ancient Greece right up to its modern incarnation in Wikipedia, his handsome book offers an erudite and amusing exploration of the human quest for knowledge.
+
+The Waste Land: A Biography of a Poemby Matthew Hollis, Faber £20
+
+In the 100 years since TS Eliot penned his famous poem, it has taken on a life of its own. So it’s fitting, perhaps, that Matthew Hollis treats Eliot’s work to its own biography. This richly analytical book locates the poem’s genesis in the aftermath of the first world war and the “nightmare agony” of Eliot’s disastrous marriage.
+
+Endless Flight: The Life of Joseph Rothby Keiron Pim, Granta £25
+
+“I paint the portrait of the age,” Joseph Roth once claimed. Certainly, his work as a journalist from 1917-1939, dissecting central and eastern Europe in more than a thousand essays and anticipating the collapse of democracy on the continent as well as 19 novels provides an exceptional anatomy of a tumultuous period of history. Keiron Pim’s biography goes some way to introducing the great Austro-Hungarian writer to a new age.
+
+Super-Infinite: The Transformations of John Donneby Katherine Rundell, Faber £16.99
+
+Katherine Rundell, a Fellow of All Souls College, Oxford, has produced a remarkable life of John Donne, the great poet of love, sex and death. Winner of this year’s Baillie Gifford Prize, her biography of the man who was at once soldier, poet, prisoner and priest is sensitive and witty, capturing the essence of a tricky subject.
+
+The Book of Phobias and Manias: A History of the World in 99 Obsessionsby Kate Summerscale, Profile £16.99
+
+This neat compendium from the prizewinning author of The Suspicions of Mr Whicher charts a broad and intriguing range of fears and madness. Although these phobias and manias are alphabetised, Kate Summerscale suggests groupings (textures, animals, communal crazes) that — accompanied by a lightly erudite introduction — illuminate some of the darker corners of our collective psyche.
+
+Papyrus: The Invention of Books in the Ancient Worldby Irene Vallejo, Hodder & Stoughton £25
+
+Described as “a masterpiece” by Mario Vargas Llosa when it was first published in Spain in 2019, this bestselling phenomenon is now available in English. In it, Irene Vallejo recounts the birth of literary culture in the ancient world while interweaving dynamic, thrilling tales that underscore and celebrate the power of words to change the world.
+
+Magnificent Rebels: The First Romantics and the Invention of the Selfby Andrea Wulf, John Murray £25/Knopf $35
+
+Between 1794-1806, the cream of Germany’s intelligentsia descended on the tiny university town of Jena. There, Johann Wolfgang von Goethe mingled with philosophers Friedrich Schelling and Georg Wilhelm Friedrich Hegel, the scientist-explorer Alexander von Humboldt and the playwright Friedrich Schiller during the first flush of Romanticism. Andrea Wulf’s wonderful book brings to life the “Jena set” and a golden age of German culture.
+
+Join our online book group on Facebook at FT Books Café",
   "tree": Object {
     "children": Array [
       Object {

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

@@ -145,6 +145,9 @@ export const baseMetadataSchema = z.object({
     .object({ apiUrl: z.string(), id: z.string() })
     .array()
     .optional(),
+  tableOfContents: z
+    .object({ labelType: z.string(), sequence: z.string() })
+    .optional(),
 })
 
 export const baseContentSchema = z.object({

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

@@ -9,6 +9,7 @@ const contentPackageContentSchema = baseContentSchema.pick({
   summary: true,
   alternativeTitles: true,
   contains: true,
+  tableOfContents: true,
   design: true,
   bodyXML: true,
 })

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

@@ -0,0 +1,21 @@
+import { ContentTree } from '@financial-times/content-tree'
+
+const extractTextFromNode = (
+  node: ContentTree.Paragraph | ContentTree.Phrasing
+): string => {
+  if (node.type === 'text') {
+    return node.value
+  } else if ('children' in node) {
+    return node.children.map(extractTextFromNode).join('')
+  } else {
+    return ''
+  }
+}
+
+export default function extractText(tree: ContentTree.Body): string {
+  return tree.children
+    .filter((node): node is ContentTree.Paragraph => node.type === 'paragraph')
+    .map(extractTextFromNode)
+    .map((paragraphText) => paragraphText.trim())
+    .join('\n\n')
+}

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

@@ -1,11 +1,11 @@
 import imageServiceUrl from '../../../helpers/imageService'
 import { FlourishResolvers } from '../../../generated'
+import { QueryContext } from '../../..'
+import isError from '../../../helpers/isError'
+import { logRecoverableError } from '@dotcom-reliability-kit/log-error/lib'
 
 export const Flourish = {
   async fallbackImage(parent, _args, context) {
-    const DEFAULT_WIDTH = 2626
-    const DEFAULT_HEIGHT = 1459
-
     const type = parent.reference.flourishType
     const timestamp =
       typeof parent.reference.timestamp === 'string'
@@ -15,23 +15,60 @@ export const Flourish = {
     const flourishUrl = `https://public.flourish.studio/${type}/${
       parent.reference.id
     }/thumbnail${timestamp ? '?cacheBuster=' + timestamp : ''}`
-    const imageMetadata = await context.dataSources.origami.getImageMetadata(
-      flourishUrl
-    )
+
+    const imageMetadata = await getImageMetadata(context, flourishUrl)
+
+    const width = imageMetadata.width
+    const height = imageMetadata.height
 
     const imageServiceWrappedUrl = imageServiceUrl({
       url: flourishUrl,
       systemCode: context.systemCode ?? 'cp-content-pipeline',
-      width: imageMetadata?.width || DEFAULT_WIDTH,
+      width,
     })
 
     return {
-      type: 'image',
       url: imageServiceWrappedUrl,
-      sourceSet: [],
+      type: 'image',
       format: 'standard',
-      width: imageMetadata?.width ? imageMetadata?.width : DEFAULT_WIDTH,
-      height: imageMetadata?.height ? imageMetadata?.height : DEFAULT_HEIGHT,
+      sourceSet: [],
+      width,
+      height,
     }
   },
 } satisfies FlourishResolvers
+
+type ImageMetadata = {
+  width: number
+  height: number
+}
+
+const getImageMetadata = async (
+  context: QueryContext,
+  flourishUrl: string
+): Promise<ImageMetadata> => {
+  const DEFAULT_WIDTH = 2626
+  const DEFAULT_HEIGHT = 1459
+
+  try {
+    const imageMetadata = await context.dataSources.origami.getImageMetadata(
+      flourishUrl
+    )
+
+    return {
+      width: imageMetadata?.width || DEFAULT_WIDTH,
+      height: imageMetadata?.height || DEFAULT_HEIGHT,
+    }
+  } catch (error) {
+    if (isError(error)) {
+      logRecoverableError({
+        error,
+        logger: context.logger,
+      })
+    }
+    return {
+      width: DEFAULT_WIDTH,
+      height: DEFAULT_HEIGHT,
+    }
+  }
+}

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

@@ -4,10 +4,7 @@ import { logRecoverableError } from '@dotcom-reliability-kit/log-error/lib'
 import imageServiceUrl from '../../../helpers/imageService'
 import { RawImage as RawImageNode } from '../Workarounds'
 import { RawImageResolvers } from '../../../generated'
-
-function isError(error: unknown): error is Error {
-  return error instanceof Error
-}
+import isError from '../../../helpers/isError'
 
 class RawImageModel implements Image {
   constructor(private rawImage: RawImageNode, private context: QueryContext) {}

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

@@ -1,9 +1,6 @@
 import { logRecoverableError } from '@dotcom-reliability-kit/log-error'
 import { TweetResolvers } from '../../../generated'
-
-function isError(error: unknown): error is Error {
-  return error instanceof Error
-}
+import isError from '../../../helpers/isError'
 
 export const Tweet = {
   async html(parent, _args, context) {

package/src/resolvers/content.ts

@@ -1,6 +1,7 @@
 import { Topper } from '../model/Topper'
 import { Byline } from '../model/Byline'
 import {
+  ArticleResolvers,
   AudioResolvers,
   ContentPackageResolvers,
   ContentResolvers,
@@ -33,17 +34,24 @@ const resolvers = {
       return new Byline(bylineText, authorUrlMapping).buildBylineTree()
     },
     url: (parent, args) =>
-      args.relative ? parent.relativeUrl() : parent.url(),
+      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(),
     commentsEnabled: (parent) => parent.commentsEnabled(),
     design: (parent) => parent.design(),
   },
 
+  Article: {
+    containedIn: (parent) => parent.containedIn(),
+  },
+
   LiveBlogPackage: {
     liveBlogPosts: (parent) => parent.liveBlogPosts(),
     realtime: (parent) => parent.realtime(),
@@ -60,6 +68,7 @@ const resolvers = {
       null,
   },
 } satisfies {
+  Article: ArticleResolvers
   Content: ContentResolvers
   LiveBlogPackage: LiveBlogPackageResolvers
   ContentPackage: ContentPackageResolvers

package/src/resolvers/image.ts

@@ -1,4 +1,3 @@
-import { ContentTree } from '@financial-times/content-tree'
 import { ImageResolvers } from '../generated'
 import { LiteralUnionScalarValues } from './literal-union'
 import { ImageFormat } from './scalars'
@@ -60,6 +59,7 @@ const resolvers = {
     width: async (image) => (await image.dimensions())?.width ?? null,
     height: async (image) => (await image.dimensions())?.height ?? null,
     sourceSet: (image, args) => image.sourceSet(args),
+    altText: (image) => image.alt(),
   },
 } satisfies { Image: ImageResolvers }
 

package/src/resolvers/teaser.ts

@@ -25,7 +25,6 @@ const resolvers = {
         isScoop: parent.isScoop(),
       }
     },
-    theme: (parent) => parent.design()?.theme,
     standfirst: (parent) => parent.standfirst(),
   },
 } satisfies { Teaser: TeaserResolvers }

package/src/resolvers/topper.ts

@@ -30,6 +30,7 @@ const resolvers = {
 
   TopperWithBrand: {
     brandConcept: (topper) => topper.brandConcept(),
+    genreConcept: (topper) => topper.genreConcept(),
   },
 
   PodcastTopper: {