@code.store/arcxp-sdk-ts 5.1.8 → 5.3.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.
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { ListAuthorsParams, ListAuthorsResponse } from './types.js';
3
3
  export declare class ArcAuthor extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,5 +1,5 @@
1
1
  import type { ANS } from '../../types/index.js';
2
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
2
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
3
3
  import type { GetStoriesByIdsParams, GetStoryParams, ScanParams, ScanResponse, SearchParams, SearchResponse } from './types.js';
4
4
  export declare class ArcContent extends ArcAbstractAPI {
5
5
  constructor(options: ArcAPIOptions);
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { ScheduleOperationPayload, UnscheduleOperationPayload } from './types.js';
3
3
  export declare class ArcContentOps extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,5 +1,5 @@
1
1
  import type { AxiosRequestConfig, AxiosResponse } from 'axios';
2
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
2
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
3
3
  export interface RequestConfig extends AxiosRequestConfig {
4
4
  }
5
5
  export declare class Custom extends ArcAbstractAPI {
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { GetAllRetailCampaignCategoriesParams, GetAllRetailCampaignCategoriesResponse, GetAllRetailCampaignsParams, GetAllRetailCampaignsResponse, GetAllRetailConditionCategoriesParams, GetAllRetailConditionCategoriesResponse, GetAllRetailOfferAttributesParams, GetAllRetailOfferAttributesResponse, GetAllRetailOffersParams, GetAllRetailOffersResponse, GetAllRetailPricingRatesParams, GetAllRetailPricingRatesResponse, GetAllRetailPricingStrategiesParams, GetAllRetailPricingStrategiesResponse, GetAllRetailProductAttributesParams, GetAllRetailProductAttributesResponse, GetAllRetailProductsParams, GetAllRetailProductsResponse, GetRetailCampaignByIdParams, GetRetailCampaignByNameParams, GetRetailCampaignCategoryByIdParams, GetRetailOfferAttributeByIdParams, GetRetailOfferByIdParams, GetRetailPricingCycleParams, GetRetailPricingRateByIdParams, GetRetailPricingStrategyByIdParams, GetRetailProductAttributeByIdParams, GetRetailProductByIdParams, GetRetailProductByPriceCodeParams, GetRetailProductBySkuParams, RetailCampaign, RetailCampaignCategory, RetailOffer, RetailOfferAttribute, RetailPricingCycle, RetailPricingRate, RetailPricingStrategy, RetailProduct, RetailProductAttribute } from './types.js';
3
3
  export declare class ArcDeveloperRetail extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,5 +1,5 @@
1
- import type { ANS } from '../../types/index.js';
2
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import type { ANS, CirculationReference } from '../../types/index.js';
2
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
3
3
  import type { Circulations, CreateDocumentRedirectPayload, CreateExternalRedirectPayload, CreateRedirectPayload, Document, DocumentRedirect, ExternalRedirect, Revision, Revisions, UpdateDraftRevisionPayload } from './types.js';
4
4
  export declare class ArcDraft extends ArcAbstractAPI {
5
5
  constructor(options: ArcAPIOptions);
@@ -11,6 +11,7 @@ export declare class ArcDraft extends ArcAbstractAPI {
11
11
  getPublishedRevision(id: string, type?: string): Promise<Revision>;
12
12
  getDraftRevision(id: string, type?: string): Promise<Revision>;
13
13
  getCirculations(id: string, type?: string, after?: string): Promise<Circulations>;
14
+ deleteCirculation(id: string, website: string, type?: string): Promise<CirculationReference>;
14
15
  getRevisions(id: string, type?: string, after?: string): Promise<Revisions>;
15
16
  getRevision(id: string, revisionId: string, type?: string): Promise<Revision>;
16
17
  createRedirect<P extends CreateRedirectPayload, R = P extends CreateExternalRedirectPayload ? ExternalRedirect : P extends CreateDocumentRedirectPayload ? DocumentRedirect : never>(website: string, websiteUrl: string, payload: P): Promise<R>;
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { CreateDistributorPayload, Distributor, GetDistributorsParams, GetDistributorsResponse } from './types.js';
3
3
  export declare class GlobalSettings extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { GetUserResponse, MigrateBatchUsersPayload, MigrateBatchUsersResponse, UserProfile } from './types.js';
3
3
  export declare class ArcIdentity extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { AddSecretPayload, Bundle, CreateIntegrationPayload, GenereteDeleteTokenResponse, GetBundlesResponse, GetSubscriptionsResponse, Integration, SubscribePayload, UpdateIntegrationPayload } from './types.js';
3
3
  export declare class ArcIFX extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,8 +1,9 @@
1
1
  import type { ArcAPIOptions } from './abstract-api.js';
2
2
  import { ArcAuthor } from './author/index.js';
3
- import { ArcContentOps } from './content-ops/index.js';
4
3
  import { ArcContent } from './content/index.js';
4
+ import { ArcContentOps } from './content-ops/index.js';
5
5
  import { Custom } from './custom/index.js';
6
+ import { ArcDeveloperRetail } from './developer-retail/index.js';
6
7
  import { ArcDraft } from './draft/index.js';
7
8
  import { GlobalSettings } from './global-settings/index.js';
8
9
  import { ArcIdentity } from './identity/index.js';
@@ -11,7 +12,6 @@ import { ArcMigrationCenter } from './migration-center/index.js';
11
12
  import { ArcProtoCenter } from './photo-center/index.js';
12
13
  import { ArcRedirect } from './redirect/index.js';
13
14
  import { ArcRetailEvents } from './retail-events/index.js';
14
- import { ArcDeveloperRetail } from './developer-retail/index.js';
15
15
  import { ArcSales, ArcSalesV2 } from './sales/index.js';
16
16
  import { ArcSigningService } from './signing-service/index.js';
17
17
  import { ArcSite } from './site/index.js';
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { Count, CountParams, DetailReport, DetailReportParams, GetANSParams, GetRecentGroupIdsResponse, GetRemainingTimeParams, GetRemainingTimeResponse, PostANSParams, PostANSPayload, Summary, SummaryReportParams } from './types.js';
3
3
  export declare class ArcMigrationCenter extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,6 +1,6 @@
1
1
  import type { ReadStream } from 'node:fs';
2
2
  import type { ANS } from '../../types/index.js';
3
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
3
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
4
4
  import type { GetGalleriesParams, GetGalleriesResponse, GetImagesParams, GetImagesResponse } from './types.js';
5
5
  export declare class ArcProtoCenter extends ArcAbstractAPI {
6
6
  constructor(options: ArcAPIOptions);
@@ -1,5 +1,5 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
2
- import type { ArcRedirectRuleContentType, ArcRedirectRuleType, ArcRedirectRulesResponse } from './types.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
+ import type { ArcRedirectRuleContentType, ArcRedirectRulesResponse, ArcRedirectRuleType } from './types.js';
3
3
  export declare class ArcRedirect extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
5
5
  getRedirects(orgSiteEnv: string): Promise<ArcRedirectRulesResponse>;
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { CreateEnterpriseGroupParams, CreateEnterpriseGroupPayload, CreateEnterpriseGroupResponse, CreateNonceResponse, MigrateBatchSubscriptionsParams, MigrateBatchSubscriptionsPayload, MigrateBatchSubscriptionsResponse } from './types.js';
3
3
  export declare class ArcSales extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { SignResponse } from './types.js';
3
3
  export declare class ArcSigningService extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { GetLinksParams, GetLinksResponse, GetSectionParams, GetSectionsResponse, Link, Section, SetSectionPayload, Website } from './types.js';
3
3
  export declare class ArcSite extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -7,6 +7,7 @@ export declare class ArcSite extends ArcAbstractAPI {
7
7
  deleteSection(id: string, website: string): Promise<void>;
8
8
  putSection(section: SetSectionPayload): Promise<any>;
9
9
  getWebsites(): Promise<Website[]>;
10
+ deleteWebsite(website: string): Promise<Website>;
10
11
  putLink(link: Link): Promise<Link>;
11
12
  deleteLink(id: string, website: string): Promise<any>;
12
13
  getLinks(params: GetLinksParams): Promise<GetLinksResponse>;
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { AddTagsPayload, AddTagsResponse, DeleteTagPayload, DeleteTagsResponse, GetAllTagsParams, GetTagsResponse, SearchTagsParams, SearchTagsV2Params } from './types.js';
3
3
  export declare class ArcTags extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,4 +1,4 @@
1
- import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api.js';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api.js';
2
2
  import type { CreateTaskPayload, CreateTaskResponse, GetEditionTimesResponse, GetPublicationsResponse, GetStatusesResponse, ReportStatusChangePayload, SectionEdition, WebskedPublication } from './types.js';
3
3
  export declare class ArcWebsked extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
@@ -1,11 +1,8 @@
1
1
  import { CommentNode, HTMLElement, type Node, type Options, TextNode } from 'node-html-parser';
2
- import type { CElement, ContentElementType } from '../types.js';
3
2
  export declare const isTextNode: (node?: Node) => node is TextNode;
4
3
  export declare const isHTMLElement: (node?: Node) => node is HTMLElement;
5
4
  export declare const isCommentNode: (node?: Node) => node is CommentNode;
6
5
  export declare const nodeTagIs: (node: Node, name: string) => node is HTMLElement;
7
6
  export declare const nodeTagIn: (node: Node, names: string[]) => node is HTMLElement;
8
- export declare const isTextCE: (ce?: CElement) => ce is ContentElementType<"text">;
9
- export declare const decodeHTMLEntities: (str: string) => string;
10
7
  export declare const htmlToText: (html?: string | null, parseOptions?: Partial<Options>) => string;
11
8
  export declare const getHTMLElementAttribute: (e: HTMLElement, key: string) => string | null;
@@ -0,0 +1,3 @@
1
+ export * as Constants from './xml.constants.js';
2
+ export { XMLProcessor } from './xml.processor.js';
3
+ export * as Utils from './xml.utils.js';
@@ -0,0 +1 @@
1
+ export declare const BLOCK_ELEMENT_TAGS: string[];
@@ -0,0 +1,45 @@
1
+ import { type ArcTypes } from '@code.store/arcxp-sdk-ts';
2
+ import * as xmldoc from 'xmldoc';
3
+ import type { MaybePromise } from '../../types/utils';
4
+ export type CElement = ArcTypes.ANS.AnElementThatCanBeListedAsPartOfContentElements;
5
+ export type NodeHandler = (node: xmldoc.XmlNodeBase) => MaybePromise<CElement[] | undefined>;
6
+ export type WrapHandler = (node: xmldoc.XmlElement, content: string) => string;
7
+ export declare class XMLProcessor {
8
+ protected handlers: {
9
+ node: Map<string, NodeHandler>;
10
+ wrap: Map<string, WrapHandler>;
11
+ };
12
+ init(): void;
13
+ parse(xml: string): Promise<ArcTypes.ANS.AnElementThatCanBeListedAsPartOfContentElements[]>;
14
+ protected handle(name: string, handler: NodeHandler): void;
15
+ protected wrap(name: string, handler: WrapHandler): void;
16
+ protected addTextAdditionalProperties(c: ArcTypes.ContentElementType<any>, parent: xmldoc.XmlElement): any;
17
+ protected wrapChildrenTextNodes(node: xmldoc.XmlElement, elements: CElement[]): ArcTypes.ANS.AnElementThatCanBeListedAsPartOfContentElements[];
18
+ protected handleNested(node: xmldoc.XmlElement): Promise<ArcTypes.ANS.AnElementThatCanBeListedAsPartOfContentElements[]>;
19
+ protected process(node: xmldoc.XmlNodeBase): Promise<ArcTypes.ANS.AnElementThatCanBeListedAsPartOfContentElements[] | undefined>;
20
+ private mergeParagraphs;
21
+ protected handleTable(node: xmldoc.XmlElement): Promise<{
22
+ type: "raw_html";
23
+ content: string;
24
+ }[]>;
25
+ protected createQuote(node: xmldoc.XmlElement): Promise<{
26
+ type: "quote";
27
+ subtype: "blockquote" | "pullquote";
28
+ citation: {
29
+ type: "text";
30
+ content: string;
31
+ };
32
+ content_elements: ArcTypes.ANS.AnElementThatCanBeListedAsPartOfContentElements[];
33
+ }[]>;
34
+ protected createList(node: xmldoc.XmlElement, type: 'ordered' | 'unordered'): Promise<{
35
+ type: "list";
36
+ list_type: "ordered" | "unordered";
37
+ items: ArcTypes.ANS.AnElementThatCanBeListedAsPartOfContentElements[];
38
+ }[]>;
39
+ protected getNodeInnerText(node: xmldoc.XmlElement): string[];
40
+ protected getNodeInnerHTML(node: xmldoc.XmlElement): string[];
41
+ protected htmlFromNode(node: xmldoc.XmlNodeBase): import("node-html-parser").HTMLElement;
42
+ protected getDecodedHTMLFromInnerNodes(node: xmldoc.XmlElement): string;
43
+ protected isBlockElement(node: xmldoc.XmlElement): true | undefined;
44
+ protected warn(metadata: Record<string, any>, message: string): void;
45
+ }
@@ -0,0 +1,5 @@
1
+ import type * as xmldoc from 'xmldoc';
2
+ export declare const isXmlElement: (node?: xmldoc.XmlNodeBase) => node is xmldoc.XmlElement;
3
+ export declare const isTextNode: (node: xmldoc.XmlNodeBase) => node is xmldoc.XmlTextNode;
4
+ export declare const nodeNameIs: (node: xmldoc.XmlNodeBase, name: string) => node is xmldoc.XmlElement;
5
+ export declare const nodeNameIn: (node: xmldoc.XmlNodeBase, names: string[]) => node is xmldoc.XmlElement;