@financial-times/cp-content-pipeline-schema 1.4.3 → 1.5.0

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

@@ -96,6 +96,20 @@ Object {
         "type": "image-set",
       },
     },
+    Object {
+      "contentApiData": undefined,
+      "reference": Object {
+        "autoplay": true,
+        "data": Object {
+          "referenceIndex": 9,
+        },
+        "dataLayout": "in-line",
+        "id": "http://api-t.ft.com/content/f17fe25b-cdea-4d5f-a6af-40e56e33e888",
+        "loop": true,
+        "muted": true,
+        "type": "clip-set",
+      },
+    },
   ],
   "text": "Eliot After The Waste Land (Eliot Biographies, 2)by Robert Crawford, Jonathan Cape £25
 
@@ -905,6 +919,17 @@ Join our online book group on Facebook at FT Books Café",
         ],
         "type": "paragraph",
       },
+      Object {
+        "autoplay": true,
+        "data": Object {
+          "referenceIndex": 9,
+        },
+        "dataLayout": "in-line",
+        "id": "http://api-t.ft.com/content/f17fe25b-cdea-4d5f-a6af-40e56e33e888",
+        "loop": true,
+        "muted": true,
+        "type": "clip-set",
+      },
       Object {
         "children": Array [
           Object {

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

@@ -25,6 +25,7 @@ const articleMetadataSchema = baseMetadataSchema.pick({
   firstPublishedDate: true,
   accessLevel: true,
   canBeSyndicated: true,
+  canBeDistributed: true,
   topper: true,
   comments: true,
   containedIn: true,

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

@@ -20,6 +20,7 @@ const audioMetadataSchema = baseMetadataSchema.pick({
   firstPublishedDate: true,
   accessLevel: true,
   canBeSyndicated: true,
+  canBeDistributed: true,
 })
 
 const audioMediaSchema = baseMediaSchema.pick({

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

@@ -88,6 +88,50 @@ export const AlternativeImage = z.object({
   promotionalImage: BaseImage,
 })
 
+const ClipSource = z.object({
+  audioCodec: z.string().optional(),
+  binaryUrl: z.string().optional(),
+  duration: z.number().optional(),
+  mediaType: z.string().optional(),
+  pixelHeight: z.number().optional(),
+  pixelWidth: z.number().optional(),
+  videoCodec: z.string().optional(),
+})
+
+export const Clip = z.object({
+  id: z.string(),
+  type: z.literal('http://www.ft.com/ontology/content/Clip'),
+  format: z
+    .union([z.literal('standardInline'), z.literal('mobile')])
+    .optional(),
+  dataSource: ClipSource.array(),
+  poster: ImageSet.optional(),
+})
+
+export const ClipSet = z.object({
+  id: z.string(),
+  type: z.literal('http://www.ft.com/ontology/content/ClipSet'),
+  members: Clip.array(),
+  caption: z.string().optional(),
+  dataCopyright: z.string().optional(),
+  description: z.string().optional(),
+  displayTitle: z.string().optional(),
+  contentWarning: z.string().array().optional(),
+  noAudio: z.boolean().optional(),
+  source: z.string().optional(),
+  subtitle: z.string().optional(),
+  publishedDate: z.string().optional(),
+  accessibility: z.object({
+    captions: z.array(
+      z.object({
+        mediaType: z.string(),
+        url: z.string(),
+      })
+    ),
+    transcript: z.string().optional(),
+  }),
+})
+
 export const DataSource = z.object({
   binaryUrl: z.string(),
   duration: z.number(),
@@ -154,6 +198,11 @@ export const baseMetadataSchema = z.object({
     z.literal('withContributorPayment'),
     z.literal('unknown'),
   ]),
+  canBeDistributed: z.union([
+    z.literal('yes'),
+    z.literal('no'),
+    z.literal('verify'),
+  ]),
   topper: Topper.optional(),
   comments: z
     .object({
@@ -208,6 +257,6 @@ export const baseMediaSchema = z.object({
   mainImage: MainImage.optional(),
   leadImages: LeadImage.array().optional(),
   alternativeImages: AlternativeImage.optional(),
-  embeds: ImageSet.array().optional(),
+  embeds: z.array(z.union([ImageSet, ClipSet])).optional(),
   dataSource: DataSource.array().optional(),
 })

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

@@ -34,6 +34,7 @@ const contentPackageMetadataSchema = baseMetadataSchema.pick({
   firstPublishedDate: true,
   accessLevel: true,
   canBeSyndicated: true,
+  canBeDistributed: true,
   topper: true,
   comments: true,
 })

package/src/model/schemas/capi/live-blog-package.ts

@@ -26,6 +26,7 @@ const liveBlogPackageMetadataSchema = baseMetadataSchema.pick({
   firstPublishedDate: true,
   accessLevel: true,
   canBeSyndicated: true,
+  canBeDistributed: true,
   topper: true,
   comments: true,
 })

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

@@ -25,6 +25,7 @@ const placeholderMetadataSchema = baseMetadataSchema.pick({
   firstPublishedDate: true,
   accessLevel: true,
   canBeSyndicated: true,
+  canBeDistributed: true,
   topper: true,
   comments: true,
   containedIn: true,

package/src/resolvers/clip.ts

@@ -0,0 +1,13 @@
+import { ClipResolvers } from '../generated'
+
+const resolvers = {
+  Clip: {
+    __resolveType: () => 'Clip',
+    dataSource: (clip) => clip.dataSource(),
+    type: (clip) => clip.type(),
+    format: (clip) => clip.format(),
+    poster: (clip) => clip.poster(),
+  },
+} satisfies { Clip: ClipResolvers }
+
+export default resolvers

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

@@ -68,7 +68,7 @@ export interface YoutubeVideo extends ContentTree.Node {
   url: string
 }
 
-export interface Clip extends ContentTree.Node {
+export interface OldClip extends ContentTree.Node {
   type: 'clip'
   url: string
   autoplay: boolean
@@ -83,6 +83,16 @@ export interface Clip extends ContentTree.Node {
   credits: string
 }
 
+// this type is used for bodyXML transformation ONLY in tagMappings
+export interface ClipSet extends ContentTree.Node {
+  type: 'clip-set'
+  id: string
+  autoplay: boolean
+  loop: boolean
+  muted: boolean
+  dataLayout: 'in-line' | 'mid-grid' | 'full-grid'
+}
+
 export type TableColumnSettings = {
   hideOnMobile: boolean
   sortable: boolean
@@ -148,6 +158,8 @@ export type AnyNode =
   | ContentTree.Blockquote
   | ContentTree.Pullquote
   | ContentTree.ImageSet
+  | ClipSet
+  | OldClip
   | ContentTree.Recommended
   | ContentTree.Tweet
   | ContentTree.Flourish
@@ -168,7 +180,6 @@ export type AnyNode =
   | TableCell
   | Video
   | YoutubeVideo
-  | Clip
   | MainImage
   | MainImageRaw
   | RawImage

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

@@ -0,0 +1,49 @@
+import type { ClipSet as CAPIClipSet } from '../../../types/internal-content'
+import type { ClipSet as ClipSetWorkaroundContentTree, OldClip as OldClipContentTree } from '../Workarounds'
+import { uuidFromUrl } from '../../../helpers/metadata'
+import { Clip } from '../../../model/Clip'
+import { ClipSetResolvers } from '../../../generated'
+import { ReferenceWithCAPIData } from '.'
+
+function getClipSet(
+  parent: ReferenceWithCAPIData<ClipSetWorkaroundContentTree|OldClipContentTree>
+) {
+  const clipSets = parent.contentApiData
+    ?.embeds()
+    ?.filter((embedded) => embedded.type.includes('ClipSet')) as
+    | CAPIClipSet[]
+    | []
+
+  const clipSet = clipSets?.find(
+    (embed: CAPIClipSet) =>
+      uuidFromUrl(embed.id) === uuidFromUrl((parent.reference as ClipSetWorkaroundContentTree).id)
+  )
+
+  return clipSet as CAPIClipSet
+}
+
+export const ClipSet = {
+  // amend id, caption, description, credits when v1 is no longer supported
+  id: (parent) => ((parent.reference as ClipSetWorkaroundContentTree).id ? uuidFromUrl((parent.reference as ClipSetWorkaroundContentTree).id) : ''),
+  autoplay: (parent) => parent.reference.autoplay,
+  noAudio: (parent) => getClipSet(parent)?.noAudio || null,
+  loop: (parent) => parent.reference.loop,
+  muted: (parent) => parent.reference.muted,
+  dataLayout: (parent) => parent.reference.dataLayout,
+  caption: (parent) => ((parent.reference as OldClipContentTree).caption ?? getClipSet(parent)?.caption),
+  accessibility: (parent) => getClipSet(parent)?.accessibility || null,
+  description: (parent) => ((parent.reference as OldClipContentTree).description ?? getClipSet(parent)?.description),
+  credits: (parent) => ((parent.reference as OldClipContentTree).credits ??  getClipSet(parent)?.dataCopyright),
+  displayTitle: (parent) => getClipSet(parent)?.displayTitle || null,
+  contentWarning: (parent) => getClipSet(parent)?.contentWarning || null,
+  source: (parent) => getClipSet(parent)?.source || null,
+  subtitle: (parent) => getClipSet(parent)?.subtitle || null,
+  publishedDate: (parent) => getClipSet(parent)?.publishedDate || null,
+  async clips(parent) {
+    const clipSet = getClipSet(parent)
+
+    return clipSet && clipSet.members && clipSet.members.length > 0
+      ? clipSet.members.map((clip) => new Clip(clip))
+      : null
+  },
+} satisfies ClipSetResolvers

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

@@ -7,12 +7,16 @@ export const ImageSet = {
   async picture(parent, _args, context) {
     const isLiveBlog = parent.contentApiData?.type() === 'LiveBlogPost'
 
-    const imageSet = parent.contentApiData
+    const imageSets = parent.contentApiData
       ?.embeds()
-      ?.find(
-        (embed: CAPIImageSet) =>
-          uuidFromUrl(embed.id) === uuidFromUrl(parent.reference.id)
-      )
+      ?.filter((embedded) => embedded.type.includes('ImageSet')) as
+      | CAPIImageSet[]
+      | []
+
+    const imageSet = imageSets?.find(
+      (embed: CAPIImageSet) =>
+        uuidFromUrl(embed.id) === uuidFromUrl(parent.reference.id)
+    )
 
     return imageSet && imageSet.members && imageSet.members.length > 0
       ? new Picture(imageSet, isLiveBlog, context)

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

@@ -7,12 +7,16 @@ export const ScrollyImage = {
   picture(parent, _args, context) {
     const isLiveBlog = parent.contentApiData?.type() === 'LiveBlogPost'
 
-    const imageSet = parent.contentApiData
+    const imageSets = parent.contentApiData
       ?.embeds()
-      ?.find(
-        (embed: CAPIImageSet) =>
-          uuidFromUrl(embed.id) === uuidFromUrl(parent.reference.id)
-      )
+      ?.filter((embedded) => embedded.type.includes('ImageSet')) as
+      | CAPIImageSet[]
+      | []
+
+    const imageSet = imageSets?.find(
+      (embed: CAPIImageSet) =>
+        uuidFromUrl(embed.id) === uuidFromUrl(parent.reference.id)
+    )
 
     return imageSet ? new Picture(imageSet, isLiveBlog, context) : null
   },

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

@@ -7,6 +7,7 @@ import { Reference } from './Reference'
 
 import { Tweet } from './Tweet'
 import { ImageSet } from './ImageSet'
+import { ClipSet } from './ClipSet'
 import { Video } from './Video'
 import { Flourish } from './Flourish'
 import { Recommended } from './Recommended'
@@ -16,6 +17,7 @@ import { ScrollyImage } from './ScrollyImage'
 import {
   FlourishResolvers,
   ImageSetResolvers,
+  ClipSetResolvers,
   LayoutImageResolvers,
   RawImageResolvers,
   RecommendedResolvers,
@@ -35,6 +37,7 @@ export const resolvers: {
   Reference: ReferenceResolvers
   Tweet: TweetResolvers
   ImageSet: ImageSetResolvers
+  ClipSet: ClipSetResolvers
   VideoReference: VideoReferenceResolvers
   Flourish: FlourishResolvers
   Recommended: RecommendedResolvers
@@ -45,6 +48,7 @@ export const resolvers: {
   Reference,
   Tweet,
   ImageSet,
+  ClipSet,
   VideoReference: Video,
   Flourish,
   Recommended,
@@ -57,6 +61,8 @@ export const mapNodeToReference = {
   flourish: 'Flourish',
   tweet: 'Tweet',
   'image-set': 'ImageSet',
+  'clip-set': 'ClipSet',
+  clip: 'ClipSet',
   video: 'VideoReference',
   recommended: 'Recommended',
   'layout-image': 'LayoutImage',

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

@@ -600,6 +600,16 @@ const commonTagMappings: TagMappings = {
     level: 'subheading',
     children: everyChildIsType('text', traverse(), 'heading', context),
   }),
+  'ft-content[type="http://www.ft.com/ontology/content/ClipSet"]': ($el) => ({
+    type: 'clip-set',
+    id: $el.attr('url') || '',
+    autoplay: getBooleanAttributeValue($el, 'autoplay'),
+    loop: getBooleanAttributeValue($el, 'loop'),
+    muted: getBooleanAttributeValue($el, 'muted'),
+    dataLayout:
+      ($el.attr('data-layout') as 'full-grid' | 'in-line' | 'mid-grid') ||
+      'in-line',
+  }),
 }
 
 // We can't trust cheerio.attr() method since with attributes like "autoplay"

package/src/resolvers/content.ts

@@ -55,6 +55,7 @@ const resolvers = {
     annotations: (parent) => parent.annotations(),
     accessLevel: (parent) => parent.accessLevel(),
     canBeSyndicated: (parent) => parent.canBeSyndicated(),
+    originatingParty: (parent) => parent.originatingParty(),
     commentsEnabled: (parent) => parent.commentsEnabled(),
     design: (parent) => parent.design(),
   },

package/src/resolvers/index.ts

@@ -2,6 +2,7 @@ import { default as concept } from './concept'
 import { default as content } from './content'
 import { default as core } from './core'
 import { default as image } from './image'
+import { default as clip } from './clip'
 import { default as metaLink } from './meta-link'
 import { default as picture } from './picture'
 import { default as richText } from './richText'
@@ -16,6 +17,7 @@ const resolvers = {
   ...content,
   ...core,
   ...image,
+  ...clip,
   ...metaLink,
   ...picture,
   ...references,

package/src/resolvers/scalars.ts

@@ -103,6 +103,13 @@ export const ImageType = new LiteralUnionScalar<['image', 'graphic']>({
   values: ['image', 'graphic'],
 })
 
+export const ClipFormat = new LiteralUnionScalar<['standard-inline', 'mobile']>(
+  {
+    name: 'ClipFormat',
+    values: ['standard-inline', 'mobile'],
+  }
+)
+
 export const RichTextSource = new LiteralUnionScalar<
   ['standfirst', 'summary', 'bodyXML']
 >({
@@ -138,6 +145,7 @@ export const ContentType = new LiteralUnionScalar<
 })
 
 const resolvers = {
+  ClipFormat,
   ImageFormat,
   PackageDesign,
   TopperBackgroundColour,

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

@@ -7,6 +7,8 @@ import {
   Annotation,
   Image,
   ImageSet,
+  Clip,
+  ClipSet,
   MainImage,
   LeadImage,
   capiNotificationResponse,
@@ -39,6 +41,8 @@ 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 Clip = z.infer<typeof Clip>
+type ClipSet = z.infer<typeof ClipSet>
 
 type ContentTypeSchemas =
   | Article