@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,13 +1,13 @@
1
- import type { CElement } from '../types/content-elements';
2
- import type { Alignment, AnImage } from '../types/story';
1
+ import type { ANS } from '../types/index.js';
2
+ import type { CElement } from './types.js';
3
3
  export declare const ContentElement: {
4
4
  divider: () => {
5
5
  type: "divider";
6
6
  };
7
- text: (content: string, alignment?: Alignment | null) => {
7
+ text: (content: string, alignment?: ANS.Alignment | null) => {
8
8
  type: "text";
9
9
  content: string;
10
- alignment: Alignment | undefined;
10
+ alignment: ANS.Alignment | undefined;
11
11
  };
12
12
  quote: (items: CElement[], citation?: string, subtype?: "blockquote" | "pullquote") => {
13
13
  type: "quote";
@@ -16,7 +16,7 @@ export declare const ContentElement: {
16
16
  type: "text";
17
17
  content: string;
18
18
  };
19
- content_elements: import("../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
19
+ content_elements: ANS.AnElementThatCanBeListedAsPartOfContentElements[];
20
20
  };
21
21
  interstitial_link: (url: string, content: string) => {
22
22
  type: "interstitial_link";
@@ -42,7 +42,7 @@ export declare const ContentElement: {
42
42
  list: (type: "ordered" | "unordered", items: CElement[]) => {
43
43
  type: "list";
44
44
  list_type: "ordered" | "unordered";
45
- items: import("../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
45
+ items: ANS.AnElementThatCanBeListedAsPartOfContentElements[];
46
46
  };
47
47
  link_list: (title: string, links: {
48
48
  content: string;
@@ -56,65 +56,65 @@ export declare const ContentElement: {
56
56
  url: string;
57
57
  }[];
58
58
  };
59
- image: (id: string, properties?: AnImage) => {
59
+ image: (id: string, properties?: ANS.AnImage) => {
60
60
  referent: {
61
61
  id: string;
62
62
  type: "image";
63
63
  referent_properties: {
64
64
  type: "image";
65
- _id: import("../types/story").GloballyUniqueIDTrait;
66
- version?: "0.10.10" | undefined;
67
- subtype?: import("../types/story").SubtypeOrTemplate;
68
- channels?: import("../types/story").ChannelTrait;
69
- alignment?: Alignment;
70
- language?: import("../types/story").Locale;
71
- copyright?: import("../types/story").CopyrightInformation;
72
- canonical_url?: import("../types/story").CanonicalURL;
73
- short_url?: import("../types/story").Short_Url;
74
- created_date?: import("../types/story").CreatedDate;
75
- last_updated_date?: import("../types/story").LastUpdatedDate;
76
- publish_date?: import("../types/story").Publish_Date;
77
- first_publish_date?: import("../types/story").FirstPublishDate;
78
- display_date?: import("../types/story").Display_Date;
79
- location?: import("../types/story").LocationRelatedTrait;
80
- geo?: import("../types/story").Geo;
81
- address?: import("../types/story").Address;
82
- editor_note?: import("../types/story").Editor_Note;
83
- status?: import("../types/story").Status;
84
- headlines?: import("../types/story").Headlines;
85
- subheadlines?: import("../types/story").SubHeadlines;
86
- description?: import("../types/story").Description;
87
- credits?: import("../types/story").CreditTrait;
88
- vanity_credits?: import("../types/story").VanityCreditsTrait;
89
- taxonomy?: import("../types/story").Taxonomy;
90
- promo_items?: import("../types/story").PromoItems;
91
- related_content?: import("../types/story").Related_Content;
92
- owner?: import("../types/story").OwnerInformation;
93
- planning?: import("../types/story").SchedulingInformation;
94
- workflow?: import("../types/story").WorkflowInformation;
95
- pitches?: import("../types/story").Pitches;
96
- revision?: import("../types/story").Revision;
97
- syndication?: import("../types/story").Syndication;
98
- source?: import("../types/story").Source;
99
- distributor?: import("../types/story").Distributor;
100
- tracking?: import("../types/story").Tracking;
101
- comments?: import("../types/story").Comments;
102
- label?: import("../types/story").Label;
103
- slug?: import("../types/story").Slug;
104
- content_restrictions?: import("../types/story").ContentRestrictions;
105
- image_type?: import("../types/story").ImageType;
106
- alt_text?: import("../types/story").AltText;
107
- focal_point?: import("../types/story").FocalPoint;
108
- auth?: import("../types/story").Auth;
109
- seo_filename?: import("../types/story").SEOFilename;
110
- additional_properties?: import("../types/story").HasAdditionalProperties;
65
+ _id: ANS.GloballyUniqueIDTrait;
66
+ version?: "0.10.12" | undefined;
67
+ subtype?: ANS.SubtypeOrTemplate;
68
+ channels?: ANS.ChannelTrait;
69
+ alignment?: ANS.Alignment;
70
+ language?: ANS.Locale;
71
+ copyright?: ANS.CopyrightInformation;
72
+ canonical_url?: ANS.CanonicalURL;
73
+ short_url?: ANS.Short_Url;
74
+ created_date?: ANS.CreatedDate;
75
+ last_updated_date?: ANS.LastUpdatedDate;
76
+ publish_date?: ANS.Publish_Date;
77
+ first_publish_date?: ANS.FirstPublishDate;
78
+ display_date?: ANS.Display_Date;
79
+ location?: ANS.LocationRelatedTrait;
80
+ geo?: ANS.Geo;
81
+ address?: ANS.Address;
82
+ editor_note?: ANS.Editor_Note;
83
+ status?: ANS.Status;
84
+ headlines?: ANS.Headlines;
85
+ subheadlines?: ANS.SubHeadlines;
86
+ description?: ANS.Description;
87
+ credits?: ANS.CreditTrait;
88
+ vanity_credits?: ANS.VanityCreditsTrait;
89
+ taxonomy?: ANS.Taxonomy;
90
+ promo_items?: ANS.PromoItems;
91
+ related_content?: ANS.Related_Content;
92
+ owner?: ANS.OwnerInformation;
93
+ planning?: ANS.SchedulingInformation;
94
+ workflow?: ANS.WorkflowInformation;
95
+ pitches?: ANS.Pitches;
96
+ revision?: ANS.Revision;
97
+ syndication?: ANS.Syndication;
98
+ source?: ANS.Source;
99
+ distributor?: ANS.Distributor;
100
+ tracking?: ANS.Tracking;
101
+ comments?: ANS.Comments;
102
+ label?: ANS.Label;
103
+ slug?: ANS.Slug;
104
+ content_restrictions?: ANS.ContentRestrictions;
105
+ image_type?: ANS.ImageType;
106
+ alt_text?: ANS.AltText;
107
+ focal_point?: ANS.FocalPoint;
108
+ auth?: ANS.Auth;
109
+ seo_filename?: ANS.SEOFilename;
110
+ additional_properties?: ANS.HasAdditionalProperties;
111
111
  subtitle?: string;
112
112
  caption?: string;
113
113
  url?: string;
114
114
  width?: number;
115
115
  height?: number;
116
116
  licensable?: boolean;
117
- contributors?: import("../types/story").Contributors;
117
+ contributors?: ANS.Contributors;
118
118
  };
119
119
  };
120
120
  type: "reference";
@@ -1,6 +1,6 @@
1
1
  import { type CommentNode, type HTMLElement, type Node } from 'node-html-parser';
2
- import type { CElement, ContentElementType } from '../../types/content-elements';
3
- import type { MaybePromise } from '../../types/utils';
2
+ import type { MaybePromise } from '../../types/utils.js';
3
+ import type { CElement, ContentElementType } from '../types.js';
4
4
  export type NodeHandler = (node: Node) => MaybePromise<CElement[] | undefined>;
5
5
  export type WrapHandler = (node: Node, content: ContentElementType<'text'>) => ContentElementType<'text'> | undefined;
6
6
  /**
@@ -34,7 +34,7 @@ export declare class HTMLProcessor {
34
34
  init(): void;
35
35
  protected handle(name: string, handler: NodeHandler): void;
36
36
  protected wrap(name: string, handler: WrapHandler): void;
37
- parse(html: string): Promise<import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[]>;
37
+ parse(html: string): Promise<import("../../types/ans-types.js").AnElementThatCanBeListedAsPartOfContentElements[]>;
38
38
  protected addTextAdditionalProperties(c: ContentElementType<any>, parent: Node): any;
39
39
  /**
40
40
  * Wraps text content elements with additional properties and handlers.
@@ -43,7 +43,7 @@ export declare class HTMLProcessor {
43
43
  *
44
44
  * @param node - The HTML node containing the text elements
45
45
  **/
46
- protected wrapChildrenTextNodes(node: Node, elements: CElement[]): import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
46
+ protected wrapChildrenTextNodes(node: Node, elements: CElement[]): import("../../types/ans-types.js").AnElementThatCanBeListedAsPartOfContentElements[];
47
47
  /**
48
48
  * Handles nested nodes by processing their children and merging text elements.
49
49
  * This method recursively processes the children of a given HTML node and
@@ -51,7 +51,7 @@ export declare class HTMLProcessor {
51
51
  *
52
52
  * @param node - The HTML node to process
53
53
  **/
54
- protected handleNested(node: Node): Promise<import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[]>;
54
+ protected handleNested(node: Node): Promise<import("../../types/ans-types.js").AnElementThatCanBeListedAsPartOfContentElements[]>;
55
55
  protected processChildNodes(node: Node): Promise<(CElement[] | undefined)[]>;
56
56
  /**
57
57
  * Processes a single HTML node and converts it into content elements.
@@ -61,7 +61,7 @@ export declare class HTMLProcessor {
61
61
  * @param node - The HTML node to process
62
62
  * @returns Promise resolving to an array of content elements, or undefined if node cannot be processed
63
63
  */
64
- protected process(node: Node): Promise<import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[] | undefined>;
64
+ protected process(node: Node): Promise<import("../../types/ans-types.js").AnElementThatCanBeListedAsPartOfContentElements[] | undefined>;
65
65
  /**
66
66
  * Merges adjacent text content elements into a single paragraph.
67
67
  * This method iterates through an array of content elements and combines
@@ -93,7 +93,7 @@ export declare class HTMLProcessor {
93
93
  type: "text";
94
94
  content: string;
95
95
  };
96
- content_elements: import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
96
+ content_elements: import("../../types/ans-types.js").AnElementThatCanBeListedAsPartOfContentElements[];
97
97
  }[]>;
98
98
  protected createText(node: Node): Promise<CElement[]>;
99
99
  protected filterListItems(items: ContentElementType<any>[]): any[];
@@ -1,5 +1,5 @@
1
- import { HTMLElement, CommentNode, type Options, TextNode, type Node } from 'node-html-parser';
2
- import type { CElement, ContentElementType } from '../../types/content-elements';
1
+ import { CommentNode, HTMLElement, type Node, type Options, TextNode } from 'node-html-parser';
2
+ import type { CElement, ContentElementType } from '../types.js';
3
3
  export declare const isTextNode: (node?: Node) => node is TextNode;
4
4
  export declare const isHTMLElement: (node?: Node) => node is HTMLElement;
5
5
  export declare const isCommentNode: (node?: Node) => node is CommentNode;
@@ -1,3 +1,3 @@
1
- export * as Constants from './html.constants';
2
- export { HTMLProcessor } from './html.processor';
3
- export * as Utils from './html.utils';
1
+ export * as Constants from './html.constants.js';
2
+ export { HTMLProcessor } from './html.processor.js';
3
+ export * as Utils from './html.utils.js';
@@ -1,2 +1,2 @@
1
- export * from './content-elements';
2
- export * as HTML from './html';
1
+ export * from './content-elements.js';
2
+ export * as HTML from './html/index.js';
@@ -0,0 +1,4 @@
1
+ import type { ANS } from '../types/index.js';
2
+ import type { ContentElement } from './content-elements.js';
3
+ export type CElement = ANS.AnElementThatCanBeListedAsPartOfContentElements;
4
+ export type ContentElementType<T extends keyof typeof ContentElement> = ReturnType<(typeof ContentElement)[T]>;