@financial-times/cp-content-pipeline-schema 2.15.0 → 3.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +39 -0
- package/lib/datasources/capi.d.ts +2 -2
- package/lib/datasources/capi.js +4 -2
- package/lib/datasources/capi.js.map +1 -1
- package/lib/datasources/capi.test.js +2 -2
- package/lib/fixtures/capiObject.d.ts +2 -2
- package/lib/fixtures/capiObject.js +2 -0
- package/lib/fixtures/capiObject.js.map +1 -1
- package/lib/fixtures/capiPerson.d.ts +1 -1
- package/lib/generated/index.d.ts +296 -131
- package/lib/helpers/decorateHeadshotUrl.d.ts +1 -2
- package/lib/helpers/decorateHeadshotUrl.js +2 -3
- package/lib/helpers/decorateHeadshotUrl.js.map +1 -1
- package/lib/model/Byline.d.ts +8 -10
- package/lib/model/Byline.js +34 -33
- package/lib/model/Byline.js.map +1 -1
- package/lib/model/Byline.test.js +105 -52
- package/lib/model/Byline.test.js.map +1 -1
- package/lib/model/CapiResponse.d.ts +12 -16
- package/lib/model/CapiResponse.js +38 -41
- package/lib/model/CapiResponse.js.map +1 -1
- package/lib/model/CapiResponse.test.js +7 -18
- package/lib/model/CapiResponse.test.js.map +1 -1
- package/lib/model/Clip.d.ts +1 -1
- package/lib/model/Concept.d.ts +1 -1
- package/lib/model/Concept.js +1 -2
- package/lib/model/Concept.js.map +1 -1
- package/lib/model/FlourishSource.d.ts +1 -1
- package/lib/model/FlourishSource.js.map +1 -1
- package/lib/model/Image.d.ts +1 -1
- package/lib/model/LeadFlourish.test.js +1 -0
- package/lib/model/LeadFlourish.test.js.map +1 -1
- package/lib/model/Person.d.ts +6 -12
- package/lib/model/Person.js +39 -66
- package/lib/model/Person.js.map +1 -1
- package/lib/model/Person.test.js +7 -60
- package/lib/model/Person.test.js.map +1 -1
- package/lib/model/Picture.d.ts +1 -1
- package/lib/model/RichText.d.ts +1 -2
- package/lib/model/Topper.d.ts +1 -1
- package/lib/model/Topper.js +10 -8
- package/lib/model/Topper.js.map +1 -1
- package/lib/model/Topper.test.js +9 -10
- package/lib/model/Topper.test.js.map +1 -1
- package/lib/model/schemas/capi/article.d.ts +7 -4
- package/lib/model/schemas/capi/article.js +1 -0
- package/lib/model/schemas/capi/article.js.map +1 -1
- package/lib/model/schemas/capi/audio.d.ts +7 -4
- package/lib/model/schemas/capi/audio.js +1 -0
- package/lib/model/schemas/capi/audio.js.map +1 -1
- package/lib/model/schemas/capi/base-schema.d.ts +14 -123
- package/lib/model/schemas/capi/base-schema.js +7 -6
- package/lib/model/schemas/capi/base-schema.js.map +1 -1
- package/lib/model/schemas/capi/content-package.d.ts +10 -5
- package/lib/model/schemas/capi/content-package.js +2 -0
- package/lib/model/schemas/capi/content-package.js.map +1 -1
- package/lib/model/schemas/capi/index.d.ts +41 -22
- package/lib/model/schemas/capi/internal-content.d.ts +24 -0
- package/lib/model/schemas/capi/internal-content.js +3 -0
- package/lib/model/schemas/capi/internal-content.js.map +1 -0
- package/lib/model/schemas/capi/live-blog-package.d.ts +7 -4
- package/lib/model/schemas/capi/live-blog-package.js +1 -0
- package/lib/model/schemas/capi/live-blog-package.js.map +1 -1
- package/lib/model/schemas/capi/placeholder.d.ts +7 -4
- package/lib/model/schemas/capi/placeholder.js +1 -0
- package/lib/model/schemas/capi/placeholder.js.map +1 -1
- package/lib/model/schemas/capi/video.d.ts +10 -5
- package/lib/model/schemas/capi/video.js +2 -0
- package/lib/model/schemas/capi/video.js.map +1 -1
- package/lib/resolvers/concept.d.ts +37 -2
- package/lib/resolvers/concept.js +17 -10
- package/lib/resolvers/concept.js.map +1 -1
- package/lib/resolvers/content-tree/Workarounds.d.ts +19 -11
- package/lib/resolvers/content-tree/references/Author.d.ts +4 -0
- package/lib/resolvers/content-tree/references/Author.js +14 -0
- package/lib/resolvers/content-tree/references/Author.js.map +1 -0
- package/lib/resolvers/content-tree/references/ClipSet.d.ts +1 -1
- package/lib/resolvers/content-tree/references/ClipSet.js +1 -1
- package/lib/resolvers/content-tree/references/ClipSet.js.map +1 -1
- package/lib/resolvers/content-tree/references/Flourish.d.ts +1 -1
- package/lib/resolvers/content-tree/references/Reference.d.ts +1 -1
- package/lib/resolvers/content-tree/references/index.d.ts +4 -2
- package/lib/resolvers/content-tree/references/index.js +4 -1
- package/lib/resolvers/content-tree/references/index.js.map +1 -1
- package/lib/resolvers/content-tree/updateTreeWithReferenceIds.d.ts +3 -3
- package/lib/resolvers/content-tree/updateTreeWithReferenceIds.js +2 -3
- package/lib/resolvers/content-tree/updateTreeWithReferenceIds.js.map +1 -1
- package/lib/resolvers/content.d.ts +27 -18
- package/lib/resolvers/content.js +4 -2
- package/lib/resolvers/content.js.map +1 -1
- package/lib/resolvers/image.d.ts +12 -12
- package/lib/resolvers/index.d.ts +89 -42
- package/lib/resolvers/leadFlourish.d.ts +2 -1
- package/lib/resolvers/leadFlourish.js +1 -0
- package/lib/resolvers/leadFlourish.js.map +1 -1
- package/lib/resolvers/person.d.ts +1 -1
- package/lib/resolvers/person.js +1 -1
- package/lib/resolvers/person.js.map +1 -1
- package/lib/resolvers/picture.d.ts +4 -4
- package/lib/resolvers/richText.d.ts +1 -1
- package/lib/resolvers/teaser.d.ts +1 -1
- package/lib/resolvers/topper.d.ts +3 -3
- package/package.json +1 -1
- package/queries/article.graphql +35 -13
- package/src/datasources/capi.test.ts +3 -3
- package/src/datasources/capi.ts +5 -3
- package/src/fixtures/capiObject.ts +4 -2
- package/src/fixtures/capiPerson.ts +1 -1
- package/src/generated/index.ts +321 -132
- package/src/helpers/decorateHeadshotUrl.ts +2 -2
- package/src/model/Byline.test.ts +136 -55
- package/src/model/Byline.ts +49 -39
- package/src/model/CapiResponse.test.ts +9 -25
- package/src/model/CapiResponse.ts +83 -56
- package/src/model/Clip.ts +1 -1
- package/src/model/Concept.ts +3 -3
- package/src/model/FlourishSource.ts +1 -1
- package/src/model/Image.test.ts +1 -1
- package/src/model/Image.ts +1 -1
- package/src/model/LeadFlourish.test.ts +1 -0
- package/src/model/Person.test.ts +11 -62
- package/src/model/Person.ts +47 -51
- package/src/model/Picture.test.ts +1 -1
- package/src/model/Picture.ts +1 -1
- package/src/model/Topper.test.ts +22 -18
- package/src/model/Topper.ts +10 -9
- package/src/model/__snapshots__/Byline.test.ts.snap +166 -27
- package/src/model/schemas/capi/article.ts +1 -0
- package/src/model/schemas/capi/audio.ts +1 -0
- package/src/model/schemas/capi/base-schema.ts +5 -4
- package/src/model/schemas/capi/content-package.ts +2 -0
- package/src/model/schemas/capi/internal-content.ts +45 -0
- package/src/model/schemas/capi/live-blog-package.ts +1 -0
- package/src/model/schemas/capi/placeholder.ts +1 -0
- package/src/model/schemas/capi/video.ts +2 -0
- package/src/resolvers/concept.ts +29 -12
- package/src/resolvers/content-tree/Workarounds.ts +39 -20
- package/src/resolvers/content-tree/references/Author.ts +18 -0
- package/src/resolvers/content-tree/references/ClipSet.ts +6 -8
- package/src/resolvers/content-tree/references/ImageSet.ts +1 -1
- package/src/resolvers/content-tree/references/ScrollyImage.ts +1 -1
- package/src/resolvers/content-tree/references/index.ts +6 -1
- package/src/resolvers/content-tree/updateTreeWithReferenceIds.ts +6 -8
- package/src/resolvers/content.ts +4 -2
- package/src/resolvers/leadFlourish.ts +1 -0
- package/src/resolvers/person.ts +1 -1
- package/src/types/n-display-metadata.d.ts +1 -1
- package/tsconfig.tsbuildinfo +1 -1
- package/typedefs/clip.graphql +2 -2
- package/typedefs/concept.graphql +64 -2
- package/typedefs/content.graphql +63 -39
- package/typedefs/image.graphql +12 -12
- package/typedefs/leadFlourish.graphql +32 -0
- package/typedefs/person.graphql +2 -2
- package/typedefs/picture.graphql +6 -6
- package/typedefs/references/author.graphql +7 -0
- package/typedefs/references/clipSet.graphql +14 -2
- package/typedefs/references/tweet.graphql +1 -1
- package/typedefs/teaser.graphql +10 -10
- package/src/types/internal-content.d.ts +0 -55
- package/typedefs/leadFlouish.graphql +0 -29
package/typedefs/teaser.graphql
CHANGED
|
@@ -2,25 +2,25 @@ union MetaLink = Concept | ContentPackage
|
|
|
2
2
|
|
|
3
3
|
type Teaser {
|
|
4
4
|
"The unique identifier of the teaser, a uuid or a url."
|
|
5
|
-
id: String
|
|
5
|
+
id: String!
|
|
6
6
|
|
|
7
7
|
"The url of the content that the teaser refers to."
|
|
8
8
|
url(relative: Boolean): String!
|
|
9
|
-
|
|
9
|
+
|
|
10
10
|
"The type of the teaser, eg. 'article' or 'video'."
|
|
11
|
-
type: String
|
|
11
|
+
type: String!
|
|
12
12
|
|
|
13
13
|
"The title of the teaser."
|
|
14
|
-
title: String
|
|
14
|
+
title: String!
|
|
15
15
|
|
|
16
16
|
"The image to be used as a thumbnail for the teaser."
|
|
17
17
|
image: Image
|
|
18
18
|
|
|
19
19
|
"The date the content of the teaser was published."
|
|
20
|
-
publishedDate: String
|
|
20
|
+
publishedDate: String!
|
|
21
21
|
|
|
22
22
|
"The date the content of the teaser was first published."
|
|
23
|
-
firstPublishedDate: String
|
|
23
|
+
firstPublishedDate: String!
|
|
24
24
|
|
|
25
25
|
"An object containing the metadata details of the teaser, eg. id, url, prefLabel."
|
|
26
26
|
metaLink: MetaLink
|
|
@@ -35,10 +35,10 @@ type Teaser {
|
|
|
35
35
|
metaSuffixText: String
|
|
36
36
|
|
|
37
37
|
"An object containing a map of indicator items to boolean values, eg. accessLevel, isOpinion."
|
|
38
|
-
indicators: Indicators
|
|
38
|
+
indicators: Indicators!
|
|
39
39
|
|
|
40
40
|
"The theme to use for the teaser, eg. 'opinion' or 'news'."
|
|
41
|
-
theme: String
|
|
41
|
+
theme: String!
|
|
42
42
|
|
|
43
43
|
"The introductory text of the teaser."
|
|
44
44
|
standfirst: String
|
|
@@ -47,11 +47,11 @@ type Teaser {
|
|
|
47
47
|
"Indicators are used to determine teaser styling."
|
|
48
48
|
type Indicators {
|
|
49
49
|
"The access level of the teaser, eg. 'free' or 'premium'."
|
|
50
|
-
accessLevel: AccessLevel
|
|
50
|
+
accessLevel: AccessLevel!
|
|
51
51
|
|
|
52
52
|
"Whether the teaser is an opinion piece."
|
|
53
53
|
isOpinion: Boolean
|
|
54
|
-
|
|
54
|
+
|
|
55
55
|
"Whether the teaser is a column, ie. has one author."
|
|
56
56
|
isColumn: Boolean
|
|
57
57
|
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
import { z } from 'zod'
|
|
2
|
-
import {
|
|
3
|
-
InternalContentSchema,
|
|
4
|
-
CapiPersonMembership,
|
|
5
|
-
CapiPerson,
|
|
6
|
-
CapiNotification,
|
|
7
|
-
Annotation,
|
|
8
|
-
Image,
|
|
9
|
-
ImageSet,
|
|
10
|
-
Clip,
|
|
11
|
-
ClipSet,
|
|
12
|
-
MainImage,
|
|
13
|
-
LeadImage,
|
|
14
|
-
LeadFlourish,
|
|
15
|
-
capiNotificationResponse,
|
|
16
|
-
} from '../model/schemas/capi/base-schema'
|
|
17
|
-
|
|
18
|
-
import { articleSchema } from '../model/schemas/capi/article'
|
|
19
|
-
import { placeholderSchema } from '../model/schemas/capi/placeholder'
|
|
20
|
-
|
|
21
|
-
import { liveBlogPackageSchema } from '../model/schemas/capi/live-blog-package'
|
|
22
|
-
import { audioSchema } from '../model/schemas/capi/audio'
|
|
23
|
-
import { videoSchema } from '../model/schemas/capi/video'
|
|
24
|
-
|
|
25
|
-
import { contentPackageSchema } from '../model/schemas/capi/content-package'
|
|
26
|
-
|
|
27
|
-
type Article = z.infer<typeof articleSchema>
|
|
28
|
-
type Placeholder = z.infer<typeof placeholderSchema>
|
|
29
|
-
type LiveBlogPackage = z.infer<typeof liveBlogPackageSchema>
|
|
30
|
-
type ContentPackage = z.infer<typeof contentPackageSchema>
|
|
31
|
-
type Audio = z.infer<typeof audioSchema>
|
|
32
|
-
type Video = z.infer<typeof videoSchema>
|
|
33
|
-
|
|
34
|
-
type InternalContent = z.infer<typeof InternalContentSchema>
|
|
35
|
-
type CapiPersonMembership = z.infer<typeof CapiPersonMembership>
|
|
36
|
-
type CapiPerson = z.infer<typeof CapiPerson>
|
|
37
|
-
type CapiNotification = z.infer<typeof CapiNotification>
|
|
38
|
-
type CapiNotificationResponse = z.infer<typeof capiNotificationResponse>
|
|
39
|
-
|
|
40
|
-
type Annotation = z.infer<typeof Annotation>
|
|
41
|
-
type Image = z.infer<typeof Image>
|
|
42
|
-
type LeadImage = z.infer<typeof LeadImage>
|
|
43
|
-
type ImageSet = z.infer<typeof ImageSet>
|
|
44
|
-
type LeadFlourish = z.infer<typeof LeadFlourish>
|
|
45
|
-
type MainImage = z.infer<typeof MainImage>
|
|
46
|
-
type Clip = z.infer<typeof Clip>
|
|
47
|
-
type ClipSet = z.infer<typeof ClipSet>
|
|
48
|
-
|
|
49
|
-
type ContentTypeSchemas =
|
|
50
|
-
| Article
|
|
51
|
-
| Placeholder
|
|
52
|
-
| LiveBlogPackage
|
|
53
|
-
| ContentPackage
|
|
54
|
-
| Audio
|
|
55
|
-
| Video
|
|
@@ -1,29 +0,0 @@
|
|
|
1
|
-
type FlourishSource {
|
|
2
|
-
"The Origami image service url"
|
|
3
|
-
url: String
|
|
4
|
-
|
|
5
|
-
"The type of the source, e.g. visualisation for leadFlourish "
|
|
6
|
-
type: String
|
|
7
|
-
|
|
8
|
-
"The format of the source, eg. 'standard'."
|
|
9
|
-
format: String
|
|
10
|
-
|
|
11
|
-
"The width of the source."
|
|
12
|
-
width: Int
|
|
13
|
-
|
|
14
|
-
"The height of the source."
|
|
15
|
-
height: Int
|
|
16
|
-
}
|
|
17
|
-
|
|
18
|
-
type LeadFlourish {
|
|
19
|
-
"The type of the chart, eg. 'visualisation'."
|
|
20
|
-
type: String
|
|
21
|
-
|
|
22
|
-
"The id of the Flourish chart."
|
|
23
|
-
id: String
|
|
24
|
-
|
|
25
|
-
"The description of the Flourish chart."
|
|
26
|
-
description: String
|
|
27
|
-
|
|
28
|
-
fallbackImage: FlourishSource!
|
|
29
|
-
}
|