@coveo/push-api-client 2.7.0 → 2.7.2
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/dist/docs/assets/main.js +1 -1
- package/dist/docs/classes/AnySecurityIdentityBuilder.html +4 -4
- package/dist/docs/classes/CatalogSource.html +17 -17
- package/dist/docs/classes/DocumentBuilder.html +28 -28
- package/dist/docs/classes/FieldAnalyser.html +12 -12
- package/dist/docs/classes/GroupSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/PushSource.html +24 -24
- package/dist/docs/classes/UserSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/VirtualGroupSecurityIdentityBuilder.html +5 -5
- package/dist/docs/classes/errors.FieldTypeInconsistencyError.html +3 -3
- package/dist/docs/classes/errors.InvalidDocument.html +3 -3
- package/dist/docs/classes/errors.InvalidPermanentId.html +3 -3
- package/dist/docs/classes/errors.NotAFileError.html +3 -3
- package/dist/docs/classes/errors.NotAJsonFileError.html +3 -3
- package/dist/docs/classes/errors.PrivilegeError.html +4 -4
- package/dist/docs/classes/errors.UnsupportedAttribute.html +3 -3
- package/dist/docs/classes/errors.UnsupportedFieldError.html +6 -6
- package/dist/docs/enums/PlatformEnvironment.html +5 -5
- package/dist/docs/functions/parseAndGetDocumentBuilderFromJSONDocument.html +1 -1
- package/dist/docs/interfaces/BatchUpdateDocuments.html +3 -3
- package/dist/docs/interfaces/Document.html +14 -14
- package/dist/docs/interfaces/SecurityIdentity.html +4 -4
- package/dist/docs/interfaces/SecurityIdentityBuilder.html +2 -2
- package/dist/docs/interfaces/UploadBatchCallbackData.html +5 -5
- package/dist/docs/modules/errors.html +1 -1
- package/dist/docs/types/BatchUpdateDocumentsFromFiles.html +1 -1
- package/dist/docs/types/CompressionType.html +1 -1
- package/dist/docs/types/FailedUploadCallback.html +1 -1
- package/dist/docs/types/Metadata.html +1 -1
- package/dist/docs/types/MetadataValue.html +1 -1
- package/dist/docs/types/PlatformUrlOptions.html +1 -1
- package/dist/docs/types/SecurityIdentityType.html +1 -1
- package/dist/docs/types/SuccessfulUploadCallback.html +1 -1
- package/dist/docs/types/Transformer.html +1 -1
- package/dist/docs/variables/BuiltInTransformers.html +1 -1
- package/dist/docs/variables/Source.html +1 -1
- package/dist/help/fileContainer.spec.js +8 -7
- package/dist/help/fileContainer.spec.js.map +1 -1
- package/package.json +8 -8
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
<h1>Variable BuiltInTransformers<code class="tsd-tag ts-flagConst">Const</code> </h1></div>
|
|
18
18
|
<div class="tsd-signature">Built<wbr/>In<wbr/>Transformers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{ </span><br/><span> </span>identity<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol">; </span><br/><span> </span>toLowerCase<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol">; </span><br/><span> </span>toSnakeCase<span class="tsd-signature-symbol">: </span><a href="../types/Transformer.html" class="tsd-signature-type" data-tsd-kind="Type alias">Transformer</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
|
|
19
19
|
<ul>
|
|
20
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
20
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/validation/transformers/transformer.ts#L56">src/validation/transformers/transformer.ts:56</a></li></ul></aside></div>
|
|
21
21
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
22
22
|
<div class="tsd-navigation settings">
|
|
23
23
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -20,7 +20,7 @@
|
|
|
20
20
|
<h3>Deprecated</h3><p>This class has been replaced by <a href="../classes/PushSource.html">PushSource</a></p>
|
|
21
21
|
</div><aside class="tsd-sources">
|
|
22
22
|
<ul>
|
|
23
|
-
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/
|
|
23
|
+
<li>Defined in <a href="https://github.com/coveo/push-api-client.js/blob/8aa6cc5/src/source/source.ts#L6">src/source/source.ts:6</a></li></ul></aside></div>
|
|
24
24
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
25
25
|
<div class="tsd-navigation settings">
|
|
26
26
|
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
|
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
jest.
|
|
4
|
-
|
|
3
|
+
const mockedPut = jest.fn();
|
|
4
|
+
jest.mock('axios', () => ({
|
|
5
|
+
default: { put: mockedPut },
|
|
6
|
+
}));
|
|
5
7
|
const __1 = require("..");
|
|
6
8
|
const fileContainer_1 = require("./fileContainer");
|
|
7
9
|
describe('#uploadContentToFileContainer', () => {
|
|
8
|
-
const mockAxios = axios_1.default;
|
|
9
10
|
const fileContainerResponse = {
|
|
10
11
|
uploadUri: 'https://fake.upload.url',
|
|
11
12
|
fileId: 'file_id',
|
|
@@ -16,14 +17,14 @@ describe('#uploadContentToFileContainer', () => {
|
|
|
16
17
|
delete: [],
|
|
17
18
|
};
|
|
18
19
|
const doMockAxiosPut = () => {
|
|
19
|
-
|
|
20
|
+
mockedPut.mockImplementation(() => Promise.resolve());
|
|
20
21
|
};
|
|
21
22
|
beforeEach(() => {
|
|
22
23
|
doMockAxiosPut();
|
|
23
24
|
});
|
|
24
25
|
it('should perform an PUT request with the right params', async () => {
|
|
25
26
|
await (0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch);
|
|
26
|
-
expect(
|
|
27
|
+
expect(mockedPut).toHaveBeenCalledWith('https://fake.upload.url/', expect.objectContaining({
|
|
27
28
|
addOrUpdate: expect.arrayContaining([
|
|
28
29
|
expect.objectContaining({
|
|
29
30
|
documentId: 'http://some.url',
|
|
@@ -39,7 +40,7 @@ describe('#uploadContentToFileContainer', () => {
|
|
|
39
40
|
});
|
|
40
41
|
describe('when an MaxBodyLengthExceededError is thrown', () => {
|
|
41
42
|
beforeEach(() => {
|
|
42
|
-
|
|
43
|
+
mockedPut.mockImplementationOnce(() => Promise.reject(new FakeMaxBodyLengthExceededError()));
|
|
43
44
|
});
|
|
44
45
|
it('should give some info on how to fix it', async () => {
|
|
45
46
|
await expect((0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch)).rejects.toThrowErrorMatchingSnapshot();
|
|
@@ -48,7 +49,7 @@ describe('#uploadContentToFileContainer', () => {
|
|
|
48
49
|
describe('when anything else than MaxBodyLengthExceededError is thrown', () => {
|
|
49
50
|
const thrownError = new Error();
|
|
50
51
|
beforeEach(() => {
|
|
51
|
-
|
|
52
|
+
mockedPut.mockImplementationOnce(() => Promise.reject(thrownError));
|
|
52
53
|
});
|
|
53
54
|
it('should just bubble up the error', async () => {
|
|
54
55
|
await expect((0, fileContainer_1.uploadContentToFileContainer)(fileContainerResponse, batch)).rejects.toBe(thrownError);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fileContainer.spec.js","sourceRoot":"","sources":["../../src/help/fileContainer.spec.ts"],"names":[],"mappings":";;AAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"fileContainer.spec.js","sourceRoot":"","sources":["../../src/help/fileContainer.spec.ts"],"names":[],"mappings":";;AAAA,MAAM,SAAS,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IACxB,OAAO,EAAE,EAAC,GAAG,EAAE,SAAS,EAAC;CAC1B,CAAC,CAAC,CAAC;AAEJ,0BAAyD;AACzD,mDAGyB;AAEzB,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,MAAM,qBAAqB,GAA0B;QACnD,SAAS,EAAE,yBAAyB;QACpC,MAAM,EAAE,SAAS;QACjB,eAAe,EAAE,EAAC,GAAG,EAAE,KAAK,EAAC;KAC9B,CAAC;IAEF,MAAM,KAAK,GAAyB;QAClC,WAAW,EAAE,CAAC,IAAI,mBAAe,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QACtE,MAAM,EAAE,EAAE;KACX,CAAC;IAEF,MAAM,cAAc,GAAG,GAAG,EAAE;QAC1B,SAAS,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC;IAEF,UAAU,CAAC,GAAG,EAAE;QACd,cAAc,EAAE,CAAC;IACnB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qDAAqD,EAAE,KAAK,IAAI,EAAE;QACnE,MAAM,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;QAEjE,MAAM,CAAC,SAAS,CAAC,CAAC,oBAAoB,CACpC,0BAA0B,EAC1B,MAAM,CAAC,gBAAgB,CAAC;YACtB,WAAW,EAAE,MAAM,CAAC,eAAe,CAAC;gBAClC,MAAM,CAAC,gBAAgB,CAAC;oBACtB,UAAU,EAAE,iBAAiB;iBAC9B,CAAC;aACH,CAAC;YACF,MAAM,EAAE,MAAM,CAAC,eAAe,CAAC,EAAE,CAAC;SACnC,CAAC,EACF;YACE,OAAO,EAAE;gBACP,GAAG,EAAE,KAAK;aACX;YACD,aAAa,EAAE,KAAK;SACrB,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8CAA8C,EAAE,GAAG,EAAE;QAC5D,UAAU,CAAC,GAAG,EAAE;YACd,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,CACpC,OAAO,CAAC,MAAM,CAAC,IAAI,8BAA8B,EAAE,CAAC,CACrD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,MAAM,CACV,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAC3D,CAAC,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,8DAA8D,EAAE,GAAG,EAAE;QAC5E,MAAM,WAAW,GAAG,IAAI,KAAK,EAAE,CAAC;QAChC,UAAU,CAAC,GAAG,EAAE;YACd,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;YAC/C,MAAM,MAAM,CACV,IAAA,4CAA4B,EAAC,qBAAqB,EAAE,KAAK,CAAC,CAC3D,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,MAAM,8BAA+B,SAAQ,KAAK;IAAlD;;QACE,SAAI,GAAG,iCAAiC,CAAC;QACzC,YAAO,GAAG,sBAAsB,CAAC;IACnC,CAAC;CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@coveo/push-api-client",
|
|
3
|
-
"version": "2.7.
|
|
3
|
+
"version": "2.7.2",
|
|
4
4
|
"description": "Push API client",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"files": [
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
"types": "./dist/definitions/index.d.ts",
|
|
11
11
|
"dependencies": {
|
|
12
12
|
"@coveo/bueno": "^0.42.0",
|
|
13
|
-
"@coveo/platform-client": "
|
|
13
|
+
"@coveo/platform-client": "37.3.0",
|
|
14
14
|
"abortcontroller-polyfill": "^1.7.1",
|
|
15
|
-
"axios": "^0.
|
|
15
|
+
"axios": "^1.0.0",
|
|
16
16
|
"dayjs": "^1.10.4",
|
|
17
17
|
"exponential-backoff": "^3.1.0",
|
|
18
18
|
"isomorphic-fetch": "^3.0.0"
|
|
@@ -21,22 +21,22 @@
|
|
|
21
21
|
"@coveo/push-api-client": "file:.",
|
|
22
22
|
"@types/jest": "29.2.2",
|
|
23
23
|
"@types/node": "18.11.9",
|
|
24
|
-
"@typescript-eslint/eslint-plugin": "5.42.
|
|
25
|
-
"@typescript-eslint/parser": "5.42.
|
|
24
|
+
"@typescript-eslint/eslint-plugin": "5.42.1",
|
|
25
|
+
"@typescript-eslint/parser": "5.42.1",
|
|
26
26
|
"cz-conventional-changelog": "3.3.0",
|
|
27
27
|
"dotenv": "16.0.3",
|
|
28
28
|
"eslint": "8.27.0",
|
|
29
29
|
"eslint-config-prettier": "8.5.0",
|
|
30
30
|
"gts": "3.1.1",
|
|
31
|
-
"husky": "8.0.
|
|
32
|
-
"jest": "29.
|
|
31
|
+
"husky": "8.0.2",
|
|
32
|
+
"jest": "29.3.1",
|
|
33
33
|
"lint-staged": "13.0.3",
|
|
34
34
|
"nodemon": "2.0.20",
|
|
35
35
|
"prettier": "2.7.1",
|
|
36
36
|
"standard-version": "9.5.0",
|
|
37
37
|
"ts-jest": "29.0.3",
|
|
38
38
|
"ts-node": "10.9.1",
|
|
39
|
-
"typedoc": "0.23.
|
|
39
|
+
"typedoc": "0.23.21",
|
|
40
40
|
"typescript": "4.8.4"
|
|
41
41
|
},
|
|
42
42
|
"husky": {
|