@coveo/push-api-client 3.1.27 → 3.1.28
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 +35 -0
- package/dist/APICore.js.map +1 -1
- package/dist/definitions/APICore.d.ts +2 -2
- package/dist/definitions/environment.d.ts +33 -4
- package/dist/definitions/help/urlUtils.d.ts +4 -4
- package/dist/definitions/index.d.ts +1 -1
- package/dist/definitions/source/catalog.d.ts +3 -3
- package/dist/definitions/source/push.d.ts +3 -3
- package/dist/environment.js +1 -1
- package/dist/environment.js.map +1 -1
- package/dist/help/urlUtils.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/source/catalog.js +3 -3
- package/dist/source/catalog.js.map +1 -1
- package/dist/source/push.js +1 -1
- package/dist/source/push.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -53,6 +53,41 @@ See more examples in the `./samples` folder.
|
|
|
53
53
|
You can use the `HTTPS_PROXY` or `https_proxy` environment variable for proxy configuration.
|
|
54
54
|
Read more about it [here](https://about.gitlab.com/blog/2021/01/27/we-need-to-talk-no-proxy/).
|
|
55
55
|
|
|
56
|
+
### Exponential backoff retry configuration
|
|
57
|
+
|
|
58
|
+
By default, the SDK leverages an exponential backoff retry mechanism. Exponential backoff allows for the SDK to make multiple attempts to resolve throttled requests, increasing the amount of time to wait for each subsequent attempt. Outgoing requests will retry when a `429` status code is returned from the platform.
|
|
59
|
+
|
|
60
|
+
The exponential backoff parameters are as follows:
|
|
61
|
+
|
|
62
|
+
- `retryAfter` - The amount of time, in milliseconds, to wait between throttled request attempts.
|
|
63
|
+
|
|
64
|
+
Optional, will default to 5,000.
|
|
65
|
+
|
|
66
|
+
- `maxRetries` - The maximum number of times to retry throttled requests.
|
|
67
|
+
|
|
68
|
+
Optional, will default to 10.
|
|
69
|
+
|
|
70
|
+
- `timeMultiple` - The multiple by which to increase the wait time between each throttled request attempt.
|
|
71
|
+
|
|
72
|
+
Optional, will default to 2.
|
|
73
|
+
|
|
74
|
+
You may configure the exponential backoff that will be applied to all outgoing requests. To do so, specify a `PlatformOptions` object when creating either a `CatalogSource` or `PushSource` object:
|
|
75
|
+
|
|
76
|
+
```js
|
|
77
|
+
const catalogSource = new CatalogSource(
|
|
78
|
+
'my_api_key',
|
|
79
|
+
'my_coveo_organization_id',
|
|
80
|
+
{maxRetries: 10, retryAfter: 2000, timeMultiple: 3}
|
|
81
|
+
);
|
|
82
|
+
const pushSource = new PushSource(
|
|
83
|
+
'my_other_api_key',
|
|
84
|
+
'my_other_coveo_organization_id',
|
|
85
|
+
{maxRetries: 3, retryAfter: 600000}
|
|
86
|
+
);
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
By default, requests will retry a maximum of 10 times, waiting 5 seconds after the first attempt, with a time multiple of 2 (which will equate to a maximum execution time of roughly 1.5 hours).
|
|
90
|
+
|
|
56
91
|
## Local development
|
|
57
92
|
|
|
58
93
|
- `npm i`
|
package/dist/APICore.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,6DAA4C;AAE5C,oDAA+C;AAC/C,0DAAqD;AAErD,MAAa,OAAO;IAClB,YACU,WAAmB,EACnB,
|
|
1
|
+
{"version":3,"file":"APICore.js","sourceRoot":"","sources":["../src/APICore.ts"],"names":[],"mappings":";;;AAAA,6DAA4C;AAE5C,oDAA+C;AAC/C,0DAAqD;AAErD,MAAa,OAAO;IAClB,YACU,WAAmB,EACnB,OAAkC;QADlC,gBAAW,GAAX,WAAW,CAAQ;QACnB,YAAO,GAAP,OAAO,CAA2B;IACzC,CAAC;IAEI,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAmB;QACpD,MAAM,GAAG,GAAG,KAAK,IAAI,EAAE;YACrB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,kCAC3B,MAAM,KACT,OAAO,kCAAM,IAAI,CAAC,cAAc,GAAK,MAAM,CAAC,OAAO,KACnD,CAAC;YACH,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACpC,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;QAEF,OAAO,IAAA,6BAAO,EAAC,GAAG,EAAE;YAClB,KAAK,EAAE,CAAC,GAAY,EAAE,EAAE,CAAC,GAAG,YAAY,6BAAa;YACrD,MAAM,EAAE,MAAM;YACd,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;YACtC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;YACtC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,YAAY;SACxC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,QAAkB;QAC7C,IAAI,QAAQ,CAAC,EAAE,EAAE;YACf,OAAO;SACR;QACD,IAAI,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE;YAC9B,MAAM,IAAI,6BAAa,EAAE,CAAC;SAC3B;QACD,MAAM,MAAM,uBAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAEO,KAAK,CAAC,WAAW,CAAI,GAAW,EAAE,MAAmB;QAC3D,OAAO,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,EAAgB,CAAC;IAChE,CAAC;IAEM,KAAK,CAAC,IAAI,CAAI,GAAW,EAAE,OAAgB,EAAE;QAClD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,EAAC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,EAAC,CAAC,CAAC;IAC7E,CAAC;IAMM,KAAK,CAAC,GAAG,CAAI,GAAW,EAAE,OAAgB,EAAE,EAAE,KAAK,GAAG,IAAI;QAC/D,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE;YACzC,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;YAC1B,MAAM,EAAE,KAAK;SACd,CAAC,CAAC;IACL,CAAC;IAEO,eAAe,CAAI,KAAc;QACvC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,WAAc,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjE,CAAC;IAKM,KAAK,CAAC,MAAM,CAAI,GAAW,EAAE,KAAK,GAAG,IAAI;QAC9C,OAAO,IAAI,CAAC,eAAe,CAAI,KAAK,CAAC,CAAC,GAAG,EAAE,EAAC,MAAM,EAAE,QAAQ,EAAC,CAAC,CAAC;IACjE,CAAC;IAED,IAAY,cAAc;QACxB,MAAM,mBAAmB,GAAG;YAC1B,aAAa,EAAE,UAAU,IAAI,CAAC,WAAW,EAAE;SAC5C,CAAC;QAEF,MAAM,uBAAuB,mCACxB,mBAAmB,KACtB,cAAc,EAAE,kBAAkB,EAClC,MAAM,EAAE,kBAAkB,GAC3B,CAAC;QAEF,OAAO,uBAAuB,CAAC;IACjC,CAAC;IAEO,WAAW,CAAC,GAAa;QAC/B,OAAO,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC;IAC5B,CAAC;CACF;AAlFD,0BAkFC"}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import type { Response } from 'undici';
|
|
2
|
-
import {
|
|
2
|
+
import { PlatformOptions } from './environment';
|
|
3
3
|
export declare class APICore {
|
|
4
4
|
private accessToken;
|
|
5
5
|
private options;
|
|
6
|
-
constructor(accessToken: string, options: Required<
|
|
6
|
+
constructor(accessToken: string, options: Required<PlatformOptions>);
|
|
7
7
|
private request;
|
|
8
8
|
private handleResponse;
|
|
9
9
|
private requestJson;
|
|
@@ -9,15 +9,44 @@ export declare enum PlatformEnvironment {
|
|
|
9
9
|
export declare const DEFAULT_ENVIRONMENT: PlatformEnvironment.Prod;
|
|
10
10
|
export declare const DEFAULT_REGION: Region.US;
|
|
11
11
|
export declare const DEFAULT_RETRY_AFTER = 5000;
|
|
12
|
-
export declare const DEFAULT_MAX_RETRIES =
|
|
12
|
+
export declare const DEFAULT_MAX_RETRIES = 10;
|
|
13
13
|
export declare const DEFAULT_TIME_MULTIPLE = 2;
|
|
14
|
-
|
|
14
|
+
/**
|
|
15
|
+
* @deprecated use {@link PlatformOptions}
|
|
16
|
+
*/
|
|
17
|
+
export type PlatformUrlOptions = PlatformOptions;
|
|
18
|
+
export type PlatformOptions = {
|
|
19
|
+
/**
|
|
20
|
+
* The platform environment in which to execute all outgoing requests.
|
|
21
|
+
*
|
|
22
|
+
* Optional, will default to production.
|
|
23
|
+
*/
|
|
15
24
|
environment?: PlatformEnvironment;
|
|
25
|
+
/**
|
|
26
|
+
* The platform region in which to execute all outgoing requests.
|
|
27
|
+
*
|
|
28
|
+
* Optional, will default to US.
|
|
29
|
+
*/
|
|
16
30
|
region?: Region;
|
|
31
|
+
/**
|
|
32
|
+
* The amount of time, in milliseconds, to wait between throttled request attempts.
|
|
33
|
+
*
|
|
34
|
+
* Optional, will default to 5000.
|
|
35
|
+
*/
|
|
17
36
|
retryAfter?: number;
|
|
37
|
+
/**
|
|
38
|
+
* The maximum number of times to retry throttled requests.
|
|
39
|
+
*
|
|
40
|
+
* Optional, will default to 10.
|
|
41
|
+
*/
|
|
18
42
|
maxRetries?: number;
|
|
43
|
+
/**
|
|
44
|
+
* The multiple by which to increase the wait time between each throttled request attempt.
|
|
45
|
+
*
|
|
46
|
+
* Optional, will default to 2.
|
|
47
|
+
*/
|
|
19
48
|
timeMultiple?: number;
|
|
20
49
|
};
|
|
21
|
-
export declare const defaultOptions: Required<
|
|
22
|
-
export declare function platformUrl(options?:
|
|
50
|
+
export declare const defaultOptions: Required<PlatformOptions>;
|
|
51
|
+
export declare function platformUrl(options?: PlatformOptions): string;
|
|
23
52
|
export declare function castEnvironmentToPlatformClient(e: PlatformEnvironment): Environment;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
|
-
import {
|
|
2
|
+
import { PlatformOptions } from '..';
|
|
3
3
|
export interface URLBuilder {
|
|
4
4
|
baseAPIURLForUpdate: URL;
|
|
5
5
|
fileContainerUrl: URL;
|
|
@@ -7,20 +7,20 @@ export interface URLBuilder {
|
|
|
7
7
|
declare abstract class BaseUrlBuilder {
|
|
8
8
|
private organizationId;
|
|
9
9
|
private options;
|
|
10
|
-
protected constructor(organizationId: string, options: Required<
|
|
10
|
+
protected constructor(organizationId: string, options: Required<PlatformOptions>);
|
|
11
11
|
protected get platformURL(): string;
|
|
12
12
|
get fileContainerUrl(): import("url").URL;
|
|
13
13
|
abstract get baseAPIURLForUpdate(): URL;
|
|
14
14
|
}
|
|
15
15
|
export declare class PushUrlBuilder extends BaseUrlBuilder implements URLBuilder {
|
|
16
16
|
private sourceId;
|
|
17
|
-
constructor(sourceId: string, organizationId: string, options: Required<
|
|
17
|
+
constructor(sourceId: string, organizationId: string, options: Required<PlatformOptions>);
|
|
18
18
|
get baseURL(): import("url").URL;
|
|
19
19
|
get baseAPIURLForUpdate(): import("url").URL;
|
|
20
20
|
}
|
|
21
21
|
export declare class StreamUrlBuilder extends BaseUrlBuilder implements URLBuilder {
|
|
22
22
|
private sourceId;
|
|
23
|
-
constructor(sourceId: string, organizationId: string, options: Required<
|
|
23
|
+
constructor(sourceId: string, organizationId: string, options: Required<PlatformOptions>);
|
|
24
24
|
get baseStreamURL(): import("url").URL;
|
|
25
25
|
get baseAPIURLForUpdate(): import("url").URL;
|
|
26
26
|
}
|
|
@@ -8,7 +8,7 @@ export { UploadBatchCallbackData, BatchUpdateDocuments, BatchUpdateDocumentsFrom
|
|
|
8
8
|
export { FieldAnalyser } from './fieldAnalyser/fieldAnalyser';
|
|
9
9
|
export { DocumentBuilder } from './documentBuilder';
|
|
10
10
|
export * from './securityIdentityBuilder';
|
|
11
|
-
export { PlatformEnvironment, Region,
|
|
11
|
+
export { PlatformEnvironment, Region, PlatformOptions } from './environment';
|
|
12
12
|
export { SourceVisibility } from '@coveo/platform-client';
|
|
13
13
|
export { PermissionSetBuilder } from './permissionSetBuilder';
|
|
14
14
|
export { parseAndGetDocumentBuilderFromJSONDocument } from './validation/parseFile';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import 'fetch-undici-polyfill';
|
|
2
2
|
import { SourceVisibility } from '@coveo/platform-client';
|
|
3
|
-
import {
|
|
3
|
+
import { PlatformOptions } from '../environment';
|
|
4
4
|
import { SecurityIdentity } from './securityIdenty';
|
|
5
5
|
import { BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, BatchUpdateDocumentsOptions } from '../interfaces';
|
|
6
6
|
/**
|
|
@@ -18,9 +18,9 @@ export declare class CatalogSource {
|
|
|
18
18
|
* Creates an instance of CatalogSource.
|
|
19
19
|
* @param {string} apikey An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
|
|
20
20
|
* @param {string} organizationid The Coveo Organization identifier.
|
|
21
|
-
* @param {
|
|
21
|
+
* @param {PlatformOptions} [options=defaultOptions] Platform request options.
|
|
22
22
|
*/
|
|
23
|
-
constructor(apikey: string, organizationid: string,
|
|
23
|
+
constructor(apikey: string, organizationid: string, options?: PlatformOptions);
|
|
24
24
|
/**
|
|
25
25
|
* Create a new catalog source
|
|
26
26
|
* @param name The name of the source to create.
|
|
@@ -2,7 +2,7 @@ import 'fetch-undici-polyfill';
|
|
|
2
2
|
import { PlatformClient, SourceVisibility } from '@coveo/platform-client';
|
|
3
3
|
export { SourceVisibility } from '@coveo/platform-client';
|
|
4
4
|
import { DocumentBuilder } from '../documentBuilder';
|
|
5
|
-
import {
|
|
5
|
+
import { PlatformOptions } from '../environment';
|
|
6
6
|
import { FieldAnalyser } from '../fieldAnalyser/fieldAnalyser';
|
|
7
7
|
import { SecurityIdentity } from './securityIdenty';
|
|
8
8
|
import { BatchUpdateDocuments, BatchUpdateDocumentsFromFiles, BatchUpdateDocumentsOptions } from '../interfaces';
|
|
@@ -22,9 +22,9 @@ export declare class PushSource {
|
|
|
22
22
|
*
|
|
23
23
|
* @param {string} apikey An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
|
|
24
24
|
* @param {string} organizationid The Coveo Organization identifier.
|
|
25
|
-
* @param {
|
|
25
|
+
* @param {PlatformOptions} [options=defaultOptions] Platform request options.
|
|
26
26
|
*/
|
|
27
|
-
constructor(apikey: string, organizationid: string, options?:
|
|
27
|
+
constructor(apikey: string, organizationid: string, options?: PlatformOptions);
|
|
28
28
|
/**
|
|
29
29
|
* Create a new push source
|
|
30
30
|
* @param name The name of the source to create.
|
package/dist/environment.js
CHANGED
|
@@ -14,7 +14,7 @@ var PlatformEnvironment;
|
|
|
14
14
|
exports.DEFAULT_ENVIRONMENT = PlatformEnvironment.Prod;
|
|
15
15
|
exports.DEFAULT_REGION = platform_client_1.Region.US;
|
|
16
16
|
exports.DEFAULT_RETRY_AFTER = 5000;
|
|
17
|
-
exports.DEFAULT_MAX_RETRIES =
|
|
17
|
+
exports.DEFAULT_MAX_RETRIES = 10;
|
|
18
18
|
exports.DEFAULT_TIME_MULTIPLE = 2;
|
|
19
19
|
exports.defaultOptions = {
|
|
20
20
|
environment: exports.DEFAULT_ENVIRONMENT,
|
package/dist/environment.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"environment.js","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":";;;AAAA,4DAA2D;AAC3D,0DAA8C;AAAtC,yGAAA,MAAM,OAAA;AAEd,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,kCAAW,CAAA;IACX,sCAAe,CAAA;IACf,oCAAa,CAAA;AACf,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B;AAEY,QAAA,mBAAmB,GAAG,mBAAmB,CAAC,IAAa,CAAC;AACxD,QAAA,cAAc,GAAG,wBAAM,CAAC,EAAW,CAAC;AACpC,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAC3B,QAAA,mBAAmB,GAAG,EAAE,CAAC;AACzB,QAAA,qBAAqB,GAAG,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"environment.js","sourceRoot":"","sources":["../src/environment.ts"],"names":[],"mappings":";;;AAAA,4DAA2D;AAC3D,0DAA8C;AAAtC,yGAAA,MAAM,OAAA;AAEd,IAAY,mBAKX;AALD,WAAY,mBAAmB;IAC7B,kCAAW,CAAA;IACX,kCAAW,CAAA;IACX,sCAAe,CAAA;IACf,oCAAa,CAAA;AACf,CAAC,EALW,mBAAmB,mCAAnB,mBAAmB,QAK9B;AAEY,QAAA,mBAAmB,GAAG,mBAAmB,CAAC,IAAa,CAAC;AACxD,QAAA,cAAc,GAAG,wBAAM,CAAC,EAAW,CAAC;AACpC,QAAA,mBAAmB,GAAG,IAAI,CAAC;AAC3B,QAAA,mBAAmB,GAAG,EAAE,CAAC;AACzB,QAAA,qBAAqB,GAAG,CAAC,CAAC;AAwC1B,QAAA,cAAc,GAA8B;IACvD,WAAW,EAAE,2BAAmB;IAChC,MAAM,EAAE,sBAAc;IACtB,UAAU,EAAE,2BAAmB;IAC/B,UAAU,EAAE,2BAAmB;IAC/B,YAAY,EAAE,6BAAqB;CACpC,CAAC;AAEF,SAAgB,WAAW,CAAC,OAAyB;IACnD,OAAO,mCAAO,sBAAc,GAAK,OAAO,CAAC,CAAC;IAC1C,MAAM,MAAM,GACV,OAAO,CAAC,WAAW,KAAK,2BAAmB,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IACzE,MAAM,SAAS,GACb,OAAO,CAAC,MAAM,KAAK,sBAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAEhE,OAAO,cAAc,MAAM,GAAG,SAAS,wCAAwC,CAAC;AAClF,CAAC;AARD,kCAQC;AAED,SAAgB,+BAA+B,CAC7C,CAAsB;IAEtB,QAAQ,CAAC,EAAE;QACT,KAAK,KAAK;YACR,OAAO,6BAAW,CAAC,GAAG,CAAC;QACzB,KAAK,KAAK;YACR,OAAO,6BAAW,CAAC,GAAG,CAAC;QACzB,KAAK,MAAM;YACT,OAAO,6BAAW,CAAC,IAAI,CAAC;QAC1B,KAAK,OAAO;YACV,OAAO,6BAAW,CAAC,KAAK,CAAC;QAC3B;YACE,OAAO,6BAAW,CAAC,IAAI,CAAC;KAC3B;AACH,CAAC;AAfD,0EAeC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"urlUtils.js","sourceRoot":"","sources":["../../src/help/urlUtils.ts"],"names":[],"mappings":";;;AACA,gDAA2C;AAO3C,MAAe,cAAc;IAC3B,YACU,cAAsB,EACtB,
|
|
1
|
+
{"version":3,"file":"urlUtils.js","sourceRoot":"","sources":["../../src/help/urlUtils.ts"],"names":[],"mappings":";;;AACA,gDAA2C;AAO3C,MAAe,cAAc;IAC3B,YACU,cAAsB,EACtB,OAAkC;QADlC,mBAAc,GAAd,cAAc,CAAQ;QACtB,YAAO,GAAP,OAAO,CAA2B;IACzC,CAAC;IACJ,IAAc,WAAW;QACvB,OAAO,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,OAAO,CAAC,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;IAC/D,CAAC;IACD,IAAW,gBAAgB;QACzB,OAAO,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,QAAQ,CAAC,CAAC;IAC9C,CAAC;CAEF;AAED,MAAa,cAAe,SAAQ,cAAc;IAChD,YACU,QAAgB,EACxB,cAAsB,EACtB,OAAkC;QAElC,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAJvB,aAAQ,GAAR,QAAQ,CAAQ;IAK1B,CAAC;IACD,IAAW,OAAO;QAChB,OAAO,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,YAAY,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjE,CAAC;IACD,IAAW,mBAAmB;QAC5B,OAAO,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,kBAAkB,CAAC,CAAC;IACpD,CAAC;CACF;AAdD,wCAcC;AAED,MAAa,gBAAiB,SAAQ,cAAc;IAClD,YACU,QAAgB,EACxB,cAAsB,EACtB,OAAkC;QAElC,KAAK,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC;QAJvB,aAAQ,GAAR,QAAQ,CAAQ;IAK1B,CAAC;IACD,IAAW,aAAa;QACtB,OAAO,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,WAAW,YAAY,IAAI,CAAC,QAAQ,SAAS,CAAC,CAAC;IACxE,CAAC;IACD,IAAW,mBAAmB;QAC5B,OAAO,IAAI,GAAG,CAAC,GAAG,IAAI,CAAC,aAAa,SAAS,CAAC,CAAC;IACjD,CAAC;CACF;AAdD,4CAcC"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,wEAAsD;AACtD,qCAAmC;AACnC,sCAAyC;AAAjC,kGAAA,UAAU,OAAA;AAClB,4CAA+C;AAAvC,wGAAA,aAAa,OAAA;AAUrB,+DAA4D;AAApD,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,4DAA0C;AAC1C,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,wEAAsD;AACtD,qCAAmC;AACnC,sCAAyC;AAAjC,kGAAA,UAAU,OAAA;AAClB,4CAA+C;AAAvC,wGAAA,aAAa,OAAA;AAUrB,+DAA4D;AAApD,8GAAA,aAAa,OAAA;AACrB,qDAAkD;AAA1C,kHAAA,eAAe,OAAA;AACvB,4DAA0C;AAC1C,6CAA2E;AAAnE,kHAAA,mBAAmB,OAAA;AAAE,qGAAA,MAAM,OAAA;AACnC,0DAAwD;AAAhD,mHAAA,gBAAgB,OAAA;AACxB,+DAA4D;AAApD,4HAAA,oBAAoB,OAAA;AAE5B,oDAAkF;AAA1E,uIAAA,0CAA0C,OAAA"}
|
package/dist/source/catalog.js
CHANGED
|
@@ -19,12 +19,12 @@ class CatalogSource {
|
|
|
19
19
|
* Creates an instance of CatalogSource.
|
|
20
20
|
* @param {string} apikey An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
|
|
21
21
|
* @param {string} organizationid The Coveo Organization identifier.
|
|
22
|
-
* @param {
|
|
22
|
+
* @param {PlatformOptions} [options=defaultOptions] Platform request options.
|
|
23
23
|
*/
|
|
24
|
-
constructor(apikey, organizationid,
|
|
24
|
+
constructor(apikey, organizationid, options = environment_1.defaultOptions) {
|
|
25
25
|
this.apikey = apikey;
|
|
26
26
|
this.organizationid = organizationid;
|
|
27
|
-
this.options = Object.assign(Object.assign({}, environment_1.defaultOptions),
|
|
27
|
+
this.options = Object.assign(Object.assign({}, environment_1.defaultOptions), options);
|
|
28
28
|
this.api = new APICore_1.APICore(this.apikey, this.options);
|
|
29
29
|
this.platformClient = new platform_client_1.PlatformClient({
|
|
30
30
|
accessToken: apikey,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../src/source/catalog.ts"],"names":[],"mappings":";;;AAAA,iCAA+B;AAE/B,4DAIgC;AAChC,gDAIwB;AACxB,qDAAkD;AAClD,sDAA6E;AAM7E,yDAAoE;AACpE,+CAAkD;AAClD,wCAAmC;AAEnC;;;;GAIG;AACH,MAAa,aAAa;IAKxB;;;;;OAKG;IACH,YACU,MAAc,EACd,cAAsB,EAC9B,
|
|
1
|
+
{"version":3,"file":"catalog.js","sourceRoot":"","sources":["../../src/source/catalog.ts"],"names":[],"mappings":";;;AAAA,iCAA+B;AAE/B,4DAIgC;AAChC,gDAIwB;AACxB,qDAAkD;AAClD,sDAA6E;AAM7E,yDAAoE;AACpE,+CAAkD;AAClD,wCAAmC;AAEnC;;;;GAIG;AACH,MAAa,aAAa;IAKxB;;;;;OAKG;IACH,YACU,MAAc,EACd,cAAsB,EAC9B,UAA2B,4BAAc;QAFjC,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAQ;QAG9B,IAAI,CAAC,OAAO,mCAAO,4BAAc,GAAK,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,GAAG,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,cAAc,GAAG,IAAI,gCAAc,CAAC;YACvC,WAAW,EAAE,MAAM;YACnB,WAAW,EAAE,IAAA,6CAA+B,EAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;YACtE,cAAc,EAAE,cAAc;YAC9B,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAY,EAAE,gBAAkC;QAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC;YACvC,IAAI;YACJ,aAAa,EAAE,IAAI;YACnB,gBAAgB;YAChB,UAAU,EAAE,4BAAU,CAAC,OAAO;SAC/B,CAAC,CAAC;IACL,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,iCAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;;OAOG;IACI,oBAAoB,CACzB,QAAgB,EAChB,KAA2B,EAC3B,OAAqC;QAErC,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACtD,OAAO,IAAA,8BAAW,EAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,oBAAoB,CAC/B,QAAgB,EAChB,KAA2B,EAC3B,OAAqC;QAErC,MAAM,QAAQ,GAAG,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,IAAA,8BAAW,EAAC,IAAI,CAAC,cAAc,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;OAKG;IACI,6BAA6B,CAClC,QAAgB,EAChB,kBAA4B,EAC5B,OAAuC;QAEvC,OAAO,IAAA,sCAAmB,EACxB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EACpC,kBAAkB,EAClB,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,6BAA6B,CAClC,QAAgB,EAChB,kBAA4B,EAC5B,OAAuC;QAEvC,OAAO,IAAA,sCAAmB,EACxB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,EAClC,kBAAkB,EAClB,OAAO,CACR,CAAC;IACJ,CAAC;IAEO,UAAU,CAAC,QAAgB;QACjC,OAAO,IAAI,2BAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC3E,CAAC;IAEO,qBAAqB,CAAC,QAAgB;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,sCAAqB,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC;IAEO,mBAAmB,CAAC,QAAgB;QAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,oCAAmB,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACvD,CAAC;CACF;AAlID,sCAkIC"}
|
package/dist/source/push.js
CHANGED
|
@@ -24,7 +24,7 @@ class PushSource {
|
|
|
24
24
|
*
|
|
25
25
|
* @param {string} apikey An apiKey capable of pushing documents and managing sources in a Coveo organization. See [Manage API Keys](https://docs.coveo.com/en/1718).
|
|
26
26
|
* @param {string} organizationid The Coveo Organization identifier.
|
|
27
|
-
* @param {
|
|
27
|
+
* @param {PlatformOptions} [options=defaultOptions] Platform request options.
|
|
28
28
|
*/
|
|
29
29
|
constructor(apikey, organizationid, options) {
|
|
30
30
|
this.apikey = apikey;
|
package/dist/source/push.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"push.js","sourceRoot":"","sources":["../../src/source/push.ts"],"names":[],"mappings":";;;AAAA,iCAA+B;AAE/B,4DAIgC;AAChC,0DAAwD;AAAhD,mHAAA,gBAAgB,OAAA;AAExB,+BAAgC;AAChC,6BAAwB;AACxB,gDAIwB;AAExB,qDAAkD;AAMlD,yDAI4B;AAC5B,+CAAgD;AAChD,sDAAwE;AACxE,4DAAmE;AACnE,wCAAmC;AAInC;;;;GAIG;AACH,MAAa,UAAU;IAIrB;;;;;OAKG;IACH,YACU,MAAc,EACd,cAAsB,EAC9B,
|
|
1
|
+
{"version":3,"file":"push.js","sourceRoot":"","sources":["../../src/source/push.ts"],"names":[],"mappings":";;;AAAA,iCAA+B;AAE/B,4DAIgC;AAChC,0DAAwD;AAAhD,mHAAA,gBAAgB,OAAA;AAExB,+BAAgC;AAChC,6BAAwB;AACxB,gDAIwB;AAExB,qDAAkD;AAMlD,yDAI4B;AAC5B,+CAAgD;AAChD,sDAAwE;AACxE,4DAAmE;AACnE,wCAAmC;AAInC;;;;GAIG;AACH,MAAa,UAAU;IAIrB;;;;;OAKG;IACH,YACU,MAAc,EACd,cAAsB,EAC9B,OAAyB;QAFjB,WAAM,GAAN,MAAM,CAAQ;QACd,mBAAc,GAAd,cAAc,CAAQ;QAG9B,IAAI,CAAC,OAAO,mCAAO,4BAAc,GAAK,OAAO,CAAC,CAAC;QAC/C,IAAI,CAAC,GAAG,GAAG,IAAI,iBAAO,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAClD,IAAI,CAAC,cAAc,GAAG,IAAI,gCAAc,CAAC;YACvC,WAAW,EAAE,IAAI,CAAC,MAAM;YACxB,WAAW,EAAE,IAAA,6CAA+B,EAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;YACtE,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,IAAY,EAAE,gBAAkC;QAC5D,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC;YACvC,UAAU,EAAE,4BAAU,CAAC,IAAI;YAC3B,WAAW,EAAE,IAAI;YACjB,IAAI;YACJ,gBAAgB;SACjB,CAAC,CAAC;IACL,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,iCAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;IACnD,CAAC;IAED;;;;;;OAMG;IACI,mBAAmB,CACxB,QAAgB,EAChB,UAA2B,EAC3B,OAAqC;QAErC,MAAM,MAAM,GAAG,IAAI,SAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC;QACzE,OAAO,IAAA,iCAAc,EACnB,IAAI,CAAC,cAAc,EACnB,UAAU,EACV,MAAM,EACN,IAAI,CAAC,GAAG,EACR,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,oBAAoB,CACzB,QAAgB,EAChB,KAA2B,EAC3B,OAAqC;QAErC,OAAO,IAAA,8BAAW,EAChB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EACpC,KAAK,EACL,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,6BAA6B,CAClC,QAAgB,EAChB,kBAA4B,EAC5B,OAAuC;QAEvC,OAAO,IAAA,sCAAmB,EACxB,IAAI,CAAC,cAAc,EACnB,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EACpC,kBAAkB,EAClB,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACI,cAAc,CACnB,QAAgB,EAChB,UAAkB,EAClB,cAAc,GAAG,KAAK;QAEtB,MAAM,SAAS,GAAG,IAAI,SAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,OAAO,YAAY,CAAC,CAAC;QAC5E,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACxD,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,gBAAgB,EAAE,GAAG,cAAc,EAAE,CAAC,CAAC;QACrE,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACI,wBAAwB,CAC7B,QAAgB,EAChB,SAAiC;QAEjC,MAAM,IAAI,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;QAC9B,MAAM,SAAS,GAAG,IAAI,SAAG,CACvB,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,OAAO,sBAAsB,CAC3D,CAAC;QACF,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,eAAe,CAC1B,QAAgB,EAChB,MAAoB;QAEpB,MAAM,SAAS,GAAG,IAAI,SAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,OAAO,SAAS,CAAC,CAAC;QACzE,SAAS,CAAC,YAAY,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;QACpD,MAAM,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC5C,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,QAAuB;QAC/C,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC;QACjC,MAAM,IAAA,mCAAsB,EAAC,IAAI,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAEO,UAAU,CAAC,QAAgB;QACjC,OAAO,IAAI,yBAAc,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IACzE,CAAC;IAEO,qBAAqB,CAAC,QAAgB;QAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;QAC7C,OAAO,IAAI,sCAAqB,CAAC,UAAU,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IACzD,CAAC;CACF;AA1KD,gCA0KC"}
|