@code.store/arcxp-sdk-ts 4.29.0 → 4.31.0

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

@@ -1,8 +1,9 @@
-import { GetStoryParams, SearchParams, SearchResponse } from './types';
+import { GetStoriesByIdsParams, GetStoryParams, SearchParams, SearchResponse } from './types';
 import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
 import { AStory } from '../../types/story';
 export declare class ArcContent extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
     getStory(params: GetStoryParams): Promise<AStory>;
     search(params: SearchParams): Promise<SearchResponse>;
+    getStoriesByIds(params: GetStoriesByIdsParams): Promise<SearchResponse>;
 }

package/dist/api/content/index.js

@@ -17,6 +17,11 @@ class ArcContent extends abstract_api_1.ArcAbstractAPI {
         const { data } = await this.client.get(`/search?${search}`);
         return data;
     }
+    async getStoriesByIds(params) {
+        const search = (0, querystring_1.stringify)({ ...params, ids: params.ids.join(',') });
+        const { data } = await this.client.get(`/ids?${search}`);
+        return data;
+    }
 }
 exports.ArcContent = ArcContent;
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/content/index.ts"],"names":[],"mappings":";;;AACA,kDAAgE;AAEhE,6CAAwC;AAExC,MAAa,UAAW,SAAQ,6BAAc;IAC5C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAsB;QACnC,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB;QAC/B,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAlBD,gCAkBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/content/index.ts"],"names":[],"mappings":";;;AACA,kDAAgE;AAEhE,6CAAwC;AAExC,MAAa,UAAW,SAAQ,6BAAc;IAC5C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,QAAQ,CAAC,MAAsB;QACnC,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAoB;QAC/B,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,MAAM,CAAC,CAAC;QAEjC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,WAAW,MAAM,EAAE,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,MAA6B;QACjD,MAAM,MAAM,GAAG,IAAA,uBAAS,EAAC,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,MAAM,EAAE,CAAC,CAAC;QACzD,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxBD,gCAwBC"}

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

@@ -6,6 +6,12 @@ export type GetStoryParams = {
     website: string;
     included_fields?: string;
 };
+export type GetStoriesByIdsParams = {
+    ids: string[];
+    published?: boolean;
+    website: string;
+    included_fields?: string;
+};
 export type SearchParams = {
     website: string;
     q?: string;

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

@@ -1,9 +1,12 @@
 import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
-import { CreateTaskPayload, CreateTaskResponse, GetPublicationsResponse, ReportStatusChangePayload, SectionStoriesPayload } from './types';
+import { CreateTaskPayload, CreateTaskResponse, GetEditionTimesResponse, GetPublicationsResponse, ReportStatusChangePayload, SectionEdition, WebskedPublication } from './types';
 export declare class ArcWebsked extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
     reportStatusChange(payload: ReportStatusChangePayload): Promise<void>;
     createTask(payload: CreateTaskPayload): Promise<CreateTaskResponse>;
-    getSectionStories(publicationId: string, sectionId: string, timestamp: number, includeStories?: boolean): Promise<SectionStoriesPayload>;
+    getEditionTimes(publicationId: string, startDate: number, endDate: number, numEditions?: number): Promise<GetEditionTimesResponse>;
+    getSectionStories(publicationId: string, sectionId: string, timestamp: number, includeStories?: boolean): Promise<SectionEdition>;
+    getSectionEditions(publicationId: string, sectionId: string, startDate: number, numEditions?: number): Promise<SectionEdition[]>;
     getPublications(nameRegex: string): Promise<GetPublicationsResponse>;
+    getPublicationById(publicationId: string): Promise<WebskedPublication>;
 }

package/dist/api/websked/index.js

@@ -14,14 +14,30 @@ class ArcWebsked extends abstract_api_1.ArcAbstractAPI {
         const { data } = await this.client.post('/tasks', payload);
         return data;
     }
+    async getEditionTimes(publicationId, startDate, endDate, numEditions = 1) {
+        const { data } = await this.client.get(`/publications/${publicationId}/editionTimes`, {
+            params: { startDate, endDate, numEditions },
+        });
+        return data;
+    }
     async getSectionStories(publicationId, sectionId, timestamp, includeStories = true) {
         const { data } = await this.client.get(`/publications/${publicationId}/sections/${sectionId}/editions/${timestamp}`, { params: { includeStories } });
         return data;
     }
+    async getSectionEditions(publicationId, sectionId, startDate, numEditions = 100) {
+        const { data } = await this.client.get(`/publications/${publicationId}/sections/${sectionId}/editions`, {
+            params: { startDate, numEditions },
+        });
+        return data;
+    }
     async getPublications(nameRegex) {
         const { data } = await this.client.get(`/publications`, { params: { nameRegex } });
         return data;
     }
+    async getPublicationById(publicationId) {
+        const { data } = await this.client.get(`/publications/${publicationId}`);
+        return data;
+    }
 }
 exports.ArcWebsked = ArcWebsked;
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/websked/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAShE,MAAa,UAAW,SAAQ,6BAAc;IAC5C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAkC;QACzD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAO,6BAA6B,EAAE,OAAO,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAA0B;QACzC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,aAAqB,EACrB,SAAiB,EACjB,SAAiB,EACjB,cAAc,GAAG,IAAI;QAErB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,iBAAiB,aAAa,aAAa,SAAS,aAAa,SAAS,EAAE,EAC5E,EAAE,MAAM,EAAE,EAAE,cAAc,EAAE,EAAE,CAC/B,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,SAAiB;QACrC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;QACnF,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAhCD,gCAgCC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/websked/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAWhE,MAAa,UAAW,SAAQ,6BAAc;IAC5C,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,OAAkC;QACzD,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAO,6BAA6B,EAAE,OAAO,CAAC,CAAC;QACtF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,OAA0B;QACzC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CACnB,aAAqB,EACrB,SAAiB,EACjB,OAAe,EACf,WAAW,GAAG,CAAC;QAEf,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,aAAa,eAAe,EAAE;YACpF,MAAM,EAAE,EAAE,SAAS,EAAE,OAAO,EAAE,WAAW,EAAE;SAC5C,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,aAAqB,EACrB,SAAiB,EACjB,SAAiB,EACjB,cAAc,GAAG,IAAI;QAErB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACpC,iBAAiB,aAAa,aAAa,SAAS,aAAa,SAAS,EAAE,EAC5E,EAAE,MAAM,EAAE,EAAE,cAAc,EAAE,EAAE,CAC/B,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,aAAqB,EACrB,SAAiB,EACjB,SAAiB,EACjB,WAAW,GAAG,GAAG;QAEjB,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,aAAa,aAAa,SAAS,WAAW,EAAE;YACtG,MAAM,EAAE,EAAE,SAAS,EAAE,WAAW,EAAE;SACnC,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,SAAiB;QACrC,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;QACnF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,aAAqB;QAC5C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,iBAAiB,aAAa,EAAE,CAAC,CAAC;QACzE,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA7DD,gCA6DC"}

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

@@ -177,7 +177,7 @@ export interface WebskedStoryImage {
     width: number;
     location: (string | null)[];
 }
-export type SectionStoriesPayload = {
+export type SectionEdition = {
     id: string;
     publicationId: string;
     sectionId: string;
@@ -190,6 +190,7 @@ export type SectionStoriesPayload = {
     storyIds: string[];
     stories?: WebskedStory[];
 };
+export type SectionStoriesPayload = SectionEdition;
 export interface WebskedPublication {
     createdDate: number;
     createdBy: string;
@@ -212,3 +213,7 @@ export type GetPublicationsResponse = {
     pageSize: number;
     results: WebskedPublication[];
 };
+export type GetEditionTimesResponse = {
+    sections: string[];
+    publicationTime: number;
+}[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "4.29.0",
+  "version": "4.31.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",