@financial-times/cp-content-pipeline-schema 2.5.3 → 2.6.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.
Files changed (66) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +187 -41
  3. package/lib/datasources/base.d.ts +1 -0
  4. package/lib/datasources/capi.js +1 -0
  5. package/lib/datasources/capi.js.map +1 -1
  6. package/lib/datasources/instrumented.d.ts +1 -0
  7. package/lib/datasources/instrumented.js +1 -9
  8. package/lib/datasources/instrumented.js.map +1 -1
  9. package/lib/datasources/origami-image.js +1 -0
  10. package/lib/datasources/origami-image.js.map +1 -1
  11. package/lib/datasources/twitter.js +1 -0
  12. package/lib/datasources/twitter.js.map +1 -1
  13. package/lib/datasources/url-management.d.ts +1 -0
  14. package/lib/datasources/url-management.js +2 -0
  15. package/lib/datasources/url-management.js.map +1 -1
  16. package/lib/fixtures/capiObject.js +1 -1
  17. package/lib/fixtures/capiObject.js.map +1 -1
  18. package/lib/generated/index.d.ts +572 -2
  19. package/lib/model/CapiResponse.d.ts +1 -0
  20. package/lib/model/CapiResponse.js +4 -2
  21. package/lib/model/CapiResponse.js.map +1 -1
  22. package/lib/model/CapiResponse.test.js +7 -0
  23. package/lib/model/CapiResponse.test.js.map +1 -1
  24. package/lib/resolvers/content-tree/Workarounds.d.ts +8 -1
  25. package/lib/resolvers/content-tree/nodePredicates.d.ts +1 -1
  26. package/lib/resolvers/content-tree/tagMappings.js +14 -5
  27. package/lib/resolvers/content-tree/tagMappings.js.map +1 -1
  28. package/lib/resolvers/content.d.ts +8 -0
  29. package/lib/resolvers/content.js +1 -0
  30. package/lib/resolvers/content.js.map +1 -1
  31. package/lib/resolvers/index.d.ts +8 -0
  32. package/package.json +1 -1
  33. package/queries/article.graphql +1 -0
  34. package/src/datasources/base.ts +1 -0
  35. package/src/datasources/capi.ts +1 -0
  36. package/src/datasources/instrumented.ts +1 -11
  37. package/src/datasources/origami-image.ts +3 -0
  38. package/src/datasources/twitter.ts +2 -0
  39. package/src/datasources/url-management.ts +2 -0
  40. package/src/fixtures/capiObject.ts +1 -1
  41. package/src/generated/index.ts +572 -2
  42. package/src/model/CapiResponse.test.ts +9 -0
  43. package/src/model/CapiResponse.ts +4 -3
  44. package/src/resolvers/content-tree/Workarounds.ts +10 -0
  45. package/src/resolvers/content-tree/tagMappings.ts +15 -5
  46. package/src/resolvers/content.ts +1 -0
  47. package/tsconfig.tsbuildinfo +1 -1
  48. package/typedefs/clip.graphql +28 -0
  49. package/typedefs/concept.graphql +21 -2
  50. package/typedefs/content.graphql +465 -36
  51. package/typedefs/core.graphql +6 -0
  52. package/typedefs/image.graphql +210 -15
  53. package/typedefs/picture.graphql +54 -1
  54. package/typedefs/references/clipSet.graphql +34 -1
  55. package/typedefs/references/flourish.graphql +8 -0
  56. package/typedefs/references/imageSet.graphql +6 -0
  57. package/typedefs/references/layoutImage.graphql +3 -0
  58. package/typedefs/references/rawImage.graphql +3 -0
  59. package/typedefs/references/recommended.graphql +3 -0
  60. package/typedefs/references/reference.graphql +1 -0
  61. package/typedefs/references/scrollyImage.graphql +3 -0
  62. package/typedefs/references/tweet.graphql +3 -0
  63. package/typedefs/references/video.graphql +5 -0
  64. package/typedefs/richText.graphql +7 -4
  65. package/typedefs/teaser.graphql +42 -1
  66. package/typedefs/topper.graphql +219 -7
package/typedefs/clip.graphql CHANGED
@@ -1,27 +1,55 @@
1
1
  type ClipSource {
2
+ "The audio encoding format of the source, eg. mp3."
2
3
  audioCodec: String
4
+
5
+ "The url of the clip source, eg. 'https://next-media-api.ft.com/renditions/16868569859480/0x0.mp3'."
3
6
  binaryUrl: String!
7
+
8
+ "The duration of the clip in milliseconds."
4
9
  duration: Int
10
+
11
+ "The media type eg. video/mp4."
5
12
  mediaType: String!
13
+
14
+ "The height of the clip in pixels."
6
15
  pixelHeight: Int
16
+
17
+ "The width of the clip in pixels."
7
18
  pixelWidth: Int
19
+
20
+ "The video encoding format of the source, eg. h264."
8
21
  videoCodec: String
9
22
  }
10
23
 
11
24
  type Clip {
25
+ "The unique identifier of the clip - a uuid or a url."
12
26
  id: String!
27
+
28
+ "The type of the clip, eg. 'http://www.ft.com/ontology/content/Clip'."
13
29
  type: String
30
+
31
+ "The format of the clip, eg. 'standard-inline' or 'mobile'."
14
32
  format: ClipFormat
33
+
34
+ "An array of data sources - includes 'video/mp4' and 'audio/mp3' sources."
15
35
  dataSource: [ClipSource!]!
36
+
37
+ "The url of the image to be used as a poster for the clip, eg. 'https://www.ft.com/__origami/service/image...'."
16
38
  poster: String
17
39
  }
18
40
 
19
41
  type Caption {
42
+ "The media type of the caption eg. text/vtt."
20
43
  mediaType: String
44
+
45
+ "The url of the caption, eg. 'https://next-media-api.ft.com/clips/captions/32065513'."
21
46
  url: String
22
47
  }
23
48
 
24
49
  type Accessibility {
50
+ "An array of captions for the clip."
25
51
  captions: [Caption]
52
+
53
+ "An abstract syntax tree of the transcript for the clip."
26
54
  transcript: RichText
27
55
  }
package/typedefs/concept.graphql CHANGED
@@ -1,11 +1,30 @@
1
+ "A concept is supplemtary information item, like a location, person, organisation or topic. It is used to provide context to an article."
2
+
1
3
  type Concept {
4
+ "The unique identifier of the concept - a uuid or a url."
5
+ id: ID!
6
+
7
+ "The url of the media, eg. 'https://next-media-api.ft.com/renditions/16868569859480/0x0.mp3'."
8
+ url(vanity: Boolean, relative: Boolean): String!
9
+
10
+ "The api url of the concept, eg. 'http://api.ft.com/things/a579350c-61ce-4c00-97ca-ddaa2e0cacf6'."
2
11
  apiUrl: String
12
+
13
+ "The type of the concept, eg. 'http://www.ft.com/ontology/Topic'."
3
14
  directType: String
15
+
16
+ "Whether the concept is part of a package brand eg. 'ftSeries' or 'ftGuides'."
4
17
  isPackageBrand: Boolean
5
- id: ID!
18
+
19
+ "The relationship between the concept and the article, eg. 'http://www.ft.com/ontology/hasAuthor'."
6
20
  predicate: String
21
+
22
+ "The preferred label of the concept, eg. 'Work & Careers'."
7
23
  prefLabel: String!
24
+
25
+ "The type of the concept, eg. 'TOPIC'."
8
26
  type: String
27
+
28
+ "An array of types, eg. ['http://www.ft.com/ontology/core/Thing', 'http://www.ft.com/ontology/Topic']."
9
29
  types: [String!]
10
- url(vanity: Boolean, relative: Boolean): String!
11
30
  }