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

package/src/generated/index.ts

@@ -58,7 +58,7 @@ export type Article = Content & {
   readonly containedIn?: Maybe<Content>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly mainImage?: Maybe<Image>;
   readonly publishedDate: Scalars['String']['output'];
   readonly standfirst?: Maybe<Scalars['String']['output']>;
@@ -92,7 +92,7 @@ export type Audio = Content & {
   readonly commentsEnabled?: Maybe<Scalars['Boolean']['output']>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly mainImage?: Maybe<Image>;
   readonly media?: Maybe<ReadonlyArray<Maybe<Media>>>;
   readonly publishedDate: Scalars['String']['output'];
@@ -170,7 +170,7 @@ export type Content = {
   readonly commentsEnabled?: Maybe<Scalars['Boolean']['output']>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly mainImage?: Maybe<Image>;
   readonly publishedDate: Scalars['String']['output'];
   readonly standfirst?: Maybe<Scalars['String']['output']>;
@@ -206,7 +206,7 @@ export type ContentPackage = Content & {
   readonly containsLength?: Maybe<Scalars['Int']['output']>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly mainImage?: Maybe<Image>;
   readonly publishedDate: Scalars['String']['output'];
   readonly standfirst?: Maybe<Scalars['String']['output']>;
@@ -527,7 +527,7 @@ export type LiveBlogPackage = Content & {
   readonly commentsEnabled?: Maybe<Scalars['Boolean']['output']>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly liveBlogPosts?: Maybe<ReadonlyArray<Maybe<Content>>>;
   readonly mainImage?: Maybe<Image>;
   readonly pinnedPost?: Maybe<Content>;
@@ -565,7 +565,7 @@ export type LiveBlogPost = Content & {
   readonly containedIn?: Maybe<Content>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly mainImage?: Maybe<Image>;
   readonly publishedDate: Scalars['String']['output'];
   readonly standfirst?: Maybe<Scalars['String']['output']>;
@@ -599,6 +599,8 @@ export type Media = {
   readonly url?: Maybe<Scalars['String']['output']>;
 };
 
+export type MetaLink = Concept | ContentPackage;
+
 export type Mutation = {
   readonly invalidateRedisCache?: Maybe<Scalars['String']['output']>;
 };
@@ -682,7 +684,7 @@ export type Placeholder = Content & {
   readonly containedIn?: Maybe<Content>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly mainImage?: Maybe<Image>;
   readonly publishedDate: Scalars['String']['output'];
   readonly standfirst?: Maybe<Scalars['String']['output']>;
@@ -800,8 +802,8 @@ export type Teaser = {
   readonly id?: Maybe<Scalars['String']['output']>;
   readonly image?: Maybe<Image>;
   readonly indicators?: Maybe<Indicators>;
-  readonly metaAltLink?: Maybe<Concept>;
-  readonly metaLink?: Maybe<Concept>;
+  readonly metaAltLink?: Maybe<MetaLink>;
+  readonly metaLink?: Maybe<MetaLink>;
   readonly metaPrefixText?: Maybe<Scalars['String']['output']>;
   readonly metaSuffixText?: Maybe<Scalars['String']['output']>;
   readonly publishedDate?: Maybe<Scalars['String']['output']>;
@@ -874,7 +876,7 @@ export type Video = Content & {
   readonly commentsEnabled?: Maybe<Scalars['Boolean']['output']>;
   readonly design?: Maybe<Design>;
   readonly firstPublishedDate: Scalars['String']['output'];
-  readonly id: Scalars['String']['output'];
+  readonly id: Scalars['ID']['output'];
   readonly mainImage?: Maybe<Image>;
   readonly publishedDate: Scalars['String']['output'];
   readonly standfirst?: Maybe<Scalars['String']['output']>;
@@ -970,6 +972,10 @@ export type DirectiveResolverFn<TResult = {}, TParent = {}, TContext = {}, TArgs
   info: GraphQLResolveInfo
 ) => TResult | Promise<TResult>;
 
+/** Mapping of union types */
+export type ResolversUnionTypes<RefType extends Record<string, unknown>> = ResolversObject<{
+  MetaLink: ( ConceptModel ) | ( CapiResponse );
+}>;
 
 /** Mapping of interface types */
 export type ResolversInterfaceTypes<RefType extends Record<string, unknown>> = ResolversObject<{
@@ -1030,6 +1036,7 @@ export type ResolversTypes = ResolversObject<{
   LiveBlogPost: ResolverTypeWrapper<CapiResponse>;
   MainImage: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.ImageSet>>;
   Media: ResolverTypeWrapper<Media>;
+  MetaLink: ResolverTypeWrapper<ResolversUnionTypes<ResolversTypes>['MetaLink']>;
   Mutation: ResolverTypeWrapper<{}>;
   OpinionTopper: ResolverTypeWrapper<TopperModel>;
   PackageDesign: ResolverTypeWrapper<Scalars['PackageDesign']['output']>;
@@ -1108,6 +1115,7 @@ export type ResolversParentTypes = ResolversObject<{
   LiveBlogPost: CapiResponse;
   MainImage: ReferenceWithCAPIData<ContentTree.ImageSet>;
   Media: Media;
+  MetaLink: ResolversUnionTypes<ResolversParentTypes>['MetaLink'];
   Mutation: {};
   OpinionTopper: TopperModel;
   PackageDesign: Scalars['PackageDesign']['output'];
@@ -1168,7 +1176,7 @@ export type ArticleResolvers<ContextType = QueryContext, ParentType extends Reso
   containedIn?: Resolver<Maybe<ResolversTypes['Content']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   standfirst?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1192,7 +1200,7 @@ export type AudioResolvers<ContextType = QueryContext, ParentType extends Resolv
   commentsEnabled?: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   media?: Resolver<Maybe<ReadonlyArray<Maybe<ResolversTypes['Media']>>>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
@@ -1262,7 +1270,7 @@ export type ContentResolvers<ContextType = QueryContext, ParentType extends Reso
   commentsEnabled?: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   standfirst?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1287,7 +1295,7 @@ export type ContentPackageResolvers<ContextType = QueryContext, ParentType exten
   containsLength?: Resolver<Maybe<ResolversTypes['Int']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   standfirst?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1572,7 +1580,7 @@ export type LiveBlogPackageResolvers<ContextType = QueryContext, ParentType exte
   commentsEnabled?: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   liveBlogPosts?: Resolver<Maybe<ReadonlyArray<Maybe<ResolversTypes['Content']>>>, ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   pinnedPost?: Resolver<Maybe<ResolversTypes['Content']>, ParentType, ContextType>;
@@ -1600,7 +1608,7 @@ export type LiveBlogPostResolvers<ContextType = QueryContext, ParentType extends
   containedIn?: Resolver<Maybe<ResolversTypes['Content']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   standfirst?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1626,6 +1634,10 @@ export type MediaResolvers<ContextType = QueryContext, ParentType extends Resolv
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 }>;
 
+export type MetaLinkResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['MetaLink'] = ResolversParentTypes['MetaLink']> = ResolversObject<{
+  __resolveType?: TypeResolveFn<'Concept' | 'ContentPackage', ParentType, ContextType>;
+}>;
+
 export type MutationResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Mutation'] = ResolversParentTypes['Mutation']> = ResolversObject<{
   invalidateRedisCache?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType, RequireFields<MutationInvalidateRedisCacheArgs, 'uuid'>>;
 }>;
@@ -1707,7 +1719,7 @@ export type PlaceholderResolvers<ContextType = QueryContext, ParentType extends
   containedIn?: Resolver<Maybe<ResolversTypes['Content']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   standfirst?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1812,8 +1824,8 @@ export type TeaserResolvers<ContextType = QueryContext, ParentType extends Resol
   id?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   image?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   indicators?: Resolver<Maybe<ResolversTypes['Indicators']>, ParentType, ContextType>;
-  metaAltLink?: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
-  metaLink?: Resolver<Maybe<ResolversTypes['Concept']>, ParentType, ContextType>;
+  metaAltLink?: Resolver<Maybe<ResolversTypes['MetaLink']>, ParentType, ContextType>;
+  metaLink?: Resolver<Maybe<ResolversTypes['MetaLink']>, ParentType, ContextType>;
   metaPrefixText?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   metaSuffixText?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   publishedDate?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1887,7 +1899,7 @@ export type VideoResolvers<ContextType = QueryContext, ParentType extends Resolv
   commentsEnabled?: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   design?: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
   firstPublishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
-  id?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
+  id?: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
   mainImage?: Resolver<Maybe<ResolversTypes['Image']>, ParentType, ContextType>;
   publishedDate?: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   standfirst?: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
@@ -1947,6 +1959,7 @@ export type Resolvers<ContextType = QueryContext> = ResolversObject<{
   LiveBlogPost?: LiveBlogPostResolvers<ContextType>;
   MainImage?: MainImageResolvers<ContextType>;
   Media?: MediaResolvers<ContextType>;
+  MetaLink?: MetaLinkResolvers<ContextType>;
   Mutation?: MutationResolvers<ContextType>;
   OpinionTopper?: OpinionTopperResolvers<ContextType>;
   PackageDesign?: GraphQLScalarType;

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 '..'
@@ -309,26 +307,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/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>
 }