@code.store/arcxp-sdk-ts 4.6.3 → 4.7.0

package/dist/api/index.d.ts

@@ -6,6 +6,7 @@ import { ArcIdentity } from './identity';
 import { ArcIFX } from './ifx';
 import { ArcMigrationCenter } from './migration-center';
 import { ArcSales } from './sales';
+import { ArcSigningService } from './signing-service';
 import { ArcSite } from './site';
 import { ArcWebsked } from './websked';
 import { WsClient } from './ws.client';
@@ -21,4 +22,5 @@ export declare const ArcAPI: (options: ArcAPIOptions) => {
     Site: ArcSite;
     Websked: ArcWebsked;
     Content: ArcContent;
+    SigningService: ArcSigningService;
 };

package/dist/api/index.js

@@ -8,6 +8,7 @@ const identity_1 = require("./identity");
 const ifx_1 = require("./ifx");
 const migration_center_1 = require("./migration-center");
 const sales_1 = require("./sales");
+const signing_service_1 = require("./signing-service");
 const site_1 = require("./site");
 const websked_1 = require("./websked");
 const ws_client_1 = require("./ws.client");
@@ -22,6 +23,7 @@ const ArcAPI = (options) => {
         Site: new site_1.ArcSite(options),
         Websked: new websked_1.ArcWebsked(options),
         Content: new content_1.ArcContent(options),
+        SigningService: new signing_service_1.ArcSigningService(options),
     };
     return {
         ...API,

package/dist/api/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;AACA,qCAAqC;AACrC,uCAAuC;AACvC,mCAAmC;AACnC,yCAAyC;AACzC,+BAA+B;AAC/B,yDAAwD;AACxD,mCAAmC;AACnC,iCAAiC;AACjC,uCAAuC;AACvC,2CAAuC;AAEhC,MAAM,MAAM,GAAG,CAAC,OAAsB,EAAE,EAAE;IAC/C,MAAM,GAAG,GAAG;QACV,MAAM,EAAE,IAAI,kBAAS,CAAC,OAAO,CAAC;QAC9B,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,GAAG,EAAE,IAAI,YAAM,CAAC,OAAO,CAAC;QACxB,eAAe,EAAE,IAAI,qCAAkB,CAAC,OAAO,CAAC;QAChD,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,IAAI,EAAE,IAAI,cAAO,CAAC,OAAO,CAAC;QAC1B,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;QAChC,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;KACjC,CAAC;IAEF,OAAO;QACL,GAAG,GAAG;QACN,SAAS,EAAE,CAAC,GAAW,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,YAAY,EAAE,CAAC,QAA8B,GAAG,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,aAAa,OAAO,CAAC,WAAW,CAAC,gBAAgB,iDAAiD,KAAK,EAAE,CAAC;YAC1H,MAAM,OAAO,GAAG;gBACd,aAAa,EAAE,UAAU,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;aAC3D,CAAC;YACF,OAAO,IAAI,oBAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AA1BW,QAAA,MAAM,UA0BjB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":";;;AACA,qCAAqC;AACrC,uCAAuC;AACvC,mCAAmC;AACnC,yCAAyC;AACzC,+BAA+B;AAC/B,yDAAwD;AACxD,mCAAmC;AACnC,uDAAsD;AACtD,iCAAiC;AACjC,uCAAuC;AACvC,2CAAuC;AAEhC,MAAM,MAAM,GAAG,CAAC,OAAsB,EAAE,EAAE;IAC/C,MAAM,GAAG,GAAG;QACV,MAAM,EAAE,IAAI,kBAAS,CAAC,OAAO,CAAC;QAC9B,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,GAAG,EAAE,IAAI,YAAM,CAAC,OAAO,CAAC;QACxB,eAAe,EAAE,IAAI,qCAAkB,CAAC,OAAO,CAAC;QAChD,KAAK,EAAE,IAAI,gBAAQ,CAAC,OAAO,CAAC;QAC5B,IAAI,EAAE,IAAI,cAAO,CAAC,OAAO,CAAC;QAC1B,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;QAChC,OAAO,EAAE,IAAI,oBAAU,CAAC,OAAO,CAAC;QAChC,cAAc,EAAE,IAAI,mCAAiB,CAAC,OAAO,CAAC;KAC/C,CAAC;IAEF,OAAO;QACL,GAAG,GAAG;QACN,SAAS,EAAE,CAAC,GAAW,EAAE,EAAE;YACzB,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACtD,CAAC;QACD,YAAY,EAAE,CAAC,QAA8B,GAAG,EAAE,EAAE;YAClD,MAAM,OAAO,GAAG,aAAa,OAAO,CAAC,WAAW,CAAC,gBAAgB,iDAAiD,KAAK,EAAE,CAAC;YAC1H,MAAM,OAAO,GAAG;gBACd,aAAa,EAAE,UAAU,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE;aAC3D,CAAC;YACF,OAAO,IAAI,oBAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC5C,CAAC;KACF,CAAC;AACJ,CAAC,CAAC;AA3BW,QAAA,MAAM,UA2BjB"}

package/dist/api/signing-service/index.d.ts

@@ -0,0 +1,6 @@
+import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
+import { SignResponse } from './types';
+export declare class ArcSigningService extends ArcAbstractAPI {
+    constructor(options: ArcAPIOptions);
+    sign(service: string, serviceVersion: string, imageId: string): Promise<SignResponse>;
+}

package/dist/api/signing-service/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcSigningService = void 0;
+const abstract_api_1 = require("../abstract-api");
+class ArcSigningService extends abstract_api_1.ArcAbstractAPI {
+    constructor(options) {
+        super({ ...options, apiPath: 'signing-service' });
+    }
+    async sign(service, serviceVersion, imageId) {
+        const { data } = await this.client.get(`/v2/sign/${service}/${serviceVersion}?value=${encodeURI(imageId)}`);
+        return data;
+    }
+}
+exports.ArcSigningService = ArcSigningService;
+//# sourceMappingURL=index.js.map

package/dist/api/signing-service/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/signing-service/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAGhE,MAAa,iBAAkB,SAAQ,6BAAc;IACnD,YAAY,OAAsB;QAChC,KAAK,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,CAAC,CAAC;IACpD,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAe,EAAE,cAAsB,EAAE,OAAe;QACjE,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,OAAO,IAAI,cAAc,UAAU,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QAC5G,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AARD,8CAQC"}

package/dist/api/signing-service/types.d.ts

@@ -0,0 +1,4 @@
+export type SignResponse = {
+    hash: string;
+    type: string;
+};

package/dist/api/signing-service/types.js

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

package/dist/api/signing-service/types.js.map

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

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

@@ -1,7 +1,8 @@
 import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
-import { CreateTaskPayload, CreateTaskResponse, ReportStatusChangePayload } from './types';
+import { CreateTaskPayload, CreateTaskResponse, ReportStatusChangePayload, SectionStoriesPayload } 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>;
 }

package/dist/api/websked/index.js

@@ -14,6 +14,10 @@ class ArcWebsked extends abstract_api_1.ArcAbstractAPI {
         const { data } = await this.client.post('/tasks', payload);
         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;
+    }
 }
 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;AAGhE,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;CACF;AAdD,gCAcC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/websked/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAGhE,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;CACF;AA3BD,gCA2BC"}

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

@@ -58,3 +58,135 @@ export type CreateTaskPayload = {
     website: string;
     authoringApp: string;
 };
+export interface WebskedStory {
+    id: string;
+    analytics: null;
+    cms: string;
+    cmsEditURL: string;
+    contentType: string;
+    creators: WebskedStoryCreator[];
+    dates: WebskedStoryDates;
+    distributorId: string;
+    editors: string | null;
+    headline: string;
+    html: string;
+    location: string | null;
+    media: WebskedStoryMedia;
+    closedPlans: string[];
+    openPlans: string[] | null;
+    sections: WebskedStorySection[];
+    originatingPlan: string;
+    primarySection: WebskedStorySection;
+    slug: string | null;
+    source: string;
+    sourceId: string;
+    sourceName: string;
+    sourceType: string;
+    sponsored: boolean;
+    status: WebskedStoryStatus;
+    storyLength: WebskedStoryLength;
+    summary: string;
+    url: string;
+    usage: number | null;
+    publicationPitches: WebskedPublicationPitch[] | null;
+    pitches: WebskedPublicationPitch[] | null;
+    pitchCount: number | null;
+    kill: number | null;
+    stats: WebskedStoryStats;
+    plannedTimeChangeLog: number | null;
+    ansNote: string;
+    note: string | null;
+    tags: string[] | null;
+    promoImage: string;
+    budgetLine: string | null;
+    subtype: string;
+    subheadline: string;
+    leadArt: string | null;
+    leadArtType: string | null;
+    leadArtResizedURL: string | null;
+    ownerName: string | null;
+}
+export interface WebskedStoryCreator {
+    contributorId: string | null;
+    email: string | null;
+    itemRole: string | null;
+    name: string;
+    role: string;
+}
+export interface WebskedStoryDates {
+    created: number;
+    planned: number | null;
+    published: number;
+    scheduled: number | null;
+    updated: number;
+    websked: number;
+    firstPublish: number;
+    latestPublish: number;
+}
+export interface WebskedStoryMedia {
+    galleries: unknown[];
+    graphics: unknown[];
+    images: WebskedStoryImage[];
+    videos: unknown[];
+    willHaveGalleries: boolean;
+    willHaveGraphics: boolean;
+    willHaveImages: boolean;
+    willHaveVideos: boolean;
+}
+export interface WebskedStorySection {
+    id: string;
+    website: string;
+    name: string;
+}
+export interface WebskedStoryStatus {
+    publish: number;
+    publishRaw: number | null;
+    workflow: number;
+    workflowRaw: number | null;
+    live: boolean;
+    note: string | null;
+    paywallStatus: string;
+}
+export interface WebskedStoryLength {
+    planned: number | null;
+    actual: number | null;
+    characterCountPlanned: number | null;
+    characterCountActual: number;
+    wordCountPlanned: number | null;
+    wordCountActual: number;
+    inchCountPlanned: number | null;
+    inchCountActual: number;
+    lineCountPlanned: number | null;
+    lineCountActual: number;
+}
+export interface WebskedPublicationPitch {
+    publicationId: string;
+    currentStatus: string;
+    currentEdition: string;
+}
+export interface WebskedStoryStats {
+    deadlineMiss: number | null;
+    creationToPublish: number;
+}
+export interface WebskedStoryImage {
+    title: string | null;
+    caption: string;
+    url: string;
+    creators: WebskedStoryCreator[];
+    height: number;
+    width: number;
+    location: (string | null)[];
+}
+export type SectionStoriesPayload = {
+    id: string;
+    publicationId: string;
+    sectionId: string;
+    publicationTime: 1698138000;
+    closed: boolean;
+    finalized: boolean;
+    pitchedCount: number;
+    pitchedStories: string[];
+    note: string | null;
+    storyIds: string[];
+    stories?: WebskedStory[];
+};

package/package.json

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