@financial-times/cp-content-pipeline-schema 3.10.0 → 3.12.0

package/src/generated/index.ts

@@ -12,7 +12,7 @@ import type { LeadFlourish as LeadFlourishModel } from '../model/LeadFlourish';
 import type { FlourishSource as FlourishSourceModel } from '../model/FlourishSource';
 import type { ContentTree } from '@financial-times/content-tree';
 import type { ReferenceWithCAPIData } from '../resolvers/content-tree/references';
-import type { Video as VideoNode, Author as AuthorNode, ClipSet as ClipSetNode, OldClip as OldClipNode, RawImage as RawImageNode } from '../resolvers/content-tree/Workarounds';
+import type { Author as AuthorNode, ClipSet as ClipSetNode, OldClip as OldClipNode, RawImage as RawImageNode } from '../resolvers/content-tree/Workarounds';
 import type { QueryContext } from '../';
 export type Maybe<T> = T | null;
 export type InputMaybe<T> = Maybe<T>;
@@ -34,6 +34,7 @@ export type Scalars = {
   CanBeSyndicated: { input: 'yes' | 'no' | 'verify' | 'withContributorPayment' | 'unknown'; output: 'yes' | 'no' | 'verify' | 'withContributorPayment' | 'unknown'; }
   ClipFormat: { input: 'standard-inline' | 'mobile'; output: 'standard-inline' | 'mobile'; }
   ContentType: { input: 'Article' | 'Placeholder' | 'Video' | 'Audio' | 'LiveBlogPackage' | 'LiveBlogPost' | 'ContentPackage' | 'Content' | 'MediaResource' | 'CustomCodeComponent'; output: 'Article' | 'Placeholder' | 'Video' | 'Audio' | 'LiveBlogPackage' | 'LiveBlogPost' | 'ContentPackage' | 'Content' | 'MediaResource' | 'CustomCodeComponent'; }
+  DisclaimerType: { input: 'co-created-content' | 'client-supplied-content' | 'ft-studios-risky' | 'auditor'; output: 'co-created-content' | 'client-supplied-content' | 'ft-studios-risky' | 'auditor'; }
   FollowButtonVariant: { input: 'standard' | 'inverse' | 'opinion' | 'alphaville' | 'monochrome' | 'inverse-monochrome'; output: 'standard' | 'inverse' | 'opinion' | 'alphaville' | 'monochrome' | 'inverse-monochrome'; }
   ImageFormat: { input: 'standard' | 'standard-inline' | 'desktop' | 'mobile' | 'wide' | 'square' | 'square-ftedit' | 'portrait' | 'landscape'; output: 'standard' | 'standard-inline' | 'desktop' | 'mobile' | 'wide' | 'square' | 'square-ftedit' | 'portrait' | 'landscape'; }
   ImageType: { input: 'image' | 'graphic'; output: 'image' | 'graphic'; }
@@ -87,6 +88,8 @@ export type Article = Content & {
   readonly containedIn?: Maybe<Content>;
   /** A design object containing the theme and layout of the article. */
   readonly design?: Maybe<Design>;
+  /** Disclaimer type for commercial Partner Content articles */
+  readonly disclaimerType?: Maybe<Scalars['DisclaimerType']['output']>;
   /** The editorial division the article belongs to, eg. 'FT-SpecialReports'. */
   readonly editorialDesk?: Maybe<Scalars['String']['output']>;
   /** The first ISO string date the article was published, eg. '2024-04-03T10:35:52.443Z'. */
@@ -1054,8 +1057,12 @@ export type ImageWideSourceSetArgs = {
 };
 
 export type Indicators = {
+  /** Whether an article is in an archived state */
+  readonly isArchived?: Maybe<Scalars['Boolean']['output']>;
   /** Whether the article is included in an FT Edit editorial curation. */
   readonly isFTEdit?: Maybe<Scalars['Boolean']['output']>;
+  /** Whether an article is a Live Q&A */
+  readonly isLiveQandA?: Maybe<Scalars['Boolean']['output']>;
   /** Whether the content is an opinion piece. */
   readonly isOpinion?: Maybe<Scalars['Boolean']['output']>;
   /** Whether the content is Commercial Partner Content. */
@@ -1990,7 +1997,7 @@ export type ResolversInterfaceTypes<RefType extends Record<string, unknown>> = R
   Content: ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel ) | ( ContentModel );
   Image: ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel ) | ( ImageModel );
   Picture: ( PictureModel ) | ( PictureModel ) | ( PictureModel );
-  Reference: ( ReferenceWithCAPIData<AuthorNode> ) | ( ReferenceWithCAPIData<ClipSetNode|OldClipNode> ) | ( ReferenceWithCAPIData<ContentTree.CustomCodeComponent> ) | ( ReferenceWithCAPIData<ContentTree.Flourish> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<ContentTree.LayoutImage> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<RawImageNode> ) | ( ReferenceWithCAPIData<ContentTree.Recommended> ) | ( ReferenceWithCAPIData<ContentTree.ScrollyImage> ) | ( ReferenceWithCAPIData<ContentTree.Tweet> ) | ( ReferenceWithCAPIData<VideoNode> );
+  Reference: ( ReferenceWithCAPIData<AuthorNode> ) | ( ReferenceWithCAPIData<ClipSetNode|OldClipNode> ) | ( ReferenceWithCAPIData<ContentTree.CustomCodeComponent> ) | ( ReferenceWithCAPIData<ContentTree.Flourish> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<ContentTree.LayoutImage> ) | ( ReferenceWithCAPIData<ContentTree.ImageSet> ) | ( ReferenceWithCAPIData<RawImageNode> ) | ( ReferenceWithCAPIData<ContentTree.Recommended> ) | ( ReferenceWithCAPIData<ContentTree.ScrollyImage> ) | ( ReferenceWithCAPIData<ContentTree.Tweet> ) | ( ReferenceWithCAPIData<ContentTree.Video> );
   Topper: ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel );
   TopperWithBrand: ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel ) | ( TopperModel );
   TopperWithHeadshot: ( TopperModel ) | ( TopperModel );
@@ -2029,6 +2036,7 @@ export type ResolversTypes = ResolversObject<{
   DeepLandscapeTopper: ResolverTypeWrapper<TopperModel>;
   DeepPortraitTopper: ResolverTypeWrapper<TopperModel>;
   Design: ResolverTypeWrapper<Design>;
+  DisclaimerType: ResolverTypeWrapper<Scalars['DisclaimerType']['output']>;
   Float: ResolverTypeWrapper<Scalars['Float']['output']>;
   Flourish: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.Flourish>>;
   FlourishSource: ResolverTypeWrapper<FlourishSourceModel>;
@@ -2097,7 +2105,7 @@ export type ResolversTypes = ResolversObject<{
   TopperWithTheme: ResolverTypeWrapper<TopperModel>;
   Tweet: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.Tweet>>;
   Video: ResolverTypeWrapper<ContentModel>;
-  VideoReference: ResolverTypeWrapper<ReferenceWithCAPIData<VideoNode>>;
+  VideoReference: ResolverTypeWrapper<ReferenceWithCAPIData<ContentTree.Video>>;
 }>;
 
 /** Mapping between all available schema types and the resolvers parents */
@@ -2130,6 +2138,7 @@ export type ResolversParentTypes = ResolversObject<{
   DeepLandscapeTopper: TopperModel;
   DeepPortraitTopper: TopperModel;
   Design: Design;
+  DisclaimerType: Scalars['DisclaimerType']['output'];
   Float: Scalars['Float']['output'];
   Flourish: ReferenceWithCAPIData<ContentTree.Flourish>;
   FlourishSource: FlourishSourceModel;
@@ -2198,7 +2207,7 @@ export type ResolversParentTypes = ResolversObject<{
   TopperWithTheme: TopperModel;
   Tweet: ReferenceWithCAPIData<ContentTree.Tweet>;
   Video: ContentModel;
-  VideoReference: ReferenceWithCAPIData<VideoNode>;
+  VideoReference: ReferenceWithCAPIData<ContentTree.Video>;
 }>;
 
 export interface AccessLevelScalarConfig extends GraphQLScalarTypeConfig<ResolversTypes['AccessLevel'], any> {
@@ -2234,6 +2243,7 @@ export type ArticleResolvers<ContextType = QueryContext, ParentType extends Reso
   commentsEnabled: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   containedIn: Resolver<Maybe<ResolversTypes['Content']>, ParentType, ContextType>;
   design: Resolver<Maybe<ResolversTypes['Design']>, ParentType, ContextType>;
+  disclaimerType: Resolver<Maybe<ResolversTypes['DisclaimerType']>, ParentType, ContextType>;
   editorialDesk: Resolver<Maybe<ResolversTypes['String']>, ParentType, ContextType>;
   firstPublishedDate: Resolver<ResolversTypes['String'], ParentType, ContextType>;
   id: Resolver<ResolversTypes['ID'], ParentType, ContextType>;
@@ -2547,6 +2557,10 @@ export type DesignResolvers<ContextType = QueryContext, ParentType extends Resol
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
 }>;
 
+export interface DisclaimerTypeScalarConfig extends GraphQLScalarTypeConfig<ResolversTypes['DisclaimerType'], any> {
+  name: 'DisclaimerType';
+}
+
 export type FlourishResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Flourish'] = ResolversParentTypes['Flourish']> = ResolversObject<{
   fallbackImage: Resolver<Maybe<ResolversTypes['FlourishSource']>, ParentType, ContextType>;
   type: Resolver<ResolversTypes['String'], ParentType, ContextType>;
@@ -2746,7 +2760,9 @@ export type ImageWideResolvers<ContextType = QueryContext, ParentType extends Re
 }>;
 
 export type IndicatorsResolvers<ContextType = QueryContext, ParentType extends ResolversParentTypes['Indicators'] = ResolversParentTypes['Indicators']> = ResolversObject<{
+  isArchived: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   isFTEdit: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
+  isLiveQandA: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   isOpinion: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   isPartnerContent: Resolver<Maybe<ResolversTypes['Boolean']>, ParentType, ContextType>;
   __isTypeOf?: IsTypeOfResolverFn<ParentType, ContextType>;
@@ -3261,6 +3277,7 @@ export type Resolvers<ContextType = QueryContext> = ResolversObject<{
   DeepLandscapeTopper: DeepLandscapeTopperResolvers<ContextType>;
   DeepPortraitTopper: DeepPortraitTopperResolvers<ContextType>;
   Design: DesignResolvers<ContextType>;
+  DisclaimerType: GraphQLScalarType;
   Flourish: FlourishResolvers<ContextType>;
   FlourishSource: FlourishSourceResolvers<ContextType>;
   FollowButtonVariant: GraphQLScalarType;

package/src/model/Content.test.ts

@@ -325,4 +325,86 @@ describe('Content', () => {
       expect(capiResponse.isFTEdit()).toBe(false)
     })
   })
+
+  describe('isLiveQandA', () => {
+    test('identifies articles that are Live Q&As', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'someStringHereisLiveQandAsomethingElse',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isLiveQandA()).toBe(true)
+    })
+
+    test('ignores articles that are not Live Q&As', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'testSomethingThatisNotALiveQ&A',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isLiveQandA()).toBe(false)
+    })
+
+    test('handles missing `internalAnalyticsTags` property', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isLiveQandA()).toBe(false)
+    })
+
+    test('is case-insensitive', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'LIVeQaNdA',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isLiveQandA()).toBe(true)
+    })
+  })
+
+  describe('isArchived', () => {
+    test('identifies articles that are archived', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'something archived somethng else',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isArchived()).toBe(true)
+    })
+
+    test('ignores articles that are not archived', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'archive will not match, it misses the d',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isArchived()).toBe(false)
+    })
+
+    test('handles missing `internalAnalyticsTags` property', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isArchived()).toBe(false)
+    })
+
+    test('is case-insensitive', () => {
+      const article = cloneDeep({
+        ...baseCapiObject,
+        internalAnalyticsTags: 'ArChIvEd',
+      })
+      const capiResponse = new Content(article, context)
+
+      expect(capiResponse.isArchived()).toBe(true)
+    })
+  })
 })

package/src/model/Content.ts

@@ -941,6 +941,32 @@ export class Content {
     return false
   }
 
+  isLiveQandA(): boolean {
+    if (
+      'internalAnalyticsTags' in this.capiData &&
+      this.capiData.internalAnalyticsTags
+    ) {
+      return this.capiData.internalAnalyticsTags
+        .toLowerCase()
+        .includes('liveqanda')
+    }
+
+    return false
+  }
+
+  isArchived(): boolean {
+    if (
+      'internalAnalyticsTags' in this.capiData &&
+      this.capiData.internalAnalyticsTags
+    ) {
+      return this.capiData.internalAnalyticsTags
+        .toLowerCase()
+        .includes('archived')
+    }
+
+    return false
+  }
+
   design(): Design {
     if ('design' in this.capiData && this.capiData.design.theme) {
       return { theme: this.capiData.design.theme }
@@ -976,4 +1002,10 @@ export class Content {
     }
     return null
   }
+  disclaimerType() {
+    if ('disclaimerType' in this.capiData && this.capiData.disclaimerType) {
+      return this.capiData.disclaimerType
+    }
+    return null
+  }
 }

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

@@ -34,6 +34,7 @@ const articleMetadataSchema = baseMetadataSchema.pick({
   containedIn: true,
   publication: true,
   clientName: true,
+  disclaimerType: true,
   internalAnalyticsTags: true,
 })
 

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

@@ -235,6 +235,14 @@ export const baseMetadataSchema = z.object({
     .optional(),
   publication: z.array(z.string()).optional(),
   clientName: z.string().optional(),
+  disclaimerType: z
+    .union([
+      z.literal('co-created-content'),
+      z.literal('client-supplied-content'),
+      z.literal('ft-studios-risky'),
+      z.literal('auditor'),
+    ])
+    .optional(),
   internalAnalyticsTags: z.string().optional(),
 })
 

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

@@ -68,13 +68,6 @@ export type MainImageRaw = Omit<RawImage, 'type'> & {
   type: 'main-image-raw'
 }
 
-export interface Video extends ContentTree.Node {
-  type: 'video'
-  id: string
-  title?: string
-  embedded: boolean
-}
-
 export interface CccFallbackText extends ContentTree.Node {
   type: 'ccc-fallback-text'
   children: ContentTree.Paragraph[]
@@ -205,7 +198,7 @@ export type BodyBlock =
   | Table
   | Recommended
   | ContentTree.Tweet
-  | Video
+  | ContentTree.Video
   | ContentTree.YoutubeVideo
 
 export type AnyNode =
@@ -247,7 +240,7 @@ export type AnyNode =
   | TableBody
   | TableRow
   | TableCell
-  | Video
+  | ContentTree.Video
   | ContentTree.YoutubeVideo
   | MainImage
   | MainImageRaw

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

@@ -229,7 +229,6 @@ const commonTagMappings: TagMappings = {
   ) => ({
     type: 'video',
     id: $el.attr('url') || '',
-    embedded: $el.attr('data-embedded') === 'true' || true,
   }),
   'a[data-asset-type="video"]': ($el) => {
     const url = $el.attr('href')

package/src/resolvers/content.ts

@@ -95,10 +95,13 @@ const resolvers = {
     containedIn: (parent) => parent.containedIn(),
     publication: (parent) => parent.publication() ?? null,
     clientName: (parent) => parent.clientName() ?? null,
+    disclaimerType: (parent) => parent.disclaimerType() ?? null,
     indicators: (parent) => {
       return {
         isPartnerContent: parent.isPartnerContent(),
         isFTEdit: parent.isFTEdit(),
+        isLiveQandA: parent.isLiveQandA(),
+        isArchived: parent.isArchived(),
       }
     },
   },
@@ -197,6 +200,8 @@ const resolvers = {
     isFTEdit: (parent) => parent.isFTEdit ?? null,
     isOpinion: (parent) => parent.isOpinion ?? null,
     isPartnerContent: (parent) => parent.isPartnerContent ?? null,
+    isLiveQandA: (parent) => parent.isLiveQandA ?? null,
+    isArchived: (parent) => parent.isArchived ?? null,
   },
 
   Media: {

package/src/resolvers/scalars.ts

@@ -175,6 +175,23 @@ export const LayoutHint = new LiteralUnionScalar<
   values: ['standaloneimage', 'landscape', 'bigstory', 'assassination'],
 })
 
+export const DisclaimerType = new LiteralUnionScalar<
+  [
+    'co-created-content',
+    'client-supplied-content',
+    'ft-studios-risky',
+    'auditor'
+  ]
+>({
+  name: 'DisclaimerType',
+  values: [
+    'co-created-content',
+    'client-supplied-content',
+    'ft-studios-risky',
+    'auditor',
+  ],
+})
+
 const resolvers = {
   ClipFormat,
   ImageFormat,
@@ -188,6 +205,7 @@ const resolvers = {
   ContentType,
   ListType,
   LayoutHint,
+  DisclaimerType,
   JSON: new GraphQLScalarType({ name: 'JSON' }),
 }