@financial-times/cp-content-pipeline-schema 3.15.2 → 3.17.0

package/src/generated/index.ts

@@ -1620,6 +1620,13 @@ export type Recommended = Reference & {
   readonly type: Scalars['String']['output'];
 };
 
+export type RecommendedList = Reference & {
+  /** Recommended references contain teaser thumbnails of related articles. */
+  readonly teasers: ReadonlyArray<Teaser>;
+  /** The type of the reference, eg. 'recommended'. */
+  readonly type: Scalars['String']['output'];
+};
+
 export type Reference = {
   /** The type of the reference, eg. 'image-set'. References are additional data that cannot be loaded by content-tree. They will be appended to content-tree nodes during resolution. */
   readonly type: Scalars['String']['output'];
@@ -1690,6 +1697,8 @@ export type TableOfContents = {
 };
 
 export type Teaser = {
+  /** The label to show if sponsored content. */
+  readonly clientName?: Maybe<Scalars['String']['output']>;
   /** The date the content of the teaser was first published. */
   readonly firstPublishedDate: Scalars['String']['output'];
   /** The unique identifier of the teaser,  a uuid or a url. */
@@ -1997,7 +2006,7 @@ export type ResolversInterfaceTypes<RefType extends Record<string, unknown>> = R
   Content: ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel );
   Image: ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel );
   Picture: ( PictureModel ) | ( PictureModel ) | ( PictureModel );
-  Reference: ( ReferenceWithCAPIData<AuthorNode> ) | ( ReferenceWithCAPIData<ClipSetNode|OldClipNode> ) | ( ReferenceWithCAPIData<ContentTree.CustomCodeComponent> ) | ( ReferenceWithCAPIData<ContentTree.Flourish> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<ContentTree.LayoutImage> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<RawImageNode> ) | ( ReferenceWithCAPIData<ContentTree.Recommended> ) | ( ReferenceWithCAPIData<ContentTree.ScrollyImage> ) | ( ReferenceWithCAPIData<ContentTree.Tweet> ) | ( ReferenceWithCAPIData<ContentTree.Video> );
+  Reference: ( ReferenceWithCAPIData<AuthorNode> ) | ( ReferenceWithCAPIData<ClipSetNode|OldClipNode> ) | ( ReferenceWithCAPIData<ContentTree.CustomCodeComponent> ) | ( ReferenceWithCAPIData<ContentTree.Flourish> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<ContentTree.LayoutImage> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<RawImageNode> ) | ( ReferenceWithCAPIData<ContentTree.Recommended> ) | ( ReferenceWithCAPIData<ContentTree.RecommendedList> ) | ( ReferenceWithCAPIData<ContentTree.ScrollyImage> ) | ( ReferenceWithCAPIData<ContentTree.Tweet> ) | ( ReferenceWithCAPIData<ContentTree.Video> );
   Topper: ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel );
   TopperWithBrand: ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel );
   TopperWithHeadshot: ( TopperModel ) | ( TopperModel );
@@ -2085,6 +2094,7 @@ export type ResolversTypes = ResolversObject<{
   Query: ResolverTypeWrapper<{}>;
   RawImage: ResolverTypeWrapper<ReferenceWithCAPIData<RawImageNode>>;
   Recommended: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.Recommended>>;
+  RecommendedList: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.RecommendedList>>;
   Reference: ResolverTypeWrapper<ReferenceWithCAPIData>;
   RichText: ResolverTypeWrapper<RichTextModel>;
   RichTextSource: ResolverTypeWrapper<Scalars['RichTextSource']['output']>;
@@ -2187,6 +2197,7 @@ export type ResolversParentTypes = ResolversObject<{
   Query: {};
   RawImage: ReferenceWithCAPIData<RawImageNode>;
   Recommended: ReferenceWithCAPIData<ContentTree.Recommended>;
+  RecommendedList: ReferenceWithCAPIData<ContentTree.RecommendedList>;
   Reference: ReferenceWithCAPIData;
   RichText: RichTextModel;
   RichTextSource: Scalars['RichTextSource']['output'];
@@ -3062,8 +3073,14 @@ export type RecommendedResolvers<ContextType = QueryContext, ParentType extends
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 }>;
 
+export type RecommendedListResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['RecommendedList'] = ResolversParentTypes['RecommendedList']> = ResolversObject<{
+  teasers: Resolver<ReadonlyArray<ResolversTypes['Teaser']>, ParentType, ContextType>;
+  type: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+}>;
+
 export type ReferenceResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Reference'] = ResolversParentTypes['Reference']> = ResolversObject<{
-  __resolveType?: TypeResolveFn<'AuthorReference' | 'ClipSet' | 'CustomCodeComponent' | 'Flourish' | 'ImageSet' | 'LayoutImage' | 'MainImage' | 'RawImage' | 'Recommended' | 'ScrollyImage' | 'Tweet' | 'VideoReference', ParentType, ContextType>;
+  __resolveType?: TypeResolveFn<'AuthorReference' | 'ClipSet' | 'CustomCodeComponent' | 'Flourish' | 'ImageSet' | 'LayoutImage' | 'MainImage' | 'RawImage' | 'Recommended' | 'RecommendedList' | 'ScrollyImage' | 'Tweet' | 'VideoReference', ParentType, ContextType>;
   type: Resolver<ResolversTypes['String'], ParentType, ContextType>;
 }>;
 
@@ -3116,6 +3133,7 @@ export type TableOfContentsResolvers<ContextType = QueryContext, ParentType exte
 }>;
 
 export type TeaserResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Teaser'] = ResolversParentTypes['Teaser']> = ResolversObject<{
+  clientName: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   firstPublishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   id: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   image: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
@@ -3323,6 +3341,7 @@ export type Resolvers<ContextType = QueryContext> = ResolversObject<{
   Query: QueryResolvers<ContextType>;
   RawImage: RawImageResolvers<ContextType>;
   Recommended: RecommendedResolvers<ContextType>;
+  RecommendedList: RecommendedListResolvers<ContextType>;
   Reference: ReferenceResolvers<ContextType>;
   RichText: RichTextResolvers<ContextType>;
   RichTextSource: GraphQLScalarType;

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

@@ -200,6 +200,7 @@ export type BodyBlock =
   | ContentTree.Tweet
   | ContentTree.Video
   | ContentTree.YoutubeVideo
+  | ContentTree.RecommendedList
 
 export type AnyNode =
   | ContentTree.Text
@@ -248,3 +249,4 @@ export type AnyNode =
   | Byline
   | Author
   | Cite
+  | ContentTree.RecommendedList

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

@@ -28,6 +28,7 @@ export const bodyBlockTypes = [
   'thematic-break',
   'table',
   'recommended',
+  'recommended-list',
   'tweet',
   'video',
   'youtube-video',

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

@@ -26,7 +26,7 @@ describe('Flourish Model', () => {
           type: 'flourish',
           id: 'example-id',
           flourishType: 'example-type',
-          layoutWidth: 'grid',
+          layoutWidth: 'full-grid',
           timestamp: '2022-01-06T14:41:01.102Z',
           description: 'Example description',
         }
@@ -53,7 +53,7 @@ describe('Flourish Model', () => {
           type: 'flourish',
           id: 'example-id',
           flourishType: 'example-type',
-          layoutWidth: 'grid',
+          layoutWidth: 'full-grid',
           timestamp: '2022-01-06T14:41:01.102Z',
           description: 'Example description',
         }
@@ -77,7 +77,7 @@ describe('Flourish Model', () => {
           type: 'flourish',
           id: 'example-id',
           flourishType: 'example-type',
-          layoutWidth: 'grid',
+          layoutWidth: 'full-grid',
           timestamp: '2022-01-06T14:41:01.102Z',
           description: 'Example description',
         }

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

@@ -0,0 +1,52 @@
+import { uuidFromUrl } from '../../../helpers/metadata'
+import { RecommendedListResolvers } from '../../../generated'
+import { OperationalError } from '@dotcom-reliability-kit/errors'
+import { ContentTree } from '@financial-times/content-tree'
+import { Logger } from '@dotcom-reliability-kit/logger'
+import { CapiDataSource } from '../../../datasources/capi'
+
+function getTeaser(context: {
+  logger: Logger
+  dataSources: { capi: CapiDataSource }
+}) {
+  return async function (child: ContentTree.Recommended) {
+    try {
+      let content = await context.dataSources.capi.getContent(
+        uuidFromUrl(child.id)
+      )
+
+      if (!content) {
+        throw new Error('Invalid content from recommended article teaser')
+      }
+
+      if (child.teaserTitleOverride) {
+        content = content.overrideTitle(child.teaserTitleOverride)
+      }
+      return content
+    } catch (error) {
+      if (error instanceof Error) {
+        context.logger.warn({
+          event: 'RECOVERABLE_ERROR',
+          error: new OperationalError({
+            code: 'RECOMMENDED_TEASER_ERROR',
+            message: `Couldn't load teaser for recommended article ${child.id}`,
+            cause: error,
+          }),
+        })
+      }
+    }
+  }
+}
+
+export const RecommendedList = {
+  async teasers(parent, _args, context) {
+    const responses = await Promise.all(
+      parent.reference.children.map(getTeaser(context))
+    )
+
+    return responses.filter((response) => response !== undefined)
+  },
+  type(parent) {
+    return parent.reference.type
+  },
+} satisfies RecommendedListResolvers

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

@@ -10,6 +10,7 @@ import { CustomCodeComponent } from './CustomCodeComponent'
 import { Video } from './Video'
 import { Flourish, FlourishSource } from './Flourish'
 import { Recommended } from './Recommended'
+import { RecommendedList } from './RecommendedList'
 import { LayoutImage } from './LayoutImage'
 import { RawImage } from './RawImage'
 import { ScrollyImage } from './ScrollyImage'
@@ -21,6 +22,7 @@ import {
   LayoutImageResolvers,
   RawImageResolvers,
   RecommendedResolvers,
+  RecommendedListResolvers,
   ReferenceResolvers,
   ScrollyImageResolvers,
   TweetResolvers,
@@ -48,6 +50,7 @@ export const resolvers: {
   Flourish: FlourishResolvers
   FlourishSource: FlourishSourceResolvers
   Recommended: RecommendedResolvers
+  RecommendedList: RecommendedListResolvers
   LayoutImage: LayoutImageResolvers
   RawImage: RawImageResolvers
   ScrollyImage: ScrollyImageResolvers
@@ -65,6 +68,7 @@ export const resolvers: {
   Flourish,
   FlourishSource,
   Recommended,
+  RecommendedList,
   LayoutImage,
   RawImage,
   ScrollyImage,
@@ -83,6 +87,7 @@ export const mapNodeToReference = {
   'custom-code-component': 'CustomCodeComponent',
   video: 'VideoReference',
   recommended: 'Recommended',
+  'recommended-list': 'RecommendedList',
   'layout-image': 'LayoutImage',
   'scrolly-image': 'ScrollyImage',
   'raw-image': 'RawImage',

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

@@ -9,6 +9,7 @@ import {
   TableChildren,
   TableColumnSettings,
   TableFooter,
+  Recommended,
 } from './Workarounds'
 
 import {
@@ -119,12 +120,24 @@ const commonTagMappings: TagMappings = {
     version: 1,
     children: childrenOfTypes(bodyBlockTypes, traverse(), 'body'),
   }),
-  'a:not([data-asset-type])': ($el, traverse, context) => ({
-    type: 'link',
-    url: $el.attr('href') || '',
-    title: '',
-    children: childrenOfTypes(phrasingTypes, traverse(), 'link', context),
-  }),
+  'a:not([data-asset-type])': ($el, traverse, context) => {
+    const isValidStyleType = (
+      value?: string
+    ): value is ContentTree.Link['styleType'] =>
+      // The data-anchor-style attribute could be used to serve different variations of styles
+      // from the standard link. Currently, only 'onward-journey' is supported.
+      !!value && ['onward-journey'].includes(value)
+
+    const styleType = $el.attr('data-anchor-style') || ''
+
+    return {
+      type: 'link',
+      url: $el.attr('href') || '',
+      title: '',
+      children: childrenOfTypes(phrasingTypes, traverse(), 'link', context),
+      ...(isValidStyleType(styleType) && { styleType }),
+    }
+  },
   strong: ($el, traverse, context) => ({
     type: 'strong',
     children: childrenOfTypes(phrasingTypes, traverse(), 'strong', context),
@@ -291,6 +304,27 @@ const commonTagMappings: TagMappings = {
       teaserTitleOverride: $firstLink.text(),
     }
   },
+  'recommended-list': ($el) => {
+    const title = $el.find('recommended-title').first().text()
+    const items = $el
+      .find('ft-content')
+      .toArray()
+      .map((item) => {
+        const $item = $el.find(item)
+
+        return {
+          id: $item.attr('url') || '',
+          type: 'recommended',
+          teaserTitleOverride: $item.text(),
+        }
+      }) as Recommended[]
+
+    return {
+      type: 'recommended-list',
+      heading: title || 'Related content',
+      children: items,
+    }
+  },
   'big-number': ($el) => {
     const $number = $el.find('big-number-headline').first()
     const $description = $el.find('big-number-intro').first()

package/src/resolvers/teaser.ts

@@ -33,6 +33,7 @@ const resolvers = {
     publishedDate: (parent) => parent.publishedDate(),
     theme: (parent) => parent.design().theme,
     title: (parent) => parent.title(),
+    clientName: (parent) => parent.clientName?.(),
   },
   TeaserIndicators: {
     accessLevel: (parent) => parent.accessLevel,