@financial-times/cp-content-pipeline-schema 1.8.5 → 2.0.0

package/queries/article.graphql

@@ -0,0 +1,615 @@
+fragment Concept on Concept {
+  id
+  prefLabel
+  types
+  type
+  directType
+  isPackageBrand
+  predicate
+  url(vanity: $useVanities)
+  relativeUrl: url(relative: true, vanity: $useVanities)
+}
+
+fragment StructuredTree on StructuredContent {
+  tree
+}
+
+fragment MetaLink on MetaLink {
+  ... on Concept {
+    id
+    url
+    relativeUrl: url(relative: true)
+    prefLabel
+  }
+  ... on ContentPackage {
+    id
+    url
+    relativeUrl: url(relative: true)
+    prefLabel: title
+  }
+}
+
+fragment Teaser on Teaser {
+  title
+  id
+  url
+  relativeUrl: url(relative: true)
+  type
+  publishedDate
+  firstPublishedDate
+  metaPrefixText
+  metaSuffixText
+  metaLink {
+    ...MetaLink
+  }
+  metaAltLink {
+    ...MetaLink
+  }
+  image {
+    url
+    width
+    height
+    altText
+  }
+  indicators {
+    accessLevel
+    isOpinion
+    isColumn
+    isPodcast
+    isEditorsChoice
+    isExclusive
+    isScoop
+  }
+}
+
+fragment ImageSource on ImageSource {
+  dpr
+  width
+  url
+}
+
+fragment Intro on RichText {
+  source
+  structured {
+    ...StructuredTree
+  }
+}
+
+fragment Topper on Topper {
+  __typename
+  headline
+  backgroundColour
+  backgroundBox
+  textShadow
+  followButtonVariant
+
+  intro {
+    ...Intro
+  }
+
+  displayConcept {
+    ...Concept
+  }
+
+  genreConcept {
+    ...Concept
+  }
+
+  ... on TopperWithBrand {
+    brandConcept {
+      ...Concept
+    }
+  }
+
+  ... on TopperWithImages {
+    fallbackImage {
+      sourceSet(width: 1440) {
+        ...ImageSource
+      }
+      ...Image
+    }
+
+    images {
+      ...Image
+    }
+  }
+
+  ... on SplitTextTopper {
+    images {
+      ... on ImageSquare {
+        sourceSet(width: 490) {
+          ...ImageSource
+        }
+      }
+      ... on ImageStandard {
+        sourceSet(width: 800) {
+          ...ImageSource
+        }
+      }
+      ... on ImageWide {
+        normal: sourceSet(width: 1220) {
+          ...ImageSource
+        }
+        widest: sourceSet(width: 1440) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+  ... on FullBleedTopper {
+    images {
+      ... on ImageSquare {
+        sourceSet(width: 490) {
+          ...ImageSource
+        }
+      }
+      ... on ImageStandard {
+        sourceSet(width: 800) {
+          ...ImageSource
+        }
+      }
+      ... on ImageWide {
+        normal: sourceSet(width: 1220) {
+          ...ImageSource
+        }
+        wide: sourceSet(width: 1440) {
+          ...ImageSource
+        }
+        wideL: sourceSet(width: 1920) {
+          ...ImageSource
+        }
+        wideXL: sourceSet(width: 3840) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+  ... on OpinionTopper {
+    headshot(dpr: 2, width: 150)
+    columnist {
+      ...Concept
+    }
+  }
+  ... on PodcastTopper {
+    headshot(dpr: 2, width: 150)
+  }
+  ... on TopperWithTheme {
+    isLargeHeadline
+    layout
+  }
+  ... on TopperWithPackage {
+    design
+  }
+  ... on DeepPortraitTopper {
+    images {
+      ... on ImagePortrait {
+        small: sourceSet(width: 490) {
+          ...ImageSource
+        }
+        normal: sourceSet(width: 740) {
+          ...ImageSource
+        }
+        wide: sourceSet(width: 1067) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+  ... on DeepLandscapeTopper {
+    images {
+      ... on ImageLandscape {
+        normal: sourceSet(width: 1440) {
+          ...ImageSource
+        }
+        wide: sourceSet(width: 1920) {
+          ...ImageSource
+        }
+      }
+      ... on ImagePortrait {
+        small: sourceSet(width: 490) {
+          ...ImageSource
+        }
+        tablets: sourceSet(width: 980) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+}
+
+fragment Image on Image {
+  __typename
+  height
+  width
+  caption
+  credit
+  format
+  url
+  id
+}
+
+fragment PictureFields on Picture {
+  __typename
+  alt
+  caption
+  credit
+  imageType
+  layoutWidth
+
+  fallbackImage {
+    ...Image
+  }
+}
+
+fragment Picture on Picture {
+  ...PictureFields
+
+  images {
+    ...Image
+  }
+
+  ... on PictureStandard {
+    images {
+      ... on ImageStandard {
+        sourceSet(width: 700) {
+          ...ImageSource
+        }
+      }
+      ... on ImageStandardInline {
+        sourceSet(width: 700) {
+          ...ImageSource
+        }
+      }
+      ... on ImageMobile {
+        sourceSet(width: 490) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+  ... on PictureInline {
+    images {
+      ... on ImageStandardInline {
+        sourceSet(width: 350) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+  ... on PictureFullBleed {
+    images {
+      ... on ImageMobile {
+        sourceSet(width: 490) {
+          ...ImageSource
+        }
+      }
+      ... on ImageDesktop {
+        sourceSet(width: 1200) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+}
+
+fragment MainImage on MainImage {
+  picture {
+    ...Picture
+  }
+}
+
+fragment ImageSet on ImageSet {
+  picture {
+    ...Picture
+  }
+}
+
+fragment Clip on Clip {
+  __typename
+  format
+  dataSource {
+    audioCodec
+    binaryUrl
+    duration
+    mediaType
+    pixelHeight
+    pixelWidth
+    videoCodec
+  }
+  poster
+}
+
+fragment Transcript on RichText {
+  source
+  structured {
+    ...StructuredTree
+  }
+}
+
+fragment ClipSet on ClipSet {
+  type
+  autoplay
+  loop
+  muted
+  dataLayout
+  id
+  noAudio
+  caption
+  credits
+  description
+  displayTitle
+  contentWarning
+  source
+  subtitle
+  publishedDate
+  clips {
+    ...Clip
+  }
+  accessibility {
+    captions {
+      url
+      mediaType
+    }
+    transcript {
+      ...Transcript
+    }
+  }
+}
+
+fragment LayoutImage on LayoutImage {
+  picture {
+    ...Picture
+  }
+}
+
+fragment Recommended on Recommended {
+  teaser {
+    ...Teaser
+  }
+}
+
+fragment Tweet on Tweet {
+  html
+}
+
+fragment Video on VideoReference {
+  title
+  id
+}
+
+fragment Flourish on Flourish {
+  fallbackImage {
+    url
+    height
+    width
+  }
+}
+
+fragment RawImage on RawImage {
+  image {
+    ...Image
+  }
+}
+
+fragment ScrollyImage on ScrollyImage {
+  picture {
+    ...PictureFields
+
+    images {
+      ...Image
+
+      ... on ImageDesktop {
+        s: sourceSet(width: 740) {
+          ...ImageSource
+        }
+        m: sourceSet(width: 980) {
+          ...ImageSource
+        }
+        l: sourceSet(width: 1220) {
+          ...ImageSource
+        }
+        xl: sourceSet(width: 1920) {
+          ...ImageSource
+        }
+        xxl: sourceSet(width: 3840) {
+          ...ImageSource
+        }
+      }
+
+      ... on ImageMobile {
+        s: sourceSet(width: 490) {
+          ...ImageSource
+        }
+        m: sourceSet(width: 600) {
+          ...ImageSource
+        }
+        l: sourceSet(width: 800) {
+          ...ImageSource
+        }
+        xl: sourceSet(width: 1200) {
+          ...ImageSource
+        }
+      }
+    }
+  }
+}
+
+fragment Design on Design {
+  theme
+  layout
+}
+
+fragment Media on Media {
+  url
+  mediaType
+}
+
+fragment PinnedPost on Content {
+  __typename
+  id
+  title
+  publishedDate
+  body {
+    structured {
+      ...StructuredContent
+    }
+  }
+  publishedDate
+  mainImage {
+    ...Image
+  }
+  altTitle {
+    promotionalTitle
+  }
+  byline(vanity: $useVanities) {
+    tree
+  }
+  accessLevel
+  canBeSyndicated
+  commentsEnabled
+}
+
+fragment ArticleReferences on Reference {
+  type
+  ...Recommended
+  ...ImageSet
+  ...ClipSet
+  ...LayoutImage
+  ...Tweet
+  ...Video
+  ...Flourish
+  ...RawImage
+  ...MainImage
+  ...ScrollyImage
+}
+
+fragment StructuredContent on StructuredContent {
+  ...StructuredTree
+
+  references {
+    ...ArticleReferences
+  }
+  text
+}
+
+fragment Content on Content {
+  __typename
+  id
+  title
+  publishedDate
+  firstPublishedDate
+  standfirst
+  topper {
+    ...Topper
+  }
+  body {
+    structured {
+      ...StructuredContent
+    }
+  }
+  publishedDate
+  mainImage {
+    ...Image
+  }
+  altTitle {
+    promotionalTitle
+  }
+  byline(vanity: $useVanities) {
+    tree
+  }
+  annotations {
+    ...Concept
+  }
+  accessLevel
+  canBeSyndicated
+  instantAlertConcept {
+    id
+    prefLabel
+  }
+  originatingParty
+  commentsEnabled
+  editorialDesk
+  design {
+    ...Design
+  }
+}
+
+fragment PackageContainer on Content {
+  ...Content
+  url(vanity: $useVanities)
+  topper {
+    ... on TopperWithBrand {
+      genreConcept {
+        ...Concept
+      }
+    }
+  }
+  ... on ContentPackage {
+    containsLength
+    contains(fromId: $uuid, surroundingArticles: 7) {
+      ...Teaser
+      standfirst
+    }
+    tableOfContents {
+      labelType
+      sequence
+    }
+  }
+}
+
+fragment ArticleFields on Content {
+  ...Content
+  url
+  ... on Article {
+    containedIn {
+      ...PackageContainer
+    }
+  }
+  ... on Placeholder {
+    containedIn {
+      ...PackageContainer
+    }
+  }
+  ... on LiveBlogPost {
+    containedIn {
+      ...PackageContainer
+    }
+  }
+  ... on LiveBlogPackage {
+    liveBlogPosts(includePinned: false) {
+      ...Content
+      url
+    }
+    pinnedPost {
+      ...PinnedPost
+    }
+    realtime
+  }
+  ... on ContentPackage {
+    contains {
+      ...Teaser
+      standfirst
+    }
+  }
+  ... on Audio {
+    media {
+      ...Media
+    }
+  }
+}
+
+query Article($uuid: String!, $useVanities: Boolean!) {
+  content(uuid: $uuid) {
+    ...ArticleFields
+  }
+}
+
+query ArticleFromJSON(
+  $content: JSON!
+  $useVanities: Boolean!
+  $uuid: String = null
+) {
+  contentFromJSON(content: $content) {
+    ...ArticleFields
+  }
+}

package/src/generated/index.ts

@@ -35,13 +35,13 @@ export type Scalars = {
   ImageType: { input: 'image' | 'graphic'; output: 'image' | 'graphic'; }
   JSON: { input: any; output: any; }
   PackageDesign: { input: 'special-report' | 'extra' | 'basic' | 'extra-wide'; output: 'special-report' | 'extra' | 'basic' | 'extra-wide'; }
-  RichTextSource: { input: 'standfirst' | 'summary' | 'bodyXML'; output: 'standfirst' | 'summary' | 'bodyXML'; }
+  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'; }
 };
 
 export type Accessibility = {
   readonly captions?: Maybe<ReadonlyArray<Maybe<Caption>>>;
-  readonly transcript?: Maybe<Scalars['String']['output']>;
+  readonly transcript?: Maybe<RichText>;
 };
 
 export type AltStandfirst = {
@@ -1080,7 +1080,7 @@ export type ResolversInterfaceTypes<RefType extends Record<string, unknown>> = R
 /** Mapping between all available schema types and the resolvers types */
 export type ResolversTypes = ResolversObject<{
   AccessLevel: ResolverTypeWrapper<Scalars['AccessLevel']['output']>;
-  Accessibility: ResolverTypeWrapper<Accessibility>;
+  Accessibility: ResolverTypeWrapper<Omit<Accessibility, 'transcript'> & { transcript?: Maybe<ResolversTypes['RichText']> }>;
   AltStandfirst: ResolverTypeWrapper<AltStandfirst>;
   AltTitle: ResolverTypeWrapper<AltTitle>;
   Article: ResolverTypeWrapper<CapiResponse>;
@@ -1165,7 +1165,7 @@ export type ResolversTypes = ResolversObject<{
 /** Mapping between all available schema types and the resolvers parents */
 export type ResolversParentTypes = ResolversObject<{
   AccessLevel: Scalars['AccessLevel']['output'];
-  Accessibility: Accessibility;
+  Accessibility: Omit<Accessibility, 'transcript'> & { transcript?: Maybe<ResolversParentTypes['RichText']> };
   AltStandfirst: AltStandfirst;
   AltTitle: AltTitle;
   Article: CapiResponse;
@@ -1253,7 +1253,7 @@ export interface AccessLevelScalarConfig extends GraphQLScalarTypeConfig<Resolve
 
 export type AccessibilityResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Accessibility'] = ResolversParentTypes['Accessibility']> = ResolversObject<{
   captions?: Resolver<Maybe<ReadonlyArray<Maybe<ResolversTypes['Caption']>>>, ParentType, ContextType>;
-  transcript?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
+  transcript?: Resolver<Maybe<ResolversTypes['RichText']>, ParentType, ContextType>;
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 }>;
 

package/src/index.ts

@@ -4,6 +4,7 @@ import type { Logger } from '@dotcom-reliability-kit/logger'
 import { loadSchemaSync } from '@graphql-tools/load'
 import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader'
 import * as path from 'path'
+import { readFileSync } from 'fs'
 
 interface Metrics {
   count(metric: string | string[], count?: number): void
@@ -23,6 +24,11 @@ export interface QueryContext {
   }
 }
 
+export const articleDocumentQuery = readFileSync(
+  require.resolve('../queries/article.graphql'),
+  'utf-8'
+)
+
 export const typeDefs = loadSchemaSync(
   path.join(__dirname, '../typedefs/**/*.graphql'),
   {

package/src/model/Topper.ts

@@ -227,15 +227,6 @@ export class Topper {
 
     const brandConcept = this.brandConcept()
     const displayConcept = this.capiResponse.getDisplayConcept()
-
-    if (this.capiResponse.isOpinion()) {
-      return brandConcept ?? displayConcept ?? null
-    }
-
-    if (displayConcept) {
-      return displayConcept
-    }
-
     const aboutAnnotation = this.capiResponse
       .annotations()
       ?.find(
@@ -244,6 +235,14 @@ export class Topper {
           'http://www.ft.com/ontology/annotation/about'
       )
 
+    if (this.capiResponse.isOpinion() && brandConcept) {
+      return brandConcept
+    }
+
+    if (displayConcept) {
+      return displayConcept
+    }
+
     return aboutAnnotation ?? null
   }
 

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

@@ -5,6 +5,7 @@ import type {
 } from '../Workarounds'
 import { uuidFromUrl } from '../../../helpers/metadata'
 import { Clip } from '../../../model/Clip'
+import { RichText } from '../../../model/RichText'
 import { ClipSetResolvers } from '../../../generated'
 import { ReferenceWithCAPIData } from '.'
 
@@ -45,7 +46,18 @@ export const ClipSet = {
   caption: (parent) =>
     (parent.reference as OldClipContentTree).caption ??
     getClipSet(parent)?.caption,
-  accessibility: (parent) => getClipSet(parent)?.accessibility || null,
+  accessibility: (parent) => {
+    const accessibility = getClipSet(parent)?.accessibility
+    if (accessibility) {
+      return {
+        ...accessibility,
+        transcript: accessibility.transcript
+          ? new RichText('transcript', accessibility.transcript)
+          : null,
+      }
+    }
+    return null
+  },
   description: (parent) =>
     (parent.reference as OldClipContentTree).description ??
     getClipSet(parent)?.description,