@financial-times/cp-content-pipeline-schema 0.7.27 → 0.7.29

package/src/model/Byline.ts

@@ -1,21 +1,23 @@
 import { ContentTree } from '@financial-times/content-tree'
 import { AuthorLink } from '../resolvers/content-tree/Workarounds'
-import { StructuredContent } from '../generated'
+import { QueryContext } from '..'
 
 export class Byline {
   constructor(
     private byline: string,
-    private authorUrlMapping: Map<string, string>
+    private vanity: boolean,
+    private authorUrlMapping: Map<string, string>,
+    private context: QueryContext
   ) {}
 
-  buildBylineTree() {
+  async buildBylineTree() {
     // Normalise apostrophes in byline string
     const bylineWithCorrectApostrophes = this.byline.replace("'", '’')
 
     const split = this.#splitBylineByName(bylineWithCorrectApostrophes, [
       ...this.authorUrlMapping.keys(),
     ])
-    return this.#buildUrlTree(this.authorUrlMapping, split)
+    return await this.#buildUrlTree(this.authorUrlMapping, split)
   }
 
   #splitBylineByName(byline: string, names: string[]) {
@@ -24,23 +26,29 @@ export class Byline {
     return byline.split(regex).filter((string) => string !== '')
   }
 
-  #buildUrlTree(urlMapping: Map<string, string>, parts: string[]) {
-    const children: (AuthorLink | ContentTree.Text)[] = parts.map((part) => {
-      const url = urlMapping.get(part)
+  async #buildUrlTree(urlMapping: Map<string, string>, parts: string[]) {
+    const children: (AuthorLink | ContentTree.Text)[] = await Promise.all(
+      parts.map(async (part) => {
+        const fullUrl = urlMapping.get(part)
+        const vanityUrl =
+          this.vanity && fullUrl
+            ? await this.context.dataSources.vanityUrls.get(fullUrl)
+            : null
 
-      if (url) {
-        return {
-          type: 'author-link',
-          href: url,
-          children: [{ type: 'text', value: part }],
+        if (fullUrl) {
+          return {
+            type: 'author-link',
+            href: vanityUrl || fullUrl,
+            children: [{ type: 'text', value: part }],
+          }
+        } else {
+          return {
+            type: 'text',
+            value: part,
+          }
         }
-      } else {
-        return {
-          type: 'text',
-          value: part,
-        }
-      }
-    })
+      })
+    )
 
     return {
       tree: { type: 'root', children },

package/src/model/CapiResponse.test.ts

@@ -1,31 +1,7 @@
 import { CapiResponse } from './CapiResponse'
 import { baseCapiObject } from '../fixtures/capiObject'
-import { jest } from '@jest/globals'
 import cloneDeep from 'clone-deep'
-
-import type { QueryContext } from '..'
-
-const now = Date.now()
-
-const context = {
-  dataSources: {
-    capi: {
-      getContent: (id: string) =>
-        Promise.resolve(
-          new CapiResponse(
-            cloneDeep({
-              ...baseCapiObject,
-              id,
-              publishedDate: new Date(
-                now + parseInt(id.slice(-1), 10)
-              ).toISOString(),
-            }),
-            {} as unknown as QueryContext
-          )
-        ),
-    },
-  },
-} as unknown as QueryContext
+import context from '../fixtures/dummyContext'
 
 describe('CAPI response', () => {
   describe('Content ID', () => {

package/src/model/CapiResponse.ts

@@ -1,10 +1,7 @@
 import type {
-  Article,
-  LiveBlogPackage,
-  ContentPackage,
   ImageSet,
-  Audio,
   Annotation,
+  ContentTypeSchemas,
 } from '../types/internal-content'
 import conceptIds from '@financial-times/n-concept-ids'
 import metadata, { TeaserMetadata } from '@financial-times/n-display-metadata'
@@ -34,8 +31,6 @@ import {
 
 import { Media } from '../generated'
 
-type ContentTypeSchemas = Article | LiveBlogPackage | ContentPackage | Audio
-
 type Design = {
   theme: LiteralUnionScalarValues<typeof PackageDesign>
   layout?: 'default' | 'wide'
@@ -276,23 +271,29 @@ export class CapiResponse {
     return new CapiResponse(clone, this.context)
   }
 
-  #teaserMetadata() {
-    return metadata.teaser({ annotations: this.#rawAnnotations() })
+  async #teaserMetadata() {
+    const containedIn = await this.containedIn()
+
+    return metadata.teaser({
+      annotations: this.#rawAnnotations(),
+      containedIn: containedIn ? [containedIn.capiData] : null,
+    })
   }
 
-  teaserMetadataLink(
+  async teaserMetadataLink(
     field: ConditionalKeys<TeaserMetadata, Annotation | null>
   ) {
-    const meta = this.#teaserMetadata()
+    const meta = await this.#teaserMetadata()
     const metaField = meta[field]
+
     return metaField ? new Concept(metaField, this.context) : null
   }
 
-  teaserMetadataText(
+  async teaserMetadataText(
     field: ConditionalKeys<TeaserMetadata, string> | 'suffixText'
   ) {
     if (field === 'prefixText') {
-      const meta = this.#teaserMetadata()
+      const meta = await this.#teaserMetadata()
       return meta[field]
     } else {
       // HACK 20230629 IM: suffixText doesn't actually exist in the metadata
@@ -474,15 +475,13 @@ 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))
+  async containedIn() {
+    const containerId =
+      'containedIn' in this.capiData && this.capiData.containedIn?.[0]?.id
+
+    return containerId
+      ? await this.context.dataSources.capi.getContent(uuidFromUrl(containerId))
+      : null
   }
 
   isContainedInPackage(): boolean {

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

@@ -4,15 +4,23 @@ import {
   baseMediaSchema,
 } from './base-schema'
 
-const contentPackageContentSchema = baseContentSchema.pick({
-  title: true,
-  summary: true,
-  alternativeTitles: true,
-  contains: true,
-  tableOfContents: true,
-  design: true,
-  bodyXML: true,
-})
+const contentPackageContentSchema = baseContentSchema
+  .pick({
+    title: true,
+    summary: true,
+    alternativeTitles: true,
+    contains: true,
+    tableOfContents: true,
+    design: true,
+    bodyXML: true,
+  })
+  .merge(
+    baseContentSchema
+      .pick({
+        summary: true,
+      })
+      .partial()
+  )
 
 const contentPackageMetadataSchema = baseMetadataSchema.pick({
   id: true,

package/src/resolvers/concept.ts

@@ -1,12 +1,10 @@
-import { IResolvers } from '@graphql-tools/utils'
-import type { QueryContext } from '..'
-import { Concept, URLArguments } from '../model/Concept'
 import { ConceptResolvers } from '../generated'
 
 const resolvers: { Concept: ConceptResolvers } = {
   Concept: {
     apiUrl: (parent) => parent.apiUrl(),
     directType: (parent) => parent.directType(),
+    isPackageBrand: (parent) => parent.isPackageBrand(),
     id: (parent) => parent.uuid(),
     predicate: (parent) => parent.predicate(),
     prefLabel: (parent) => parent.prefLabel(),

package/src/resolvers/content.ts

@@ -26,12 +26,20 @@ const resolvers = {
     body(parent) {
       return new RichText('bodyXML', parent.bodyXML(), parent)
     },
-    topper: (parent, args, context) => new Topper(parent, context),
-    byline(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, authorUrlMapping).buildBylineTree()
+
+      return new Byline(
+        bylineText,
+        vanity,
+        authorUrlMapping,
+        context
+      ).buildBylineTree()
     },
     url: (parent, args) =>
       args.relative

package/src/types/internal-content.d.ts

@@ -37,3 +37,5 @@ type Image = z.infer<typeof Image>
 type LeadImage = z.infer<typeof LeadImage>
 type ImageSet = z.infer<typeof ImageSet>
 type MainImage = z.infer<typeof MainImage>
+
+type ContentTypeSchemas = Article | LiveBlogPackage | ContentPackage | Audio

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

@@ -1,5 +1,5 @@
 declare module '@financial-times/n-display-metadata' {
-  import { Annotation } from './internal-content'
+  import { Annotation, ContentTypeSchemas } from './internal-content'
 
   export interface FlagsMetadata {
     isOpinion: boolean
@@ -15,6 +15,7 @@ declare module '@financial-times/n-display-metadata' {
 
   export interface Content {
     annotations: Annotation[]
+    containedIn: ContentTypeSchemas | null
   }
 
   export function teaser(content: Content): TeaserMetadata