@financial-times/cp-content-pipeline-schema 1.4.3 → 1.5.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 (87) hide show
  1. package/CHANGELOG.md +24 -0
  2. package/lib/fixtures/capiObject.js +1 -1
  3. package/lib/fixtures/capiObject.js.map +1 -1
  4. package/lib/fixtures/clipSet.d.ts +2 -0
  5. package/lib/fixtures/clipSet.js +70 -0
  6. package/lib/fixtures/clipSet.js.map +1 -0
  7. package/lib/generated/index.d.ts +136 -3
  8. package/lib/model/CapiResponse.d.ts +3 -2
  9. package/lib/model/CapiResponse.js +10 -1
  10. package/lib/model/CapiResponse.js.map +1 -1
  11. package/lib/model/Clip.d.ts +28 -0
  12. package/lib/model/Clip.js +51 -0
  13. package/lib/model/Clip.js.map +1 -0
  14. package/lib/model/schemas/capi/article.d.ts +605 -9
  15. package/lib/model/schemas/capi/article.js +1 -0
  16. package/lib/model/schemas/capi/article.js.map +1 -1
  17. package/lib/model/schemas/capi/audio.d.ts +34 -31
  18. package/lib/model/schemas/capi/audio.js +1 -0
  19. package/lib/model/schemas/capi/audio.js.map +1 -1
  20. package/lib/model/schemas/capi/base-schema.d.ts +1358 -14
  21. package/lib/model/schemas/capi/base-schema.js +46 -2
  22. package/lib/model/schemas/capi/base-schema.js.map +1 -1
  23. package/lib/model/schemas/capi/content-package.d.ts +6 -3
  24. package/lib/model/schemas/capi/content-package.js +1 -0
  25. package/lib/model/schemas/capi/content-package.js.map +1 -1
  26. package/lib/model/schemas/capi/live-blog-package.d.ts +605 -9
  27. package/lib/model/schemas/capi/live-blog-package.js +1 -0
  28. package/lib/model/schemas/capi/live-blog-package.js.map +1 -1
  29. package/lib/model/schemas/capi/placeholder.d.ts +605 -9
  30. package/lib/model/schemas/capi/placeholder.js +1 -0
  31. package/lib/model/schemas/capi/placeholder.js.map +1 -1
  32. package/lib/resolvers/clip.d.ts +10 -0
  33. package/lib/resolvers/clip.js +13 -0
  34. package/lib/resolvers/clip.js.map +1 -0
  35. package/lib/resolvers/content-tree/Workarounds.d.ts +10 -2
  36. package/lib/resolvers/content-tree/nodePredicates.d.ts +3 -3
  37. package/lib/resolvers/content-tree/references/ClipSet.d.ts +27 -0
  38. package/lib/resolvers/content-tree/references/ClipSet.js +37 -0
  39. package/lib/resolvers/content-tree/references/ClipSet.js.map +1 -0
  40. package/lib/resolvers/content-tree/references/ImageSet.js +3 -2
  41. package/lib/resolvers/content-tree/references/ImageSet.js.map +1 -1
  42. package/lib/resolvers/content-tree/references/Reference.d.ts +1 -1
  43. package/lib/resolvers/content-tree/references/ScrollyImage.js +3 -2
  44. package/lib/resolvers/content-tree/references/ScrollyImage.js.map +1 -1
  45. package/lib/resolvers/content-tree/references/index.d.ts +4 -1
  46. package/lib/resolvers/content-tree/references/index.js +4 -0
  47. package/lib/resolvers/content-tree/references/index.js.map +1 -1
  48. package/lib/resolvers/content-tree/tagMappings.js +9 -0
  49. package/lib/resolvers/content-tree/tagMappings.js.map +1 -1
  50. package/lib/resolvers/content.d.ts +1 -0
  51. package/lib/resolvers/content.js +1 -0
  52. package/lib/resolvers/content.js.map +1 -1
  53. package/lib/resolvers/index.d.ts +10 -0
  54. package/lib/resolvers/index.js +2 -0
  55. package/lib/resolvers/index.js.map +1 -1
  56. package/lib/resolvers/scalars.d.ts +2 -0
  57. package/lib/resolvers/scalars.js +6 -1
  58. package/lib/resolvers/scalars.js.map +1 -1
  59. package/package.json +1 -1
  60. package/src/fixtures/capiObject.ts +1 -1
  61. package/src/fixtures/clipSet.ts +72 -0
  62. package/src/generated/index.ts +144 -3
  63. package/src/model/CapiResponse.ts +12 -2
  64. package/src/model/Clip.ts +75 -0
  65. package/src/model/__snapshots__/RichText.test.ts.snap +25 -0
  66. package/src/model/schemas/capi/article.ts +1 -0
  67. package/src/model/schemas/capi/audio.ts +1 -0
  68. package/src/model/schemas/capi/base-schema.ts +50 -1
  69. package/src/model/schemas/capi/content-package.ts +1 -0
  70. package/src/model/schemas/capi/live-blog-package.ts +1 -0
  71. package/src/model/schemas/capi/placeholder.ts +1 -0
  72. package/src/resolvers/clip.ts +13 -0
  73. package/src/resolvers/content-tree/Workarounds.ts +13 -2
  74. package/src/resolvers/content-tree/references/ClipSet.ts +49 -0
  75. package/src/resolvers/content-tree/references/ImageSet.ts +9 -5
  76. package/src/resolvers/content-tree/references/ScrollyImage.ts +9 -5
  77. package/src/resolvers/content-tree/references/index.ts +6 -0
  78. package/src/resolvers/content-tree/tagMappings.ts +10 -0
  79. package/src/resolvers/content.ts +1 -0
  80. package/src/resolvers/index.ts +2 -0
  81. package/src/resolvers/scalars.ts +8 -0
  82. package/src/types/internal-content.d.ts +4 -0
  83. package/tsconfig.tsbuildinfo +1 -1
  84. package/typedefs/clip.graphql +28 -0
  85. package/typedefs/content.graphql +8 -2
  86. package/typedefs/references/clipSet.graphql +19 -0
  87. package/typedefs/scalars.graphql +1 -0
@@ -22,6 +22,7 @@ const articleMetadataSchema = base_schema_1.baseMetadataSchema.pick({
22
22
  firstPublishedDate: true,
23
23
  accessLevel: true,
24
24
  canBeSyndicated: true,
25
+ canBeDistributed: true,
25
26
  topper: true,
26
27
  comments: true,
27
28
  containedIn: true,
@@ -1 +1 @@
1
- {"version":3,"file":"article.js","sourceRoot":"","sources":["../../../../src/model/schemas/capi/article.ts"],"names":[],"mappings":";;;AAAA,+CAIsB;AAEtB,MAAM,oBAAoB,GAAG,+BAAiB,CAAC,IAAI,CAAC;IAClD,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,iBAAiB,EAAE,IAAI;IACvB,sBAAsB,EAAE,IAAI;CAC7B,CAAC,CAAA;AAEF,MAAM,qBAAqB,GAAG,gCAAkB,CAAC,IAAI,CAAC;IACpD,EAAE,EAAE,IAAI;IACR,WAAW,EAAE,IAAI;IACjB,MAAM,EAAE,IAAI;IACZ,eAAe,EAAE,IAAI;IACrB,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;IACd,aAAa,EAAE,IAAI;IACnB,kBAAkB,EAAE,IAAI;IACxB,WAAW,EAAE,IAAI;IACjB,eAAe,EAAE,IAAI;IACrB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,IAAI;CAClB,CAAC,CAAA;AAEF,MAAM,kBAAkB,GAAG,6BAAe,CAAC,IAAI,CAAC;IAC9C,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;IAChB,iBAAiB,EAAE,IAAI;IACvB,MAAM,EAAE,IAAI;CACb,CAAC,CAAA;AAEW,QAAA,aAAa,GAAG,oBAAoB;KAC9C,KAAK,CAAC,qBAAqB,CAAC;KAC5B,KAAK,CAAC,kBAAkB,CAAC,CAAA"}
1
+ {"version":3,"file":"article.js","sourceRoot":"","sources":["../../../../src/model/schemas/capi/article.ts"],"names":[],"mappings":";;;AAAA,+CAIsB;AAEtB,MAAM,oBAAoB,GAAG,+BAAiB,CAAC,IAAI,CAAC;IAClD,KAAK,EAAE,IAAI;IACX,UAAU,EAAE,IAAI;IAChB,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,iBAAiB,EAAE,IAAI;IACvB,sBAAsB,EAAE,IAAI;CAC7B,CAAC,CAAA;AAEF,MAAM,qBAAqB,GAAG,gCAAkB,CAAC,IAAI,CAAC;IACpD,EAAE,EAAE,IAAI;IACR,WAAW,EAAE,IAAI;IACjB,MAAM,EAAE,IAAI;IACZ,eAAe,EAAE,IAAI;IACrB,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,IAAI;IACX,QAAQ,EAAE,IAAI;IACd,aAAa,EAAE,IAAI;IACnB,kBAAkB,EAAE,IAAI;IACxB,WAAW,EAAE,IAAI;IACjB,eAAe,EAAE,IAAI;IACrB,gBAAgB,EAAE,IAAI;IACtB,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,WAAW,EAAE,IAAI;CAClB,CAAC,CAAA;AAEF,MAAM,kBAAkB,GAAG,6BAAe,CAAC,IAAI,CAAC;IAC9C,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;IAChB,iBAAiB,EAAE,IAAI;IACvB,MAAM,EAAE,IAAI;CACb,CAAC,CAAA;AAEW,QAAA,aAAa,GAAG,oBAAoB;KAC9C,KAAK,CAAC,qBAAqB,CAAC;KAC5B,KAAK,CAAC,kBAAkB,CAAC,CAAA"}
@@ -2,6 +2,7 @@ export declare const audioSchema: import("zod").ZodObject<{
2
2
  id: import("zod").ZodString;
3
3
  types: import("zod").ZodArray<import("zod").ZodString, "many">;
4
4
  title: import("zod").ZodString;
5
+ publishedDate: import("zod").ZodString;
5
6
  annotations: import("zod").ZodArray<import("zod").ZodObject<{
6
7
  id: import("zod").ZodString;
7
8
  apiUrl: import("zod").ZodString;
@@ -32,10 +33,10 @@ export declare const audioSchema: import("zod").ZodObject<{
32
33
  }>, "many">;
33
34
  webUrl: import("zod").ZodOptional<import("zod").ZodString>;
34
35
  canonicalWebUrl: import("zod").ZodOptional<import("zod").ZodString>;
35
- publishedDate: import("zod").ZodString;
36
36
  firstPublishedDate: import("zod").ZodString;
37
37
  accessLevel: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"premium">, import("zod").ZodLiteral<"subscribed">, import("zod").ZodLiteral<"registered">, import("zod").ZodLiteral<"free">]>>;
38
38
  canBeSyndicated: import("zod").ZodUnion<[import("zod").ZodLiteral<"yes">, import("zod").ZodLiteral<"no">, import("zod").ZodLiteral<"verify">, import("zod").ZodLiteral<"withContributorPayment">, import("zod").ZodLiteral<"unknown">]>;
39
+ canBeDistributed: import("zod").ZodUnion<[import("zod").ZodLiteral<"yes">, import("zod").ZodLiteral<"no">, import("zod").ZodLiteral<"verify">]>;
39
40
  byline: import("zod").ZodOptional<import("zod").ZodString>;
40
41
  alternativeTitles: import("zod").ZodOptional<import("zod").ZodObject<{
41
42
  promotionalTitle: import("zod").ZodString;
@@ -44,6 +45,22 @@ export declare const audioSchema: import("zod").ZodObject<{
44
45
  }, {
45
46
  promotionalTitle: string;
46
47
  }>>;
48
+ dataSource: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
49
+ binaryUrl: import("zod").ZodString;
50
+ duration: import("zod").ZodNumber;
51
+ filesize: import("zod").ZodNumber;
52
+ mediaType: import("zod").ZodString;
53
+ }, "strip", import("zod").ZodTypeAny, {
54
+ binaryUrl: string;
55
+ duration: number;
56
+ mediaType: string;
57
+ filesize: number;
58
+ }, {
59
+ binaryUrl: string;
60
+ duration: number;
61
+ mediaType: string;
62
+ filesize: number;
63
+ }>, "many">>;
47
64
  mainImage: import("zod").ZodOptional<import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
48
65
  id: import("zod").ZodString;
49
66
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/ImageSet">;
@@ -300,26 +317,11 @@ export declare const audioSchema: import("zod").ZodObject<{
300
317
  pixelWidth?: number | undefined;
301
318
  pixelHeight?: number | undefined;
302
319
  }>]>>;
303
- dataSource: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodObject<{
304
- binaryUrl: import("zod").ZodString;
305
- duration: import("zod").ZodNumber;
306
- filesize: import("zod").ZodNumber;
307
- mediaType: import("zod").ZodString;
308
- }, "strip", import("zod").ZodTypeAny, {
309
- binaryUrl: string;
310
- duration: number;
311
- filesize: number;
312
- mediaType: string;
313
- }, {
314
- binaryUrl: string;
315
- duration: number;
316
- filesize: number;
317
- mediaType: string;
318
- }>, "many">>;
319
320
  }, "strip", import("zod").ZodTypeAny, {
320
321
  id: string;
321
322
  types: string[];
322
323
  title: string;
324
+ publishedDate: string;
323
325
  annotations: {
324
326
  id: string;
325
327
  apiUrl: string;
@@ -330,9 +332,9 @@ export declare const audioSchema: import("zod").ZodObject<{
330
332
  type?: string | undefined;
331
333
  headshot?: string | undefined;
332
334
  }[];
333
- publishedDate: string;
334
335
  firstPublishedDate: string;
335
336
  canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
337
+ canBeDistributed: "yes" | "no" | "verify";
336
338
  webUrl?: string | undefined;
337
339
  canonicalWebUrl?: string | undefined;
338
340
  accessLevel?: "premium" | "subscribed" | "registered" | "free" | undefined;
@@ -340,6 +342,12 @@ export declare const audioSchema: import("zod").ZodObject<{
340
342
  alternativeTitles?: {
341
343
  promotionalTitle: string;
342
344
  } | undefined;
345
+ dataSource?: {
346
+ binaryUrl: string;
347
+ duration: number;
348
+ mediaType: string;
349
+ filesize: number;
350
+ }[] | undefined;
343
351
  mainImage?: {
344
352
  id: string;
345
353
  type: "http://www.ft.com/ontology/content/Image";
@@ -402,16 +410,11 @@ export declare const audioSchema: import("zod").ZodObject<{
402
410
  })[];
403
411
  description?: string | undefined;
404
412
  } | undefined;
405
- dataSource?: {
406
- binaryUrl: string;
407
- duration: number;
408
- filesize: number;
409
- mediaType: string;
410
- }[] | undefined;
411
413
  }, {
412
414
  id: string;
413
415
  types: string[];
414
416
  title: string;
417
+ publishedDate: string;
415
418
  annotations: {
416
419
  id: string;
417
420
  apiUrl: string;
@@ -422,9 +425,9 @@ export declare const audioSchema: import("zod").ZodObject<{
422
425
  type?: string | undefined;
423
426
  headshot?: string | undefined;
424
427
  }[];
425
- publishedDate: string;
426
428
  firstPublishedDate: string;
427
429
  canBeSyndicated: "unknown" | "yes" | "no" | "verify" | "withContributorPayment";
430
+ canBeDistributed: "yes" | "no" | "verify";
428
431
  webUrl?: string | undefined;
429
432
  canonicalWebUrl?: string | undefined;
430
433
  accessLevel?: "premium" | "subscribed" | "registered" | "free" | undefined;
@@ -432,6 +435,12 @@ export declare const audioSchema: import("zod").ZodObject<{
432
435
  alternativeTitles?: {
433
436
  promotionalTitle: string;
434
437
  } | undefined;
438
+ dataSource?: {
439
+ binaryUrl: string;
440
+ duration: number;
441
+ mediaType: string;
442
+ filesize: number;
443
+ }[] | undefined;
435
444
  mainImage?: {
436
445
  id: string;
437
446
  type: "http://www.ft.com/ontology/content/Image";
@@ -494,10 +503,4 @@ export declare const audioSchema: import("zod").ZodObject<{
494
503
  })[];
495
504
  description?: string | undefined;
496
505
  } | undefined;
497
- dataSource?: {
498
- binaryUrl: string;
499
- duration: number;
500
- filesize: number;
501
- mediaType: string;
502
- }[] | undefined;
503
506
  }>;
@@ -17,6 +17,7 @@ const audioMetadataSchema = base_schema_1.baseMetadataSchema.pick({
17
17
  firstPublishedDate: true,
18
18
  accessLevel: true,
19
19
  canBeSyndicated: true,
20
+ canBeDistributed: true,
20
21
  });
21
22
  const audioMediaSchema = base_schema_1.baseMediaSchema.pick({
22
23
  mainImage: true,
@@ -1 +1 @@
1
- {"version":3,"file":"audio.js","sourceRoot":"","sources":["../../../../src/model/schemas/capi/audio.ts"],"names":[],"mappings":";;;AAAA,+CAIsB;AAEtB,MAAM,kBAAkB,GAAG,+BAAiB,CAAC,IAAI,CAAC;IAChD,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,iBAAiB,EAAE,IAAI;CACxB,CAAC,CAAA;AAEF,MAAM,mBAAmB,GAAG,gCAAkB,CAAC,IAAI,CAAC;IAClD,EAAE,EAAE,IAAI;IACR,WAAW,EAAE,IAAI;IACjB,MAAM,EAAE,IAAI;IACZ,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,IAAI;IACX,aAAa,EAAE,IAAI;IACnB,kBAAkB,EAAE,IAAI;IACxB,WAAW,EAAE,IAAI;IACjB,eAAe,EAAE,IAAI;CACtB,CAAC,CAAA;AAEF,MAAM,gBAAgB,GAAG,6BAAe,CAAC,IAAI,CAAC;IAC5C,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;CACjB,CAAC,CAAA;AAEW,QAAA,WAAW,GAAG,kBAAkB;KAC1C,KAAK,CAAC,mBAAmB,CAAC;KAC1B,KAAK,CAAC,gBAAgB,CAAC,CAAA"}
1
+ {"version":3,"file":"audio.js","sourceRoot":"","sources":["../../../../src/model/schemas/capi/audio.ts"],"names":[],"mappings":";;;AAAA,+CAIsB;AAEtB,MAAM,kBAAkB,GAAG,+BAAiB,CAAC,IAAI,CAAC;IAChD,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,IAAI;IACZ,iBAAiB,EAAE,IAAI;CACxB,CAAC,CAAA;AAEF,MAAM,mBAAmB,GAAG,gCAAkB,CAAC,IAAI,CAAC;IAClD,EAAE,EAAE,IAAI;IACR,WAAW,EAAE,IAAI;IACjB,MAAM,EAAE,IAAI;IACZ,eAAe,EAAE,IAAI;IACrB,KAAK,EAAE,IAAI;IACX,aAAa,EAAE,IAAI;IACnB,kBAAkB,EAAE,IAAI;IACxB,WAAW,EAAE,IAAI;IACjB,eAAe,EAAE,IAAI;IACrB,gBAAgB,EAAE,IAAI;CACvB,CAAC,CAAA;AAEF,MAAM,gBAAgB,GAAG,6BAAe,CAAC,IAAI,CAAC;IAC5C,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;CACjB,CAAC,CAAA;AAEW,QAAA,WAAW,GAAG,kBAAkB;KAC1C,KAAK,CAAC,mBAAmB,CAAC;KAC1B,KAAK,CAAC,gBAAgB,CAAC,CAAA"}