@code.store/arcxp-sdk-ts 2.0.3 → 3.0.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.
- package/README.md +103 -1
- package/dist/api/index.d.ts +1 -1
- package/dist/api/index.js +2 -5
- package/dist/api/index.js.map +1 -1
- package/dist/api/ws.client.d.ts +1 -1
- package/dist/api/ws.client.js +2 -1
- package/dist/api/ws.client.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +2 -5
- package/dist/index.js.map +1 -1
- package/package.json +10 -2
package/README.md
CHANGED
|
@@ -1,2 +1,104 @@
|
|
|
1
1
|
# arcxp-sdk-ts
|
|
2
|
-
|
|
2
|
+
<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>
|
|
3
|
+
|
|
4
|
+
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
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
Install the package with:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
npm i @code.store/arcxp-sdk-ts
|
|
11
|
+
```
|
|
12
|
+
## Features
|
|
13
|
+
#### API
|
|
14
|
+
* Draft
|
|
15
|
+
* Site
|
|
16
|
+
* Websked
|
|
17
|
+
* Identity
|
|
18
|
+
* Sales
|
|
19
|
+
* Retail Events (WebSockets)
|
|
20
|
+
* Author
|
|
21
|
+
* IFX
|
|
22
|
+
* Migration Center
|
|
23
|
+
|
|
24
|
+
##### Usage example
|
|
25
|
+
```ts
|
|
26
|
+
import { ArcAPI } from '@code.store/arcxp-sdk-ts';
|
|
27
|
+
|
|
28
|
+
const api = ArcAPI({
|
|
29
|
+
credentials: { organizationName: 'YOUR_ORG_NAME', accessToken: 'YOUR_ACCESS_TOKEN' },
|
|
30
|
+
maxRPS: 10,
|
|
31
|
+
});
|
|
32
|
+
const id = await api.Draft.generateId(Date.now().toString());
|
|
33
|
+
```
|
|
34
|
+
#### Content Elements
|
|
35
|
+
* text
|
|
36
|
+
* header
|
|
37
|
+
* image
|
|
38
|
+
* quote
|
|
39
|
+
* interstitial_link
|
|
40
|
+
* raw_html
|
|
41
|
+
* gallery
|
|
42
|
+
* list
|
|
43
|
+
* link_list
|
|
44
|
+
* jwPlayer
|
|
45
|
+
|
|
46
|
+
##### Usage example
|
|
47
|
+
```ts
|
|
48
|
+
import { ContentElement } from '@code.store/arcxp-sdk-ts';
|
|
49
|
+
|
|
50
|
+
const header = ContentElement.header('Header', 4);
|
|
51
|
+
const text = ContentElement.text('text');
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Image migration example
|
|
56
|
+
```ts
|
|
57
|
+
import { ArcTypes, ArcAPI } from '@code.store/arcxp-sdk-ts';
|
|
58
|
+
import { ArcAPI } from '../../../arc';
|
|
59
|
+
|
|
60
|
+
const api = ArcAPI({
|
|
61
|
+
credentials: { organizationName: 'YOUR_ORG_NAME', accessToken: 'YOUR_ACCESS_TOKEN' },
|
|
62
|
+
maxRPS: 10,
|
|
63
|
+
});
|
|
64
|
+
const sourceImageId = 'sourceImageId';
|
|
65
|
+
const id = await api.Draft.generateId(sourceImageId);
|
|
66
|
+
const ans: ArcTypes.Story.AnImage = {
|
|
67
|
+
_id: id,
|
|
68
|
+
description: { basic: 'Description' },
|
|
69
|
+
caption: 'Caption',
|
|
70
|
+
subtitle: 'Subtitle',
|
|
71
|
+
alt_text: 'Alt',
|
|
72
|
+
type: 'image',
|
|
73
|
+
version: '0.10.9',
|
|
74
|
+
image_type: 'photograph',
|
|
75
|
+
source: {
|
|
76
|
+
name: 'codestore-arcxp-sdk-ts',
|
|
77
|
+
system: 'codestore-arcxp-sdk-ts',
|
|
78
|
+
source_id: sourceImageId,
|
|
79
|
+
},
|
|
80
|
+
additional_properties: {
|
|
81
|
+
originalName: 'originalName',
|
|
82
|
+
version: 0,
|
|
83
|
+
originalUrl: 'https://picsum.photos/200',
|
|
84
|
+
published: true,
|
|
85
|
+
},
|
|
86
|
+
};
|
|
87
|
+
|
|
88
|
+
await api.MigrationCenter.postAns(
|
|
89
|
+
{
|
|
90
|
+
website: 'YOUR_WEBSITE',
|
|
91
|
+
groupId: 'images',
|
|
92
|
+
priority: 'historical',
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
sourceId: sourceImageId,
|
|
96
|
+
sourceType: 'image',
|
|
97
|
+
ANS: ans,
|
|
98
|
+
}
|
|
99
|
+
);
|
|
100
|
+
```
|
|
101
|
+
## License
|
|
102
|
+
|
|
103
|
+
[MIT](https://choosealicense.com/licenses/mit/)
|
|
104
|
+
|
package/dist/api/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@ import { ArcMigrationCenter } from './migration-center';
|
|
|
7
7
|
import { ArcSales } from './sales';
|
|
8
8
|
import { ArcSite } from './site';
|
|
9
9
|
import { ArcWebsked } from './websked';
|
|
10
|
-
import WsClient from './ws.client';
|
|
10
|
+
import { WsClient } from './ws.client';
|
|
11
11
|
export declare const ArcAPI: (options: ArcAPIOptions) => {
|
|
12
12
|
setMaxRPS: (rps: number) => void;
|
|
13
13
|
RetailEvents: (index?: '0' | '1' | 'string') => WsClient;
|
package/dist/api/index.js
CHANGED
|
@@ -1,7 +1,4 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
-
};
|
|
5
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
3
|
exports.ArcAPI = void 0;
|
|
7
4
|
const author_1 = require("./author");
|
|
@@ -12,7 +9,7 @@ const migration_center_1 = require("./migration-center");
|
|
|
12
9
|
const sales_1 = require("./sales");
|
|
13
10
|
const site_1 = require("./site");
|
|
14
11
|
const websked_1 = require("./websked");
|
|
15
|
-
const ws_client_1 =
|
|
12
|
+
const ws_client_1 = require("./ws.client");
|
|
16
13
|
const ArcAPI = (options) => {
|
|
17
14
|
const API = {
|
|
18
15
|
Author: new author_1.ArcAuthor(options),
|
|
@@ -34,7 +31,7 @@ const ArcAPI = (options) => {
|
|
|
34
31
|
const headers = {
|
|
35
32
|
Authorization: `Bearer ${options.credentials.accessToken}`,
|
|
36
33
|
};
|
|
37
|
-
return new ws_client_1.
|
|
34
|
+
return new ws_client_1.WsClient(address, { headers });
|
|
38
35
|
},
|
|
39
36
|
};
|
|
40
37
|
};
|
package/dist/api/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api/index.ts"],"names":[],"mappings":"
|
|
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"}
|
package/dist/api/ws.client.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import ws from 'ws';
|
|
2
2
|
export type PromiseOr<T> = Promise<T> | T;
|
|
3
3
|
export type Callback<Args extends any[] = any[]> = (...args: Args) => PromiseOr<void>;
|
|
4
|
-
export
|
|
4
|
+
export declare class WsClient {
|
|
5
5
|
private address;
|
|
6
6
|
private readonly options;
|
|
7
7
|
private socket?;
|
package/dist/api/ws.client.js
CHANGED
|
@@ -3,6 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
3
3
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
4
|
};
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.WsClient = void 0;
|
|
6
7
|
const ws_1 = __importDefault(require("ws"));
|
|
7
8
|
class WsClient {
|
|
8
9
|
constructor(address, options) {
|
|
@@ -63,5 +64,5 @@ class WsClient {
|
|
|
63
64
|
}
|
|
64
65
|
}
|
|
65
66
|
}
|
|
66
|
-
exports.
|
|
67
|
+
exports.WsClient = WsClient;
|
|
67
68
|
//# sourceMappingURL=ws.client.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ws.client.js","sourceRoot":"","sources":["../../src/api/ws.client.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ws.client.js","sourceRoot":"","sources":["../../src/api/ws.client.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AAKpB,MAAa,QAAQ;IAGnB,YAAoB,OAAe,EAAmB,OAAyB;QAA3D,YAAO,GAAP,OAAO,CAAQ;QAAmB,YAAO,GAAP,OAAO,CAAkB;QAgCvE,aAAQ,GAAG,KAAK,CAAC;IAhCyD,CAAC;IAMnF,KAAK,CAAC,OAAO;QACX,IAAI,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI;YAAE,OAAO;QAEvE,MAAM,MAAM,GAAG,IAAI,YAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,MAAM,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAE9C,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpC,MAAM,CAAC,OAAO,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1C,MAAM,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,SAAS,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;YAC9B,IAAI,OAA4B,CAAC;YACjC,IAAI;gBACF,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;aACvC;YAAC,OAAO,KAAK,EAAE;gBACd,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;aAC5C;YAED,IAAI,CAAC,SAAS,EAAE,CAAC,OAAO,CAAC,CAAC;QAC5B,CAAC,CAAC;QAEF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC;IAClB,CAAC;IAGD,KAAK,CAAC,KAAqB;QACzB,IAAI,IAAI,CAAC,QAAQ;YAAE,OAAO;QAC1B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAC;QACrB,IAAI,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,IAAY;QACrB,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACpC,IAAI,CAAC,MAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;gBAChC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YAC7C,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,cAAc;QACpB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC5C;QAED,MAAM,EAAE,UAAU,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACzC,IAAI,UAAU,KAAK,IAAI;YAAE,OAAO;QAChC,IAAI,UAAU,GAAG,IAAI,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;SAC/C;QACD,IAAI,UAAU,GAAG,IAAI,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;IACH,CAAC;CACF;AAnED,4BAmEC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ArcAPI } from './api';
|
|
2
2
|
import { ContentElement, ContentElementType } from './content-elements';
|
|
3
|
+
import { WsClient } from './api/ws.client';
|
|
3
4
|
import * as ArcTypes from './types';
|
|
4
|
-
import WsClient from './api/ws.client';
|
|
5
5
|
export * from './api/identity/types';
|
|
6
6
|
export * from './api/draft/types';
|
|
7
7
|
export * from './api/site/types';
|
package/dist/index.js
CHANGED
|
@@ -25,19 +25,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
25
25
|
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
26
26
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
27
27
|
};
|
|
28
|
-
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
29
|
-
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
30
|
-
};
|
|
31
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
32
29
|
exports.ArcTypes = exports.ContentElement = exports.WsClient = exports.ArcAPI = void 0;
|
|
33
30
|
const api_1 = require("./api");
|
|
34
31
|
Object.defineProperty(exports, "ArcAPI", { enumerable: true, get: function () { return api_1.ArcAPI; } });
|
|
35
32
|
const content_elements_1 = require("./content-elements");
|
|
36
33
|
Object.defineProperty(exports, "ContentElement", { enumerable: true, get: function () { return content_elements_1.ContentElement; } });
|
|
34
|
+
const ws_client_1 = require("./api/ws.client");
|
|
35
|
+
Object.defineProperty(exports, "WsClient", { enumerable: true, get: function () { return ws_client_1.WsClient; } });
|
|
37
36
|
const ArcTypes = __importStar(require("./types"));
|
|
38
37
|
exports.ArcTypes = ArcTypes;
|
|
39
|
-
const ws_client_1 = __importDefault(require("./api/ws.client"));
|
|
40
|
-
exports.WsClient = ws_client_1.default;
|
|
41
38
|
__exportStar(require("./api/identity/types"), exports);
|
|
42
39
|
__exportStar(require("./api/draft/types"), exports);
|
|
43
40
|
__exportStar(require("./api/site/types"), exports);
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"
|
|
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"}
|
package/package.json
CHANGED
|
@@ -1,10 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@code.store/arcxp-sdk-ts",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "3.0.1",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "./dist/index.js",
|
|
7
7
|
"types": "./dist/index.d.ts",
|
|
8
|
+
"repository": {
|
|
9
|
+
"url": "https://github.com/code-store-platform/arcxp-sdk-ts"
|
|
10
|
+
},
|
|
11
|
+
"homepage": "https://github.com/code-store-platform/arcxp-sdk-ts",
|
|
8
12
|
"files": [
|
|
9
13
|
"dist"
|
|
10
14
|
],
|
|
@@ -13,7 +17,11 @@
|
|
|
13
17
|
"lint": "tsc --noEmit && TIMING=1 eslint \"src/**/*.ts*\"",
|
|
14
18
|
"test": "vitest"
|
|
15
19
|
},
|
|
16
|
-
"keywords": [
|
|
20
|
+
"keywords": [
|
|
21
|
+
"ArcXP",
|
|
22
|
+
"SDK",
|
|
23
|
+
"Code.Store"
|
|
24
|
+
],
|
|
17
25
|
"author": "code.store",
|
|
18
26
|
"license": "MIT",
|
|
19
27
|
"dependencies": {
|