@financial-times/cp-content-pipeline-schema 3.11.0 → 3.12.1

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 (43) hide show
  1. package/CHANGELOG.md +15 -0
  2. package/README.md +4 -4
  3. package/lib/generated/index.d.ts +17 -4
  4. package/lib/model/Content.d.ts +1 -0
  5. package/lib/model/Content.js +6 -0
  6. package/lib/model/Content.js.map +1 -1
  7. package/lib/model/schemas/capi/article.d.ts +33 -34
  8. package/lib/model/schemas/capi/article.js +1 -0
  9. package/lib/model/schemas/capi/article.js.map +1 -1
  10. package/lib/model/schemas/capi/audio.d.ts +31 -34
  11. package/lib/model/schemas/capi/base-schema.d.ts +61 -68
  12. package/lib/model/schemas/capi/base-schema.js +8 -0
  13. package/lib/model/schemas/capi/base-schema.js.map +1 -1
  14. package/lib/model/schemas/capi/content-package.d.ts +32 -52
  15. package/lib/model/schemas/capi/custom-code-component.d.ts +37 -39
  16. package/lib/model/schemas/capi/index.d.ts +193 -227
  17. package/lib/model/schemas/capi/live-blog-package.d.ts +31 -34
  18. package/lib/model/schemas/capi/placeholder.d.ts +31 -34
  19. package/lib/model/schemas/capi/video.d.ts +31 -34
  20. package/lib/resolvers/content-tree/Workarounds.d.ts +2 -8
  21. package/lib/resolvers/content-tree/references/Video.d.ts +3 -3
  22. package/lib/resolvers/content-tree/tagMappings.js +0 -1
  23. package/lib/resolvers/content-tree/tagMappings.js.map +1 -1
  24. package/lib/resolvers/content.d.ts +1 -0
  25. package/lib/resolvers/content.js +1 -0
  26. package/lib/resolvers/content.js.map +1 -1
  27. package/lib/resolvers/index.d.ts +2 -0
  28. package/lib/resolvers/scalars.d.ts +2 -0
  29. package/lib/resolvers/scalars.js +11 -1
  30. package/lib/resolvers/scalars.js.map +1 -1
  31. package/package.json +4 -4
  32. package/queries/article.graphql +1 -0
  33. package/src/generated/index.ts +15 -4
  34. package/src/model/Content.ts +6 -0
  35. package/src/model/schemas/capi/article.ts +1 -0
  36. package/src/model/schemas/capi/base-schema.ts +8 -0
  37. package/src/resolvers/content-tree/Workarounds.ts +2 -9
  38. package/src/resolvers/content-tree/tagMappings.ts +0 -1
  39. package/src/resolvers/content.ts +1 -0
  40. package/src/resolvers/scalars.ts +18 -0
  41. package/tsconfig.tsbuildinfo +1 -1
  42. package/typedefs/content.graphql +3 -0
  43. package/typedefs/scalars.graphql +1 -0
package/lib/model/schemas/capi/audio.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export declare const audioSchema: import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<Pick<{
1
+ export declare const audioSchema: import("zod").ZodObject<Pick<{
2
2
  title: import("zod").ZodString;
3
3
  standfirst: import("zod").ZodOptional<import("zod").ZodString>;
4
4
  byline: import("zod").ZodOptional<import("zod").ZodString>;
@@ -43,9 +43,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
43
43
  theme: "special-report" | "extra" | "basic" | "extra-wide";
44
44
  }>;
45
45
  transcript: import("zod").ZodOptional<import("zod").ZodString>;
46
- }, "title" | "byline" | "alternativeTitles">, Pick<{
46
+ }, "title" | "byline" | "alternativeTitles"> & Pick<{
47
47
  id: import("zod").ZodString;
48
- annotations: import("zod").ZodArray<import("zod").ZodObject<import("zod").objectUtil.extendShape<{
48
+ annotations: import("zod").ZodArray<import("zod").ZodObject<{
49
49
  id: import("zod").ZodString;
50
50
  apiUrl: import("zod").ZodString;
51
51
  directType: import("zod").ZodString;
@@ -53,9 +53,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
53
53
  type: import("zod").ZodOptional<import("zod").ZodString>;
54
54
  types: import("zod").ZodArray<import("zod").ZodString, "many">;
55
55
  headshot: import("zod").ZodOptional<import("zod").ZodString>;
56
- }, {
56
+ } & {
57
57
  predicate: import("zod").ZodString;
58
- }>, "strip", import("zod").ZodTypeAny, {
58
+ }, "strip", import("zod").ZodTypeAny, {
59
59
  id: string;
60
60
  apiUrl: string;
61
61
  directType: string;
@@ -157,8 +157,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
157
157
  }>>;
158
158
  publication: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
159
159
  clientName: import("zod").ZodOptional<import("zod").ZodString>;
160
+ disclaimerType: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"co-created-content">, import("zod").ZodLiteral<"client-supplied-content">, import("zod").ZodLiteral<"ft-studios-risky">, import("zod").ZodLiteral<"auditor">]>>;
160
161
  internalAnalyticsTags: import("zod").ZodOptional<import("zod").ZodString>;
161
- }, "id" | "types" | "publishedDate" | "annotations" | "webUrl" | "canonicalWebUrl" | "firstPublishedDate" | "publishReference" | "lastModified" | "editorialDesk" | "accessLevel" | "canBeSyndicated" | "canBeDistributed" | "internalAnalyticsTags">>, Pick<{
162
+ }, "id" | "types" | "publishedDate" | "annotations" | "webUrl" | "canonicalWebUrl" | "firstPublishedDate" | "publishReference" | "lastModified" | "editorialDesk" | "accessLevel" | "canBeSyndicated" | "canBeDistributed" | "internalAnalyticsTags"> & Pick<{
162
163
  mainImage: import("zod").ZodOptional<import("zod").ZodDiscriminatedUnion<"type", [import("zod").ZodObject<{
163
164
  id: import("zod").ZodString;
164
165
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/ImageSet">;
@@ -209,9 +210,8 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
209
210
  maxDisplayWidth?: string | undefined;
210
211
  pixelWidth?: number | undefined;
211
212
  pixelHeight?: number | undefined;
212
- }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
213
+ }>, import("zod").ZodObject<{
213
214
  id: import("zod").ZodString;
214
- type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
215
215
  format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
216
216
  title: import("zod").ZodOptional<import("zod").ZodString>;
217
217
  description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -227,9 +227,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
227
227
  maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
228
228
  pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
229
229
  pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
230
- }, {
230
+ } & {
231
231
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
232
- }>, "strip", import("zod").ZodTypeAny, {
232
+ }, "strip", import("zod").ZodTypeAny, {
233
233
  id: string;
234
234
  type: "http://www.ft.com/ontology/content/Graphic";
235
235
  binaryUrl: string;
@@ -370,9 +370,8 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
370
370
  maxDisplayWidth?: string | undefined;
371
371
  pixelWidth?: number | undefined;
372
372
  pixelHeight?: number | undefined;
373
- }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
373
+ }>, import("zod").ZodObject<{
374
374
  id: import("zod").ZodString;
375
- type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
376
375
  format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
377
376
  title: import("zod").ZodOptional<import("zod").ZodString>;
378
377
  description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -388,9 +387,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
388
387
  maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
389
388
  pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
390
389
  pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
391
- }, {
390
+ } & {
392
391
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
393
- }>, "strip", import("zod").ZodTypeAny, {
392
+ }, "strip", import("zod").ZodTypeAny, {
394
393
  id: string;
395
394
  type: "http://www.ft.com/ontology/content/Graphic";
396
395
  binaryUrl: string;
@@ -468,9 +467,8 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
468
467
  maxDisplayWidth?: string | undefined;
469
468
  pixelWidth?: number | undefined;
470
469
  pixelHeight?: number | undefined;
471
- }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
470
+ }>, import("zod").ZodObject<{
472
471
  id: import("zod").ZodString;
473
- type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
474
472
  format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
475
473
  title: import("zod").ZodOptional<import("zod").ZodString>;
476
474
  description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -486,9 +484,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
486
484
  maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
487
485
  pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
488
486
  pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
489
- }, {
487
+ } & {
490
488
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
491
- }>, "strip", import("zod").ZodTypeAny, {
489
+ }, "strip", import("zod").ZodTypeAny, {
492
490
  id: string;
493
491
  type: "http://www.ft.com/ontology/content/Graphic";
494
492
  binaryUrl: string;
@@ -726,9 +724,8 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
726
724
  maxDisplayWidth?: string | undefined;
727
725
  pixelWidth?: number | undefined;
728
726
  pixelHeight?: number | undefined;
729
- }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
727
+ }>, import("zod").ZodObject<{
730
728
  id: import("zod").ZodString;
731
- type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
732
729
  format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
733
730
  title: import("zod").ZodOptional<import("zod").ZodString>;
734
731
  description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -744,9 +741,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
744
741
  maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
745
742
  pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
746
743
  pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
747
- }, {
744
+ } & {
748
745
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
749
- }>, "strip", import("zod").ZodTypeAny, {
746
+ }, "strip", import("zod").ZodTypeAny, {
750
747
  id: string;
751
748
  type: "http://www.ft.com/ontology/content/Graphic";
752
749
  binaryUrl: string;
@@ -923,9 +920,8 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
923
920
  maxDisplayWidth?: string | undefined;
924
921
  pixelWidth?: number | undefined;
925
922
  pixelHeight?: number | undefined;
926
- }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<{
923
+ }>, import("zod").ZodObject<{
927
924
  id: import("zod").ZodString;
928
- type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Image">;
929
925
  format: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"standardInline">, import("zod").ZodLiteral<"mobile">, import("zod").ZodLiteral<"desktop">, import("zod").ZodLiteral<"standard">, import("zod").ZodLiteral<"square">, import("zod").ZodLiteral<"ftEditSquare">, import("zod").ZodLiteral<"wide">, import("zod").ZodLiteral<"portrait">, import("zod").ZodLiteral<"landscape">]>>;
930
926
  title: import("zod").ZodOptional<import("zod").ZodString>;
931
927
  description: import("zod").ZodOptional<import("zod").ZodString>;
@@ -941,9 +937,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
941
937
  maxDisplayWidth: import("zod").ZodOptional<import("zod").ZodString>;
942
938
  pixelWidth: import("zod").ZodOptional<import("zod").ZodNumber>;
943
939
  pixelHeight: import("zod").ZodOptional<import("zod").ZodNumber>;
944
- }, {
940
+ } & {
945
941
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/Graphic">;
946
- }>, "strip", import("zod").ZodTypeAny, {
942
+ }, "strip", import("zod").ZodTypeAny, {
947
943
  id: string;
948
944
  type: "http://www.ft.com/ontology/content/Graphic";
949
945
  binaryUrl: string;
@@ -1305,9 +1301,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
1305
1301
  }[] | undefined;
1306
1302
  transcript?: string | undefined;
1307
1303
  } | undefined;
1308
- }>, import("zod").ZodObject<import("zod").objectUtil.extendShape<import("zod").objectUtil.extendShape<Pick<{
1304
+ }>, import("zod").ZodObject<Pick<{
1309
1305
  id: import("zod").ZodString;
1310
- annotations: import("zod").ZodArray<import("zod").ZodObject<import("zod").objectUtil.extendShape<{
1306
+ annotations: import("zod").ZodArray<import("zod").ZodObject<{
1311
1307
  id: import("zod").ZodString;
1312
1308
  apiUrl: import("zod").ZodString;
1313
1309
  directType: import("zod").ZodString;
@@ -1315,9 +1311,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
1315
1311
  type: import("zod").ZodOptional<import("zod").ZodString>;
1316
1312
  types: import("zod").ZodArray<import("zod").ZodString, "many">;
1317
1313
  headshot: import("zod").ZodOptional<import("zod").ZodString>;
1318
- }, {
1314
+ } & {
1319
1315
  predicate: import("zod").ZodString;
1320
- }>, "strip", import("zod").ZodTypeAny, {
1316
+ }, "strip", import("zod").ZodTypeAny, {
1321
1317
  id: string;
1322
1318
  apiUrl: string;
1323
1319
  directType: string;
@@ -1419,8 +1415,9 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
1419
1415
  }>>;
1420
1416
  publication: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString, "many">>;
1421
1417
  clientName: import("zod").ZodOptional<import("zod").ZodString>;
1418
+ disclaimerType: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodLiteral<"co-created-content">, import("zod").ZodLiteral<"client-supplied-content">, import("zod").ZodLiteral<"ft-studios-risky">, import("zod").ZodLiteral<"auditor">]>>;
1422
1419
  internalAnalyticsTags: import("zod").ZodOptional<import("zod").ZodString>;
1423
- }, "id" | "publishedDate" | "canonicalWebUrl" | "firstPublishedDate" | "publishReference" | "canBeSyndicated" | "canBeDistributed">, Pick<{
1420
+ }, "id" | "publishedDate" | "canonicalWebUrl" | "firstPublishedDate" | "publishReference" | "canBeSyndicated" | "canBeDistributed"> & Pick<{
1424
1421
  title: import("zod").ZodString;
1425
1422
  standfirst: import("zod").ZodOptional<import("zod").ZodString>;
1426
1423
  byline: import("zod").ZodOptional<import("zod").ZodString>;
@@ -1465,13 +1462,13 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
1465
1462
  theme: "special-report" | "extra" | "basic" | "extra-wide";
1466
1463
  }>;
1467
1464
  transcript: import("zod").ZodOptional<import("zod").ZodString>;
1468
- }, "bodyXML">>, {
1465
+ }, "bodyXML"> & {
1469
1466
  apiUrl: import("zod").ZodString;
1470
1467
  type: import("zod").ZodLiteral<"http://www.ft.com/ontology/content/CustomCodeComponent">;
1471
1468
  path: import("zod").ZodString;
1472
1469
  versionRange: import("zod").ZodString;
1473
1470
  attributes: import("zod").ZodRecord<import("zod").ZodString, import("zod").ZodUnion<[import("zod").ZodString, import("zod").ZodBoolean, import("zod").ZodUndefined]>>;
1474
- }>, "strip", import("zod").ZodTypeAny, {
1471
+ }, "strip", import("zod").ZodTypeAny, {
1475
1472
  id: string;
1476
1473
  apiUrl: string;
1477
1474
  type: "http://www.ft.com/ontology/content/CustomCodeComponent";
@@ -1516,7 +1513,7 @@ export declare const audioSchema: import("zod").ZodObject<import("zod").objectUt
1516
1513
  mediaType: string;
1517
1514
  filesize?: number | undefined;
1518
1515
  }>, "many">>;
1519
- }, "dataSource" | "mainImage">>, "strip", import("zod").ZodTypeAny, {
1516
+ }, "dataSource" | "mainImage">, "strip", import("zod").ZodTypeAny, {
1520
1517
  id: string;
1521
1518
  types: string[];
1522
1519
  title: string;