@code.store/arcxp-sdk-ts 4.0.1 → 4.1.1

package/README.md

@@ -1,27 +1,33 @@
 # arcxp-sdk-ts
+
 <p align="left"> <a href="https://www.typescriptlang.org/" target="_blank" rel="noreferrer"> <img src="https://raw.githubusercontent.com/devicons/devicon/master/icons/typescript/typescript-original.svg" alt="typescript" width="40" height="40"/> </a> </p>
 
 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.
 
 ## Installation
+
 Install the package with:
 
 ```
 npm i @code.store/arcxp-sdk-ts
 ```
+
 ## Features
+
 #### API
-* Draft
-* Site
-* Websked
-* Identity
-* Sales
-* Retail Events (WebSockets)
-* Author
-* IFX
-* Migration Center
+
+- Draft
+- Site
+- Websked
+- Identity
+- Sales
+- Retail Events (WebSockets)
+- Author
+- IFX
+- Migration Center
 
 ##### Usage example
+
 ```ts
 import { ArcAPI } from '@code.store/arcxp-sdk-ts';
 
@@ -31,31 +37,33 @@ const api = ArcAPI({
 });
 const id = await api.Draft.generateId(Date.now().toString());
 ```
+
 #### Content Elements
-* text
-* header
-* image
-* quote
-* interstitial_link
-* raw_html
-* gallery
-* list
-* link_list
-* jwPlayer
+
+- text
+- header
+- image
+- quote
+- interstitial_link
+- raw_html
+- gallery
+- list
+- link_list
+- jwPlayer
 
 ##### Usage example
+
 ```ts
 import { ContentElement } from '@code.store/arcxp-sdk-ts';
 
 const header = ContentElement.header('Header', 4);
 const text = ContentElement.text('text');
-
 ```
 
 ## Image migration example
+
 ```ts
 import { ArcTypes, ArcAPI } from '@code.store/arcxp-sdk-ts';
-import { ArcAPI } from '../../../arc';
 
 const api = ArcAPI({
   credentials: { organizationName: 'YOUR_ORG_NAME', accessToken: 'YOUR_ACCESS_TOKEN' },
@@ -98,7 +106,11 @@ await api.MigrationCenter.postAns(
   }
 );
 ```
+
+## Changeset
+
+`npx changeset && npx changeset version`
+
 ## License
 
 [MIT](https://choosealicense.com/licenses/mit/)
-

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

@@ -0,0 +1,7 @@
+import { GetStoryParams } 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>;
+}

package/dist/api/content/index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ArcContent = void 0;
+const abstract_api_1 = require("../abstract-api");
+class ArcContent extends abstract_api_1.ArcAbstractAPI {
+    constructor(options) {
+        super({ ...options, apiPath: 'content/v4' });
+    }
+    async getStory(params) {
+        const search = new URLSearchParams({ ...params, published: params.published.toString() }).toString();
+        const { data } = await this.client.get(`/stories?${search}`);
+        return data;
+    }
+}
+exports.ArcContent = ArcContent;
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/content/index.ts"],"names":[],"mappings":";;;AACA,kDAAgE;AAGhE,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,IAAI,eAAe,CAAC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC;QAErG,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,YAAY,MAAM,EAAE,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAXD,gCAWC"}

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

@@ -0,0 +1,5 @@
+export type GetStoryParams = {
+    _id: string;
+    published: boolean;
+    website: string;
+};

package/dist/api/content/types.js

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

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

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

package/dist/api/index.d.ts

@@ -1,5 +1,6 @@
 import { ArcAPIOptions } from './abstract-api';
 import { ArcAuthor } from './author';
+import { ArcContent } from './content';
 import { ArcDraft } from './draft';
 import { ArcIdentity } from './identity';
 import { ArcIFX } from './ifx';
@@ -19,4 +20,5 @@ export declare const ArcAPI: (options: ArcAPIOptions) => {
     Sales: ArcSales;
     Site: ArcSite;
     Websked: ArcWebsked;
+    Content: ArcContent;
 };

package/dist/api/index.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArcAPI = void 0;
 const author_1 = require("./author");
+const content_1 = require("./content");
 const draft_1 = require("./draft");
 const identity_1 = require("./identity");
 const ifx_1 = require("./ifx");
@@ -20,6 +21,7 @@ const ArcAPI = (options) => {
         Sales: new sales_1.ArcSales(options),
         Site: new site_1.ArcSite(options),
         Websked: new websked_1.ArcWebsked(options),
+        Content: new content_1.ArcContent(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,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;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;AAzBW,QAAA,MAAM,UAyBjB"}
+{"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"}

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

@@ -33,29 +33,29 @@ type AuthorANS = {
     linkedin: string;
     status: boolean;
 };
+export type CirculationReference = {
+    document_id: string;
+    website_id: string;
+    website_url?: string;
+    primary_section?: SectionReference;
+    website_primary_section?: SectionReference;
+    website_sections: SectionReference[];
+};
+export type Operation = {
+    type: string;
+    story_id: string;
+    operation: string;
+    date: string;
+    organization_id: string;
+    endpoint: string;
+};
 export type PostANSPayload = {
     sourceId: string;
     sourceType: string;
     ANS: AStory | AnImage | AuthorANS | TagANS;
     references?: unknown[];
-    circulations?: [
-        {
-            document_id: string;
-            website_id: string;
-            website_url?: string;
-            primary_section: SectionReference;
-            website_primary_section: SectionReference;
-            website_sections: SectionReference[];
-        }
-    ];
-    operations?: {
-        type: string;
-        story_id: string;
-        operation: string;
-        date: string;
-        organization_id: string;
-        endpoint: string;
-    }[];
+    circulations?: CirculationReference[];
+    operations?: Operation[];
     arcAdditionalProperties?: {
         importPriority?: string;
         story?: {

package/dist/api/migration-center/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/api/migration-center/types.ts"],"names":[],"mappings":";;;AAgFA,IAAY,OAQX;AARD,WAAY,OAAO;IACjB,0BAAe,CAAA;IACf,0BAAe,CAAA;IACf,sBAAW,CAAA;IACX,4BAAiB,CAAA;IACjB,8BAAmB,CAAA;IACnB,0BAAe,CAAA;IACf,gCAAqB,CAAA;AACvB,CAAC,EARW,OAAO,GAAP,eAAO,KAAP,eAAO,QAQlB;AAED,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;IACjB,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,8CAA2B,CAAA;IAC3B,4CAAyB,CAAA;IACzB,sCAAmB,CAAA;IACnB,wDAAqC,CAAA;AACvC,CAAC,EAbW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAa1B;AA4DD,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,0CAAyB,CAAA;IACzB,0CAAyB,CAAA;IACzB,0BAAS,CAAA;AACX,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;IACX,iCAAa,CAAA;AACf,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/api/migration-center/types.ts"],"names":[],"mappings":";;;AAkFA,IAAY,OAQX;AARD,WAAY,OAAO;IACjB,0BAAe,CAAA;IACf,0BAAe,CAAA;IACf,sBAAW,CAAA;IACX,4BAAiB,CAAA;IACjB,8BAAmB,CAAA;IACnB,0BAAe,CAAA;IACf,gCAAqB,CAAA;AACvB,CAAC,EARW,OAAO,GAAP,eAAO,KAAP,eAAO,QAQlB;AAED,IAAY,eAaX;AAbD,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;IACjB,4CAAyB,CAAA;IACzB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,0CAAuB,CAAA;IACvB,8CAA2B,CAAA;IAC3B,4CAAyB,CAAA;IACzB,sCAAmB,CAAA;IACnB,wDAAqC,CAAA;AACvC,CAAC,EAbW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAa1B;AA4DD,IAAY,aAIX;AAJD,WAAY,aAAa;IACvB,0CAAyB,CAAA;IACzB,0CAAyB,CAAA;IACzB,0BAAS,CAAA;AACX,CAAC,EAJW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAIxB;AAED,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,+BAAW,CAAA;IACX,iCAAa,CAAA;AACf,CAAC,EAHW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAG3B"}

package/dist/index.d.ts

@@ -9,4 +9,5 @@ export * from './api/ifx/types';
 export * from './api/migration-center/types';
 export * from './api/sales/types';
 export * from './api/websked/types';
+export * from './api/content/types';
 export { ArcAPI, WsClient, ContentElement, ContentElementType, ArcTypes };

package/dist/index.js

@@ -42,4 +42,5 @@ __exportStar(require("./api/ifx/types"), exports);
 __exportStar(require("./api/migration-center/types"), exports);
 __exportStar(require("./api/sales/types"), exports);
 __exportStar(require("./api/websked/types"), exports);
+__exportStar(require("./api/content/types"), exports);
 //# 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;AAatB,uFAbA,YAAM,OAaA;AAZf,yDAAwE;AAY7C,+FAZlB,iCAAc,OAYkB;AAXzC,+CAA2C;AAW1B,yFAXR,oBAAQ,OAWQ;AAVzB,kDAAoC;AAU2B,4BAAQ;AARvE,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,kDAAgC;AAChC,+DAA6C;AAC7C,oDAAkC;AAClC,sDAAoC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+BAA+B;AActB,uFAdA,YAAM,OAcA;AAbf,yDAAwE;AAa7C,+FAblB,iCAAc,OAakB;AAZzC,+CAA2C;AAY1B,yFAZR,oBAAQ,OAYQ;AAXzB,kDAAoC;AAW2B,4BAAQ;AATvE,uDAAqC;AACrC,oDAAkC;AAClC,mDAAiC;AACjC,kDAAgC;AAChC,+DAA6C;AAC7C,oDAAkC;AAClC,sDAAoC;AACpC,sDAAoC"}

package/dist/utils/cache.d.ts

@@ -2,7 +2,7 @@
 export type CacheItem<Data> = {
     data: Data;
     ttl: number;
-    timer?: NodeJS.Timer;
+    timer?: NodeJS.Timeout;
 };
 export default class Cache<Data = any> {
     private ttl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "4.0.1",
+  "version": "4.1.1",
   "description": "",
   "type": "commonjs",
   "main": "./dist/index.js",
@@ -15,7 +15,8 @@
   "scripts": {
     "build": "tsc",
     "lint": "tsc --noEmit && TIMING=1 eslint \"src/**/*.ts*\"",
-    "test": "vitest"
+    "test": "vitest",
+    "cs": "npx changeset && npx changeset version"
   },
   "keywords": [
     "ArcXP",