@financial-times/cp-content-pipeline-schema 1.4.2 → 1.4.4

package/src/model/CapiResponse.ts

@@ -1,13 +1,11 @@
 import type {
   ImageSet,
-  Annotation,
   ContentTypeSchemas,
   MainImage,
 } from '../types/internal-content'
 import conceptIds from '@financial-times/n-concept-ids'
-import metadata, { TeaserMetadata } from '@financial-times/n-display-metadata'
+import metadata from '@financial-times/n-display-metadata'
 import cloneDeep from 'clone-deep'
-import { ConditionalKeys } from 'type-fest'
 import { OperationalError } from '@dotcom-reliability-kit/errors'
 
 import type { QueryContext } from '..'
@@ -241,6 +239,15 @@ export class CapiResponse {
   canBeSyndicated(): LiteralUnionScalarValues<typeof CanBeSyndicated> {
     return this.capiData.canBeSyndicated
   }
+  originatingParty(): string | null {
+    return this.capiData.canBeDistributed === 'no' &&
+      this.annotations().some((annotation) => {
+        annotation.id() ===
+          'http://api.ft.com/things/ed3b6ec5-6466-47ef-b1d8-16952fd522c7'
+      })
+      ? 'Reuters'
+      : 'FT'
+  }
   summary() {
     if ('summary' in this.capiData) return this.capiData.summary
     return null
@@ -309,26 +316,37 @@ export class CapiResponse {
     })
   }
 
-  async teaserMetadataLink(
-    field: ConditionalKeys<TeaserMetadata, Annotation | null>
-  ) {
+  async metaLink() {
     const meta = await this.#teaserMetadata()
-    const metaField = meta[field]
 
-    return metaField ? new Concept(metaField, this.context) : null
+    if (!meta.link) {
+      return meta.link
+    }
+
+    // TODO:KB:20231017 rewrite n-display-metadata in typescript using our types (lol. lmao)
+    // if meta.link has a predicate field, it's a concept, so wrap it in our concept model
+    if ('predicate' in meta.link) {
+      return new Concept(meta.link, this.context)
+    }
+
+    // otherwise, it's the package container, so return that directly as we already have it
+    return this.containedIn()
   }
 
-  async teaserMetadataText(
-    field: ConditionalKeys<TeaserMetadata, string> | 'suffixText'
-  ) {
-    if (field === 'prefixText') {
-      const meta = await this.#teaserMetadata()
-      return meta[field]
-    } else {
-      // HACK 20230629 IM: suffixText doesn't actually exist in the metadata
-      // type lol but deleting the field would be a breaking change
+  async metaAltLink() {
+    const meta = await this.#teaserMetadata()
+
+    if (!meta.altLink) {
       return null
     }
+
+    // unlike meta.link, meta.altLink alwyas returns a Concept
+    return new Concept(meta.altLink, this.context)
+  }
+
+  async metaPrefixText() {
+    const meta = await this.#teaserMetadata()
+    return meta.prefixText
   }
 
   teaser() {

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

@@ -154,6 +154,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({

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/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 metaLink } from './meta-link'
 import { default as picture } from './picture'
 import { default as richText } from './richText'
 import { default as scalars } from './scalars'
@@ -15,12 +16,13 @@ const resolvers = {
   ...content,
   ...core,
   ...image,
+  ...metaLink,
   ...picture,
+  ...references,
   ...richText,
   ...scalars,
   ...teaser,
   ...topper,
-  ...references,
 } satisfies Resolvers
 
 export default resolvers

package/src/resolvers/meta-link.ts

@@ -0,0 +1,16 @@
+import { MetaLinkResolvers } from '../generated'
+import { Concept } from '../model/Concept'
+
+const resolvers: { MetaLink: MetaLinkResolvers } = {
+  MetaLink: {
+    __resolveType(parent) {
+      if (parent instanceof Concept) {
+        return 'Concept'
+      }
+
+      return 'ContentPackage'
+    },
+  },
+}
+
+export default resolvers

package/src/resolvers/teaser.ts

@@ -9,10 +9,12 @@ const resolvers = {
         .type()
         .replace(/[A-Z]/g, (letter) => `-${letter.toLowerCase()}`)
         .slice(1),
-    metaLink: (parent) => parent.teaserMetadataLink('link'),
-    metaAltLink: (parent) => parent.teaserMetadataLink('altLink'),
-    metaPrefixText: (parent) => parent.teaserMetadataText('prefixText'),
-    metaSuffixText: (parent) => parent.teaserMetadataText('suffixText'),
+    metaLink: (parent) => parent.metaLink(),
+    metaAltLink: (parent) => parent.metaAltLink(),
+    metaPrefixText: (parent) => parent.metaPrefixText(),
+    // HACK 20230629 IM: suffixText doesn't actually exist in the metadata
+    // type lol but deleting the field would be a breaking change
+    metaSuffixText: () => null,
     image: (parent) => parent.teaserImage(),
     indicators(parent) {
       return {

package/src/types/n-display-metadata.d.ts

@@ -1,22 +1,29 @@
 declare module '@financial-times/n-display-metadata' {
-  import { Annotation, ContentTypeSchemas } from './internal-content'
+  export interface MetaLink {
+    id?: string
+    url?: string
+    relativeUrl?: string
+    prefLabel?: string
+  }
 
   export interface FlagsMetadata {
     isOpinion: boolean
     isColumn: boolean
   }
 
-  export interface TeaserMetadata {
+  export interface TeaserMetadata<ConceptType, ContainedInType> {
     flags: FlagsMetadata
     prefixText: string
-    link: Annotation | null
-    altLink: Annotation | null
+    link: ConceptType | ContainedInType | null
+    altLink: ConceptType | null
   }
 
-  export interface Content {
-    annotations: Annotation[]
-    containedIn: ContentTypeSchemas | null
+  export interface Content<ConceptType, ContainedInType> {
+    annotations: ConceptType[]
+    containedIn: ContainedInType[] | null
   }
 
-  export function teaser(content: Content): TeaserMetadata
+  export function teaser<ConceptType, ContainedInType>(
+    content: Content<ConceptType, ContainedInType>
+  ): TeaserMetadata<ConceptType, ContainedInType>
 }