@code.store/arcxp-sdk-ts 4.33.0 → 4.34.0

package/dist/ans/doc.d.ts

@@ -0,0 +1,56 @@
+import type { ANSContent, CirculationReference, PostANSParams, PostANSPayload } from '../api/migration-center/types';
+import type { ArcTypes, ContentElementType } from '..';
+import type { MaybePromise, Optional } from '../types/utils';
+/**
+ * Base class for all arc entities, it provides common methods and properties
+ * If you want to create a new entity subtype you should extend this class
+ *
+ * Use case: You want to migrate stories from BBC
+ * You define `class BBCStory extends ArcDocument<ArcTypes.Story.AStory>` and implement all abstract methods
+ * Then you can override the specific methods to enrich the story with the data from BBC
+ *
+ * To migrate it call .migrate() method
+ */
+export declare abstract class ArcDocument<ANS extends ANSContent> {
+    ans: ANS | null;
+    circulations: CirculationReference[];
+    init(): Promise<void>;
+    abstract get sourceId(): string;
+    abstract get sourceType(): string;
+    abstract get websiteId(): string;
+    abstract get legacyUrl(): string;
+    abstract get arcId(): string;
+    abstract get type(): string;
+    abstract get groupId(): string;
+    abstract get version(): ArcTypes.Story.DescribesTheANSVersionOfThisObject;
+    abstract getAns(): MaybePromise<ANS>;
+    abstract post(params: PostANSParams, payload: PostANSPayload): Promise<void>;
+    migrate(): Promise<{
+        params: PostANSParams;
+        payload: PostANSPayload<ANS>;
+    }>;
+    private payload;
+    private params;
+    protected get additionalProperties(): PostANSPayload['arcAdditionalProperties'];
+    protected get priority(): 'historical' | 'live';
+    protected getDistributor(): MaybePromise<Optional<ArcTypes.Story.Distributor>>;
+    protected getLanguage(): string;
+    protected getComments(): Optional<ArcTypes.Story.Comments>;
+    protected getSource(): Optional<ArcTypes.Story.Source>;
+    protected getSubheadlines(): Optional<ArcTypes.Story.SubHeadlines>;
+    protected getDescription(): Optional<ArcTypes.Story.Description>;
+    protected formatDate(date?: Date): string | undefined;
+    protected getDisplayDate(): Optional<Date>;
+    protected getContentElements(): Promise<ContentElementType<any>[]>;
+    protected getPublicationDate(): Optional<Date>;
+    protected getHeadlines(): Optional<ArcTypes.Story.Headlines>;
+    protected getTags(): MaybePromise<Optional<ArcTypes.Story.Tag[]>>;
+    protected getSubtype(): MaybePromise<Optional<ArcTypes.Story.SubtypeOrTemplate>>;
+    protected getLabel(): MaybePromise<Optional<ArcTypes.Story.Label>>;
+    protected getRelatedContent(): MaybePromise<Optional<ArcTypes.Story.Related_Content>>;
+    protected getPromoItems(): Promise<Optional<ArcTypes.Story.PromoItems>>;
+    protected getWebskedStatusCode(): MaybePromise<ArcTypes.Story.WorkflowInformation['status_code']>;
+    protected getCreditsBy(): MaybePromise<ArcTypes.Story.By>;
+    protected getCirculations(): MaybePromise<CirculationReference[]>;
+    protected getEditorNote(): MaybePromise<Optional<ArcTypes.Story.Editor_Note>>;
+}

package/dist/ans/doc.js

@@ -0,0 +1,132 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcDocument = void 0;
+/**
+ * Base class for all arc entities, it provides common methods and properties
+ * If you want to create a new entity subtype you should extend this class
+ *
+ * Use case: You want to migrate stories from BBC
+ * You define `class BBCStory extends ArcDocument<ArcTypes.Story.AStory>` and implement all abstract methods
+ * Then you can override the specific methods to enrich the story with the data from BBC
+ *
+ * To migrate it call .migrate() method
+ */
+class ArcDocument {
+    constructor() {
+        this.ans = null;
+        this.circulations = [];
+    }
+    async init() {
+        // fetch necessary data and validate it here
+    }
+    async migrate() {
+        await this.init();
+        const payload = await this.payload();
+        const params = await this.params();
+        await this.post(params, payload);
+        return { payload, params };
+    }
+    async payload() {
+        this.ans = await this.getAns();
+        this.circulations = await this.getCirculations();
+        return {
+            sourceId: this.sourceId,
+            sourceType: this.sourceType,
+            ANS: this.ans,
+            circulations: this.circulations,
+            arcAdditionalProperties: this.additionalProperties,
+        };
+    }
+    async params() {
+        if (!this.websiteId) {
+            throw new Error('Website is not initialized! get params() should be called after payload()!');
+        }
+        return {
+            website: this.websiteId,
+            groupId: this.groupId,
+            priority: this.priority,
+        };
+    }
+    get additionalProperties() {
+        return {
+            story: {
+                publish: false,
+            },
+        };
+    }
+    get priority() {
+        return 'historical';
+    }
+    getDistributor() {
+        return;
+    }
+    getLanguage() {
+        return 'en-GB';
+    }
+    getComments() {
+        return;
+    }
+    getSource() {
+        return {
+            name: 'code-store',
+            system: 'code-store',
+            source_id: this.sourceId,
+        };
+    }
+    getSubheadlines() {
+        return {
+            basic: '',
+        };
+    }
+    getDescription() {
+        return this.getSubheadlines();
+    }
+    formatDate(date) {
+        if (!date)
+            return;
+        return date.toISOString();
+    }
+    getDisplayDate() {
+        return new Date();
+    }
+    async getContentElements() {
+        return [];
+    }
+    getPublicationDate() {
+        return new Date();
+    }
+    getHeadlines() {
+        return {
+            basic: '',
+        };
+    }
+    getTags() {
+        return [];
+    }
+    getSubtype() {
+        return;
+    }
+    getLabel() {
+        return;
+    }
+    getRelatedContent() {
+        return;
+    }
+    async getPromoItems() {
+        return;
+    }
+    getWebskedStatusCode() {
+        return;
+    }
+    getCreditsBy() {
+        return [];
+    }
+    getCirculations() {
+        return [];
+    }
+    getEditorNote() {
+        return;
+    }
+}
+exports.ArcDocument = ArcDocument;
+//# sourceMappingURL=doc.js.map

package/dist/ans/doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc.js","sourceRoot":"","sources":["../../src/ans/doc.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;GASG;AACH,MAAsB,WAAW;IAAjC;QACS,QAAG,GAAe,IAAI,CAAC;QACvB,iBAAY,GAA2B,EAAE,CAAC;IA6JnD,CAAC;IA3JC,KAAK,CAAC,IAAI;QACR,4CAA4C;IAC9C,CAAC;IAcD,KAAK,CAAC,OAAO;QAIX,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAElB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAEnC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAEjC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;IAC7B,CAAC;IAEO,KAAK,CAAC,OAAO;QACnB,IAAI,CAAC,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QAC/B,IAAI,CAAC,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAEjD,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,uBAAuB,EAAE,IAAI,CAAC,oBAAoB;SACnD,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,MAAM;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAChG,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI,CAAC,SAAS;YACvB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;IACJ,CAAC;IAED,IAAc,oBAAoB;QAChC,OAAO;YACL,KAAK,EAAE;gBACL,OAAO,EAAE,KAAK;aACf;SACF,CAAC;IACJ,CAAC;IAED,IAAc,QAAQ;QACpB,OAAO,YAAY,CAAC;IACtB,CAAC;IAES,cAAc;QACtB,OAAO;IACT,CAAC;IAES,WAAW;QACnB,OAAO,OAAO,CAAC;IACjB,CAAC;IAES,WAAW;QACnB,OAAO;IACT,CAAC;IAES,SAAS;QACjB,OAAO;YACL,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE,IAAI,CAAC,QAAQ;SACzB,CAAC;IACJ,CAAC;IAES,eAAe;QACvB,OAAO;YACL,KAAK,EAAE,EAAE;SACV,CAAC;IACJ,CAAC;IAES,cAAc;QACtB,OAAO,IAAI,CAAC,eAAe,EAAE,CAAC;IAChC,CAAC;IAES,UAAU,CAAC,IAAW;QAC9B,IAAI,CAAC,IAAI;YAAE,OAAO;QAClB,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAES,cAAc;QACtB,OAAO,IAAI,IAAI,EAAE,CAAC;IACpB,CAAC;IAES,KAAK,CAAC,kBAAkB;QAChC,OAAO,EAAE,CAAC;IACZ,CAAC;IAES,kBAAkB;QAC1B,OAAO,IAAI,IAAI,EAAE,CAAC;IACpB,CAAC;IAES,YAAY;QACpB,OAAO;YACL,KAAK,EAAE,EAAE;SACV,CAAC;IACJ,CAAC;IAES,OAAO;QACf,OAAO,EAAE,CAAC;IACZ,CAAC;IAES,UAAU;QAClB,OAAO;IACT,CAAC;IAES,QAAQ;QAChB,OAAO;IACT,CAAC;IAES,iBAAiB;QACzB,OAAO;IACT,CAAC;IAES,KAAK,CAAC,aAAa;QAC3B,OAAO;IACT,CAAC;IAES,oBAAoB;QAC5B,OAAO;IACT,CAAC;IAES,YAAY;QACpB,OAAO,EAAE,CAAC;IACZ,CAAC;IAES,eAAe;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAES,aAAa;QACrB,OAAO;IACT,CAAC;CACF;AA/JD,kCA+JC"}

package/dist/ans/image.d.ts

@@ -0,0 +1,5 @@
+import type { ArcTypes } from '..';
+import { ArcDocument } from './doc';
+export declare abstract class ArcImage extends ArcDocument<ArcTypes.Story.AnImage> {
+    type: "image";
+}

package/dist/ans/image.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcImage = void 0;
+const doc_1 = require("./doc");
+class ArcImage extends doc_1.ArcDocument {
+    constructor() {
+        super(...arguments);
+        this.type = 'image';
+    }
+}
+exports.ArcImage = ArcImage;
+//# sourceMappingURL=image.js.map

package/dist/ans/image.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.js","sourceRoot":"","sources":["../../src/ans/image.ts"],"names":[],"mappings":";;;AACA,+BAAoC;AAEpC,MAAsB,QAAS,SAAQ,iBAAmC;IAA1E;;QACE,SAAI,GAAG,OAAgB,CAAC;IAC1B,CAAC;CAAA;AAFD,4BAEC"}

package/dist/ans/index.d.ts

@@ -0,0 +1,3 @@
+export { ArcDocument } from './doc';
+export { ArcStory } from './story';
+export { ArcImage } from './image';

package/dist/ans/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcImage = exports.ArcStory = exports.ArcDocument = void 0;
+var doc_1 = require("./doc");
+Object.defineProperty(exports, "ArcDocument", { enumerable: true, get: function () { return doc_1.ArcDocument; } });
+var story_1 = require("./story");
+Object.defineProperty(exports, "ArcStory", { enumerable: true, get: function () { return story_1.ArcStory; } });
+var image_1 = require("./image");
+Object.defineProperty(exports, "ArcImage", { enumerable: true, get: function () { return image_1.ArcImage; } });
+//# sourceMappingURL=index.js.map

package/dist/ans/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/ans/index.ts"],"names":[],"mappings":";;;AAAA,6BAAoC;AAA3B,kGAAA,WAAW,OAAA;AACpB,iCAAmC;AAA1B,iGAAA,QAAQ,OAAA;AACjB,iCAAmC;AAA1B,iGAAA,QAAQ,OAAA"}

package/dist/ans/story.d.ts

@@ -0,0 +1,58 @@
+import type { Story } from '../types';
+import { ArcDocument } from './doc';
+/**
+ * Base class for all arc stories, it provides common methods and properties
+ * If you want to create a new story subtype you should extend this class
+ *
+ * Use case: You want to migrate stories from BBC
+ * You define `class BBCStory extends ArcStory` and implement all abstract methods
+ * Then you need to override the specific methods to enrich the story with the data from BBC
+ *
+ * For example:
+ * To add tag to BBC stories you need to override
+ * protected getTags(): MaybePromise<ArcTypes.Story.Tag[]> {
+ *     return [{
+ *       slug: 'bbc',
+ *       text: 'bbc',
+ *     }];
+ * }
+ */
+export declare abstract class ArcStory extends ArcDocument<Story.AStory> {
+    type: "story";
+    getAns(): Promise<{
+        type: "story";
+        _id: string;
+        version: "0.10.10";
+        website: string;
+        canonical_website: string;
+        language: string;
+        subtype: import("../types/utils").Optional<string>;
+        label: import("../types/utils").Optional<Story.Label>;
+        editor_note: import("../types/utils").Optional<string>;
+        credits: {
+            by: Story.By;
+        };
+        headlines: import("../types/utils").Optional<Story.Headlines>;
+        subheadlines: import("../types/utils").Optional<Story.SubHeadlines>;
+        description: import("../types/utils").Optional<Story.Description>;
+        distributor: import("../types/utils").Optional<Story.Distributor>;
+        promo_items: import("../types/utils").Optional<Story.PromoItems>;
+        related_content: import("../types/utils").Optional<Story.Related_Content>;
+        created_date: string | undefined;
+        first_publish_date: string | undefined;
+        publish_date: string | undefined;
+        display_date: string | undefined;
+        source: import("../types/utils").Optional<Story.Source>;
+        comments: import("../types/utils").Optional<Story.Comments>;
+        taxonomy: {
+            tags: import("../types/utils").Optional<Story.Tag[]>;
+        };
+        workflow: {
+            status_code: number | undefined;
+        };
+        content_elements: any[];
+        additional_properties: {
+            url: string;
+        };
+    }>;
+}

package/dist/ans/story.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcStory = void 0;
+const doc_1 = require("./doc");
+/**
+ * Base class for all arc stories, it provides common methods and properties
+ * If you want to create a new story subtype you should extend this class
+ *
+ * Use case: You want to migrate stories from BBC
+ * You define `class BBCStory extends ArcStory` and implement all abstract methods
+ * Then you need to override the specific methods to enrich the story with the data from BBC
+ *
+ * For example:
+ * To add tag to BBC stories you need to override
+ * protected getTags(): MaybePromise<ArcTypes.Story.Tag[]> {
+ *     return [{
+ *       slug: 'bbc',
+ *       text: 'bbc',
+ *     }];
+ * }
+ */
+class ArcStory extends doc_1.ArcDocument {
+    constructor() {
+        super(...arguments);
+        this.type = 'story';
+    }
+    async getAns() {
+        const id = this.arcId;
+        const publicationDate = this.getPublicationDate();
+        const headlines = this.getHeadlines();
+        const subheadlines = this.getSubheadlines();
+        const description = this.getDescription();
+        const language = this.getLanguage();
+        const tags = await this.getTags();
+        const subtype = await this.getSubtype();
+        const label = await this.getLabel();
+        const by = await this.getCreditsBy();
+        const relatedContent = await this.getRelatedContent();
+        const editorNote = await this.getEditorNote();
+        const distributor = await this.getDistributor();
+        const promoItems = await this.getPromoItems();
+        const contentElements = await this.getContentElements();
+        const webskedStatusCode = await this.getWebskedStatusCode();
+        return {
+            type: this.type,
+            _id: id,
+            version: this.version,
+            website: this.websiteId,
+            canonical_website: this.websiteId,
+            language,
+            subtype,
+            label,
+            editor_note: editorNote,
+            credits: {
+                by,
+            },
+            headlines,
+            subheadlines,
+            description,
+            distributor,
+            promo_items: promoItems,
+            related_content: relatedContent,
+            created_date: this.formatDate(new Date()),
+            first_publish_date: this.formatDate(publicationDate),
+            publish_date: this.formatDate(publicationDate),
+            display_date: this.formatDate(this.getDisplayDate()),
+            source: this.getSource(),
+            comments: this.getComments(),
+            taxonomy: {
+                tags,
+            },
+            workflow: {
+                status_code: webskedStatusCode,
+            },
+            content_elements: contentElements,
+            additional_properties: {
+                url: this.legacyUrl,
+            },
+        };
+    }
+}
+exports.ArcStory = ArcStory;
+//# sourceMappingURL=story.js.map

package/dist/ans/story.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"story.js","sourceRoot":"","sources":["../../src/ans/story.ts"],"names":[],"mappings":";;;AACA,+BAAoC;AAEpC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAsB,QAAS,SAAQ,iBAAyB;IAAhE;;QACE,SAAI,GAAG,OAAgB,CAAC;IAyD1B,CAAC;IAvDC,KAAK,CAAC,MAAM;QACV,MAAM,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QACtB,MAAM,eAAe,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAClD,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE,CAAC;QACtC,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACpC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACxC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACrC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACtD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAChD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,eAAe,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;QACxD,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAE5D,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,GAAG,EAAE,EAAE;YACP,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,OAAO,EAAE,IAAI,CAAC,SAAS;YACvB,iBAAiB,EAAE,IAAI,CAAC,SAAS;YACjC,QAAQ;YACR,OAAO;YACP,KAAK;YACL,WAAW,EAAE,UAAU;YACvB,OAAO,EAAE;gBACP,EAAE;aACH;YACD,SAAS;YACT,YAAY;YACZ,WAAW;YACX,WAAW;YACX,WAAW,EAAE,UAAU;YACvB,eAAe,EAAE,cAAc;YAC/B,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;YACzC,kBAAkB,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACpD,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YAC9C,YAAY,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACpD,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE;YACxB,QAAQ,EAAE,IAAI,CAAC,WAAW,EAAE;YAC5B,QAAQ,EAAE;gBACR,IAAI;aACL;YACD,QAAQ,EAAE;gBACR,WAAW,EAAE,iBAAiB;aAC/B;YACD,gBAAgB,EAAE,eAAe;YACjC,qBAAqB,EAAE;gBACrB,GAAG,EAAE,IAAI,CAAC,SAAS;aACpB;SACF,CAAC;IACJ,CAAC;CACF;AA1DD,4BA0DC"}

package/dist/api/index.d.ts

@@ -34,3 +34,4 @@ export declare const ArcAPI: (options: ArcAPIOptions) => {
     Tags: ArcTags;
     ContentOps: ArcContentOps;
 };
+export type ArcAPIType = ReturnType<typeof ArcAPI>;

package/dist/api/migration-center/types.d.ts

@@ -54,10 +54,10 @@ export type Operation = {
     endpoint: string;
 };
 export type ANSContent = AStory | AGallery | AnImage | AuthorANS | TagANS | VideoContent;
-export type PostANSPayload = {
+export type PostANSPayload<ANS extends ANSContent = ANSContent> = {
     sourceId: string;
     sourceType: string;
-    ANS: ANSContent;
+    ANS: ANS;
     references?: unknown[];
     circulations?: CirculationReference[];
     operations?: Operation[];

package/dist/api/retail-events/index.d.ts

@@ -3,5 +3,5 @@ import { WsClient } from '../ws.client';
 export declare class ArcRetailEvents {
     private readonly options;
     constructor(options: Pick<ArcAPIOptions, 'credentials'>);
-    createWsClient(index?: '0' | '1' | 'string'): WsClient;
+    createWsClient(index?: '0' | '1' | string): WsClient;
 }

package/dist/api/retail-events/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/retail-events/index.ts"],"names":[],"mappings":";;;AACA,4CAAwC;AAExC,MAAa,eAAe;IAC1B,YAA6B,OAA2C;QAA3C,YAAO,GAAP,OAAO,CAAoC;IAAG,CAAC;IAE5E,cAAc,CAAC,QAA8B,GAAG;QAC9C,MAAM,OAAO,GAAG,aAAa,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB,iDAAiD,KAAK,EAAE,CAAC;QAC/H,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;SAChE,CAAC;QAEF,OAAO,IAAI,oBAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAXD,0CAWC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/retail-events/index.ts"],"names":[],"mappings":";;;AACA,4CAAwC;AAExC,MAAa,eAAe;IAC1B,YAA6B,OAA2C;QAA3C,YAAO,GAAP,OAAO,CAAoC;IAAG,CAAC;IAE5E,cAAc,CAAC,QAA4B,GAAG;QAC5C,MAAM,OAAO,GAAG,aAAa,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,gBAAgB,iDAAiD,KAAK,EAAE,CAAC;QAC/H,MAAM,OAAO,GAAG;YACd,aAAa,EAAE,UAAU,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;SAChE,CAAC;QAEF,OAAO,IAAI,oBAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5C,CAAC;CACF;AAXD,0CAWC"}

package/dist/index.d.ts

@@ -1,9 +1,10 @@
-import { ArcAPI } from './api';
+import { ArcAPI, ArcAPIType } from './api';
 import { ArcError } from './api/error';
 import { WsClient } from './api/ws.client';
 import { ContentElement, ContentElementType } from './content-elements';
 import * as ArcTypes from './types';
 import { ArcUtils } from './utils/arc';
+import * as ArcAns from './ans';
 export * from './api/identity/types';
 export * from './api/draft/types';
 export * from './api/site/types';
@@ -17,4 +18,4 @@ export * from './api/photo-center/types';
 export * from './api/global-settings/types';
 export * from './api/tags/types';
 export * from './api/content-ops/types';
-export { ArcAPI, ArcUtils, WsClient, ContentElement, ContentElementType, ArcTypes, ArcError };
+export { ArcAPI, ArcAPIType, ArcUtils, WsClient, ContentElement, ContentElementType, ArcTypes, ArcError, ArcAns };

package/dist/index.js

@@ -26,7 +26,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArcError = exports.ArcTypes = exports.ContentElement = exports.WsClient = exports.ArcUtils = exports.ArcAPI = void 0;
+exports.ArcAns = exports.ArcError = exports.ArcTypes = exports.ContentElement = exports.WsClient = exports.ArcUtils = exports.ArcAPI = void 0;
 const api_1 = require("./api");
 Object.defineProperty(exports, "ArcAPI", { enumerable: true, get: function () { return api_1.ArcAPI; } });
 const error_1 = require("./api/error");
@@ -39,6 +39,8 @@ const ArcTypes = __importStar(require("./types"));
 exports.ArcTypes = ArcTypes;
 const arc_1 = require("./utils/arc");
 Object.defineProperty(exports, "ArcUtils", { enumerable: true, get: function () { return arc_1.ArcUtils; } });
+const ArcAns = __importStar(require("./ans"));
+exports.ArcAns = ArcAns;
 __exportStar(require("./api/identity/types"), exports);
 __exportStar(require("./api/draft/types"), exports);
 __exportStar(require("./api/site/types"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA+B;AAqBtB,uFArBA,YAAM,OAqBA;AApBf,uCAAuC;AAoB4C,yFApB1E,gBAAQ,OAoB0E;AAnB3F,+CAA2C;AAmBhB,yFAnBlB,oBAAQ,OAmBkB;AAlBnC,yDAAwE;AAkBnC,+FAlB5B,iCAAc,OAkB4B;AAjBnD,kDAAoC;AAiBqC,4BAAQ;AAhBjF,qCAAuC;AAgBtB,yFAhBR,cAAQ,OAgBQ;AAdzB,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,kDAAgC;AAChC,uDAAqC;AACrC,+DAA6C;AAC7C,oDAAkC;AAClC,sDAAoC;AACpC,sDAAoC;AACpC,2DAAyC;AACzC,8DAA4C;AAC5C,mDAAiC;AACjC,0DAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA2C;AAsBlC,uFAtBA,YAAM,OAsBA;AArBf,uCAAuC;AAqBwD,yFArBtF,gBAAQ,OAqBsF;AApBvG,+CAA2C;AAoBJ,yFApB9B,oBAAQ,OAoB8B;AAnB/C,yDAAwE;AAmBvB,+FAnBxC,iCAAc,OAmBwC;AAlB/D,kDAAoC;AAkBiD,4BAAQ;AAjB7F,qCAAuC;AAiBV,yFAjBpB,cAAQ,OAiBoB;AAhBrC,8CAAgC;AAgByE,wBAAM;AAd/G,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,kDAAgC;AAChC,uDAAqC;AACrC,+DAA6C;AAC7C,oDAAkC;AAClC,sDAAoC;AACpC,sDAAoC;AACpC,2DAAyC;AACzC,8DAA4C;AAC5C,mDAAiC;AACjC,0DAAwC"}

package/dist/tests/ans/story.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/ans/story.test.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const story_1 = require("../../ans/story");
+const content_elements_1 = require("../../content-elements");
+const mocks = {
+    init: vitest_1.vi.fn().mockResolvedValue(undefined),
+    getSourceId: vitest_1.vi.fn().mockReturnValue('source_id'),
+    getSourceType: vitest_1.vi.fn().mockReturnValue('source_type'),
+    getWebsiteId: vitest_1.vi.fn().mockReturnValue('website_id'),
+    getLegacyUrl: vitest_1.vi.fn().mockReturnValue('legacy_url'),
+    getArcId: vitest_1.vi.fn().mockReturnValue('arc_id'),
+    getGroupId: vitest_1.vi.fn().mockReturnValue('group_id'),
+    getContentElements: vitest_1.vi.fn().mockResolvedValue([content_elements_1.ContentElement.text('')]),
+    post: vitest_1.vi.fn().mockResolvedValue(undefined),
+};
+class CodeStory extends story_1.ArcStory {
+    constructor() {
+        super(...arguments);
+        this.version = '1.0.0';
+        this.groupId = mocks.getGroupId();
+        this.sourceId = mocks.getSourceId();
+        this.sourceType = mocks.getSourceType();
+        this.websiteId = mocks.getWebsiteId();
+        this.legacyUrl = mocks.getLegacyUrl();
+        this.arcId = mocks.getArcId();
+        this.init = mocks.init;
+        this.post = mocks.post;
+        this.getContentElements = mocks.getContentElements;
+    }
+}
+(0, vitest_1.describe)('ArcStory', () => {
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.clearAllMocks();
+    });
+    (0, vitest_1.test)('Should return valid ANS', async () => {
+        const story = new CodeStory();
+        (0, vitest_1.expect)(story.sourceId).toBe('source_id');
+        (0, vitest_1.expect)(story.sourceType).toBe('source_type');
+        (0, vitest_1.expect)(story.websiteId).toBe('website_id');
+        (0, vitest_1.expect)(story.legacyUrl).toBe('legacy_url');
+        (0, vitest_1.expect)(story.arcId).toBe('arc_id');
+        const ans = await story.getAns();
+        (0, vitest_1.expect)(ans).toBeDefined();
+        (0, vitest_1.expect)(ans.type).toBe('story');
+        (0, vitest_1.expect)(ans._id).toBe('arc_id');
+        (0, vitest_1.expect)(ans.version).toBe('1.0.0');
+        (0, vitest_1.expect)(mocks.getSourceId).toBeCalledTimes(1);
+        (0, vitest_1.expect)(mocks.getSourceType).toBeCalledTimes(1);
+        (0, vitest_1.expect)(mocks.getWebsiteId).toBeCalledTimes(1);
+        (0, vitest_1.expect)(mocks.getLegacyUrl).toBeCalledTimes(1);
+        (0, vitest_1.expect)(mocks.getArcId).toBeCalledTimes(1);
+        (0, vitest_1.expect)(mocks.getGroupId).toBeCalledTimes(1);
+    });
+    (0, vitest_1.test)('migrate() should call post, getAns', async () => {
+        const story = new CodeStory();
+        const getAns = vitest_1.vi.spyOn(story, 'getAns');
+        const payload = vitest_1.vi.spyOn(story, 'payload');
+        const params = vitest_1.vi.spyOn(story, 'params');
+        await story.migrate();
+        (0, vitest_1.expect)(mocks.post).toBeCalledTimes(1);
+        (0, vitest_1.expect)(mocks.init).toBeCalledTimes(1);
+        (0, vitest_1.expect)(getAns).toBeCalledTimes(1);
+        (0, vitest_1.expect)(payload).toBeCalledTimes(1);
+        (0, vitest_1.expect)(params).toBeCalledTimes(1);
+        (0, vitest_1.expect)(mocks.getContentElements).toBeCalledTimes(1);
+    });
+});
+//# sourceMappingURL=story.test.js.map

package/dist/tests/ans/story.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"story.test.js","sourceRoot":"","sources":["../../../src/tests/ans/story.test.ts"],"names":[],"mappings":";;AAAA,mCAAgE;AAChE,2CAA2C;AAC3C,6DAAwD;AAExD,MAAM,KAAK,GAAG;IACZ,IAAI,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;IAC1C,WAAW,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,WAAW,CAAC;IACjD,aAAa,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,aAAa,CAAC;IACrD,YAAY,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC;IACnD,YAAY,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,YAAY,CAAC;IACnD,QAAQ,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,QAAQ,CAAC;IAC3C,UAAU,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,UAAU,CAAC;IAC/C,kBAAkB,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,iCAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IACxE,IAAI,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;CAC3C,CAAC;AAEF,MAAM,SAAU,SAAQ,gBAAQ;IAAhC;;QACE,YAAO,GAAG,OAAc,CAAC;QACzB,YAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QAC7B,aAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;QAC/B,eAAU,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;QACnC,cAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QACjC,cAAS,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC;QACjC,UAAK,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC;QAEzB,SAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAClB,SAAI,GAAG,KAAK,CAAC,IAAI,CAAC;QAClB,uBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC;IAChD,CAAC;CAAA;AAED,IAAA,iBAAQ,EAAC,UAAU,EAAE,GAAG,EAAE;IACxB,IAAA,mBAAU,EAAC,GAAG,EAAE;QACd,WAAE,CAAC,aAAa,EAAE,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACzC,MAAM,KAAK,GAAG,IAAI,SAAS,EAAE,CAAC;QAC9B,IAAA,eAAM,EAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACzC,IAAA,eAAM,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC7C,IAAA,eAAM,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAA,eAAM,EAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAC3C,IAAA,eAAM,EAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEnC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,MAAM,EAAE,CAAC;QAEjC,IAAA,eAAM,EAAC,GAAG,CAAC,CAAC,WAAW,EAAE,CAAC;QAC1B,IAAA,eAAM,EAAC,GAAG,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAA,eAAM,EAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC/B,IAAA,eAAM,EAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAElC,IAAA,eAAM,EAAC,KAAK,CAAC,WAAW,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC7C,IAAA,eAAM,EAAC,KAAK,CAAC,aAAa,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC/C,IAAA,eAAM,EAAC,KAAK,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAA,eAAM,EAAC,KAAK,CAAC,YAAY,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC9C,IAAA,eAAM,EAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAC1C,IAAA,eAAM,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QACpD,MAAM,KAAK,GAAG,IAAI,SAAS,EAAE,CAAC;QAC9B,MAAM,MAAM,GAAG,WAAE,CAAC,KAAK,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QACzC,MAAM,OAAO,GAAG,WAAE,CAAC,KAAK,CAAC,KAAK,EAAE,SAAgB,CAAC,CAAC;QAClD,MAAM,MAAM,GAAG,WAAE,CAAC,KAAK,CAAC,KAAK,EAAE,QAAe,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;QAEtB,IAAA,eAAM,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACtC,IAAA,eAAM,EAAC,KAAK,CAAC,IAAI,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACtC,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAClC,IAAA,eAAM,EAAC,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACnC,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QAClC,IAAA,eAAM,EAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/types/index.d.ts

@@ -3,3 +3,4 @@ export * as Story from './story';
 export * as Section from './section';
 export * as Gallery from './gallery';
 export * as Video from './video';
+export * as Utils from './utils';

package/dist/types/index.js

@@ -23,10 +23,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Video = exports.Gallery = exports.Section = exports.Story = exports.Author = void 0;
+exports.Utils = exports.Video = exports.Gallery = exports.Section = exports.Story = exports.Author = void 0;
 exports.Author = __importStar(require("./author"));
 exports.Story = __importStar(require("./story"));
 exports.Section = __importStar(require("./section"));
 exports.Gallery = __importStar(require("./gallery"));
 exports.Video = __importStar(require("./video"));
+exports.Utils = __importStar(require("./utils"));
 //# sourceMappingURL=index.js.map

package/dist/types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAmC;AACnC,iDAAiC;AACjC,qDAAqC;AACrC,qDAAqC;AACrC,iDAAiC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAmC;AACnC,iDAAiC;AACjC,qDAAqC;AACrC,qDAAqC;AACrC,iDAAiC;AACjC,iDAAiC"}

package/dist/types/utils.d.ts

@@ -0,0 +1,2 @@
+export type MaybePromise<T> = T | Promise<T>;
+export type Optional<T> = T | undefined;

package/dist/types/utils.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=utils.js.map

package/dist/types/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/types/utils.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "4.33.0",
+  "version": "4.34.0",
   "description": "A strongly typed set of ArcXP API's and utilities reduce the amount of work required to develop with ArcXP, starting with reducing the boilerplate code you have to write.",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -13,7 +13,9 @@
     "url": "https://github.com/code-store-platform/arcxp-sdk-ts"
   },
   "homepage": "https://github.com/code-store-platform/arcxp-sdk-ts",
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsc",
     "format": "npx @biomejs/biome format --write .",
@@ -24,7 +26,11 @@
     "cs": "npx changeset && npx changeset version",
     "swaggerToTypes": "npx swagger-typescript-api -p ./tmp/swagger.json -o ./tmp -n swaggerTypes.ts"
   },
-  "keywords": ["ArcXP", "SDK", "Code.Store"],
+  "keywords": [
+    "ArcXP",
+    "SDK",
+    "Code.Store"
+  ],
   "author": "code.store",
   "license": "MIT",
   "dependencies": {