@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
@@ -1,12 +1,13 @@
1
- import type { ArcTypes } from '..';
2
- import type { ANSContent, CirculationReference, PostANSParams, PostANSPayload } from '../api/migration-center/types';
3
- import type { MaybePromise, Optional } from '../types/utils';
1
+ import type { ANSContent, CirculationReference, PostANSParams, PostANSPayload } from '../api/migration-center/types.js';
2
+ import type { ContentElementType } from '../content-elements/types.js';
3
+ import type { ANS } from '../types/index.js';
4
+ import type { MaybePromise, Optional } from '../types/utils.js';
4
5
  /**
5
6
  * Base class for all arc entities, it provides common methods and properties
6
7
  * If you want to create a new entity subtype you should extend this class
7
8
  *
8
9
  * Use case: You want to migrate stories from BBC
9
- * You define `class BBCStory extends ArcDocument<ArcTypes.Story.AStory>` and implement all abstract methods
10
+ * You define `class BBCStory extends ArcDocument<ANS.AStory>` and implement all abstract methods
10
11
  * Then you can override the specific methods to enrich the story with the data from BBC
11
12
  *
12
13
  * To migrate it call .migrate() method
@@ -22,7 +23,7 @@ export declare abstract class Document<ANS extends ANSContent> {
22
23
  abstract arcId(): MaybePromise<string>;
23
24
  abstract type(): MaybePromise<string>;
24
25
  abstract groupId(): MaybePromise<string>;
25
- abstract version(): ArcTypes.Story.DescribesTheANSVersionOfThisObject;
26
+ abstract version(): ANS.DescribesTheANSVersionOfThisObject;
26
27
  abstract getAns(): MaybePromise<ANS>;
27
28
  prepare(): Promise<{
28
29
  params: PostANSParams;
@@ -32,29 +33,29 @@ export declare abstract class Document<ANS extends ANSContent> {
32
33
  private params;
33
34
  protected additionalProperties(): PostANSPayload['arcAdditionalProperties'];
34
35
  protected priority(): 'historical' | 'live';
35
- protected getDistributor(): MaybePromise<Optional<ArcTypes.Story.Distributor>>;
36
+ protected getDistributor(): MaybePromise<Optional<ANS.Distributor>>;
36
37
  protected getLanguage(): string;
37
- protected getComments(): Optional<ArcTypes.Story.Comments>;
38
- protected getSource(): Promise<Optional<ArcTypes.Story.Source>>;
39
- protected getSubheadlines(): Optional<ArcTypes.Story.SubHeadlines>;
40
- protected getDescription(): Optional<ArcTypes.Story.Description>;
38
+ protected getComments(): Optional<ANS.Comments>;
39
+ protected getSource(): Promise<Optional<ANS.Source>>;
40
+ protected getSubheadlines(): Optional<ANS.SubHeadlines>;
41
+ protected getDescription(): Optional<ANS.Description>;
41
42
  protected formatDate(date?: Date): string | undefined;
42
43
  protected getDisplayDate(): MaybePromise<Optional<Date>>;
43
- protected getContentElements(): Promise<ArcTypes.ContentElements.ContentElementType<any>[]>;
44
+ protected getContentElements(): Promise<ContentElementType<any>[]>;
44
45
  protected getPublicationDate(): MaybePromise<Optional<Date>>;
45
- protected getHeadlines(): Optional<ArcTypes.Story.Headlines>;
46
- protected getTags(): MaybePromise<Optional<ArcTypes.Story.Tag[]>>;
47
- protected getSubtype(): MaybePromise<Optional<ArcTypes.Story.SubtypeOrTemplate>>;
48
- protected getLabel(): MaybePromise<Optional<ArcTypes.Story.Label>>;
49
- protected getRelatedContent(): MaybePromise<Optional<ArcTypes.Story.Related_Content>>;
50
- protected getPromoItems(): Promise<Optional<ArcTypes.Story.PromoItems>>;
51
- protected getWebskedStatusCode(): MaybePromise<ArcTypes.Story.WorkflowInformation['status_code']>;
52
- protected getCreditsBy(): MaybePromise<ArcTypes.Story.By>;
46
+ protected getHeadlines(): Optional<ANS.Headlines>;
47
+ protected getTags(): MaybePromise<Optional<ANS.Tag[]>>;
48
+ protected getSubtype(): MaybePromise<Optional<ANS.SubtypeOrTemplate>>;
49
+ protected getLabel(): MaybePromise<Optional<ANS.Label>>;
50
+ protected getRelatedContent(): MaybePromise<Optional<ANS.Related_Content>>;
51
+ protected getPromoItems(): Promise<Optional<ANS.PromoItems>>;
52
+ protected getWebskedStatusCode(): MaybePromise<ANS.WorkflowInformation['status_code']>;
53
+ protected getCreditsBy(): MaybePromise<ANS.By>;
53
54
  protected getCirculations(): MaybePromise<CirculationReference[]>;
54
- protected getEditorNote(): MaybePromise<Optional<ArcTypes.Story.Editor_Note>>;
55
- protected getContentRestrictions(): MaybePromise<Optional<ArcTypes.Story.ContentRestrictions>>;
56
- protected getOwnerInformation(): MaybePromise<Optional<ArcTypes.Story.OwnerInformation>>;
57
- protected getSyndication(): MaybePromise<Optional<ArcTypes.Story.Syndication>>;
58
- protected getSchedulingInformation(): MaybePromise<Optional<ArcTypes.Story.SchedulingInformation>>;
59
- protected getTaxonomy(): MaybePromise<Optional<ArcTypes.Story.Taxonomy>>;
55
+ protected getEditorNote(): MaybePromise<Optional<ANS.Editor_Note>>;
56
+ protected getContentRestrictions(): MaybePromise<Optional<ANS.ContentRestrictions>>;
57
+ protected getOwnerInformation(): MaybePromise<Optional<ANS.OwnerInformation>>;
58
+ protected getSyndication(): MaybePromise<Optional<ANS.Syndication>>;
59
+ protected getSchedulingInformation(): MaybePromise<Optional<ANS.SchedulingInformation>>;
60
+ protected getTaxonomy(): MaybePromise<Optional<ANS.Taxonomy>>;
60
61
  }
@@ -1,2 +1,2 @@
1
- export { Document } from './doc';
2
- export { Story } from './story';
1
+ export { Document } from './doc.js';
2
+ export { Story } from './story.js';
@@ -1,6 +1,6 @@
1
- import type { ANSContent } from '../api/migration-center/types';
2
- import type * as Types from '../types';
3
- import { Document } from './doc';
1
+ import type { ANSContent } from '../api/migration-center/types.js';
2
+ import type { ANS } from '../types/index.js';
3
+ import { Document } from './doc.js';
4
4
  /**
5
5
  * Base class for all arc stories, it provides common methods and properties
6
6
  * If you want to create a new story subtype you should extend this class
@@ -18,7 +18,7 @@ import { Document } from './doc';
18
18
  * }];
19
19
  * }
20
20
  */
21
- export declare abstract class Story<ANS extends ANSContent = Types.Story.AStory> extends Document<ANS> {
21
+ export declare abstract class Story<ANS extends ANSContent = ANS.AStory> extends Document<ANS> {
22
22
  type(): "story";
23
23
  getAns(): Promise<ANS>;
24
24
  protected getMigrationMetaProperties(): Promise<Record<string, any>>;