@code.store/arcxp-sdk-ts 4.49.1 → 5.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.
Files changed (194) hide show
  1. package/dist/api/abstract-api.d.ts +2 -2
  2. package/dist/api/author/index.d.ts +2 -2
  3. package/dist/api/author/types.d.ts +32 -1
  4. package/dist/api/content/index.d.ts +4 -4
  5. package/dist/api/content/types.d.ts +3 -4
  6. package/dist/api/content-ops/index.d.ts +2 -2
  7. package/dist/api/custom/index.d.ts +1 -1
  8. package/dist/api/draft/index.d.ts +4 -4
  9. package/dist/api/draft/types.d.ts +4 -4
  10. package/dist/api/global-settings/index.d.ts +2 -2
  11. package/dist/api/identity/index.d.ts +2 -2
  12. package/dist/api/ifx/index.d.ts +2 -2
  13. package/dist/api/index.d.ts +19 -20
  14. package/dist/api/migration-center/index.d.ts +2 -2
  15. package/dist/api/migration-center/types.d.ts +4 -38
  16. package/dist/api/photo-center/index.d.ts +8 -9
  17. package/dist/api/photo-center/types.d.ts +3 -4
  18. package/dist/api/redirect/index.d.ts +2 -2
  19. package/dist/api/retail-events/index.d.ts +2 -2
  20. package/dist/api/sales/index.d.ts +2 -2
  21. package/dist/api/signing-service/index.d.ts +2 -2
  22. package/dist/api/site/index.d.ts +3 -4
  23. package/dist/api/site/types.d.ts +88 -1
  24. package/dist/api/tags/index.d.ts +2 -2
  25. package/dist/api/websked/index.d.ts +2 -2
  26. package/dist/api/ws.client.d.ts +1 -1
  27. package/dist/content-elements/content-elements.d.ts +54 -54
  28. package/dist/content-elements/html/html.processor.d.ts +7 -7
  29. package/dist/content-elements/html/html.utils.d.ts +2 -2
  30. package/dist/content-elements/html/index.d.ts +3 -3
  31. package/dist/content-elements/index.d.ts +2 -2
  32. package/dist/content-elements/types.d.ts +4 -0
  33. package/dist/index.cjs +2082 -0
  34. package/dist/index.cjs.map +1 -0
  35. package/dist/index.d.ts +9 -20
  36. package/dist/index.js +2048 -61
  37. package/dist/index.js.map +1 -1
  38. package/dist/lib/platform/index.d.ts +6 -0
  39. package/dist/lib/platform/node.d.ts +6 -0
  40. package/dist/mapper/doc.d.ts +26 -25
  41. package/dist/mapper/index.d.ts +2 -2
  42. package/dist/mapper/story.d.ts +4 -4
  43. package/dist/types/{story.d.ts → ans-types.d.ts} +378 -85
  44. package/dist/types/index.d.ts +15 -7
  45. package/dist/utils/arc/ans.d.ts +2 -2
  46. package/dist/utils/arc/content.d.ts +1 -1
  47. package/dist/utils/arc/index.d.ts +5 -3
  48. package/dist/utils/arc/section.d.ts +33 -0
  49. package/dist/utils/decorator.d.ts +1 -1
  50. package/package.json +26 -10
  51. package/dist/api/abstract-api.js +0 -61
  52. package/dist/api/abstract-api.js.map +0 -1
  53. package/dist/api/author/index.js +0 -19
  54. package/dist/api/author/index.js.map +0 -1
  55. package/dist/api/author/types.js +0 -3
  56. package/dist/api/author/types.js.map +0 -1
  57. package/dist/api/content/index.js +0 -29
  58. package/dist/api/content/index.js.map +0 -1
  59. package/dist/api/content/types.js +0 -3
  60. package/dist/api/content/types.js.map +0 -1
  61. package/dist/api/content-ops/index.js +0 -27
  62. package/dist/api/content-ops/index.js.map +0 -1
  63. package/dist/api/content-ops/types.js +0 -3
  64. package/dist/api/content-ops/types.js.map +0 -1
  65. package/dist/api/custom/index.js +0 -18
  66. package/dist/api/custom/index.js.map +0 -1
  67. package/dist/api/draft/index.js +0 -63
  68. package/dist/api/draft/index.js.map +0 -1
  69. package/dist/api/draft/types.js +0 -3
  70. package/dist/api/draft/types.js.map +0 -1
  71. package/dist/api/error.js +0 -26
  72. package/dist/api/error.js.map +0 -1
  73. package/dist/api/global-settings/index.js +0 -19
  74. package/dist/api/global-settings/index.js.map +0 -1
  75. package/dist/api/global-settings/types.js +0 -3
  76. package/dist/api/global-settings/types.js.map +0 -1
  77. package/dist/api/identity/index.js +0 -35
  78. package/dist/api/identity/index.js.map +0 -1
  79. package/dist/api/identity/types.js +0 -3
  80. package/dist/api/identity/types.js.map +0 -1
  81. package/dist/api/ifx/index.js +0 -94
  82. package/dist/api/ifx/index.js.map +0 -1
  83. package/dist/api/ifx/types.js +0 -3
  84. package/dist/api/ifx/types.js.map +0 -1
  85. package/dist/api/index.js +0 -49
  86. package/dist/api/index.js.map +0 -1
  87. package/dist/api/migration-center/index.js +0 -45
  88. package/dist/api/migration-center/index.js.map +0 -1
  89. package/dist/api/migration-center/types.js +0 -41
  90. package/dist/api/migration-center/types.js.map +0 -1
  91. package/dist/api/photo-center/index.js +0 -64
  92. package/dist/api/photo-center/index.js.map +0 -1
  93. package/dist/api/photo-center/types.js +0 -3
  94. package/dist/api/photo-center/types.js.map +0 -1
  95. package/dist/api/redirect/index.js +0 -23
  96. package/dist/api/redirect/index.js.map +0 -1
  97. package/dist/api/redirect/types.js +0 -3
  98. package/dist/api/redirect/types.js.map +0 -1
  99. package/dist/api/retail-events/index.js +0 -18
  100. package/dist/api/retail-events/index.js.map +0 -1
  101. package/dist/api/sales/index.js +0 -25
  102. package/dist/api/sales/index.js.map +0 -1
  103. package/dist/api/sales/types.js +0 -3
  104. package/dist/api/sales/types.js.map +0 -1
  105. package/dist/api/signing-service/index.js +0 -15
  106. package/dist/api/signing-service/index.js.map +0 -1
  107. package/dist/api/signing-service/types.js +0 -3
  108. package/dist/api/signing-service/types.js.map +0 -1
  109. package/dist/api/site/index.js +0 -44
  110. package/dist/api/site/index.js.map +0 -1
  111. package/dist/api/site/types.js +0 -3
  112. package/dist/api/site/types.js.map +0 -1
  113. package/dist/api/tags/index.js +0 -36
  114. package/dist/api/tags/index.js.map +0 -1
  115. package/dist/api/tags/types.js +0 -3
  116. package/dist/api/tags/types.js.map +0 -1
  117. package/dist/api/websked/index.js +0 -47
  118. package/dist/api/websked/index.js.map +0 -1
  119. package/dist/api/websked/types.js +0 -3
  120. package/dist/api/websked/types.js.map +0 -1
  121. package/dist/api/ws.client.js +0 -68
  122. package/dist/api/ws.client.js.map +0 -1
  123. package/dist/content-elements/content-elements.js +0 -235
  124. package/dist/content-elements/content-elements.js.map +0 -1
  125. package/dist/content-elements/html/html.constants.js +0 -40
  126. package/dist/content-elements/html/html.constants.js.map +0 -1
  127. package/dist/content-elements/html/html.processor.js +0 -370
  128. package/dist/content-elements/html/html.processor.js.map +0 -1
  129. package/dist/content-elements/html/html.utils.js +0 -79
  130. package/dist/content-elements/html/html.utils.js.map +0 -1
  131. package/dist/content-elements/html/index.js +0 -41
  132. package/dist/content-elements/html/index.js.map +0 -1
  133. package/dist/content-elements/index.js +0 -42
  134. package/dist/content-elements/index.js.map +0 -1
  135. package/dist/mapper/doc.js +0 -146
  136. package/dist/mapper/doc.js.map +0 -1
  137. package/dist/mapper/index.js +0 -8
  138. package/dist/mapper/index.js.map +0 -1
  139. package/dist/mapper/story.js +0 -111
  140. package/dist/mapper/story.js.map +0 -1
  141. package/dist/scripts/json-schema-to-ts.js +0 -8
  142. package/dist/scripts/json-schema-to-ts.js.map +0 -1
  143. package/dist/tests/ans/mapper.test.d.ts +0 -1
  144. package/dist/tests/ans/mapper.test.js +0 -93
  145. package/dist/tests/ans/mapper.test.js.map +0 -1
  146. package/dist/tests/api/basic.test.d.ts +0 -1
  147. package/dist/tests/api/basic.test.js +0 -20
  148. package/dist/tests/api/basic.test.js.map +0 -1
  149. package/dist/tests/api/retry.test.d.ts +0 -1
  150. package/dist/tests/api/retry.test.js +0 -51
  151. package/dist/tests/api/retry.test.js.map +0 -1
  152. package/dist/tests/api/utils.test.d.ts +0 -1
  153. package/dist/tests/api/utils.test.js +0 -255
  154. package/dist/tests/api/utils.test.js.map +0 -1
  155. package/dist/tests/content-elements/html.processor.test.d.ts +0 -1
  156. package/dist/tests/content-elements/html.processor.test.js +0 -35
  157. package/dist/tests/content-elements/html.processor.test.js.map +0 -1
  158. package/dist/types/author.d.ts +0 -1640
  159. package/dist/types/author.js +0 -8
  160. package/dist/types/author.js.map +0 -1
  161. package/dist/types/content-elements.d.ts +0 -4
  162. package/dist/types/content-elements.js +0 -3
  163. package/dist/types/content-elements.js.map +0 -1
  164. package/dist/types/gallery.d.ts +0 -52
  165. package/dist/types/gallery.js +0 -3
  166. package/dist/types/gallery.js.map +0 -1
  167. package/dist/types/index.js +0 -44
  168. package/dist/types/index.js.map +0 -1
  169. package/dist/types/section.d.ts +0 -88
  170. package/dist/types/section.js +0 -3
  171. package/dist/types/section.js.map +0 -1
  172. package/dist/types/story.js +0 -8
  173. package/dist/types/story.js.map +0 -1
  174. package/dist/types/utils.js +0 -3
  175. package/dist/types/utils.js.map +0 -1
  176. package/dist/types/video.d.ts +0 -1425
  177. package/dist/types/video.js +0 -8
  178. package/dist/types/video.js.map +0 -1
  179. package/dist/utils/arc/ans.js +0 -14
  180. package/dist/utils/arc/ans.js.map +0 -1
  181. package/dist/utils/arc/content.js +0 -79
  182. package/dist/utils/arc/content.js.map +0 -1
  183. package/dist/utils/arc/id.js +0 -40
  184. package/dist/utils/arc/id.js.map +0 -1
  185. package/dist/utils/arc/index.js +0 -45
  186. package/dist/utils/arc/index.js.map +0 -1
  187. package/dist/utils/cache.js +0 -63
  188. package/dist/utils/cache.js.map +0 -1
  189. package/dist/utils/decorator.js +0 -20
  190. package/dist/utils/decorator.js.map +0 -1
  191. package/dist/utils/duration.js +0 -21
  192. package/dist/utils/duration.js.map +0 -1
  193. package/dist/utils/index.js +0 -52
  194. package/dist/utils/index.js.map +0 -1
@@ -10,7 +10,7 @@ export type GloballyUniqueIDTrait = string;
10
10
  /**
11
11
  * The version of ANS that this object was serialized as, in major.minor.patch format. For top-level content objects, this is a required trait.
12
12
  */
13
- export type DescribesTheANSVersionOfThisObject = '0.10.10';
13
+ export type DescribesTheANSVersionOfThisObject = '0.10.12';
14
14
  /**
15
15
  * A user-defined categorization method to supplement type. In Arc, this field is reserved for organization-defined purposes, such as selecting the PageBuilder template that should be used to render a document.
16
16
  */
@@ -162,7 +162,7 @@ export type SEOFilename = string;
162
162
  export type SocialLinks = {
163
163
  site?: string;
164
164
  url?: string;
165
- [k: string]: unknown | undefined;
165
+ [k: string]: unknown;
166
166
  }[];
167
167
  /**
168
168
  * The real first name of a human author.
@@ -264,7 +264,7 @@ export type Org = string;
264
264
  export type SocialLinks1 = {
265
265
  site?: string;
266
266
  url?: string;
267
- [k: string]: unknown | undefined;
267
+ [k: string]: unknown;
268
268
  }[];
269
269
  /**
270
270
  * The primary author(s) of this document. For a story, is is the writer or reporter. For an image, it is the photographer.
@@ -274,14 +274,18 @@ export type By = (AnAuthorOfAPieceOfContent | RepresentationOfANormalizedElement
274
274
  * The photographer(s) of supplementary images included in this document, if it is a story. Note that if this document is an image, the photographer(s) should appear in the 'by' slot.
275
275
  */
276
276
  export type PhotosBy1 = (AnAuthorOfAPieceOfContent | RepresentationOfANormalizedElement)[];
277
- /**
278
- * Trait that applies a list of corrections to a document.
279
- */
280
- export type Corrections = Correction[];
281
277
  /**
282
278
  * Holds attributes of an ANS collection - a common parent to story and gallery objects.
283
279
  */
284
280
  export type ACollectionOfContent = AnElementThatCanBeListedAsPartOfContentElements[];
281
+ /**
282
+ * The absolute URL of the document on website which will override any relative URL specified by the `canonical_url` field.
283
+ */
284
+ export type CanonicalExternalURL = string;
285
+ /**
286
+ * Trait that applies a list of corrections to a document.
287
+ */
288
+ export type Corrections = Correction[];
285
289
  /**
286
290
  * True if and only if at least one published edition exists for this content item.
287
291
  */
@@ -350,8 +354,8 @@ export type VoiceTranscriptSConfigurationAndOutput = [
350
354
  subtype?: SubtypeOrTemplate;
351
355
  options: OptionsRequested;
352
356
  options_used?: OptionsUsed;
353
- output?: HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01010AudioJson;
354
- [k: string]: unknown | undefined;
357
+ output?: HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01012AudioJson;
358
+ [k: string]: unknown;
355
359
  },
356
360
  ...{
357
361
  _id?: GloballyUniqueIDTrait;
@@ -359,8 +363,8 @@ export type VoiceTranscriptSConfigurationAndOutput = [
359
363
  subtype?: SubtypeOrTemplate;
360
364
  options: OptionsRequested;
361
365
  options_used?: OptionsUsed;
362
- output?: HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01010AudioJson;
363
- [k: string]: unknown | undefined;
366
+ output?: HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01012AudioJson;
367
+ [k: string]: unknown;
364
368
  }[]
365
369
  ];
366
370
  /**
@@ -382,7 +386,7 @@ export type VoiceID1 = string;
382
386
  /**
383
387
  * Audio Content
384
388
  */
385
- export type HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01010AudioJson = {
389
+ export type HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01012AudioJson = {
386
390
  type: 'audio';
387
391
  _id?: GloballyUniqueIDTrait;
388
392
  version: DescribesTheANSVersionOfThisObject;
@@ -457,9 +461,9 @@ export type HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainReso
457
461
  */
458
462
  streams?: [AStreamOfAudio, ...AStreamOfAudio[]];
459
463
  } & ({
460
- [k: string]: unknown | undefined;
464
+ [k: string]: unknown;
461
465
  } | {
462
- [k: string]: unknown | undefined;
466
+ [k: string]: unknown;
463
467
  });
464
468
  /**
465
469
  * The size of the audio file in bytes.
@@ -481,11 +485,16 @@ export type URL1 = string;
481
485
  * The bitrate of the audio in kilobytes per second.
482
486
  */
483
487
  export type Bitrate = number;
488
+ export interface Root {
489
+ gallery_root: AGallery;
490
+ story_root: AStory;
491
+ video_root: VideoContent;
492
+ }
484
493
  /**
485
- * Holds attributes of an ANS story. In the Arc ecosystem, these are stored in the Story API.
494
+ * Holds attributes of an ANS gallery. In the Arc ecosystem, these are stored in Anglerfish.
486
495
  */
487
- export interface AStory {
488
- type: 'story';
496
+ export interface AGallery {
497
+ type: 'gallery';
489
498
  _id?: GloballyUniqueIDTrait;
490
499
  version: DescribesTheANSVersionOfThisObject;
491
500
  subtype?: SubtypeOrTemplate;
@@ -529,14 +538,9 @@ export interface AStory {
529
538
  label?: Label;
530
539
  slug?: Slug;
531
540
  content_restrictions?: ContentRestrictions;
532
- rendering_guides?: RenderingGuides;
533
541
  additional_properties?: HasAdditionalProperties;
534
542
  content_aliases?: AliasesTrait;
535
- corrections?: Corrections;
536
543
  content_elements?: ACollectionOfContent;
537
- publishing?: PublishingInformation;
538
- variations?: VariantContentMetadata;
539
- voice_transcripts?: VoiceTranscriptSConfigurationAndOutput;
540
544
  websites?: WebsitesInput;
541
545
  contributors?: Contributors;
542
546
  }
@@ -546,7 +550,7 @@ export interface AStory {
546
550
  export interface Geo {
547
551
  latitude?: number;
548
552
  longitude?: number;
549
- [k: string]: unknown | undefined;
553
+ [k: string]: unknown;
550
554
  }
551
555
  /**
552
556
  * An Address following the convention of http://microformats.org/wiki/hcard
@@ -565,7 +569,7 @@ export interface Address {
565
569
  * A grab-bag object for non-validatable data.
566
570
  */
567
571
  export interface HasAdditionalProperties {
568
- [k: string]: unknown | undefined;
572
+ [k: string]: unknown;
569
573
  }
570
574
  /**
571
575
  * The headline(s) or title for this content. The 'basic' key is required.
@@ -794,7 +798,7 @@ export interface RepresentationOfANormalizedElement {
794
798
  * An object for key-value pairs that should override the values of keys with the same name in the denormalized object
795
799
  */
796
800
  referent_properties?: {
797
- [k: string]: unknown | undefined;
801
+ [k: string]: unknown;
798
802
  };
799
803
  };
800
804
  }
@@ -840,14 +844,14 @@ export interface Taxonomy {
840
844
  */
841
845
  custom_entities?: CustomEntity[];
842
846
  /**
843
- * Deprecated in 0.10.10. (See `primary_section` instead.) A primary site object or reference to one. In the Arc ecosystem, a reference here is denormalized into a site from the arc-site-service.
847
+ * Deprecated in 0.10.12. (See `primary_section` instead.) A primary site object or reference to one. In the Arc ecosystem, a reference here is denormalized into a site from the arc-site-service.
844
848
  */
845
849
  primary_site?: Site | (RepresentationOfANormalizedElement & {
846
850
  referent?: {
847
851
  type?: 'site';
848
- [k: string]: unknown | undefined;
852
+ [k: string]: unknown;
849
853
  };
850
- [k: string]: unknown | undefined;
854
+ [k: string]: unknown;
851
855
  });
852
856
  /**
853
857
  * A primary section object or reference to one. In the Arc ecosystem, a reference here is denormalized into a site from the arc-site-service.
@@ -855,19 +859,19 @@ export interface Taxonomy {
855
859
  primary_section?: Section | (RepresentationOfANormalizedElement & {
856
860
  referent?: {
857
861
  type?: 'section';
858
- [k: string]: unknown | undefined;
862
+ [k: string]: unknown;
859
863
  };
860
- [k: string]: unknown | undefined;
864
+ [k: string]: unknown;
861
865
  });
862
866
  /**
863
- * Deprecated in 0.10.10. (See `sections` instead.) A list of site objects or references to them. In the Arc ecosystem, references in this list are denormalized into sites from the arc-site-service. In a multi-site context, sites will be denormalized against an organization's default website only.
867
+ * Deprecated in 0.10.12. (See `sections` instead.) A list of site objects or references to them. In the Arc ecosystem, references in this list are denormalized into sites from the arc-site-service. In a multi-site context, sites will be denormalized against an organization's default website only.
864
868
  */
865
869
  sites?: (Site | (RepresentationOfANormalizedElement & {
866
870
  referent?: {
867
871
  type?: 'site';
868
- [k: string]: unknown | undefined;
872
+ [k: string]: unknown;
869
873
  };
870
- [k: string]: unknown | undefined;
874
+ [k: string]: unknown;
871
875
  }))[];
872
876
  /**
873
877
  * A list of site objects or references to them. In the Arc ecosystem, references in this list are denormalized into sites from the arc-site-service. In a multi-site context, sites will be denormalized against an organization's default website only.
@@ -875,9 +879,9 @@ export interface Taxonomy {
875
879
  sections?: (Section | (RepresentationOfANormalizedElement & {
876
880
  referent?: {
877
881
  type?: 'section';
878
- [k: string]: unknown | undefined;
882
+ [k: string]: unknown;
879
883
  };
880
- [k: string]: unknown | undefined;
884
+ [k: string]: unknown;
881
885
  }))[];
882
886
  /**
883
887
  * A list of user-editable manually entered keywords for search purposes. In the Arc ecosystem, these can be generated and saved in source CMS systems, editors, etc.
@@ -1158,7 +1162,7 @@ export interface Section {
1158
1162
  */
1159
1163
  parent?: {
1160
1164
  default?: string;
1161
- [k: string]: unknown | undefined;
1165
+ [k: string]: unknown;
1162
1166
  };
1163
1167
  /**
1164
1168
  * Is this the primary site?
@@ -1169,12 +1173,12 @@ export interface Section {
1169
1173
  * Lists of promotional content to use when highlighting the story. In the Arc ecosystem, references in these lists will be denormalized.
1170
1174
  */
1171
1175
  export interface PromoItems {
1172
- basic?: AContentObject | RepresentationOfANormalizedElement | HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01010StoryElementsRawHtmlJson | CustomEmbed;
1176
+ basic?: AContentObject | RepresentationOfANormalizedElement | HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01012StoryElementsRawHtmlJson | CustomEmbed;
1173
1177
  /**
1174
1178
  * This interface was referenced by `PromoItems`'s JSON-Schema definition
1175
1179
  * via the `patternProperty` ".*".
1176
1180
  */
1177
- [k: string]: AContentObject | RepresentationOfANormalizedElement | HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01010StoryElementsRawHtmlJson | CustomEmbed | undefined;
1181
+ [k: string]: AContentObject | RepresentationOfANormalizedElement | HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01012StoryElementsRawHtmlJson | CustomEmbed | undefined;
1178
1182
  }
1179
1183
  /**
1180
1184
  * Holds common attributes of ANS Content objects.
@@ -1224,7 +1228,7 @@ export interface AContentObject {
1224
1228
  additional_properties?: HasAdditionalProperties;
1225
1229
  content_aliases?: AliasesTrait;
1226
1230
  contributors?: Contributors;
1227
- [k: string]: unknown | undefined;
1231
+ [k: string]: unknown;
1228
1232
  }
1229
1233
  /**
1230
1234
  * Lists of content items or references this story is related to, arbitrarily keyed. In the Arc ecosystem, references in this object will be denormalized into the fully-inflated content objects they represent.
@@ -1240,7 +1244,7 @@ export interface Related_Content {
1240
1244
  * This interface was referenced by `Related_Content`'s JSON-Schema definition
1241
1245
  * via the `patternProperty` ".*".
1242
1246
  */
1243
- [k: string]: (AContentObject | RepresentationOfANormalizedElement | CustomEmbed)[] | [ARedirectObject] | undefined;
1247
+ [k: string]: [ARedirectObject] | (AContentObject | RepresentationOfANormalizedElement | CustomEmbed)[] | undefined;
1244
1248
  }
1245
1249
  /**
1246
1250
  * A redirect to another story.
@@ -1263,14 +1267,14 @@ export interface OwnerInformation {
1263
1267
  */
1264
1268
  id?: string;
1265
1269
  /**
1266
- * Deprecated in 0.10.10. See `distributor.name`. (Formerly: The human-readable name of original producer of content. Distinguishes between Wires, Staff and other sources.)
1270
+ * Deprecated in 0.10.12. See `distributor.name`. (Formerly: The human-readable name of original producer of content. Distinguishes between Wires, Staff and other sources.)
1267
1271
  */
1268
1272
  name?: string;
1269
1273
  /**
1270
1274
  * True if this content is advertorial or native advertising.
1271
1275
  */
1272
1276
  sponsored?: boolean;
1273
- [k: string]: unknown | undefined;
1277
+ [k: string]: unknown;
1274
1278
  }
1275
1279
  /**
1276
1280
  * Trait that applies revision information to a document. In the Arc ecosystem, many of these fields are populated in stories by the Story API.
@@ -1327,19 +1331,19 @@ export interface Embed {
1327
1331
  */
1328
1332
  export interface EmbedConfiguration {
1329
1333
  referent?: {
1330
- [k: string]: unknown | undefined;
1334
+ [k: string]: unknown;
1331
1335
  };
1332
1336
  type?: {
1333
- [k: string]: unknown | undefined;
1337
+ [k: string]: unknown;
1334
1338
  };
1335
1339
  version?: {
1336
- [k: string]: unknown | undefined;
1340
+ [k: string]: unknown;
1337
1341
  };
1338
1342
  /**
1339
1343
  * This interface was referenced by `EmbedConfiguration`'s JSON-Schema definition
1340
1344
  * via the `patternProperty` "^([a-zA-Z0-9_])*$".
1341
1345
  */
1342
- [k: string]: unknown | undefined;
1346
+ [k: string]: unknown;
1343
1347
  }
1344
1348
  /**
1345
1349
  * Trait that applies planning information to a document or resource. In the Arc ecosystem, this data is generated by WebSked. Newsroom use only. All these fields should be available and editable in WebSked.
@@ -1558,11 +1562,11 @@ export interface Source {
1558
1562
  */
1559
1563
  source_id?: string;
1560
1564
  /**
1561
- * Deprecated in 0.10.10. See `distributor.category` and `distributor.subcategory`. (Formerly: The method used to enter this content. E.g. 'staff', 'wires'.)
1565
+ * Deprecated in 0.10.12. See `distributor.category` and `distributor.subcategory`. (Formerly: The method used to enter this content. E.g. 'staff', 'wires'.)
1562
1566
  */
1563
1567
  source_type?: string;
1564
1568
  /**
1565
- * Deprecated in 0.10.10. See `distributor.name`. (Formerly: The human-readable name of the organization who first produced this content. E.g., 'Reuters'.)
1569
+ * Deprecated in 0.10.12. See `distributor.name`. (Formerly: The human-readable name of the organization who first produced this content. E.g., 'Reuters'.)
1566
1570
  */
1567
1571
  name?: string;
1568
1572
  /**
@@ -1579,7 +1583,7 @@ export interface Source {
1579
1583
  * Tracking information, probably implementation-dependent
1580
1584
  */
1581
1585
  export interface Tracking {
1582
- [k: string]: unknown | undefined;
1586
+ [k: string]: unknown;
1583
1587
  }
1584
1588
  /**
1585
1589
  * Comment configuration data
@@ -1602,7 +1606,7 @@ export interface Comments {
1602
1606
  */
1603
1607
  moderation_required?: boolean;
1604
1608
  additional_properties?: HasAdditionalProperties;
1605
- [k: string]: unknown | undefined;
1609
+ [k: string]: unknown;
1606
1610
  }
1607
1611
  /**
1608
1612
  * What the Washington Post calls a Kicker
@@ -1692,7 +1696,7 @@ export interface ContentRestrictions {
1692
1696
  }
1693
1697
  ];
1694
1698
  };
1695
- [k: string]: unknown | undefined;
1699
+ [k: string]: unknown;
1696
1700
  }
1697
1701
  /**
1698
1702
  * Trait that holds information on who created and contributed to a given document in Arc.
@@ -1710,13 +1714,13 @@ export interface Contributors {
1710
1714
  * The display name of the Arc user who created the Document
1711
1715
  */
1712
1716
  display_name?: string;
1713
- [k: string]: unknown | undefined;
1717
+ [k: string]: unknown;
1714
1718
  };
1715
1719
  }
1716
1720
  /**
1717
1721
  * An html content element
1718
1722
  */
1719
- export interface HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01010StoryElementsRawHtmlJson {
1723
+ export interface HttpsRawGithubusercontentComWashingtonpostAnsSchemaMasterSrcMainResourcesSchemaAns01012StoryElementsRawHtmlJson {
1720
1724
  type: 'raw_html';
1721
1725
  _id?: GloballyUniqueIDTrait;
1722
1726
  subtype?: SubtypeOrTemplate;
@@ -1740,7 +1744,7 @@ export interface FocalPoint {
1740
1744
  * The coordinate point on the vertical axis
1741
1745
  */
1742
1746
  y: number;
1743
- [k: string]: unknown | undefined;
1747
+ [k: string]: unknown;
1744
1748
  }
1745
1749
  /**
1746
1750
  * Mapping of integers to tokens, where the integer represents the Signing Service's secret version, and token represents an object's public key for usage on the frontend.
@@ -1759,6 +1763,98 @@ export interface Book {
1759
1763
  export interface School {
1760
1764
  school_name?: SchoolName;
1761
1765
  }
1766
+ /**
1767
+ * An item that conforms to this schema can be rendered in a sequence
1768
+ */
1769
+ export interface AnElementThatCanBeListedAsPartOfContentElements {
1770
+ type: string;
1771
+ _id?: GloballyUniqueIDTrait;
1772
+ subtype?: SubtypeOrTemplate;
1773
+ channels?: ChannelTrait;
1774
+ alignment?: Alignment;
1775
+ additional_properties?: HasAdditionalProperties;
1776
+ gallery_properties?: HasGalleryProperties;
1777
+ [k: string]: unknown;
1778
+ }
1779
+ /**
1780
+ * An object for overrides for images when images are used in a gallery. Example usage: Each image in a gallery may have the images own focal point overridden by the gallery.
1781
+ */
1782
+ export interface HasGalleryProperties {
1783
+ [k: string]: unknown;
1784
+ }
1785
+ /**
1786
+ * Website-specific metadata for url generation for multi-site copies. These fields are not indexed in Content API.
1787
+ */
1788
+ export interface WebsitesInput {
1789
+ /**
1790
+ * This interface was referenced by `WebsitesInput`'s JSON-Schema definition
1791
+ * via the `patternProperty` "^[a-zA-Z0-9_]*".
1792
+ */
1793
+ [k: string]: {
1794
+ website_section?: RepresentationOfANormalizedElement | Section;
1795
+ website_url?: WebsiteURL;
1796
+ };
1797
+ }
1798
+ /**
1799
+ * Holds attributes of an ANS story. In the Arc ecosystem, these are stored in the Story API.
1800
+ */
1801
+ export interface AStory {
1802
+ type: 'story';
1803
+ _id?: GloballyUniqueIDTrait;
1804
+ version: DescribesTheANSVersionOfThisObject;
1805
+ subtype?: SubtypeOrTemplate;
1806
+ channels?: ChannelTrait;
1807
+ alignment?: Alignment;
1808
+ language?: Locale;
1809
+ copyright?: CopyrightInformation;
1810
+ canonical_url?: CanonicalURL;
1811
+ canonical_url_external?: CanonicalExternalURL;
1812
+ canonical_website?: CanonicalWebsite;
1813
+ website?: Website;
1814
+ website_url?: WebsiteURL;
1815
+ short_url?: Short_Url;
1816
+ created_date?: CreatedDate;
1817
+ last_updated_date?: LastUpdatedDate;
1818
+ publish_date?: Publish_Date;
1819
+ first_publish_date?: FirstPublishDate;
1820
+ display_date?: Display_Date;
1821
+ location?: LocationRelatedTrait;
1822
+ geo?: Geo;
1823
+ address?: Address;
1824
+ editor_note?: Editor_Note;
1825
+ status?: Status;
1826
+ headlines?: Headlines;
1827
+ subheadlines?: SubHeadlines;
1828
+ description?: Description;
1829
+ credits?: CreditTrait;
1830
+ vanity_credits?: VanityCreditsTrait;
1831
+ taxonomy?: Taxonomy;
1832
+ promo_items?: PromoItems;
1833
+ related_content?: Related_Content;
1834
+ owner?: OwnerInformation;
1835
+ planning?: SchedulingInformation;
1836
+ workflow?: WorkflowInformation;
1837
+ pitches?: Pitches;
1838
+ revision?: Revision;
1839
+ syndication?: Syndication;
1840
+ source?: Source;
1841
+ distributor?: Distributor;
1842
+ tracking?: Tracking;
1843
+ comments?: Comments;
1844
+ label?: Label;
1845
+ slug?: Slug;
1846
+ content_restrictions?: ContentRestrictions;
1847
+ rendering_guides?: RenderingGuides;
1848
+ additional_properties?: HasAdditionalProperties;
1849
+ content_aliases?: AliasesTrait;
1850
+ corrections?: Corrections;
1851
+ content_elements?: ACollectionOfContent;
1852
+ publishing?: PublishingInformation;
1853
+ variations?: VariantContentMetadata;
1854
+ voice_transcripts?: VoiceTranscriptSConfigurationAndOutput;
1855
+ websites?: WebsitesInput;
1856
+ contributors?: Contributors;
1857
+ }
1762
1858
  /**
1763
1859
  * Trait that provides suggestions for the rendering system.
1764
1860
  */
@@ -1767,7 +1863,7 @@ export interface RenderingGuides {
1767
1863
  * The preferred rendering method of the story. Blank means there is no preference. If the rendering application is aware of these other options, it can decide to either use one of them, render messaging to the viewer, or render the story as normal
1768
1864
  */
1769
1865
  preferred_method?: (('website' | 'native') | string)[];
1770
- [k: string]: unknown | undefined;
1866
+ [k: string]: unknown;
1771
1867
  }
1772
1868
  /**
1773
1869
  * Describes a change that has been made to the document for transparency, or describes inaccuracies or falsehoods that remain in the document.
@@ -1788,25 +1884,6 @@ export interface Correction {
1788
1884
  */
1789
1885
  text: string;
1790
1886
  }
1791
- /**
1792
- * An item that conforms to this schema can be rendered in a sequence
1793
- */
1794
- export interface AnElementThatCanBeListedAsPartOfContentElements {
1795
- type: string;
1796
- _id?: GloballyUniqueIDTrait;
1797
- subtype?: SubtypeOrTemplate;
1798
- channels?: ChannelTrait;
1799
- alignment?: Alignment;
1800
- additional_properties?: HasAdditionalProperties;
1801
- gallery_properties?: HasGalleryProperties;
1802
- [k: string]: unknown | undefined;
1803
- }
1804
- /**
1805
- * An object for overrides for images when images are used in a gallery. Example usage: Each image in a gallery may have the images own focal point overridden by the gallery.
1806
- */
1807
- export interface HasGalleryProperties {
1808
- [k: string]: unknown | undefined;
1809
- }
1810
1887
  /**
1811
1888
  * The current published state of all editions of a content item as well as any scheduled publishing information. Machine-generated.
1812
1889
  */
@@ -1906,6 +1983,7 @@ export interface AStory1 {
1906
1983
  language?: Locale;
1907
1984
  copyright?: CopyrightInformation;
1908
1985
  canonical_url?: CanonicalURL;
1986
+ canonical_url_external?: CanonicalExternalURL;
1909
1987
  canonical_website?: CanonicalWebsite;
1910
1988
  website?: Website;
1911
1989
  website_url?: WebsiteURL;
@@ -1958,7 +2036,7 @@ export interface AStory1 {
1958
2036
  export interface OptionsRequested {
1959
2037
  enabled: Enabled;
1960
2038
  voice?: VoiceID;
1961
- [k: string]: unknown | undefined;
2039
+ [k: string]: unknown;
1962
2040
  }
1963
2041
  /**
1964
2042
  * The transcription settings that were used by the renderer to generate the final output. (If these differ from 'options' it may indicate an inability to render exactly as specified.) These values can be used when rendering to readers or external users.
@@ -1966,7 +2044,7 @@ export interface OptionsRequested {
1966
2044
  export interface OptionsUsed {
1967
2045
  enabled: Enabled1;
1968
2046
  voice?: VoiceID1;
1969
- [k: string]: unknown | undefined;
2047
+ [k: string]: unknown;
1970
2048
  }
1971
2049
  /**
1972
2050
  * Configuration for a piece of audio content, over a stream.
@@ -1977,18 +2055,233 @@ export interface AStreamOfAudio {
1977
2055
  stream_type?: AudioStreamType;
1978
2056
  url: URL1;
1979
2057
  bitrate?: Bitrate;
1980
- [k: string]: unknown | undefined;
2058
+ [k: string]: unknown;
1981
2059
  }
1982
2060
  /**
1983
- * Website-specific metadata for url generation for multi-site copies. These fields are not indexed in Content API.
2061
+ * Holds attributes of an ANS video component. In the Arc ecosystem, these are stored in Goldfish.
1984
2062
  */
1985
- export interface WebsitesInput {
2063
+ export interface VideoContent {
2064
+ type: 'video';
2065
+ _id?: GloballyUniqueIDTrait;
2066
+ version: DescribesTheANSVersionOfThisObject;
2067
+ subtype?: SubtypeOrTemplate;
2068
+ channels?: ChannelTrait;
2069
+ alignment?: Alignment;
2070
+ language?: Locale;
2071
+ copyright?: CopyrightInformation;
2072
+ canonical_url?: CanonicalURL;
2073
+ canonical_website?: CanonicalWebsite;
2074
+ website?: Website;
2075
+ website_url?: WebsiteURL;
2076
+ short_url?: Short_Url;
2077
+ created_date?: CreatedDate;
2078
+ last_updated_date?: LastUpdatedDate;
2079
+ publish_date?: Publish_Date;
2080
+ first_publish_date?: FirstPublishDate;
2081
+ display_date?: Display_Date;
2082
+ location?: LocationRelatedTrait;
2083
+ geo?: Geo;
2084
+ address?: Address;
2085
+ editor_note?: Editor_Note;
2086
+ status?: Status;
2087
+ headlines?: Headlines;
2088
+ subheadlines?: SubHeadlines;
2089
+ description?: Description;
2090
+ credits?: CreditTrait;
2091
+ vanity_credits?: VanityCreditsTrait;
2092
+ taxonomy?: Taxonomy;
2093
+ promo_items?: PromoItems;
2094
+ related_content?: Related_Content;
2095
+ owner?: OwnerInformation;
2096
+ planning?: SchedulingInformation;
2097
+ workflow?: WorkflowInformation;
2098
+ pitches?: Pitches;
2099
+ revision?: Revision;
2100
+ syndication?: Syndication;
2101
+ source?: Source;
2102
+ distributor?: Distributor;
2103
+ tracking?: Tracking;
2104
+ comments?: Comments;
2105
+ label?: Label;
2106
+ slug?: Slug;
2107
+ content_restrictions?: ContentRestrictions;
2108
+ additional_properties?: HasAdditionalProperties;
2109
+ content_aliases?: AliasesTrait;
1986
2110
  /**
1987
- * This interface was referenced by `WebsitesInput`'s JSON-Schema definition
1988
- * via the `patternProperty` "^[a-zA-Z0-9_]*".
2111
+ * Runtime of the video in milliseconds.
1989
2112
  */
1990
- [k: string]: {
1991
- website_section?: RepresentationOfANormalizedElement | Section;
1992
- website_url?: WebsiteURL;
1993
- };
2113
+ duration?: number;
2114
+ /**
2115
+ * A transcript of the contents of the video.
2116
+ */
2117
+ transcript?: string;
2118
+ /**
2119
+ * A rating of the video, to be used for appropriate age/content warnings.
2120
+ */
2121
+ rating?: string;
2122
+ /**
2123
+ * The type of video (e.g. clip, livestream, etc)
2124
+ */
2125
+ video_type?: string;
2126
+ /**
2127
+ * The YouTube ID of the content, if (re)hosted on youtube.com
2128
+ */
2129
+ youtube_content_id?: string;
2130
+ /**
2131
+ * The different streams this video can play in.
2132
+ */
2133
+ streams?: AStreamOfVideo[];
2134
+ subtitles?: VideoSubtitleConfigurationSchema;
2135
+ promo_image?: AnImage1;
2136
+ /**
2137
+ * An HTML snippet used to embed this video in another document. Used for oembed responses.
2138
+ */
2139
+ embed_html?: string;
2140
+ corrections?: Corrections;
2141
+ websites?: WebsitesInput;
2142
+ contributors?: Contributors;
2143
+ }
2144
+ /**
2145
+ * Configuration for a piece of video content, over a stream.
2146
+ */
2147
+ export interface AStreamOfVideo {
2148
+ /**
2149
+ * The height of the video.
2150
+ */
2151
+ height?: number;
2152
+ /**
2153
+ * The width of the video.
2154
+ */
2155
+ width?: number;
2156
+ /**
2157
+ * The size of the video, in bytes.
2158
+ */
2159
+ filesize?: number;
2160
+ /**
2161
+ * The audio codec.
2162
+ */
2163
+ audio_codec?: string;
2164
+ /**
2165
+ * The video codec.
2166
+ */
2167
+ video_codec?: string;
2168
+ /**
2169
+ * The type of video (e.g. mp4).
2170
+ */
2171
+ stream_type?: string;
2172
+ /**
2173
+ * Where to get the stream from.
2174
+ */
2175
+ url?: string;
2176
+ /**
2177
+ * The bitrate of the video
2178
+ */
2179
+ bitrate?: number;
2180
+ /**
2181
+ * The provider of the video.
2182
+ */
2183
+ provider?: string;
2184
+ [k: string]: unknown;
2185
+ }
2186
+ /**
2187
+ * Data about different subtitle encodings and confidences of auto-transcribed content.
2188
+ */
2189
+ export interface VideoSubtitleConfigurationSchema {
2190
+ /**
2191
+ * How confident the transcriber (human or automated) is of the accuracy of the subtitles.
2192
+ */
2193
+ confidence?: number;
2194
+ /**
2195
+ * The locations of any subtitle transcriptions of the video.
2196
+ */
2197
+ urls?: SubtitleUrl[];
2198
+ [k: string]: unknown;
2199
+ }
2200
+ export interface SubtitleUrl {
2201
+ /**
2202
+ * The format of the subtitles (e.g. SRT, DFXP, WEB_VTT, etc)
2203
+ */
2204
+ format?: string;
2205
+ /**
2206
+ * The url of the subtitle stream.
2207
+ */
2208
+ url?: string;
2209
+ [k: string]: unknown;
2210
+ }
2211
+ /**
2212
+ * Holds attributes of an ANS image component. In the Arc ecosystem, these are stored in Anglerfish.
2213
+ */
2214
+ export interface AnImage1 {
2215
+ type: 'image';
2216
+ _id?: GloballyUniqueIDTrait;
2217
+ version: DescribesTheANSVersionOfThisObject;
2218
+ subtype?: SubtypeOrTemplate;
2219
+ channels?: ChannelTrait;
2220
+ alignment?: Alignment;
2221
+ language?: Locale;
2222
+ copyright?: CopyrightInformation;
2223
+ canonical_url?: CanonicalURL;
2224
+ short_url?: Short_Url;
2225
+ created_date?: CreatedDate;
2226
+ last_updated_date?: LastUpdatedDate;
2227
+ publish_date?: Publish_Date;
2228
+ first_publish_date?: FirstPublishDate;
2229
+ display_date?: Display_Date;
2230
+ location?: LocationRelatedTrait;
2231
+ geo?: Geo;
2232
+ address?: Address;
2233
+ editor_note?: Editor_Note;
2234
+ status?: Status;
2235
+ headlines?: Headlines;
2236
+ subheadlines?: SubHeadlines;
2237
+ description?: Description;
2238
+ credits?: CreditTrait;
2239
+ vanity_credits?: VanityCreditsTrait;
2240
+ taxonomy?: Taxonomy;
2241
+ promo_items?: PromoItems;
2242
+ related_content?: Related_Content;
2243
+ owner?: OwnerInformation;
2244
+ planning?: SchedulingInformation;
2245
+ workflow?: WorkflowInformation;
2246
+ pitches?: Pitches;
2247
+ revision?: Revision;
2248
+ syndication?: Syndication;
2249
+ source?: Source;
2250
+ distributor?: Distributor;
2251
+ tracking?: Tracking;
2252
+ comments?: Comments;
2253
+ label?: Label;
2254
+ slug?: Slug;
2255
+ content_restrictions?: ContentRestrictions;
2256
+ image_type?: ImageType;
2257
+ alt_text?: AltText;
2258
+ focal_point?: FocalPoint;
2259
+ auth?: Auth;
2260
+ seo_filename?: SEOFilename;
2261
+ additional_properties?: HasAdditionalProperties;
2262
+ /**
2263
+ * Subtitle for the image.
2264
+ */
2265
+ subtitle?: string;
2266
+ /**
2267
+ * Caption for the image.
2268
+ */
2269
+ caption?: string;
2270
+ /**
2271
+ * URL for the image.
2272
+ */
2273
+ url?: string;
2274
+ /**
2275
+ * Width for the image.
2276
+ */
2277
+ width?: number;
2278
+ /**
2279
+ * Height for the image.
2280
+ */
2281
+ height?: number;
2282
+ /**
2283
+ * True if the image can legally be licensed to others.
2284
+ */
2285
+ licensable?: boolean;
2286
+ contributors?: Contributors;
1994
2287
  }