@financial-times/cp-content-pipeline-schema 2.14.2 → 2.15.1

package/src/datasources/capi.ts

@@ -6,6 +6,7 @@ import {
   KeyValueCache,
   PrefixingKeyValueCache,
 } from '@apollo/utils.keyvaluecache'
+import { CapiList } from '../model/CapiList'
 import TimeoutError from '../helpers/timeout-error'
 
 const REQUEST_TIMEOUT = process.env.CAPI_DATASOURCE_REQUEST_TIMEOUT
@@ -57,7 +58,12 @@ export class CapiDataSource extends InstrumentedRESTDataSource {
     uuid: string,
     packageContainer?: CapiResponse
   ): Promise<CapiResponse> {
-    this.context.addSurrogateKeys([uuid])
+    this.context.addSurrogateKeys([
+      {
+        prefix: 'contentPipelineArticle',
+        id: uuid,
+      },
+    ])
 
     const content = await this.get(`internalcontent/${uuid}`, {
       cacheOptions: { ttl: this.articleCacheTTL },
@@ -79,6 +85,18 @@ export class CapiDataSource extends InstrumentedRESTDataSource {
     })
   }
 
+  async getList(uuid: string): Promise<CapiList> {
+    this.context.addSurrogateKeys([
+      {
+        prefix: 'contentPipelineList',
+        id: uuid,
+      },
+    ])
+
+    const list = await this.get(`lists/${uuid}`)
+    return CapiList.fromJSON(list, this.context)
+  }
+
   // replicates the logic implicit in PrefixingKeyValueCache to
   // construct a cache key for an article used to purge Redis
   async getHTTPCacheKeyForContent(uuid: string) {

package/src/fixtures/dummyContext.ts

@@ -4,7 +4,7 @@ import cloneDeep from 'clone-deep'
 import { QueryContext } from '..'
 const now = Date.now()
 
-const addSurrogateKeys = (ids: string[]) => {
+const addSurrogateKeys = (ids: {prefix: string, id: string}[]) => {
   const keys = []
   keys.push(...ids)
 }

package/src/generated/index.ts

@@ -1,6 +1,7 @@
 import type { GraphQLResolveInfo, GraphQLScalarType, GraphQLScalarTypeConfig } from 'graphql';
 import type { Concept as ConceptModel } from '../model/Concept';
 import type { Person as PersonModel } from '../model/Person';
+import type { CapiList } from '../model/CapiList';
 import type { CapiResponse } from '../model/CapiResponse';
 import type { Image as ImageModel } from '../model/Image';
 import type { Clip as ClipModel } from '../model/Clip';
@@ -37,6 +38,8 @@ export type Scalars = {
   ImageFormat: { input: 'standard' | 'standard-inline' | 'desktop' | 'mobile' | 'wide' | 'square' | 'square-ftedit' | 'portrait' | 'landscape'; output: 'standard' | 'standard-inline' | 'desktop' | 'mobile' | 'wide' | 'square' | 'square-ftedit' | 'portrait' | 'landscape'; }
   ImageType: { input: 'image' | 'graphic'; output: 'image' | 'graphic'; }
   JSON: { input: any; output: any; }
+  LayoutHint: { input: 'standaloneimage' | 'landscape' | 'bigstory' | 'assassination'; output: 'standaloneimage' | 'landscape' | 'bigstory' | 'assassination'; }
+  ListType: { input: 'OpinionAnalysis' | 'Promotional' | 'Recommended' | 'TopStories' | 'TopStoriesBeta' | 'KeyDevelopments'; output: 'OpinionAnalysis' | 'Promotional' | 'Recommended' | 'TopStories' | 'TopStoriesBeta' | 'KeyDevelopments'; }
   PackageDesign: { input: 'special-report' | 'extra' | 'basic' | 'extra-wide'; output: 'special-report' | 'extra' | 'basic' | 'extra-wide'; }
   RichTextSource: { input: 'standfirst' | 'summary' | 'bodyXML' | 'transcript'; output: 'standfirst' | 'summary' | 'bodyXML' | 'transcript'; }
   TopperBackgroundColour: { input: 'paper' | 'wheat' | 'white' | 'black' | 'claret' | 'oxford' | 'slate' | 'crimson' | 'sky' | 'matisse'; output: 'paper' | 'wheat' | 'white' | 'black' | 'claret' | 'oxford' | 'slate' | 'crimson' | 'sky' | 'matisse'; }
@@ -95,7 +98,7 @@ export type Article = Content & {
   /** The party that originated the article, eg. 'FT'. */
   readonly originatingParty?: Maybe<Scalars['String']['output']>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -161,7 +164,7 @@ export type Audio = Content & {
   /** The party that originated the article, eg. 'FT'. */
   readonly originatingParty?: Maybe<Scalars['String']['output']>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -372,7 +375,7 @@ export type Content = {
   /** The party that originated the article, eg. 'FT'. */
   readonly originatingParty?: Maybe<Scalars['String']['output']>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -440,7 +443,7 @@ export type ContentPackage = Content & {
   /** The party that originated the article, eg. 'FT'. */
   readonly originatingParty?: Maybe<Scalars['String']['output']>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -942,6 +945,27 @@ export type LeadFlourish = {
   readonly type?: Maybe<Scalars['String']['output']>;
 };
 
+export type List = {
+  /** The upstream API URL for the list */
+  readonly apiUrl: Scalars['String']['output'];
+  /** The UUID of the list */
+  readonly id: Scalars['String']['output'];
+  /** The content items referenced by this list */
+  readonly items: ReadonlyArray<Content>;
+  /** Used by ft.com to determine the visual style to use on the website */
+  readonly layoutHint?: Maybe<Scalars['LayoutHint']['output']>;
+  /** The type of the list, e.g. Recommended */
+  readonly listType: Scalars['ListType']['output'];
+  /** Array of publication IDs this list pertains to, e.g. 88fdde6c-2aa4-4f78-af02-9f680097cfd6 for FT Pink */
+  readonly publication?: Maybe<ReadonlyArray<Scalars['String']['output']>>;
+  /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
+  /** The date when this list was published */
+  readonly publishedDate: Scalars['String']['output'];
+  /** The title of the list */
+  readonly title: Scalars['String']['output'];
+};
+
 export type LiveBlogPackage = Content & {
   /** A scalar representing the access level of the article, eg. 'free'. */
   readonly accessLevel?: Maybe<Scalars['AccessLevel']['output']>;
@@ -980,7 +1004,7 @@ export type LiveBlogPackage = Content & {
   /** The pinned article of this live blog package. */
   readonly pinnedPost?: Maybe<Content>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -1058,7 +1082,7 @@ export type LiveBlogPost = Content & {
   /** The party that originated the article, eg. 'FT'. */
   readonly originatingParty?: Maybe<Scalars['String']['output']>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -1288,7 +1312,7 @@ export type Placeholder = Content & {
   /** The party that originated the article, eg. 'FT'. */
   readonly originatingParty?: Maybe<Scalars['String']['output']>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -1359,6 +1383,8 @@ export type Query = {
   readonly content: Content;
   /** The article content as resolved from passed-in content-api json data. */
   readonly contentFromJSON: Content;
+  /** Resolve a content list from a uuid. */
+  readonly list: List;
   /** The version of the schema, eg. 2.0.0. */
   readonly version: Scalars['String']['output'];
 };
@@ -1373,6 +1399,11 @@ export type QueryContentFromJsonArgs = {
   content: Scalars['JSON']['input'];
 };
 
+
+export type QueryListArgs = {
+  uuid: Scalars['String']['input'];
+};
+
 export type RawImage = Reference & {
   /** The raw image object. */
   readonly image: Image;
@@ -1619,7 +1650,7 @@ export type Video = Content & {
   /** The party that originated the article, eg. 'FT'. */
   readonly originatingParty?: Maybe<Scalars['String']['output']>;
   /** A string ID used to trace content publishes through the pipeline, e.g. 'republish_tid_JNhUrBjdXo'. */
-  readonly publishReference: Scalars['String']['output'];
+  readonly publishReference?: Maybe<Scalars['String']['output']>;
   /** The ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
   readonly publishedDate: Scalars['String']['output'];
   /** The number of milliseconds since the unix epoch the article was published, eg '1712140552443'. */
@@ -1793,8 +1824,11 @@ export type ResolversTypes = ResolversObject<{
   Indicators: ResolverTypeWrapper<Indicators>;
   Int: ResolverTypeWrapper<Scalars['Int']['output']>;
   JSON: ResolverTypeWrapper<Scalars['JSON']['output']>;
+  LayoutHint: ResolverTypeWrapper<Scalars['LayoutHint']['output']>;
   LayoutImage: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.LayoutImage>>;
   LeadFlourish: ResolverTypeWrapper<LeadFlourishModel>;
+  List: ResolverTypeWrapper<CapiList>;
+  ListType: ResolverTypeWrapper<Scalars['ListType']['output']>;
   LiveBlogPackage: ResolverTypeWrapper<CapiResponse>;
   LiveBlogPost: ResolverTypeWrapper<CapiResponse>;
   MainImage: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.ImageSet>>;
@@ -1884,8 +1918,11 @@ export type ResolversParentTypes = ResolversObject<{
   Indicators: Indicators;
   Int: Scalars['Int']['output'];
   JSON: Scalars['JSON']['output'];
+  LayoutHint: Scalars['LayoutHint']['output'];
   LayoutImage: ReferenceWithCAPIData<ContentTree.LayoutImage>;
   LeadFlourish: LeadFlourishModel;
+  List: CapiList;
+  ListType: Scalars['ListType']['output'];
   LiveBlogPackage: CapiResponse;
   LiveBlogPost: CapiResponse;
   MainImage: ReferenceWithCAPIData<ContentTree.ImageSet>;
@@ -1965,7 +2002,7 @@ export type ArticleResolvers<ContextType = QueryContext, ParentType extends Reso
   instantAlertConcept: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   standfirst: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1995,7 +2032,7 @@ export type AudioResolvers<ContextType = QueryContext, ParentType extends Resolv
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   media: Resolver<Maybe<ReadonlyArray<Maybe<ResolversTypes['Media']>>>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   standfirst: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -2120,7 +2157,7 @@ export type ContentResolvers<ContextType = QueryContext, ParentType extends Reso
   instantAlertConcept: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   standfirst: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -2150,7 +2187,7 @@ export type ContentPackageResolvers<ContextType = QueryContext, ParentType exten
   instantAlertConcept: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   standfirst: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -2426,6 +2463,10 @@ export interface JsonScalarConfig extends GraphQLScalarTypeConfig<ResolversTypes
   name: 'JSON';
 }
 
+export interface LayoutHintScalarConfig extends GraphQLScalarTypeConfig<ResolversTypes['LayoutHint'], any> {
+  name: 'LayoutHint';
+}
+
 export type LayoutImageResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['LayoutImage'] = ResolversParentTypes['LayoutImage']> = ResolversObject<{
   picture: Resolver<Maybe<ResolversTypes['Picture']>, ParentType, ContextType>;
   type: Resolver<ResolversTypes['String'], ParentType, ContextType>;
@@ -2440,6 +2481,23 @@ export type LeadFlourishResolvers<ContextType = QueryContext, ParentType extends
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 }>;
 
+export type ListResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['List'] = ResolversParentTypes['List']> = ResolversObject<{
+  apiUrl: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  items: Resolver<ReadonlyArray<ResolversTypes['Content']>, ParentType, ContextType>;
+  layoutHint: Resolver<Maybe<ResolversTypes['LayoutHint']>, ParentType, ContextType>;
+  listType: Resolver<ResolversTypes['ListType'], ParentType, ContextType>;
+  publication: Resolver<Maybe<ReadonlyArray<ResolversTypes['String']>>, ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
+  publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  title: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
+}>;
+
+export interface ListTypeScalarConfig extends GraphQLScalarTypeConfig<ResolversTypes['ListType'], any> {
+  name: 'ListType';
+}
+
 export type LiveBlogPackageResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['LiveBlogPackage'] = ResolversParentTypes['LiveBlogPackage']> = ResolversObject<{
   accessLevel: Resolver<Maybe<ResolversTypes['AccessLevel']>, ParentType, ContextType>;
   altStandfirst: Resolver<Maybe<ResolversTypes['AltStandfirst']>, ParentType, ContextType>;
@@ -2459,7 +2517,7 @@ export type LiveBlogPackageResolvers<ContextType = QueryContext, ParentType exte
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   pinnedPost: Resolver<Maybe<ResolversTypes['Content']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   realtime: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
@@ -2493,7 +2551,7 @@ export type LiveBlogPostResolvers<ContextType = QueryContext, ParentType extends
   isPinned: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   standfirst: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -2628,7 +2686,7 @@ export type PlaceholderResolvers<ContextType = QueryContext, ParentType extends
   instantAlertConcept: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   standfirst: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -2660,6 +2718,7 @@ export type PodcastTopperResolvers<ContextType = QueryContext, ParentType extend
 export type QueryResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Query'] = ResolversParentTypes['Query']> = ResolversObject<{
   content: Resolver<ResolversTypes['Content'], ParentType, ContextType, RequireFields<QueryContentArgs, 'uuid'>>;
   contentFromJSON: Resolver<ResolversTypes['Content'], ParentType, ContextType, RequireFields<QueryContentFromJsonArgs, 'content'>>;
+  list: Resolver<ResolversTypes['List'], ParentType, ContextType, RequireFields<QueryListArgs, 'uuid'>>;
   version: Resolver<ResolversTypes['String'], ParentType, ContextType>;
 }>;
 
@@ -2830,7 +2889,7 @@ export type VideoResolvers<ContextType = QueryContext, ParentType extends Resolv
   instantAlertConcept: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
   mainImage: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   originatingParty: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
-  publishReference: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  publishReference: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   publishedTimestamp: Resolver<ResolversTypes['Float'], ParentType, ContextType>;
   standfirst: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -2892,8 +2951,11 @@ export type Resolvers<ContextType = QueryContext> = ResolversObject<{
   ImageWide: ImageWideResolvers<ContextType>;
   Indicators: IndicatorsResolvers<ContextType>;
   JSON: GraphQLScalarType;
+  LayoutHint: GraphQLScalarType;
   LayoutImage: LayoutImageResolvers<ContextType>;
   LeadFlourish: LeadFlourishResolvers<ContextType>;
+  List: ListResolvers<ContextType>;
+  ListType: GraphQLScalarType;
   LiveBlogPackage: LiveBlogPackageResolvers<ContextType>;
   LiveBlogPost: LiveBlogPostResolvers<ContextType>;
   MainImage: MainImageResolvers<ContextType>;

package/src/helpers/flatten-formatted-zod-errors.ts

@@ -0,0 +1,67 @@
+function isPlainObject(object: unknown): object is Record<string, unknown> {
+  if (object && typeof object === 'object') {
+    return true
+  }
+
+  return false
+}
+
+type FormattedZodIssues = {
+  _errors: string[]
+  [key: string]: FormattedZodIssues | string[]
+}
+
+export default function flattenFormattedZodIssues(
+  issues: FormattedZodIssues,
+  object: unknown,
+  path: string[] = [],
+  flattened: string[] = []
+): string[] {
+  if (issues._errors.length > 0) {
+    const literalErrors = issues._errors.filter((error) =>
+      error.startsWith('Invalid literal value')
+    )
+    const otherErrors = issues._errors.filter(
+      (error) => !error.startsWith('Invalid literal value')
+    )
+
+    if (literalErrors.length > 0) {
+      flattened.push(
+        `${path.join(
+          '.'
+        )}: Invalid literal value, received "${object}", expected one of ` +
+          literalErrors
+            .flatMap((error) => {
+              const match = error.match(/expected (".+")$/)
+              if (match && match[1]) {
+                return [match[1]]
+              }
+
+              return []
+            })
+            .join()
+      )
+    }
+
+    flattened.push(...otherErrors.map((error) => `${path.join('.')}: ${error}`))
+  }
+
+  for (const [key, value] of Object.entries(issues)) {
+    if (
+      key !== '_errors' &&
+      !Array.isArray(value) &&
+      object &&
+      (Array.isArray(object) || isPlainObject(object))
+    ) {
+      const isArrayKey = !Number.isNaN(parseInt(key))
+      flattenFormattedZodIssues(
+        value,
+        Array.isArray(object) ? object[parseInt(key)] : object[key],
+        [...path, isArrayKey ? '[]' : key],
+        flattened
+      )
+    }
+  }
+
+  return flattened
+}

package/src/index.ts

@@ -17,6 +17,8 @@ export type BodyXMLToTreeError = {
   actual: AnyNode['type'] | AnyNode['type'][]
 }
 
+export type SurrogateKey = { prefix: string; id: string }
+
 export interface QueryContext {
   redisAdapter: KeyValueCache
   metrics: Metrics
@@ -30,7 +32,7 @@ export interface QueryContext {
     schema: string
   }
   aggregatedErrors?: { bodyXMLToTree: BodyXMLToTreeError[] }
-  addSurrogateKeys(keys: string[]): void
+  addSurrogateKeys(keys: SurrogateKey[]): void
 }
 
 export const articleDocumentQuery = readFileSync(

package/src/model/CapiList.ts

@@ -0,0 +1,103 @@
+import { BaseError, OperationalError } from '@dotcom-reliability-kit/errors'
+import { QueryContext } from '..'
+import { uuidFromUrl } from '../helpers/metadata'
+import { List, listSchema } from './schemas/capi/list'
+import flattenFormattedZodIssues from '../helpers/flatten-formatted-zod-errors'
+
+export class CapiList {
+  static fromJSON(list: unknown, context: QueryContext): CapiList {
+    const result = listSchema.safeParse(list)
+
+    if (!result.success) {
+      context.logger.warn({
+        event: 'RECOVERABLE_ERROR',
+        error: new OperationalError({
+          message:
+            'The data received from the CAPI data source does not match our data source schema. It is likely that our schema will require updating to handle all possible responses from CAPI.',
+          code: 'CAPI_SCHEMA_VALIDATION_FAILURE',
+          schemaError: flattenFormattedZodIssues(result.error.format(), list),
+          contentId: (list as { id?: string }).id,
+          contentType: 'List',
+        }),
+      })
+      context.metrics?.count(
+        `graphql.datasource.CapiDataSource.List.validation.failure.count`,
+        1
+      )
+    } else {
+      context.metrics?.count(
+        `graphql.datasource.CapiDataSource.List.validation.success.count`,
+        1
+      )
+    }
+
+    return new CapiList(list as List, context)
+  }
+
+  constructor(private list: List, private context: QueryContext) {}
+
+  async items() {
+    if (!this.list.items) return []
+
+    const items = await Promise.all(
+      this.list.items.map(({ id }) =>
+        this.context.dataSources.capi
+          .getContent(uuidFromUrl(id))
+          .catch((error) => {
+            if (error instanceof BaseError) {
+              if (error.data.upstreamStatusCode === 404) {
+                this.context.logger.warn({
+                  event: 'RECOVERABLE_ERROR',
+                  error: new OperationalError({
+                    code: 'LIST_CONTENT_NOT_FOUND',
+                    message: 'List content not found in Content API',
+                    uuid: uuidFromUrl(error.data.upstreamUrl),
+                    cause: error,
+                  }),
+                })
+
+                return null
+              }
+            }
+
+            throw error
+          })
+      )
+    )
+
+    // filter out missing list items to match n-lists-client behaviour
+    return items.filter((item) => item !== null)
+  }
+
+  id() {
+    return uuidFromUrl(this.list.id)
+  }
+
+  apiUrl() {
+    return this.list.apiUrl
+  }
+
+  title() {
+    return this.list.title
+  }
+
+  listType() {
+    return this.list.listType
+  }
+
+  publishedDate() {
+    return this.list.publishedDate
+  }
+
+  layoutHint() {
+    return this.list.layoutHint ?? null
+  }
+
+  publication() {
+    return this.list.publication ?? null
+  }
+
+  publishReference() {
+    return this.list.publishReference ?? null
+  }
+}

package/src/model/CapiResponse.ts

@@ -39,25 +39,13 @@ 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') {
-    return true
-  }
-
-  return false
-}
+import flattenFormattedZodIssues from '../helpers/flatten-formatted-zod-errors'
 
 type Design = {
   theme: LiteralUnionScalarValues<typeof PackageDesign>
   layout?: 'default' | 'wide'
 }
 
-type FormattedZodIssues = {
-  _errors: string[]
-  [key: string]: FormattedZodIssues | string[]
-}
-
 type ZodInputValue =
   | ZodInputObject
   | ZodInputValue[]
@@ -71,61 +59,6 @@ type ZodInputObject = {
   [key: string]: ZodInputValue
 }
 
-function flattenFormattedZodIssues(
-  issues: FormattedZodIssues,
-  object: unknown,
-  path: string[] = [],
-  flattened: string[] = []
-): string[] {
-  if (issues._errors.length > 0) {
-    const literalErrors = issues._errors.filter((error) =>
-      error.startsWith('Invalid literal value')
-    )
-    const otherErrors = issues._errors.filter(
-      (error) => !error.startsWith('Invalid literal value')
-    )
-
-    if (literalErrors.length > 0) {
-      flattened.push(
-        `${path.join(
-          '.'
-        )}: Invalid literal value, received "${object}", expected one of ` +
-          literalErrors
-            .flatMap((error) => {
-              const match = error.match(/expected (".+")$/)
-              if (match && match[1]) {
-                return [match[1]]
-              }
-
-              return []
-            })
-            .join()
-      )
-    }
-
-    flattened.push(...otherErrors.map((error) => `${path.join('.')}: ${error}`))
-  }
-
-  for (const [key, value] of Object.entries(issues)) {
-    if (
-      key !== '_errors' &&
-      !Array.isArray(value) &&
-      object &&
-      (Array.isArray(object) || isPlainObject(object))
-    ) {
-      const isArrayKey = !Number.isNaN(parseInt(key))
-      flattenFormattedZodIssues(
-        value,
-        Array.isArray(object) ? object[parseInt(key)] : object[key],
-        [...path, isArrayKey ? '[]' : key],
-        flattened
-      )
-    }
-  }
-
-  return flattened
-}
-
 function getContentType(
   content: BaselineContent,
   validate?: true
@@ -390,7 +323,7 @@ export class CapiResponse {
     return this.capiData.firstPublishedDate || this.capiData.publishedDate
   }
   publishReference() {
-    return this.capiData.publishReference
+    return this.capiData.publishReference ?? null
   }
   alternativeTitle() {
     return this.capiData.alternativeTitles ?? null
@@ -730,7 +663,12 @@ export class CapiResponse {
     const contains = await this.contains()
 
     if (contains && contains.length) {
-      this.context.addSurrogateKeys(contains.map((article) => article.id()))
+      this.context.addSurrogateKeys(
+        contains.map((article) => ({
+          prefix: 'contentPipelineArticle',
+          id: article.id(),
+        }))
+      )
 
       const liveBlogPosts = contains.sort(
         (a, b) => b.publishedTimestamp() - a.publishedTimestamp()

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

@@ -194,7 +194,7 @@ export const baseMetadataSchema = z.object({
     .optional(),
   publishedDate: z.string(),
   firstPublishedDate: z.string(),
-  publishReference: z.string(),
+  publishReference: z.string().optional(),
   realtime: z.boolean(),
   editorialDesk: z.string().optional(),
   accessLevel: z