@code.store/arcxp-sdk-ts 3.0.0 → 3.2.0

package/README.md

@@ -1,2 +1,104 @@
 # arcxp-sdk-ts
-TypeScript SDK for ArcXP
+<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
+
+##### Usage example
+```ts
+import { ArcAPI } from '@code.store/arcxp-sdk-ts';
+
+const api = ArcAPI({
+  credentials: { organizationName: 'YOUR_ORG_NAME', accessToken: 'YOUR_ACCESS_TOKEN' },
+  maxRPS: 10,
+});
+const id = await api.Draft.generateId(Date.now().toString());
+```
+#### Content Elements
+* 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' },
+  maxRPS: 10,
+});
+const sourceImageId = 'sourceImageId';
+const id = await api.Draft.generateId(sourceImageId);
+const ans: ArcTypes.Story.AnImage = {
+  _id: id,
+  description: { basic: 'Description' },
+  caption: 'Caption',
+  subtitle: 'Subtitle',
+  alt_text: 'Alt',
+  type: 'image',
+  version: '0.10.9',
+  image_type: 'photograph',
+  source: {
+    name: 'codestore-arcxp-sdk-ts',
+    system: 'codestore-arcxp-sdk-ts',
+    source_id: sourceImageId,
+  },
+  additional_properties: {
+    originalName: 'originalName',
+    version: 0,
+    originalUrl: 'https://picsum.photos/200',
+    published: true,
+  },
+};
+
+await api.MigrationCenter.postAns(
+  {
+    website: 'YOUR_WEBSITE',
+    groupId: 'images',
+    priority: 'historical',
+  },
+  {
+    sourceId: sourceImageId,
+    sourceType: 'image',
+    ANS: ans,
+  }
+);
+```
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)
+

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

@@ -76,7 +76,7 @@ export type PostANSParams = {
 };
 export type GetANSParams = {
     ansId: string;
-    ansType: string;
+    ansType: ANSType;
 };
 export declare enum ANSType {
     Story = "story",
@@ -109,7 +109,7 @@ export type SummaryRecord = {
     sourceLocation: string;
     sourceAdditionalProperties: string;
     ansId: string;
-    ansType: string;
+    ansType: ANSType;
     ansLocation: string;
     status: MigrationStatus;
     website: string;
@@ -142,7 +142,7 @@ export type DetailReportRequest = {
     sourceId?: string;
     sourceType?: string;
     ansId?: string;
-    ansType?: string;
+    ansType?: ANSType;
     version?: string;
     documentType?: string;
 };

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

@@ -1,6 +1,7 @@
 import { ArcAbstractAPI, ArcAPIOptions } from '../abstract-api';
-import { ReportStatusChangePayload } from './types';
+import { CreateTaskPayload, CreateTaskResponse, ReportStatusChangePayload } from './types';
 export declare class ArcWebsked extends ArcAbstractAPI {
     constructor(options: ArcAPIOptions);
-    reportStatusChange(payload: ReportStatusChangePayload): Promise<any>;
+    reportStatusChange(payload: ReportStatusChangePayload): Promise<void>;
+    createTask(payload: CreateTaskPayload): Promise<CreateTaskResponse>;
 }

package/dist/api/websked/index.js

@@ -10,6 +10,10 @@ class ArcWebsked extends abstract_api_1.ArcAbstractAPI {
         const { data } = await this.client.post('/tasks/workflowStatusChange', payload);
         return data;
     }
+    async createTask(payload) {
+        const { data } = await this.client.post('/tasks', payload);
+        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,CAAC,6BAA6B,EAAE,OAAO,CAAC,CAAC;QAChF,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AATD,gCASC"}
+{"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"}

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

@@ -5,3 +5,56 @@ export type ReportStatusChangePayload = {
     newWorkflowStatus: number;
     note: string;
 };
+export type WebskedEvent = {
+    priority: number;
+    startDate?: number;
+    deadline?: number;
+    assignedGroup?: string;
+    assignedUser?: string;
+    datetime: number;
+    user: object;
+    note: string;
+    status: number;
+    customFields: Record<string, {
+        value: string;
+    }>;
+};
+export type CreateTaskResponse = {
+    id: string;
+    storyID: string;
+    type: number;
+    createdDate: number;
+    events: WebskedEvent[];
+    latestEvent: WebskedEvent;
+    creationEvent: WebskedEvent;
+    taskTemplateId: string | null;
+    website: string;
+    authoringApp: string;
+    startDate: number;
+    content: {
+        type: 'ans';
+        contentId: string;
+        versionId: null;
+    };
+};
+export type CreateTaskPayload = {
+    priority: number;
+    startDate?: number;
+    deadline?: number;
+    assignedGroup: string;
+    note: string;
+    status: number;
+    customFields: {
+        sourceId: {
+            value: string;
+        };
+    };
+    type: number;
+    storyID: string;
+    content: {
+        type: 'ans';
+        contentId: string;
+    };
+    website: string;
+    authoringApp: string;
+};

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@code.store/arcxp-sdk-ts",
-  "version": "3.0.0",
+  "version": "3.2.0",
   "description": "",
   "type": "commonjs",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "repository": {
+    "url": "https://github.com/code-store-platform/arcxp-sdk-ts"
+  },
+  "homepage": "https://github.com/code-store-platform/arcxp-sdk-ts",
   "files": [
     "dist"
   ],
@@ -13,10 +17,16 @@
     "lint": "tsc --noEmit && TIMING=1 eslint \"src/**/*.ts*\"",
     "test": "vitest"
   },
-  "keywords": [],
+  "keywords": [
+    "ArcXP",
+    "SDK",
+    "Code.Store"
+  ],
   "author": "code.store",
   "license": "MIT",
   "dependencies": {
+    "@changesets/changelog-github": "^0.4.8",
+    "@changesets/cli": "^2.26.2",
     "axios": "^1.4.0",
     "axios-rate-limit": "^1.3.0",
     "form-data": "^4.0.0",