@code.store/arcxp-sdk-ts 4.34.1 → 4.36.0

package/dist/api/content/types.d.ts

@@ -4,6 +4,7 @@ export type GetStoryParams = {
     _id: string;
     published: boolean;
     website: string;
+    website_url: string;
     included_fields?: string;
 };
 export type GetStoriesByIdsParams = {

package/dist/api/draft/index.d.ts

@@ -1,5 +1,5 @@
 import { type ArcAPIOptions, ArcAbstractAPI } from '../abstract-api';
-import type { CreateDocumentRedirectPayload, CreateExternalRedirectPayload, CreateRedirectPayload, Document, DocumentRedirect, ExternalRedirect, Revision, UpdateDraftRevisionPayload } from './types';
+import type { Circulations, CreateDocumentRedirectPayload, CreateExternalRedirectPayload, CreateRedirectPayload, Document, DocumentRedirect, ExternalRedirect, Revision, UpdateDraftRevisionPayload } from './types';
 export declare class ArcDraft extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
     generateId(id: string): Promise<string>;
@@ -8,6 +8,7 @@ export declare class ArcDraft extends ArcAbstractAPI {
     deleteDocument(id: string, type?: string): Promise<Document>;
     getPublishedRevision(id: string, type?: string): Promise<Revision>;
     getDraftRevision(id: string, type?: string): Promise<Revision>;
+    getCirculations(id: string, type?: string, after?: string): Promise<Circulations>;
     createRedirect<P extends CreateRedirectPayload, R = P extends CreateExternalRedirectPayload ? ExternalRedirect : P extends CreateDocumentRedirectPayload ? DocumentRedirect : never>(website: string, websiteUrl: string, payload: P): Promise<R>;
     getRedirect(website: string, websiteUrl: string): Promise<DocumentRedirect | ExternalRedirect>;
     updateDraftRevision(id: string, payload: UpdateDraftRevisionPayload, type?: string): Promise<Revision>;

package/dist/api/draft/index.js

@@ -30,6 +30,10 @@ class ArcDraft extends abstract_api_1.ArcAbstractAPI {
         const { data } = await this.client.get(`/${type}/${id}/revision/draft`);
         return data;
     }
+    async getCirculations(id, type = 'story', after) {
+        const { data } = await this.client.get(`/${type}/${id}/circulation`, { params: { after } });
+        return data;
+    }
     async createRedirect(website, websiteUrl, payload) {
         const { data } = await this.client.post(`/redirect/${website}/${websiteUrl}`, payload);
         return data;

package/dist/api/draft/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/draft/index.ts"],"names":[],"mappings":";;;AAAA,kDAAqE;AAYrE,MAAa,QAAS,SAAQ,6BAAc;IAC1C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAiB,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAC9C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAW,IAAI,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAChD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAW,IAAI,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAC7C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAW,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QACnD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,IAAI,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,IAAI,IAAI,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,cAAc,CAOlB,OAAe,EAAE,UAAkB,EAAE,OAAU;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAI,aAAa,OAAO,IAAI,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,UAAkB;QACnD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAsC,aAAa,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QAClH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,OAAmC,EAAE,IAAI,GAAG,OAAO;QACvF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,IAAI,IAAI,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAC3F,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxDD,4BAwDC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/draft/index.ts"],"names":[],"mappings":";;;AAAA,kDAAqE;AAarE,MAAa,QAAS,SAAQ,6BAAc;IAC1C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAiB,UAAU,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC,EAAE,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAC9C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAW,IAAI,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACvF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,iBAAiB,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAChD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAW,IAAI,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACzF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAC7C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAW,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QACnD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,IAAI,IAAI,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,IAAI,IAAI,IAAI,EAAE,iBAAiB,CAAC,CAAC;QAClF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,EAAU,EAAE,IAAI,GAAG,OAAO,EAAE,KAAc;QAC9D,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAe,IAAI,IAAI,IAAI,EAAE,cAAc,EAAE,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAC1G,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,cAAc,CAOlB,OAAe,EAAE,UAAkB,EAAE,OAAU;QAC/C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAI,aAAa,OAAO,IAAI,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1F,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,UAAkB;QACnD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAsC,aAAa,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QAClH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,OAAmC,EAAE,IAAI,GAAG,OAAO;QACvF,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAW,IAAI,IAAI,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;QAC3F,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7DD,4BA6DC"}

package/dist/api/draft/types.d.ts

@@ -1,4 +1,5 @@
 import type { AStory } from '../../types/story';
+import type { CirculationReference } from '../migration-center/types';
 export type CreateExternalRedirectPayload = {
     redirect_to: string;
     document_id?: undefined;
@@ -44,4 +45,8 @@ export type UpdateDraftRevisionPayload = {
     ans: AStory;
     type: 'DRAFT';
 };
+export type Circulations = {
+    circulations: CirculationReference[];
+    last?: string;
+};
 export {};

package/dist/content-elements/content-elements.d.ts

@@ -0,0 +1,212 @@
+import type { CElement } from '../types/content-elements';
+import type { Alignment, AnImage } from '../types/story';
+export declare const ContentElement: {
+    divider: () => {
+        type: "divider";
+    };
+    text: (content: string, alignment?: Alignment) => {
+        type: "text";
+        content: string;
+        alignment: Alignment;
+    };
+    quote: (items: CElement[], citation?: string, subtype?: 'blockquote' | 'pullquote') => {
+        type: "quote";
+        subtype: "blockquote" | "pullquote";
+        citation: {
+            type: "text";
+            content: string;
+        };
+        content_elements: import("../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
+    };
+    interstitial_link: (url: string, content: string) => {
+        type: "interstitial_link";
+        url: string;
+        content: string;
+    };
+    header: (content: string, level: number) => {
+        type: "header";
+        content: string;
+        level: number;
+    };
+    raw_html: (content: string) => {
+        type: "raw_html";
+        content: string;
+    };
+    gallery: (id: string) => {
+        type: "reference";
+        referent: {
+            type: "gallery";
+            id: string;
+        };
+    };
+    list: (type: 'ordered' | 'unordered', items: CElement[]) => {
+        type: "list";
+        list_type: "ordered" | "unordered";
+        items: import("../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
+    };
+    link_list: (title: string, links: {
+        content: string;
+        url: string;
+    }[]) => {
+        type: "link_list";
+        title: string;
+        items: {
+            type: "interstitial_link";
+            content: string;
+            url: string;
+        }[];
+    };
+    image: (id: string, properties?: AnImage) => {
+        referent: {
+            id: string;
+            type: "image";
+            referent_properties: {
+                type: "image";
+                _id: string;
+                version?: "0.10.10" | undefined;
+                subtype?: string | undefined;
+                channels?: import("../types/story").ChannelTrait | undefined;
+                alignment?: Alignment | undefined;
+                language?: string | undefined;
+                copyright?: string | undefined;
+                canonical_url?: string | undefined;
+                short_url?: string | undefined;
+                created_date?: string | undefined;
+                last_updated_date?: string | undefined;
+                publish_date?: string | undefined;
+                first_publish_date?: string | undefined;
+                display_date?: string | undefined;
+                location?: string | undefined;
+                geo?: import("../types/story").Geo | undefined;
+                address?: import("../types/story").Address | undefined;
+                editor_note?: string | undefined;
+                status?: string | undefined;
+                headlines?: import("../types/story").Headlines | undefined;
+                subheadlines?: import("../types/story").SubHeadlines | undefined;
+                description?: import("../types/story").Description | undefined;
+                credits?: import("../types/story").CreditTrait | undefined;
+                vanity_credits?: import("../types/story").VanityCreditsTrait | undefined;
+                taxonomy?: import("../types/story").Taxonomy | undefined;
+                promo_items?: import("../types/story").PromoItems | undefined;
+                related_content?: import("../types/story").Related_Content | undefined;
+                owner?: import("../types/story").OwnerInformation | undefined;
+                planning?: import("../types/story").SchedulingInformation | undefined;
+                workflow?: import("../types/story").WorkflowInformation | undefined;
+                pitches?: import("../types/story").Pitches | undefined;
+                revision?: import("../types/story").Revision | undefined;
+                syndication?: import("../types/story").Syndication | undefined;
+                source?: import("../types/story").Source | undefined;
+                distributor?: import("../types/story").Distributor | undefined;
+                tracking?: import("../types/story").Tracking | undefined;
+                comments?: import("../types/story").Comments | undefined;
+                label?: import("../types/story").Label | undefined;
+                slug?: string | undefined;
+                content_restrictions?: import("../types/story").ContentRestrictions | undefined;
+                image_type?: string | undefined;
+                alt_text?: string | undefined;
+                focal_point?: import("../types/story").FocalPoint | undefined;
+                auth?: import("../types/story").Auth | undefined;
+                seo_filename?: string | undefined;
+                additional_properties?: import("../types/story").HasAdditionalProperties | undefined;
+                subtitle?: string | undefined;
+                caption?: string | undefined;
+                url?: string | undefined;
+                width?: number | undefined;
+                height?: number | undefined;
+                licensable?: boolean | undefined;
+                contributors?: import("../types/story").Contributors | undefined;
+            };
+        };
+        type: "reference";
+    };
+    jwPlayer: (id: string) => {
+        embed: {
+            config: {};
+            id: string;
+            url: string;
+        };
+        subtype: "jw_player";
+        type: "custom_embed";
+    };
+    twitter: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: "oembed";
+            type: "twitter";
+        };
+        type: "reference";
+    };
+    youtube: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+    facebook_video: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+    facebook_post: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+    soundcloud: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+    vimeo: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+    instagram: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+    dailymotion: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+    tiktok: (id: string, provider?: string) => {
+        referent: {
+            id: string;
+            provider: string;
+            service: string;
+            type: string;
+        };
+        type: "reference";
+    };
+};

package/dist/content-elements/content-elements.js

@@ -0,0 +1,202 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentElement = void 0;
+exports.ContentElement = {
+    divider: () => {
+        return {
+            type: 'divider',
+        };
+    },
+    text: (content, alignment = 'left') => {
+        return {
+            type: 'text',
+            content,
+            alignment,
+        };
+    },
+    quote: (items, citation = '', subtype = 'pullquote') => {
+        return {
+            type: 'quote',
+            subtype,
+            citation: {
+                type: 'text',
+                content: citation,
+            },
+            content_elements: items,
+        };
+    },
+    interstitial_link: (url, content) => {
+        return {
+            type: 'interstitial_link',
+            url,
+            content,
+        };
+    },
+    header: (content, level) => {
+        return {
+            type: 'header',
+            content,
+            level,
+        };
+    },
+    raw_html: (content) => {
+        return {
+            type: 'raw_html',
+            content,
+        };
+    },
+    gallery: (id) => {
+        return {
+            type: 'reference',
+            referent: {
+                type: 'gallery',
+                id,
+            },
+        };
+    },
+    list: (type, items) => {
+        return {
+            type: 'list',
+            list_type: type,
+            items,
+        };
+    },
+    link_list: (title, links) => {
+        return {
+            type: 'link_list',
+            title,
+            items: links.map(({ content, url }) => {
+                return {
+                    type: 'interstitial_link',
+                    content,
+                    url,
+                };
+            }),
+        };
+    },
+    image: (id, properties) => {
+        return {
+            referent: {
+                id,
+                type: 'image',
+                referent_properties: {
+                    _id: id,
+                    type: 'image',
+                    ...properties,
+                },
+            },
+            type: 'reference',
+        };
+    },
+    jwPlayer: (id) => {
+        return {
+            embed: {
+                config: {},
+                id,
+                url: 'https://cdn.jwplayer.com/players',
+            },
+            subtype: 'jw_player',
+            type: 'custom_embed',
+        };
+    },
+    twitter: (id, provider = 'https://publish.twitter.com/oembed?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'twitter',
+            },
+            type: 'reference',
+        };
+    },
+    youtube: (id, provider = 'https://www.youtube.com/oembed?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'youtube',
+            },
+            type: 'reference',
+        };
+    },
+    facebook_video: (id, provider = 'https://www.facebook.com/plugins/post/oembed.json/?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'facebook-video',
+            },
+            type: 'reference',
+        };
+    },
+    facebook_post: (id, provider = 'https://www.facebook.com/plugins/post/oembed.json/?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'facebook-post',
+            },
+            type: 'reference',
+        };
+    },
+    soundcloud: (id, provider = 'https://soundcloud.com/oembed.json/?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'soundcloud',
+            },
+            type: 'reference',
+        };
+    },
+    vimeo: (id, provider = 'https://vimeo.com/api/oembed.json?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'vimeo',
+            },
+            type: 'reference',
+        };
+    },
+    instagram: (id, provider = 'https://api.instagram.com/oembed?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'instagram',
+            },
+            type: 'reference',
+        };
+    },
+    dailymotion: (id, provider = 'https://www.dailymotion.com/services/oembed?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'dailymotion',
+            },
+            type: 'reference',
+        };
+    },
+    tiktok: (id, provider = 'https://www.tiktok.com/oembed?url=') => {
+        return {
+            referent: {
+                id,
+                provider,
+                service: 'oembed',
+                type: 'tiktok',
+            },
+            type: 'reference',
+        };
+    },
+};
+//# sourceMappingURL=content-elements.js.map

package/dist/content-elements/content-elements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"content-elements.js","sourceRoot":"","sources":["../../src/content-elements/content-elements.ts"],"names":[],"mappings":";;;AAGa,QAAA,cAAc,GAAG;IAC5B,OAAO,EAAE,GAAG,EAAE;QACZ,OAAO;YACL,IAAI,EAAE,SAAkB;SACzB,CAAC;IACJ,CAAC;IACD,IAAI,EAAE,CAAC,OAAe,EAAE,YAAuB,MAAM,EAAE,EAAE;QACvD,OAAO;YACL,IAAI,EAAE,MAAe;YACrB,OAAO;YACP,SAAS;SACV,CAAC;IACJ,CAAC;IACD,KAAK,EAAE,CAAC,KAAiB,EAAE,QAAQ,GAAG,EAAE,EAAE,UAAsC,WAAW,EAAE,EAAE;QAC7F,OAAO;YACL,IAAI,EAAE,OAAgB;YACtB,OAAO;YACP,QAAQ,EAAE;gBACR,IAAI,EAAE,MAAe;gBACrB,OAAO,EAAE,QAAQ;aAClB;YACD,gBAAgB,EAAE,KAAK;SACxB,CAAC;IACJ,CAAC;IACD,iBAAiB,EAAE,CAAC,GAAW,EAAE,OAAe,EAAE,EAAE;QAClD,OAAO;YACL,IAAI,EAAE,mBAA4B;YAClC,GAAG;YACH,OAAO;SACR,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,CAAC,OAAe,EAAE,KAAa,EAAE,EAAE;QACzC,OAAO;YACL,IAAI,EAAE,QAAiB;YACvB,OAAO;YACP,KAAK;SACN,CAAC;IACJ,CAAC;IACD,QAAQ,EAAE,CAAC,OAAe,EAAE,EAAE;QAC5B,OAAO;YACL,IAAI,EAAE,UAAmB;YACzB,OAAO;SACR,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC,EAAU,EAAE,EAAE;QACtB,OAAO;YACL,IAAI,EAAE,WAAoB;YAC1B,QAAQ,EAAE;gBACR,IAAI,EAAE,SAAkB;gBACxB,EAAE;aACH;SACF,CAAC;IACJ,CAAC;IACD,IAAI,EAAE,CAAC,IAA6B,EAAE,KAAiB,EAAE,EAAE;QACzD,OAAO;YACL,IAAI,EAAE,MAAe;YACrB,SAAS,EAAE,IAAI;YACf,KAAK;SACN,CAAC;IACJ,CAAC;IACD,SAAS,EAAE,CAAC,KAAa,EAAE,KAAyC,EAAE,EAAE;QACtE,OAAO;YACL,IAAI,EAAE,WAAoB;YAC1B,KAAK;YACL,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE;gBACpC,OAAO;oBACL,IAAI,EAAE,mBAA4B;oBAClC,OAAO;oBACP,GAAG;iBACJ,CAAC;YACJ,CAAC,CAAC;SACH,CAAC;IACJ,CAAC;IACD,KAAK,EAAE,CAAC,EAAU,EAAE,UAAoB,EAAE,EAAE;QAC1C,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,IAAI,EAAE,OAAgB;gBACtB,mBAAmB,EAAE;oBACnB,GAAG,EAAE,EAAE;oBACP,IAAI,EAAE,OAAgB;oBACtB,GAAG,UAAU;iBACd;aACF;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,QAAQ,EAAE,CAAC,EAAU,EAAE,EAAE;QACvB,OAAO;YACL,KAAK,EAAE;gBACL,MAAM,EAAE,EAAE;gBACV,EAAE;gBACF,GAAG,EAAE,kCAAkC;aACxC;YACD,OAAO,EAAE,WAAoB;YAC7B,IAAI,EAAE,cAAuB;SAC9B,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,yCAAyC,EAAE,EAAE;QAC5E,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAiB;gBAC1B,IAAI,EAAE,SAAkB;aACzB;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,qCAAqC,EAAE,EAAE;QACxE,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,SAAS;aAChB;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,cAAc,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,yDAAyD,EAAE,EAAE;QACnG,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,gBAAgB;aACvB;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,aAAa,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,yDAAyD,EAAE,EAAE;QAClG,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,eAAe;aACtB;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,UAAU,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,0CAA0C,EAAE,EAAE;QAChF,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,YAAY;aACnB;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,KAAK,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,wCAAwC,EAAE,EAAE;QACzE,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,OAAO;aACd;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,SAAS,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,uCAAuC,EAAE,EAAE;QAC5E,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,WAAW;aAClB;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,WAAW,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,kDAAkD,EAAE,EAAE;QACzF,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,aAAa;aACpB;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;IACD,MAAM,EAAE,CAAC,EAAU,EAAE,QAAQ,GAAG,oCAAoC,EAAE,EAAE;QACtE,OAAO;YACL,QAAQ,EAAE;gBACR,EAAE;gBACF,QAAQ;gBACR,OAAO,EAAE,QAAQ;gBACjB,IAAI,EAAE,QAAQ;aACf;YACD,IAAI,EAAE,WAAoB;SAC3B,CAAC;IACJ,CAAC;CACF,CAAC"}

package/dist/content-elements/html/html.constants.d.ts

@@ -0,0 +1 @@
+export declare const BLOCK_ELEMENT_TAGS: string[];

package/dist/content-elements/html/html.constants.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BLOCK_ELEMENT_TAGS = void 0;
+exports.BLOCK_ELEMENT_TAGS = [
+    'ADDRESS',
+    'ARTICLE',
+    'ASIDE',
+    'BLOCKQUOTE',
+    'DETAILS',
+    'DIV',
+    'DL',
+    'FIELDSET',
+    'FIGCAPTION',
+    'FIGURE',
+    'FOOTER',
+    'FORM',
+    'H1',
+    'H2',
+    'H3',
+    'H4',
+    'H5',
+    'H6',
+    'HEADER',
+    'HR',
+    'LINE',
+    'MAIN',
+    'MENU',
+    'NAV',
+    'OL',
+    'P',
+    'PARAGRAPH',
+    'PRE',
+    'SECTION',
+    'TABLE',
+    'UL',
+    'LI',
+    'BODY',
+    'HTML',
+];
+//# sourceMappingURL=html.constants.js.map

package/dist/content-elements/html/html.constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.constants.js","sourceRoot":"","sources":["../../../src/content-elements/html/html.constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,kBAAkB,GAAG;IAChC,SAAS;IACT,SAAS;IACT,OAAO;IACP,YAAY;IACZ,SAAS;IACT,KAAK;IACL,IAAI;IACJ,UAAU;IACV,YAAY;IACZ,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,QAAQ;IACR,IAAI;IACJ,MAAM;IACN,MAAM;IACN,MAAM;IACN,KAAK;IACL,IAAI;IACJ,GAAG;IACH,WAAW;IACX,KAAK;IACL,SAAS;IACT,OAAO;IACP,IAAI;IACJ,IAAI;IACJ,MAAM;IACN,MAAM;CACP,CAAC"}

package/dist/content-elements/html/html.processor.d.ts

@@ -0,0 +1,106 @@
+import { type CommentNode, type HTMLElement, type Node } from 'node-html-parser';
+import type { CElement, ContentElementType } from '../../types/content-elements';
+import type { MaybePromise } from '../../types/utils';
+export type NodeHandler = (node: Node) => MaybePromise<CElement[] | undefined>;
+export type WrapHandler = (node: Node, content: ContentElementType<'text'>) => ContentElementType<'text'> | undefined;
+/**
+ * HTMLProcessor is responsible for parsing HTML content into structured content elements.
+ * It provides a flexible way to handle different HTML nodes and wrap text content.
+ *
+ * The processor can be extended with custom handlers for specific node types and
+ * wrappers for text content.
+ *
+ * @example
+ * ```ts
+ * // Create and initialize processor
+ * const processor = new HTMLProcessor();
+ * processor.init();
+ *
+ * // Parse HTML content
+ * const html = '<div><p>Some text</p><img src="image.jpg"></div>';
+ * const elements = await processor.parse(html);
+ * ```
+ *
+ * The processor comes with built-in handlers for common HTML elements like links,
+ * text formatting (i, u, strong), and block elements. Custom handlers can be added
+ * using the `handle()` and `wrap()` methods.
+ */
+export declare class HTMLProcessor {
+    protected handlers: {
+        node: Map<string, NodeHandler>;
+        wrap: Map<string, WrapHandler>;
+    };
+    init(): void;
+    protected handle(name: string, handler: NodeHandler): void;
+    protected wrap(name: string, handler: WrapHandler): void;
+    parse(html: string): Promise<import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[]>;
+    protected addTextAdditionalProperties(c: ContentElementType<any>, parent: Node): any;
+    /**
+     * Wraps text content elements with additional properties and handlers.
+     * This method iterates through an array of content elements and applies
+     * wrappers to text elements.
+     *
+     * @param node - The HTML node containing the text elements
+     **/
+    protected wrapChildrenTextNodes(node: Node, elements: CElement[]): import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
+    /**
+     * Handles nested nodes by processing their children and merging text elements.
+     * This method recursively processes the children of a given HTML node and
+     * returns a list of content elements.
+     *
+     * @param node - The HTML node to process
+     **/
+    protected handleNested(node: Node): Promise<import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[]>;
+    /**
+     * Processes a single HTML node and converts it into content elements.
+     * This method iterates through registered node handlers and attempts to process the node.
+     * If a handler successfully processes the node, it returns an array of content elements.
+     *
+     * @param node - The HTML node to process
+     * @returns Promise resolving to an array of content elements, or undefined if node cannot be processed
+     */
+    protected process(node: Node): Promise<import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[] | undefined>;
+    /**
+     * Merges adjacent text content elements into a single paragraph.
+     * This method iterates through an array of content elements and combines
+     * adjacent text elements into a single paragraph.
+     *
+     * @param items - The array of content elements to merge
+     **/
+    private mergeParagraphs;
+    protected handleComment(_: CommentNode): MaybePromise<CElement[]>;
+    protected handleTable(node: Node): Promise<{
+        type: "raw_html";
+        content: string;
+    }[]>;
+    protected handleIframe(node: Node): Promise<{
+        type: "raw_html";
+        content: string;
+    }[]>;
+    protected handleImage(node: Node): Promise<{
+        type: "raw_html";
+        content: string;
+    }[]>;
+    protected handleBreak(_: Node): Promise<{
+        type: "divider";
+    }[]>;
+    protected createQuote(node: Node): Promise<{
+        type: "quote";
+        subtype: "blockquote" | "pullquote";
+        citation: {
+            type: "text";
+            content: string;
+        };
+        content_elements: import("../../types/story").AnElementThatCanBeListedAsPartOfContentElements[];
+    }[]>;
+    protected createText(node: Node): Promise<CElement[]>;
+    protected filterListItems(items: ContentElementType<any>[]): any[];
+    protected createList(node: Node, type: 'ordered' | 'unordered'): Promise<ContentElementType<any>[]>;
+    protected createHeader(node: HTMLElement): Promise<{
+        type: "header";
+        content: string;
+        level: number;
+    }[]>;
+    protected isBlockElement(node: Node): boolean;
+    protected warn(metadata: Record<string, any>, message: string): void;
+}