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

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,4 @@
-import { ArcAPI } 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';
+export * as ArcTypes from './types';
 export * from './api/identity/types';
 export * from './api/draft/types';
 export * from './api/site/types';
@@ -17,4 +12,9 @@ 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 } from './api';
+export { ArcUtils } from './utils/arc';
+export { ArcError } from './api/error';
+export { WsClient } from './api/ws.client';
+export { ContentElement, ContentElementType } from './content-elements';
+export * as AnsMapper from './mapper';

package/dist/index.js

@@ -26,19 +26,8 @@ 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;
-const api_1 = require("./api");
-Object.defineProperty(exports, "ArcAPI", { enumerable: true, get: function () { return api_1.ArcAPI; } });
-const error_1 = require("./api/error");
-Object.defineProperty(exports, "ArcError", { enumerable: true, get: function () { return error_1.ArcError; } });
-const ws_client_1 = require("./api/ws.client");
-Object.defineProperty(exports, "WsClient", { enumerable: true, get: function () { return ws_client_1.WsClient; } });
-const content_elements_1 = require("./content-elements");
-Object.defineProperty(exports, "ContentElement", { enumerable: true, get: function () { return content_elements_1.ContentElement; } });
-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; } });
+exports.AnsMapper = exports.ContentElement = exports.WsClient = exports.ArcError = exports.ArcUtils = exports.ArcAPI = exports.ArcTypes = void 0;
+exports.ArcTypes = __importStar(require("./types"));
 __exportStar(require("./api/identity/types"), exports);
 __exportStar(require("./api/draft/types"), exports);
 __exportStar(require("./api/site/types"), exports);
@@ -52,4 +41,15 @@ __exportStar(require("./api/photo-center/types"), exports);
 __exportStar(require("./api/global-settings/types"), exports);
 __exportStar(require("./api/tags/types"), exports);
 __exportStar(require("./api/content-ops/types"), exports);
+var api_1 = require("./api");
+Object.defineProperty(exports, "ArcAPI", { enumerable: true, get: function () { return api_1.ArcAPI; } });
+var arc_1 = require("./utils/arc");
+Object.defineProperty(exports, "ArcUtils", { enumerable: true, get: function () { return arc_1.ArcUtils; } });
+var error_1 = require("./api/error");
+Object.defineProperty(exports, "ArcError", { enumerable: true, get: function () { return error_1.ArcError; } });
+var ws_client_1 = require("./api/ws.client");
+Object.defineProperty(exports, "WsClient", { enumerable: true, get: function () { return ws_client_1.WsClient; } });
+var content_elements_1 = require("./content-elements");
+Object.defineProperty(exports, "ContentElement", { enumerable: true, get: function () { return content_elements_1.ContentElement; } });
+exports.AnsMapper = __importStar(require("./mapper"));
 //# sourceMappingURL=index.js.map

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,oDAAoC;AACpC,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;AAExC,6BAA2C;AAAlC,6FAAA,MAAM,OAAA;AACf,mCAAuC;AAA9B,+FAAA,QAAQ,OAAA;AACjB,qCAAuC;AAA9B,iGAAA,QAAQ,OAAA;AACjB,6CAA2C;AAAlC,qGAAA,QAAQ,OAAA;AACjB,uDAAwE;AAA/D,kHAAA,cAAc,OAAA;AACvB,sDAAsC"}

package/dist/mapper/doc.d.ts

@@ -0,0 +1,55 @@
+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 Document<ANS extends ANSContent> {
+    ans: ANS | null;
+    circulations: CirculationReference[];
+    init(): Promise<void>;
+    abstract sourceId(): MaybePromise<string>;
+    abstract sourceType(): MaybePromise<string>;
+    abstract websiteId(): MaybePromise<string>;
+    abstract legacyUrl(): MaybePromise<string>;
+    abstract arcId(): MaybePromise<string>;
+    abstract type(): MaybePromise<string>;
+    abstract groupId(): MaybePromise<string>;
+    abstract version(): ArcTypes.Story.DescribesTheANSVersionOfThisObject;
+    abstract getAns(): MaybePromise<ANS>;
+    prepare(): Promise<{
+        params: PostANSParams;
+        payload: PostANSPayload<ANS>;
+    }>;
+    private payload;
+    private params;
+    protected additionalProperties(): PostANSPayload['arcAdditionalProperties'];
+    protected priority(): 'historical' | 'live';
+    protected getDistributor(): MaybePromise<Optional<ArcTypes.Story.Distributor>>;
+    protected getLanguage(): string;
+    protected getComments(): Optional<ArcTypes.Story.Comments>;
+    protected getSource(): Promise<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/mapper/doc.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Document = 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 Document {
+    constructor() {
+        this.ans = null;
+        this.circulations = [];
+    }
+    async init() {
+        // fetch necessary data and validate it here
+    }
+    async prepare() {
+        await this.init();
+        const payload = await this.payload();
+        const params = await this.params();
+        return { payload, params };
+    }
+    async payload() {
+        this.ans = await this.getAns();
+        this.circulations = await this.getCirculations();
+        return {
+            sourceId: await this.sourceId(),
+            sourceType: await 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: await this.websiteId(),
+            groupId: await this.groupId(),
+            priority: this.priority(),
+        };
+    }
+    additionalProperties() {
+        return {
+            story: {
+                publish: false,
+            },
+        };
+    }
+    priority() {
+        return 'historical';
+    }
+    getDistributor() {
+        return;
+    }
+    getLanguage() {
+        return 'en-GB';
+    }
+    getComments() {
+        return;
+    }
+    async getSource() {
+        return {
+            name: 'code-store',
+            system: 'code-store',
+            source_id: await 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.Document = Document;
+//# sourceMappingURL=doc.js.map

package/dist/mapper/doc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc.js","sourceRoot":"","sources":["../../src/mapper/doc.ts"],"names":[],"mappings":";;;AAIA;;;;;;;;;GASG;AACH,MAAsB,QAAQ;IAA9B;QACS,QAAG,GAAe,IAAI,CAAC;QACvB,iBAAY,GAA2B,EAAE,CAAC;IA0JnD,CAAC;IAxJC,KAAK,CAAC,IAAI;QACR,4CAA4C;IAC9C,CAAC;IAaD,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,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,MAAM,IAAI,CAAC,QAAQ,EAAE;YAC/B,UAAU,EAAE,MAAM,IAAI,CAAC,UAAU,EAAE;YACnC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,uBAAuB,EAAE,IAAI,CAAC,oBAAoB,EAAE;SACrD,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,MAAM;QAClB,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;QAChG,CAAC;QAED,OAAO;YACL,OAAO,EAAE,MAAM,IAAI,CAAC,SAAS,EAAE;YAC/B,OAAO,EAAE,MAAM,IAAI,CAAC,OAAO,EAAE;YAC7B,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE;SAC1B,CAAC;IACJ,CAAC;IAES,oBAAoB;QAC5B,OAAO;YACL,KAAK,EAAE;gBACL,OAAO,EAAE,KAAK;aACf;SACF,CAAC;IACJ,CAAC;IAES,QAAQ;QAChB,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,KAAK,CAAC,SAAS;QACvB,OAAO;YACL,IAAI,EAAE,YAAY;YAClB,MAAM,EAAE,YAAY;YACpB,SAAS,EAAE,MAAM,IAAI,CAAC,QAAQ,EAAE;SACjC,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;AA5JD,4BA4JC"}

package/dist/mapper/index.d.ts

@@ -0,0 +1,2 @@
+export { Document } from './doc';
+export { Story } from './story';

package/dist/mapper/index.js

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

package/dist/mapper/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/mapper/index.ts"],"names":[],"mappings":";;;AAAA,6BAAiC;AAAxB,+FAAA,QAAQ,OAAA;AACjB,iCAAgC;AAAvB,8FAAA,KAAK,OAAA"}

package/dist/mapper/story.d.ts

@@ -0,0 +1,24 @@
+import type { ANSContent } from '../api/migration-center/types';
+import type * as Types from '../types';
+import { Document } 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 Story<ANS extends ANSContent = Types.Story.AStory> extends Document<ANS> {
+    type(): "story";
+    getAns(): Promise<ANS>;
+}

package/dist/mapper/story.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Story = 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 Story extends doc_1.Document {
+    type() {
+        return 'story';
+    }
+    async getAns() {
+        const id = await this.arcId();
+        const version = this.version();
+        const type = this.type();
+        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();
+        const websiteId = await this.websiteId();
+        const source = await this.getSource();
+        const comments = await this.getComments();
+        const legacyUrl = await this.legacyUrl();
+        return {
+            type,
+            _id: id,
+            version,
+            website: websiteId,
+            canonical_website: 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,
+            comments,
+            taxonomy: {
+                tags,
+            },
+            workflow: {
+                status_code: webskedStatusCode,
+            },
+            content_elements: contentElements,
+            additional_properties: {
+                url: legacyUrl,
+            },
+        };
+    }
+}
+exports.Story = Story;
+//# sourceMappingURL=story.js.map

package/dist/mapper/story.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"story.js","sourceRoot":"","sources":["../../src/mapper/story.ts"],"names":[],"mappings":";;;AAEA,+BAAiC;AAEjC;;;;;;;;;;;;;;;;GAgBG;AACH,MAAsB,KAAmD,SAAQ,cAAa;IAC5F,IAAI;QACF,OAAO,OAAgB,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,MAAM;QACV,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;QACzB,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;QAC5D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QACtC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC1C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;QAEzC,OAAO;YACL,IAAI;YACJ,GAAG,EAAE,EAAE;YACP,OAAO;YACP,OAAO,EAAE,SAAS;YAClB,iBAAiB,EAAE,SAAS;YAC5B,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;YACN,QAAQ;YACR,QAAQ,EAAE;gBACR,IAAI;aACL;YACD,QAAQ,EAAE;gBACR,WAAW,EAAE,iBAAiB;aAC/B;YACD,gBAAgB,EAAE,eAAe;YACjC,qBAAqB,EAAE;gBACrB,GAAG,EAAE,SAAS;aACf;SACgB,CAAC;IACtB,CAAC;CACF;AAlED,sBAkEC"}

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

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

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

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const content_elements_1 = require("../../content-elements");
+const mapper_1 = require("../../mapper");
+(0, vitest_1.describe)('Mapper', () => {
+    const ans = {
+        type: 'story',
+        _id: 'arc_id',
+        version: '1.0.0',
+        website: 'website_id',
+        canonical_website: 'website_id',
+        language: 'en-GB',
+        subtype: 'subtype',
+        credits: { by: [] },
+        headlines: { basic: '' },
+        subheadlines: { basic: '' },
+        description: { basic: '' },
+        created_date: vitest_1.expect.any(String),
+        first_publish_date: vitest_1.expect.any(String),
+        publish_date: vitest_1.expect.any(String),
+        display_date: vitest_1.expect.any(String),
+        source: { name: 'code-store', system: 'code-store', source_id: 'source_id' },
+        taxonomy: { tags: [] },
+        workflow: vitest_1.expect.any(Object),
+        content_elements: [{ type: 'text', content: '', alignment: 'left' }],
+        additional_properties: { url: 'legacy_url' },
+    };
+    const mocks = {
+        init: vitest_1.vi.fn().mockResolvedValue(undefined),
+        getSourceId: vitest_1.vi.fn().mockResolvedValue('source_id'),
+        getSourceType: vitest_1.vi.fn().mockResolvedValue('source_type'),
+        getWebsiteId: vitest_1.vi.fn().mockResolvedValue('website_id'),
+        getLegacyUrl: vitest_1.vi.fn().mockResolvedValue('legacy_url'),
+        getArcId: vitest_1.vi.fn().mockResolvedValue('arc_id'),
+        getGroupId: vitest_1.vi.fn().mockResolvedValue('group_id'),
+        getSubtype: vitest_1.vi.fn().mockResolvedValue('subtype'),
+        getContentElements: vitest_1.vi.fn().mockResolvedValue([content_elements_1.ContentElement.text('')]),
+    };
+    class CodeStory extends mapper_1.Story {
+        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.getSubtype = mocks.getSubtype;
+            this.getContentElements = mocks.getContentElements;
+        }
+    }
+    (0, vitest_1.beforeEach)(() => {
+        vitest_1.vi.clearAllMocks();
+    });
+    (0, vitest_1.test)('Should return valid ANS', async () => {
+        const story = new CodeStory();
+        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.test)('prepare() should call params, payload, 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');
+        const result = await story.prepare();
+        (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);
+        (0, vitest_1.expect)(result.params).toBeDefined();
+        (0, vitest_1.expect)(result.params.website).toBe('website_id');
+        (0, vitest_1.expect)(result.params.groupId).toBe('group_id');
+        (0, vitest_1.expect)(result.params.priority).toBe('historical');
+        (0, vitest_1.expect)(result.payload).toBeDefined();
+        (0, vitest_1.expect)(result.payload.sourceId).toBe('source_id');
+        (0, vitest_1.expect)(result.payload.sourceType).toBe('source_type');
+        (0, vitest_1.expect)(result.payload.ANS).toMatchObject(ans);
+    });
+});
+//# sourceMappingURL=mapper.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapper.test.js","sourceRoot":"","sources":["../../../src/tests/ans/mapper.test.ts"],"names":[],"mappings":";;AAAA,mCAAgE;AAChE,6DAAwD;AACxD,yCAAqC;AAErC,IAAA,iBAAQ,EAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,MAAM,GAAG,GAAG;QACV,IAAI,EAAE,OAAO;QACb,GAAG,EAAE,QAAQ;QACb,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,YAAY;QACrB,iBAAiB,EAAE,YAAY;QAC/B,QAAQ,EAAE,OAAO;QACjB,OAAO,EAAE,SAAS;QAClB,OAAO,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE;QACnB,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QACxB,YAAY,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QAC3B,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QAC1B,YAAY,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;QAChC,kBAAkB,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;QACtC,YAAY,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;QAChC,YAAY,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;QAChC,MAAM,EAAE,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE;QAC5E,QAAQ,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;QACtB,QAAQ,EAAE,eAAM,CAAC,GAAG,CAAC,MAAM,CAAC;QAC5B,gBAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;QACpE,qBAAqB,EAAE,EAAE,GAAG,EAAE,YAAY,EAAE;KAC7C,CAAC;IAEF,MAAM,KAAK,GAAG;QACZ,IAAI,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;QAC1C,WAAW,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,WAAW,CAAC;QACnD,aAAa,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,aAAa,CAAC;QACvD,YAAY,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC;QACrD,YAAY,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,YAAY,CAAC;QACrD,QAAQ,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC;QAC7C,UAAU,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,UAAU,CAAC;QACjD,UAAU,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,SAAS,CAAC;QAChD,kBAAkB,EAAE,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,iCAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;KACzE,CAAC;IAEF,MAAM,SAAU,SAAQ,cAAK;QAA7B;;YACE,YAAO,GAAG,GAAG,EAAE,CAAC,OAAc,CAAC;YAC/B,YAAO,GAAG,KAAK,CAAC,UAAU,CAAC;YAC3B,aAAQ,GAAG,KAAK,CAAC,WAAW,CAAC;YAC7B,eAAU,GAAG,KAAK,CAAC,aAAa,CAAC;YACjC,cAAS,GAAG,KAAK,CAAC,YAAY,CAAC;YAC/B,cAAS,GAAG,KAAK,CAAC,YAAY,CAAC;YAC/B,UAAK,GAAG,KAAK,CAAC,QAAQ,CAAC;YAEvB,SAAI,GAAG,KAAK,CAAC,IAAI,CAAC;YAClB,eAAU,GAAG,KAAK,CAAC,UAAU,CAAC;YAC9B,uBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC;QAChD,CAAC;KAAA;IAED,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;QAE9B,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;IACpC,CAAC,CAAC,CAAC;IAEH,IAAA,aAAI,EAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC/D,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,MAAM,GAAG,MAAM,KAAK,CAAC,OAAO,EAAE,CAAC;QAErC,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;QAEpD,IAAA,eAAM,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;QACpC,IAAA,eAAM,EAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QACjD,IAAA,eAAM,EAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAA,eAAM,EAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;QAElD,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;QACrC,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClD,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACtD,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAChD,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.1",
   "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": {