@code.store/arcxp-sdk-ts 4.26.1 → 4.27.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
- import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
2
- import { CreateDocumentRedirectPayload, CreateExternalRedirectPayload, CreateRedirectPayload, DocumentRedirect, ExternalRedirect, Revision, Document } from './types';
1
+ import { ArcAbstractAPI, type ArcAPIOptions } from '../abstract-api';
2
+ import type { CreateDocumentRedirectPayload, CreateExternalRedirectPayload, CreateRedirectPayload, DocumentRedirect, ExternalRedirect, Revision, Document, UpdateDraftRevisionPayload } from './types';
3
3
  export declare class ArcDraft extends ArcAbstractAPI {
4
4
  constructor(options: ArcAPIOptions);
5
5
  generateId(id: string): Promise<string>;
@@ -9,4 +9,5 @@ export declare class ArcDraft extends ArcAbstractAPI {
9
9
  getDraftRevision(id: string, type?: string): Promise<Revision>;
10
10
  createRedirect<P extends CreateRedirectPayload, R = P extends CreateExternalRedirectPayload ? ExternalRedirect : P extends CreateDocumentRedirectPayload ? DocumentRedirect : never>(website: string, websiteUrl: string, payload: P): Promise<R>;
11
11
  getRedirect(website: string, websiteUrl: string): Promise<DocumentRedirect | ExternalRedirect>;
12
+ updateDraftRevision(id: string, payload: UpdateDraftRevisionPayload, type?: string): Promise<Revision>;
12
13
  }
@@ -34,6 +34,10 @@ class ArcDraft extends abstract_api_1.ArcAbstractAPI {
34
34
  const { data } = await this.client.get(`/redirect/${website}/${websiteUrl}`);
35
35
  return data;
36
36
  }
37
+ async updateDraftRevision(id, payload, type = 'story') {
38
+ const { data } = await this.client.put(`/${type}/${id}/revision/draft`, payload);
39
+ return data;
40
+ }
37
41
  }
38
42
  exports.ArcDraft = ArcDraft;
39
43
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/draft/index.ts"],"names":[],"mappings":";;;AAAA,kDAAgE;AAWhE,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,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;CACF;AA9CD,4BA8CC"}
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,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;AAnDD,4BAmDC"}
@@ -1,4 +1,4 @@
1
- import { AStory } from '../../types/story';
1
+ import type { AStory } from '../../types/story';
2
2
  export type CreateExternalRedirectPayload = {
3
3
  redirect_to: string;
4
4
  document_id?: undefined;
@@ -39,4 +39,9 @@ export type Document = {
39
39
  first_unpublished_at?: string;
40
40
  last_unpublished_at?: string;
41
41
  };
42
+ export type UpdateDraftRevisionPayload = {
43
+ document_id: string;
44
+ ans: AStory;
45
+ type: 'DRAFT';
46
+ };
42
47
  export {};
@@ -11,13 +11,13 @@ import { ArcSales } from './sales';
11
11
  import { ArcSigningService } from './signing-service';
12
12
  import { ArcSite } from './site';
13
13
  import { ArcWebsked } from './websked';
14
- import { WsClient } from './ws.client';
15
14
  import { GlobalSettings } from './global-settings';
16
15
  import { ArcTags } from './tags';
17
16
  import { ArcContentOps } from './content-ops';
17
+ import { ArcRetailEvents } from './retail-events';
18
18
  export declare const ArcAPI: (options: ArcAPIOptions) => {
19
19
  setMaxRPS: (rps: number) => void;
20
- RetailEvents: (index?: '0' | '1' | 'string') => WsClient;
20
+ RetailEvents: ArcRetailEvents;
21
21
  Author: ArcAuthor;
22
22
  Draft: ArcDraft;
23
23
  Identity: ArcIdentity;
package/dist/api/index.js CHANGED
@@ -13,10 +13,10 @@ const sales_1 = require("./sales");
13
13
  const signing_service_1 = require("./signing-service");
14
14
  const site_1 = require("./site");
15
15
  const websked_1 = require("./websked");
16
- const ws_client_1 = require("./ws.client");
17
16
  const global_settings_1 = require("./global-settings");
18
17
  const tags_1 = require("./tags");
19
18
  const content_ops_1 = require("./content-ops");
19
+ const retail_events_1 = require("./retail-events");
20
20
  const ArcAPI = (options) => {
21
21
  const API = {
22
22
  Author: new author_1.ArcAuthor(options),
@@ -40,13 +40,7 @@ const ArcAPI = (options) => {
40
40
  setMaxRPS: (rps) => {
41
41
  Object.values(API).forEach((a) => a.setMaxRPS(rps));
42
42
  },
43
- RetailEvents: (index = '0') => {
44
- const address = `wss://api.${options.credentials.organizationName}.arcpublishing.com/retail/api/v1/event/stream/${index}`;
45
- const headers = {
46
- Authorization: `Bearer ${options.credentials.accessToken}`,
47
- };
48
- return new ws_client_1.WsClient(address, { headers });
49
- },
43
+ RetailEvents: new retail_events_1.ArcRetailEvents(options),
50
44
  };
51
45
  };
52
46
  exports.ArcAPI = ArcAPI;
@@ -1 +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,yCAAyC;AACzC,yDAAwD;AACxD,iDAAgD;AAChD,mCAAmC;AACnC,uDAAsD;AACtD,iCAAiC;AACjC,uCAAuC;AACvC,2CAAuC;AACvC,uDAAmD;AACnD,iCAAiC;AACjC,+CAA8C;AAEvC,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,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,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;QAC9C,WAAW,EAAE,IAAI,6BAAc,CAAC,OAAO,CAAC;QACxC,cAAc,EAAE,IAAI,gCAAc,CAAC,OAAO,CAAC;QAC3C,IAAI,EAAE,IAAI,cAAO,CAAC,OAAO,CAAC;QAC1B,UAAU,EAAE,IAAI,2BAAa,CAAC,OAAO,CAAC;KACvC,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;AAhCW,QAAA,MAAM,UAgCjB"}
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,yCAAyC;AACzC,yDAAwD;AACxD,iDAAgD;AAChD,mCAAmC;AACnC,uDAAsD;AACtD,iCAAiC;AACjC,uCAAuC;AACvC,uDAAmD;AACnD,iCAAiC;AACjC,+CAA8C;AAC9C,mDAAkD;AAE3C,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,QAAQ,EAAE,IAAI,sBAAW,CAAC,OAAO,CAAC;QAClC,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;QAC9C,WAAW,EAAE,IAAI,6BAAc,CAAC,OAAO,CAAC;QACxC,cAAc,EAAE,IAAI,gCAAc,CAAC,OAAO,CAAC;QAC3C,IAAI,EAAE,IAAI,cAAO,CAAC,OAAO,CAAC;QAC1B,UAAU,EAAE,IAAI,2BAAa,CAAC,OAAO,CAAC;KACvC,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,IAAI,+BAAe,CAAC,OAAO,CAAC;KAC3C,CAAC;AACJ,CAAC,CAAC;AA1BW,QAAA,MAAM,UA0BjB"}
@@ -0,0 +1,7 @@
1
+ import type { ArcAPIOptions } from '../abstract-api';
2
+ import { WsClient } from '../ws.client';
3
+ export declare class ArcRetailEvents {
4
+ private readonly options;
5
+ constructor(options: Pick<ArcAPIOptions, 'credentials'>);
6
+ createWsClient(index?: '0' | '1' | 'string'): WsClient;
7
+ }
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ArcRetailEvents = void 0;
4
+ const ws_client_1 = require("../ws.client");
5
+ class ArcRetailEvents {
6
+ constructor(options) {
7
+ this.options = options;
8
+ }
9
+ createWsClient(index = '0') {
10
+ const address = `wss://api.${this.options.credentials.organizationName}.arcpublishing.com/retail/api/v1/event/stream/${index}`;
11
+ const headers = {
12
+ Authorization: `Bearer ${this.options.credentials.accessToken}`,
13
+ };
14
+ return new ws_client_1.WsClient(address, { headers });
15
+ }
16
+ }
17
+ exports.ArcRetailEvents = ArcRetailEvents;
18
+ //# sourceMappingURL=index.js.map
@@ -0,0 +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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@code.store/arcxp-sdk-ts",
3
- "version": "4.26.1",
3
+ "version": "4.27.1",
4
4
  "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.",
5
5
  "type": "commonjs",
6
6
  "main": "./dist/index.js",