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

package/src/model/schemas/capi/list.ts

@@ -0,0 +1,36 @@
+import { z } from 'zod'
+
+export const listSchema = z.object({
+  id: z.string(),
+  apiUrl: z.string(),
+  title: z.string(),
+  items: z
+    .array(
+      z.object({
+        id: z.string(),
+        apiUrl: z.string(),
+      })
+    )
+    .optional(),
+  listType: z.union([
+    z.literal('OpinionAnalysis'),
+    z.literal('Promotional'),
+    z.literal('Recommended'),
+    z.literal('TopStories'),
+    z.literal('TopStoriesBeta'),
+    z.literal('KeyDevelopments'),
+  ]),
+  publishedDate: z.string(),
+  layoutHint: z
+    .union([
+      z.literal('standaloneimage'),
+      z.literal('landscape'),
+      z.literal('bigstory'),
+      z.literal('assassination'),
+    ])
+    .optional(),
+  publication: z.array(z.string()).optional(),
+  publishReference: z.string().optional(),
+})
+
+export type List = z.input<typeof listSchema>

package/src/resolvers/core.ts

@@ -10,6 +10,31 @@ const packageJson = JSON.parse(
 
 export const version = packageJson.version
 
+function handleContentError(error: unknown, uuid: string): Error | unknown {
+  if (error instanceof BaseError) {
+    if (error.data.upstreamStatusCode === 404) {
+      return new HttpError({
+        code: 'CONTENT_NOT_FOUND',
+        message: 'Content not found in Content API',
+        cause: error,
+        uuid,
+        statusCode: 404,
+        relatesToSystems: ['up-ica'],
+      })
+    }
+    if (error.code === 'UNEXPECTED_CONTENT_TYPE') {
+      throw new HttpError({
+        code: error.code,
+        cause: error,
+        message: `Requested a content type we don't handle`,
+        statusCode: 404,
+      })
+    }
+  }
+
+  return error
+}
+
 const resolvers = {
   Query: {
     version: () => version,
@@ -17,30 +42,12 @@ const resolvers = {
       try {
         return await context.dataSources.capi.getContent(args.uuid)
       } catch (error) {
-        if (error instanceof BaseError) {
-          if (error.data.upstreamStatusCode === 404) {
-            throw new HttpError({
-              code: 'CONTENT_NOT_FOUND',
-              message: 'Content not found in Content API',
-              cause: error,
-              uuid: args.uuid,
-              statusCode: 404,
-              relatesToSystems: ['up-ica'],
-            })
-          }
-          if (error.code === 'UNEXPECTED_CONTENT_TYPE') {
-            throw new HttpError({
-              code: error.code,
-              cause: error,
-              message: `Requested a content type we don't handle`,
-              statusCode: 404,
-            })
-          }
-        }
-
-        throw error
+        throw handleContentError(error, args.uuid)
       }
     },
+    list(_, args, context) {
+      return context.dataSources.capi.getList(args.uuid)
+    },
     contentFromJSON(_, { content }, context) {
       return CapiResponse.fromJSON(content, context)
     },

package/src/resolvers/index.ts

@@ -11,6 +11,7 @@ import { default as teaser } from './teaser'
 import { default as topper } from './topper'
 import { default as person } from './person'
 import { default as leadFlourish } from './leadFlourish'
+import { default as list } from './list'
 import { resolvers as references } from './content-tree/references'
 import { Resolvers } from '../generated'
 
@@ -29,6 +30,7 @@ const resolvers = {
   ...topper,
   ...person,
   ...leadFlourish,
+  ...list,
 } satisfies Resolvers
 
 export default resolvers

package/src/resolvers/list.ts

@@ -0,0 +1,15 @@
+import { ListResolvers } from '../generated'
+
+export default {
+  List: {
+    id: (parent) => parent.id(),
+    apiUrl: (parent) => parent.apiUrl(),
+    title: (parent) => parent.title(),
+    items: (parent) => parent.items(),
+    listType: (parent) => parent.listType(),
+    publishedDate: (parent) => parent.publishedDate(),
+    layoutHint: (parent) => parent.layoutHint(),
+    publication: (parent) => parent.publication(),
+    publishReference: (parent) => parent.publishReference(),
+  },
+} satisfies { List: ListResolvers }

package/src/resolvers/scalars.ts

@@ -145,6 +145,34 @@ export const ContentType = new LiteralUnionScalar<
   ],
 })
 
+export const ListType = new LiteralUnionScalar<
+  [
+    'OpinionAnalysis',
+    'Promotional',
+    'Recommended',
+    'TopStories',
+    'TopStoriesBeta',
+    'KeyDevelopments'
+  ]
+>({
+  name: 'ListType',
+  values: [
+    'OpinionAnalysis',
+    'Promotional',
+    'Recommended',
+    'TopStories',
+    'TopStoriesBeta',
+    'KeyDevelopments',
+  ],
+})
+
+export const LayoutHint = new LiteralUnionScalar<
+  ['standaloneimage', 'landscape', 'bigstory', 'assassination']
+>({
+  name: 'LayoutHint',
+  values: ['standaloneimage', 'landscape', 'bigstory', 'assassination'],
+})
+
 const resolvers = {
   ClipFormat,
   ImageFormat,
@@ -156,6 +184,8 @@ const resolvers = {
   ImageType,
   RichTextSource,
   ContentType,
+  ListType,
+  LayoutHint,
   JSON: new GraphQLScalarType({ name: 'JSON' }),
 }