@v3finance/monitoring-sdk 0.1.0 → 0.2.0
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/CHANGELOG.md +21 -11
- package/README.md +223 -148
- package/dist/cjs/client.d.ts +23 -42
- package/dist/cjs/client.d.ts.map +1 -1
- package/dist/cjs/client.js +44 -53
- package/dist/cjs/client.js.map +1 -1
- package/dist/cjs/core/errors.d.ts +18 -18
- package/dist/cjs/core/errors.d.ts.map +1 -1
- package/dist/cjs/core/errors.js +17 -17
- package/dist/cjs/core/errors.js.map +1 -1
- package/dist/cjs/core/http.d.ts +22 -26
- package/dist/cjs/core/http.d.ts.map +1 -1
- package/dist/cjs/core/http.js +28 -36
- package/dist/cjs/core/http.js.map +1 -1
- package/dist/cjs/core/pagination.d.ts +6 -7
- package/dist/cjs/core/pagination.d.ts.map +1 -1
- package/dist/cjs/core/pagination.js +1 -1
- package/dist/cjs/core/pagination.js.map +1 -1
- package/dist/cjs/core/scope.d.ts +8 -0
- package/dist/cjs/core/scope.d.ts.map +1 -0
- package/dist/cjs/core/scope.js +3 -0
- package/dist/cjs/core/scope.js.map +1 -0
- package/dist/cjs/generated/types.d.ts +129 -117
- package/dist/cjs/generated/types.d.ts.map +1 -1
- package/dist/cjs/generated/types.js +1 -1
- package/dist/cjs/generated/types.js.map +1 -1
- package/dist/cjs/index.d.ts +6 -6
- package/dist/cjs/index.d.ts.map +1 -1
- package/dist/cjs/index.js +13 -16
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/resources/account.d.ts +12 -51
- package/dist/cjs/resources/account.d.ts.map +1 -1
- package/dist/cjs/resources/account.js +17 -61
- package/dist/cjs/resources/account.js.map +1 -1
- package/dist/cjs/resources/addresses.d.ts +49 -65
- package/dist/cjs/resources/addresses.d.ts.map +1 -1
- package/dist/cjs/resources/addresses.js +60 -69
- package/dist/cjs/resources/addresses.js.map +1 -1
- package/dist/cjs/resources/catalog.d.ts +17 -10
- package/dist/cjs/resources/catalog.d.ts.map +1 -1
- package/dist/cjs/resources/catalog.js +23 -17
- package/dist/cjs/resources/catalog.js.map +1 -1
- package/dist/cjs/resources/deliveries.d.ts +34 -23
- package/dist/cjs/resources/deliveries.d.ts.map +1 -1
- package/dist/cjs/resources/deliveries.js +27 -17
- package/dist/cjs/resources/deliveries.js.map +1 -1
- package/dist/cjs/resources/transactions.d.ts +14 -14
- package/dist/cjs/resources/transactions.d.ts.map +1 -1
- package/dist/cjs/resources/transactions.js +15 -16
- package/dist/cjs/resources/transactions.js.map +1 -1
- package/dist/cjs/resources/webhooks.d.ts +22 -0
- package/dist/cjs/resources/webhooks.d.ts.map +1 -0
- package/dist/cjs/resources/webhooks.js +35 -0
- package/dist/cjs/resources/webhooks.js.map +1 -0
- package/dist/cjs/units.d.ts +11 -11
- package/dist/cjs/units.js +14 -14
- package/dist/cjs/units.js.map +1 -1
- package/dist/cjs/version.d.ts +3 -3
- package/dist/cjs/version.d.ts.map +1 -1
- package/dist/cjs/version.js +3 -3
- package/dist/cjs/version.js.map +1 -1
- package/dist/cjs/webhooks.d.ts +33 -28
- package/dist/cjs/webhooks.d.ts.map +1 -1
- package/dist/cjs/webhooks.js +33 -28
- package/dist/cjs/webhooks.js.map +1 -1
- package/dist/esm/client.d.ts +23 -42
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +46 -55
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/core/errors.d.ts +18 -18
- package/dist/esm/core/errors.d.ts.map +1 -1
- package/dist/esm/core/errors.js +17 -17
- package/dist/esm/core/errors.js.map +1 -1
- package/dist/esm/core/http.d.ts +22 -26
- package/dist/esm/core/http.d.ts.map +1 -1
- package/dist/esm/core/http.js +28 -36
- package/dist/esm/core/http.js.map +1 -1
- package/dist/esm/core/pagination.d.ts +6 -7
- package/dist/esm/core/pagination.d.ts.map +1 -1
- package/dist/esm/core/pagination.js +1 -1
- package/dist/esm/core/pagination.js.map +1 -1
- package/dist/esm/core/scope.d.ts +8 -0
- package/dist/esm/core/scope.d.ts.map +1 -0
- package/dist/esm/core/scope.js +2 -0
- package/dist/esm/core/scope.js.map +1 -0
- package/dist/esm/generated/types.d.ts +129 -117
- package/dist/esm/generated/types.d.ts.map +1 -1
- package/dist/esm/generated/types.js +1 -1
- package/dist/esm/generated/types.js.map +1 -1
- package/dist/esm/index.d.ts +6 -6
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +6 -6
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/resources/account.d.ts +12 -51
- package/dist/esm/resources/account.d.ts.map +1 -1
- package/dist/esm/resources/account.js +15 -57
- package/dist/esm/resources/account.js.map +1 -1
- package/dist/esm/resources/addresses.d.ts +49 -65
- package/dist/esm/resources/addresses.d.ts.map +1 -1
- package/dist/esm/resources/addresses.js +60 -69
- package/dist/esm/resources/addresses.js.map +1 -1
- package/dist/esm/resources/catalog.d.ts +17 -10
- package/dist/esm/resources/catalog.d.ts.map +1 -1
- package/dist/esm/resources/catalog.js +23 -17
- package/dist/esm/resources/catalog.js.map +1 -1
- package/dist/esm/resources/deliveries.d.ts +34 -23
- package/dist/esm/resources/deliveries.d.ts.map +1 -1
- package/dist/esm/resources/deliveries.js +27 -17
- package/dist/esm/resources/deliveries.js.map +1 -1
- package/dist/esm/resources/transactions.d.ts +14 -14
- package/dist/esm/resources/transactions.d.ts.map +1 -1
- package/dist/esm/resources/transactions.js +15 -16
- package/dist/esm/resources/transactions.js.map +1 -1
- package/dist/esm/resources/webhooks.d.ts +22 -0
- package/dist/esm/resources/webhooks.d.ts.map +1 -0
- package/dist/esm/resources/webhooks.js +31 -0
- package/dist/esm/resources/webhooks.js.map +1 -0
- package/dist/esm/units.d.ts +11 -11
- package/dist/esm/units.js +14 -14
- package/dist/esm/units.js.map +1 -1
- package/dist/esm/version.d.ts +3 -3
- package/dist/esm/version.d.ts.map +1 -1
- package/dist/esm/version.js +3 -3
- package/dist/esm/version.js.map +1 -1
- package/dist/esm/webhooks.d.ts +33 -28
- package/dist/esm/webhooks.d.ts.map +1 -1
- package/dist/esm/webhooks.js +33 -28
- package/dist/esm/webhooks.js.map +1 -1
- package/package.json +8 -5
- package/src/client.ts +50 -61
- package/src/core/errors.ts +18 -18
- package/src/core/http.ts +45 -55
- package/src/core/pagination.ts +7 -8
- package/src/core/scope.ts +8 -0
- package/src/generated/types.ts +139 -125
- package/src/index.ts +7 -24
- package/src/resources/account.ts +18 -72
- package/src/resources/addresses.ts +84 -109
- package/src/resources/catalog.ts +28 -19
- package/src/resources/deliveries.ts +43 -30
- package/src/resources/transactions.ts +18 -17
- package/src/resources/webhooks.ts +36 -0
- package/src/units.ts +14 -14
- package/src/version.ts +3 -3
- package/src/webhooks.ts +37 -32
- package/dist/cjs/resources/clients.d.ts +0 -84
- package/dist/cjs/resources/clients.d.ts.map +0 -1
- package/dist/cjs/resources/clients.js +0 -102
- package/dist/cjs/resources/clients.js.map +0 -1
- package/dist/esm/resources/clients.d.ts +0 -84
- package/dist/esm/resources/clients.d.ts.map +0 -1
- package/dist/esm/resources/clients.js +0 -97
- package/dist/esm/resources/clients.js.map +0 -1
- package/src/resources/clients.ts +0 -135
package/dist/cjs/client.js
CHANGED
|
@@ -1,88 +1,79 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.MonitoringClient = void 0;
|
|
4
|
+
const errors_js_1 = require("./core/errors.js");
|
|
4
5
|
const http_js_1 = require("./core/http.js");
|
|
5
6
|
const account_js_1 = require("./resources/account.js");
|
|
6
7
|
const addresses_js_1 = require("./resources/addresses.js");
|
|
7
8
|
const catalog_js_1 = require("./resources/catalog.js");
|
|
8
|
-
const clients_js_1 = require("./resources/clients.js");
|
|
9
9
|
const deliveries_js_1 = require("./resources/deliveries.js");
|
|
10
10
|
const transactions_js_1 = require("./resources/transactions.js");
|
|
11
|
+
const webhooks_js_1 = require("./resources/webhooks.js");
|
|
11
12
|
const version_js_1 = require("./version.js");
|
|
12
13
|
/**
|
|
13
|
-
*
|
|
14
|
-
* Только для сервера: ключ в браузере увидит любой.
|
|
14
|
+
* Client for the V3 Finance Monitoring API.
|
|
15
15
|
*
|
|
16
|
-
*
|
|
16
|
+
* Use it on the server only: an API key in a browser is visible to anyone.
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
17
19
|
* ```ts
|
|
18
20
|
* import { MonitoringClient } from '@v3finance/monitoring-sdk'
|
|
19
21
|
*
|
|
20
|
-
* const monitoring = new MonitoringClient({ apiKey: process.env.MONITORING_API_KEY })
|
|
21
|
-
* await monitoring.addresses.add(clientId, [{ network: 'tron', address: 'T…' }], { assets: ['USDT'], direction: 'in' })
|
|
22
|
-
* ```
|
|
22
|
+
* const monitoring = new MonitoringClient({ apiKey: process.env.MONITORING_API_KEY! })
|
|
23
23
|
*
|
|
24
|
-
*
|
|
25
|
-
* ```ts
|
|
26
|
-
* const { client } = await MonitoringClient.signIn({ email, password })
|
|
27
|
-
* const { key } = await client.account.keys.create({ name: 'ci' })
|
|
24
|
+
* await monitoring.addresses.add([{ network: 'tron', address: 'TA8Hg…' }], { assets: ['USDT'], direction: 'in' })
|
|
28
25
|
* ```
|
|
29
26
|
*/
|
|
30
27
|
class MonitoringClient {
|
|
31
|
-
/**
|
|
28
|
+
/** Your client: the account your API key belongs to. */
|
|
32
29
|
account;
|
|
33
|
-
/**
|
|
34
|
-
auth;
|
|
35
|
-
/** Сети */
|
|
36
|
-
networks;
|
|
37
|
-
/** Нативные монеты и токены */
|
|
38
|
-
assets;
|
|
39
|
-
/** Ваш клиент: URL вебхука, секрет, ключи, участники, тестовый вебхук */
|
|
40
|
-
clients;
|
|
41
|
-
/** Адреса на мониторинге и подписка */
|
|
30
|
+
/** Addresses you monitor and their subscriptions. */
|
|
42
31
|
addresses;
|
|
43
|
-
/**
|
|
32
|
+
/** Test your webhook endpoint. */
|
|
33
|
+
webhooks;
|
|
34
|
+
/** History of webhooks sent to you. */
|
|
44
35
|
deliveries;
|
|
45
|
-
/**
|
|
36
|
+
/** Any transaction by hash, with confirmations and finality. */
|
|
46
37
|
transactions;
|
|
38
|
+
/** Supported networks. */
|
|
39
|
+
networks;
|
|
40
|
+
/** Supported native coins and tokens. */
|
|
41
|
+
assets;
|
|
47
42
|
#http;
|
|
43
|
+
#clientId;
|
|
48
44
|
/**
|
|
49
|
-
* @param options -
|
|
50
|
-
* @throws {@link MonitoringError}
|
|
45
|
+
* @param options - API key and optional settings.
|
|
46
|
+
* @throws {@link MonitoringError} when `apiKey` is missing or `fetch` is not available.
|
|
51
47
|
*/
|
|
52
|
-
constructor(options
|
|
48
|
+
constructor(options) {
|
|
53
49
|
this.#http = new http_js_1.HttpClient(options, version_js_1.DEFAULT_BASE_URL);
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
this.
|
|
58
|
-
this.
|
|
59
|
-
this.
|
|
60
|
-
this.deliveries = new deliveries_js_1.DeliveriesResource(
|
|
61
|
-
this.transactions = new transactions_js_1.TransactionsResource(
|
|
50
|
+
if (options.clientId)
|
|
51
|
+
this.#clientId = Promise.resolve(options.clientId);
|
|
52
|
+
const scope = { http: this.#http, clientPath: async () => `/v1/clients/${(0, http_js_1.seg)(await this.#resolveClientId())}` };
|
|
53
|
+
this.account = new account_js_1.AccountResource(scope, () => this.#resolveClientId());
|
|
54
|
+
this.addresses = new addresses_js_1.AddressesResource(scope);
|
|
55
|
+
this.webhooks = new webhooks_js_1.WebhooksResource(scope);
|
|
56
|
+
this.deliveries = new deliveries_js_1.DeliveriesResource(scope);
|
|
57
|
+
this.transactions = new transactions_js_1.TransactionsResource(scope);
|
|
58
|
+
this.networks = new catalog_js_1.NetworksResource(scope);
|
|
59
|
+
this.assets = new catalog_js_1.AssetsResource(scope);
|
|
62
60
|
}
|
|
63
|
-
/**
|
|
61
|
+
/** API base URL this client sends requests to. */
|
|
64
62
|
get baseUrl() {
|
|
65
63
|
return this.#http.baseUrl;
|
|
66
64
|
}
|
|
67
|
-
/**
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
method: 'POST',
|
|
78
|
-
path: '/api/auth/sign-in/email',
|
|
79
|
-
body: credentials,
|
|
80
|
-
idempotent: false,
|
|
81
|
-
auth: false,
|
|
82
|
-
// повтор при отказе 429 только сожжёт попытки входа
|
|
83
|
-
options: { maxRetries: 0, ...requestOptions },
|
|
65
|
+
/** Client ID of the API key: from the options, or resolved once from the API and cached. */
|
|
66
|
+
#resolveClientId() {
|
|
67
|
+
this.#clientId ??= this.#http.request({ method: 'GET', path: '/v1/me', idempotent: true }).then((identity) => {
|
|
68
|
+
if (!identity.actor.clientId)
|
|
69
|
+
throw new errors_js_1.MonitoringError('this API key is not bound to a client: pass clientId in the options');
|
|
70
|
+
return identity.actor.clientId;
|
|
71
|
+
}, (error) => {
|
|
72
|
+
// a failed lookup is not cached: the next call tries again
|
|
73
|
+
this.#clientId = undefined;
|
|
74
|
+
throw error;
|
|
84
75
|
});
|
|
85
|
-
return
|
|
76
|
+
return this.#clientId;
|
|
86
77
|
}
|
|
87
78
|
}
|
|
88
79
|
exports.MonitoringClient = MonitoringClient;
|
package/dist/cjs/client.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;AAAA,
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;AAAA,gDAAkD;AAClD,4CAAoE;AAGpE,uDAAwD;AACxD,2DAA4D;AAC5D,uDAAyE;AACzE,6DAA8D;AAC9D,iEAAkE;AAClE,yDAA0D;AAC1D,6CAA+C;AAE/C;;;;;;;;;;;;;GAaG;AACH;IACE,wDAAwD;IAC/C,OAAO,CAAiB;IACjC,qDAAqD;IAC5C,SAAS,CAAmB;IACrC,kCAAkC;IACzB,QAAQ,CAAkB;IACnC,uCAAuC;IAC9B,UAAU,CAAoB;IACvC,gEAAgE;IACvD,YAAY,CAAsB;IAC3C,0BAA0B;IACjB,QAAQ,CAAkB;IACnC,yCAAyC;IAChC,MAAM,CAAgB;IAEtB,KAAK,CAAY;IAC1B,SAAS,CAA6B;IAEtC;;;OAGG;IACH,YAAY,OAAsB;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,oBAAU,CAAC,OAAO,EAAE,6BAAgB,CAAC,CAAA;QACtD,IAAI,OAAO,CAAC,QAAQ;YAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAA;QACxE,MAAM,KAAK,GAAU,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,eAAe,IAAA,aAAG,EAAC,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC,EAAE,EAAE,CAAA;QACtH,IAAI,CAAC,OAAO,GAAG,IAAI,4BAAe,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAAA;QACxE,IAAI,CAAC,SAAS,GAAG,IAAI,gCAAiB,CAAC,KAAK,CAAC,CAAA;QAC7C,IAAI,CAAC,QAAQ,GAAG,IAAI,8BAAgB,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,UAAU,GAAG,IAAI,kCAAkB,CAAC,KAAK,CAAC,CAAA;QAC/C,IAAI,CAAC,YAAY,GAAG,IAAI,sCAAoB,CAAC,KAAK,CAAC,CAAA;QACnD,IAAI,CAAC,QAAQ,GAAG,IAAI,6BAAgB,CAAC,KAAK,CAAC,CAAA;QAC3C,IAAI,CAAC,MAAM,GAAG,IAAI,2BAAc,CAAC,KAAK,CAAC,CAAA;IACzC,CAAC;IAED,kDAAkD;IAClD,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAA;IAC3B,CAAC;IAED,4FAA4F;IAC5F,gBAAgB;QACd,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,KAAK,CAAC,OAAO,CAAW,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CACvG,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ;gBAAE,MAAM,IAAI,2BAAe,CAAC,qEAAqE,CAAC,CAAA;YAC9H,OAAO,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAA;QAChC,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;YACjB,2DAA2D;YAC3D,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;YAC1B,MAAM,KAAK,CAAA;QACb,CAAC,CACF,CAAA;QACD,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;CACF"}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import type { ApiErrorBody } from '../generated/types.js';
|
|
2
|
-
/**
|
|
2
|
+
/** A per-item problem of a batch request: the item's index in your request and the reason. */
|
|
3
3
|
export type ErrorDetail = NonNullable<ApiErrorBody['error']['details']>[number];
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Base class of every error thrown by the SDK.
|
|
6
6
|
*
|
|
7
7
|
* @example
|
|
8
8
|
* ```ts
|
|
9
9
|
* try {
|
|
10
|
-
* await monitoring.addresses.add(
|
|
11
|
-
* } catch (
|
|
12
|
-
* if (
|
|
13
|
-
* else throw
|
|
10
|
+
* await monitoring.addresses.add(items)
|
|
11
|
+
* } catch (error) {
|
|
12
|
+
* if (error instanceof MonitoringApiError && error.status === 400) console.log(error.details)
|
|
13
|
+
* else throw error
|
|
14
14
|
* }
|
|
15
15
|
* ```
|
|
16
16
|
*/
|
|
@@ -19,20 +19,20 @@ export declare class MonitoringError extends Error {
|
|
|
19
19
|
cause?: unknown;
|
|
20
20
|
});
|
|
21
21
|
}
|
|
22
|
-
/** API
|
|
22
|
+
/** The API responded with an error status (4xx or 5xx). */
|
|
23
23
|
export declare class MonitoringApiError extends MonitoringError {
|
|
24
|
-
/** HTTP
|
|
24
|
+
/** HTTP status code. */
|
|
25
25
|
readonly status: number;
|
|
26
26
|
/**
|
|
27
|
-
*
|
|
28
|
-
* `rate_limited`, `upstream_error`, `upstream_rate_limited
|
|
27
|
+
* Machine-readable error code, e.g. `invalid_request`, `unauthorized`, `forbidden`, `not_found`,
|
|
28
|
+
* `rate_limited`, `upstream_error`, `upstream_rate_limited`.
|
|
29
29
|
*/
|
|
30
30
|
readonly code: string;
|
|
31
|
-
/**
|
|
31
|
+
/** Per-item problems of a batch request, such as invalid addresses. Empty when there are none. */
|
|
32
32
|
readonly details: ErrorDetail[];
|
|
33
|
-
/**
|
|
33
|
+
/** Request ID. Include it when contacting support. */
|
|
34
34
|
readonly requestId: string | undefined;
|
|
35
|
-
/**
|
|
35
|
+
/** Raw response body. */
|
|
36
36
|
readonly body: unknown;
|
|
37
37
|
constructor(init: {
|
|
38
38
|
status: number;
|
|
@@ -42,23 +42,23 @@ export declare class MonitoringApiError extends MonitoringError {
|
|
|
42
42
|
requestId?: string;
|
|
43
43
|
body?: unknown;
|
|
44
44
|
});
|
|
45
|
-
/**
|
|
45
|
+
/** `true` for transient errors — rate limits and unavailable upstream providers — that can be retried later. */
|
|
46
46
|
get retryable(): boolean;
|
|
47
47
|
}
|
|
48
|
-
/**
|
|
48
|
+
/** The request did not get a response because of a network or connection failure. */
|
|
49
49
|
export declare class MonitoringConnectionError extends MonitoringError {
|
|
50
50
|
constructor(message: string, options?: {
|
|
51
51
|
cause?: unknown;
|
|
52
52
|
});
|
|
53
53
|
}
|
|
54
|
-
/**
|
|
54
|
+
/** The request did not complete within `timeoutMs`. */
|
|
55
55
|
export declare class MonitoringTimeoutError extends MonitoringConnectionError {
|
|
56
56
|
constructor(timeoutMs: number);
|
|
57
57
|
}
|
|
58
|
-
/**
|
|
58
|
+
/** The webhook signature does not match: the body was altered or is verified with the wrong secret. */
|
|
59
59
|
export declare class WebhookSignatureError extends MonitoringError {
|
|
60
60
|
constructor(message?: string);
|
|
61
61
|
}
|
|
62
|
-
/**
|
|
62
|
+
/** Builds an error from any error body the API returns. */
|
|
63
63
|
export declare function apiErrorFrom(status: number, body: unknown, requestId: string | undefined): MonitoringApiError;
|
|
64
64
|
//# sourceMappingURL=errors.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,
|
|
1
|
+
{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AAEzD,8FAA8F;AAC9F,MAAM,MAAM,WAAW,GAAG,WAAW,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;AAE/E;;;;;;;;;;;;GAYG;AACH,qBAAa,eAAgB,SAAQ,KAAK;IACxC,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,EAGzD;CACF;AAED,2DAA2D;AAC3D,qBAAa,kBAAmB,SAAQ,eAAe;IACrD,wBAAwB;IACxB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;IACvB;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,kGAAkG;IAClG,QAAQ,CAAC,OAAO,EAAE,WAAW,EAAE,CAAA;IAC/B,sDAAsD;IACtD,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,yBAAyB;IACzB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;IAEtB,YAAY,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,OAAO,CAAA;KAAE,EAQ/H;IAED,gHAAgH;IAChH,IAAI,SAAS,IAAI,OAAO,CAEvB;CACF;AAED,qFAAqF;AACrF,qBAAa,yBAA0B,SAAQ,eAAe;IAC5D,YAAY,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,EAGzD;CACF;AAED,uDAAuD;AACvD,qBAAa,sBAAuB,SAAQ,yBAAyB;IACnE,YAAY,SAAS,EAAE,MAAM,EAG5B;CACF;AAED,uGAAuG;AACvG,qBAAa,qBAAsB,SAAQ,eAAe;IACxD,YAAY,OAAO,SAA+B,EAGjD;CACF;AAED,2DAA2D;AAC3D,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,SAAS,GAAG,kBAAkB,CAW7G"}
|
package/dist/cjs/core/errors.js
CHANGED
|
@@ -3,15 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.WebhookSignatureError = exports.MonitoringTimeoutError = exports.MonitoringConnectionError = exports.MonitoringApiError = exports.MonitoringError = void 0;
|
|
4
4
|
exports.apiErrorFrom = apiErrorFrom;
|
|
5
5
|
/**
|
|
6
|
-
*
|
|
6
|
+
* Base class of every error thrown by the SDK.
|
|
7
7
|
*
|
|
8
8
|
* @example
|
|
9
9
|
* ```ts
|
|
10
10
|
* try {
|
|
11
|
-
* await monitoring.addresses.add(
|
|
12
|
-
* } catch (
|
|
13
|
-
* if (
|
|
14
|
-
* else throw
|
|
11
|
+
* await monitoring.addresses.add(items)
|
|
12
|
+
* } catch (error) {
|
|
13
|
+
* if (error instanceof MonitoringApiError && error.status === 400) console.log(error.details)
|
|
14
|
+
* else throw error
|
|
15
15
|
* }
|
|
16
16
|
* ```
|
|
17
17
|
*/
|
|
@@ -22,20 +22,20 @@ class MonitoringError extends Error {
|
|
|
22
22
|
}
|
|
23
23
|
}
|
|
24
24
|
exports.MonitoringError = MonitoringError;
|
|
25
|
-
/** API
|
|
25
|
+
/** The API responded with an error status (4xx or 5xx). */
|
|
26
26
|
class MonitoringApiError extends MonitoringError {
|
|
27
|
-
/** HTTP
|
|
27
|
+
/** HTTP status code. */
|
|
28
28
|
status;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
31
|
-
* `rate_limited`, `upstream_error`, `upstream_rate_limited
|
|
30
|
+
* Machine-readable error code, e.g. `invalid_request`, `unauthorized`, `forbidden`, `not_found`,
|
|
31
|
+
* `rate_limited`, `upstream_error`, `upstream_rate_limited`.
|
|
32
32
|
*/
|
|
33
33
|
code;
|
|
34
|
-
/**
|
|
34
|
+
/** Per-item problems of a batch request, such as invalid addresses. Empty when there are none. */
|
|
35
35
|
details;
|
|
36
|
-
/**
|
|
36
|
+
/** Request ID. Include it when contacting support. */
|
|
37
37
|
requestId;
|
|
38
|
-
/**
|
|
38
|
+
/** Raw response body. */
|
|
39
39
|
body;
|
|
40
40
|
constructor(init) {
|
|
41
41
|
super(`${init.message} (HTTP ${init.status}, ${init.code})`);
|
|
@@ -46,13 +46,13 @@ class MonitoringApiError extends MonitoringError {
|
|
|
46
46
|
this.requestId = init.requestId;
|
|
47
47
|
this.body = init.body;
|
|
48
48
|
}
|
|
49
|
-
/**
|
|
49
|
+
/** `true` for transient errors — rate limits and unavailable upstream providers — that can be retried later. */
|
|
50
50
|
get retryable() {
|
|
51
51
|
return this.status === 429 || this.status === 503;
|
|
52
52
|
}
|
|
53
53
|
}
|
|
54
54
|
exports.MonitoringApiError = MonitoringApiError;
|
|
55
|
-
/**
|
|
55
|
+
/** The request did not get a response because of a network or connection failure. */
|
|
56
56
|
class MonitoringConnectionError extends MonitoringError {
|
|
57
57
|
constructor(message, options) {
|
|
58
58
|
super(message, options);
|
|
@@ -60,7 +60,7 @@ class MonitoringConnectionError extends MonitoringError {
|
|
|
60
60
|
}
|
|
61
61
|
}
|
|
62
62
|
exports.MonitoringConnectionError = MonitoringConnectionError;
|
|
63
|
-
/**
|
|
63
|
+
/** The request did not complete within `timeoutMs`. */
|
|
64
64
|
class MonitoringTimeoutError extends MonitoringConnectionError {
|
|
65
65
|
constructor(timeoutMs) {
|
|
66
66
|
super(`request timed out after ${timeoutMs} ms`);
|
|
@@ -68,7 +68,7 @@ class MonitoringTimeoutError extends MonitoringConnectionError {
|
|
|
68
68
|
}
|
|
69
69
|
}
|
|
70
70
|
exports.MonitoringTimeoutError = MonitoringTimeoutError;
|
|
71
|
-
/**
|
|
71
|
+
/** The webhook signature does not match: the body was altered or is verified with the wrong secret. */
|
|
72
72
|
class WebhookSignatureError extends MonitoringError {
|
|
73
73
|
constructor(message = 'webhook signature mismatch') {
|
|
74
74
|
super(message);
|
|
@@ -76,7 +76,7 @@ class WebhookSignatureError extends MonitoringError {
|
|
|
76
76
|
}
|
|
77
77
|
}
|
|
78
78
|
exports.WebhookSignatureError = WebhookSignatureError;
|
|
79
|
-
/**
|
|
79
|
+
/** Builds an error from any error body the API returns. */
|
|
80
80
|
function apiErrorFrom(status, body, requestId) {
|
|
81
81
|
const b = (body ?? {});
|
|
82
82
|
const v1 = typeof b.error === 'object' && b.error !== null ? b.error : undefined;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":";;;;AAKA;;;;;;;;;;;;GAYG;AACH,qBAA6B,SAAQ,KAAK;IACxC,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IAC/B,CAAC;CACF;;AAED,
|
|
1
|
+
{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../../src/core/errors.ts"],"names":[],"mappings":";;;;AAKA;;;;;;;;;;;;GAYG;AACH,qBAA6B,SAAQ,KAAK;IACxC,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAA;IAC/B,CAAC;CACF;;AAED,2DAA2D;AAC3D,wBAAgC,SAAQ,eAAe;IACrD,wBAAwB;IACf,MAAM,CAAQ;IACvB;;;OAGG;IACM,IAAI,CAAQ;IACrB,kGAAkG;IACzF,OAAO,CAAe;IAC/B,sDAAsD;IAC7C,SAAS,CAAoB;IACtC,yBAAyB;IAChB,IAAI,CAAS;IAEtB,YAAY,IAAoH;QAC9H,KAAK,CAAC,GAAG,IAAI,CAAC,OAAO,UAAU,IAAI,CAAC,MAAM,KAAK,IAAI,CAAC,IAAI,GAAG,CAAC,CAAA;QAC5D,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAA;QAChC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAA;QACzB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;QACrB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAA;QACjC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;IACvB,CAAC;IAED,gHAAgH;IAChH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,MAAM,KAAK,GAAG,CAAA;IACnD,CAAC;CACF;;AAED,qFAAqF;AACrF,+BAAuC,SAAQ,eAAe;IAC5D,YAAY,OAAe,EAAE,OAA6B;QACxD,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;QACvB,IAAI,CAAC,IAAI,GAAG,2BAA2B,CAAA;IACzC,CAAC;CACF;;AAED,uDAAuD;AACvD,4BAAoC,SAAQ,yBAAyB;IACnE,YAAY,SAAiB;QAC3B,KAAK,CAAC,2BAA2B,SAAS,KAAK,CAAC,CAAA;QAChD,IAAI,CAAC,IAAI,GAAG,wBAAwB,CAAA;IACtC,CAAC;CACF;;AAED,uGAAuG;AACvG,2BAAmC,SAAQ,eAAe;IACxD,YAAY,OAAO,GAAG,4BAA4B;QAChD,KAAK,CAAC,OAAO,CAAC,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAA;IACrC,CAAC;CACF;;AAED,2DAA2D;AAC3D,sBAA6B,MAAc,EAAE,IAAa,EAAE,SAA6B;IACvF,MAAM,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE,CAA4B,CAAA;IACjD,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAE,CAAC,CAAC,KAAiC,CAAC,CAAC,CAAC,SAAS,CAAA;IAC7G,MAAM,OAAO,GACX,CAAC,OAAO,EAAE,EAAE,OAAO,KAAK,QAAQ,IAAI,EAAE,CAAC,OAAO,CAAC;QAC/C,CAAC,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,KAAK,CAAC;QACxC,CAAC,OAAO,CAAC,CAAC,OAAO,KAAK,QAAQ,IAAI,CAAC,CAAC,OAAO,CAAC;QAC5C,QAAQ,MAAM,EAAE,CAAA;IAClB,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,IAAI,KAAK,QAAQ,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,WAAW,CAAC,MAAM,CAAC,CAAA;IACrI,MAAM,OAAO,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAkB,CAAA;IACtH,OAAO,IAAI,kBAAkB,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;AACpF,CAAC;AAED,SAAS,WAAW,CAAC,MAAc;IACjC,MAAM,KAAK,GAA2B,EAAE,GAAG,EAAE,iBAAiB,EAAE,GAAG,EAAE,cAAc,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAE,cAAc,EAAE,CAAA;IAC/J,OAAO,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,IAAI,GAAG,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,CAAA;AACzE,CAAC"}
|
package/dist/cjs/core/http.d.ts
CHANGED
|
@@ -1,62 +1,58 @@
|
|
|
1
|
-
/**
|
|
1
|
+
/** Per-request options, accepted as the last argument of every method. */
|
|
2
2
|
export interface RequestOptions {
|
|
3
|
-
/**
|
|
3
|
+
/** Cancels the request, including pending retries. */
|
|
4
4
|
signal?: AbortSignal;
|
|
5
|
-
/**
|
|
5
|
+
/** Timeout for this request in milliseconds. Overrides {@link ClientOptions.timeoutMs}. */
|
|
6
6
|
timeoutMs?: number;
|
|
7
|
-
/**
|
|
7
|
+
/** Maximum number of retries for this request. Overrides {@link ClientOptions.maxRetries}. */
|
|
8
8
|
maxRetries?: number;
|
|
9
9
|
}
|
|
10
|
-
/**
|
|
10
|
+
/** Options of {@link MonitoringClient}. */
|
|
11
11
|
export interface ClientOptions {
|
|
12
|
+
/** Your API key. Sent in the `x-api-key` header. */
|
|
13
|
+
apiKey: string;
|
|
12
14
|
/**
|
|
13
|
-
*
|
|
14
|
-
* (всё, что вы можете в панели, с вашими правами). Уходит в заголовке `x-api-key`.
|
|
15
|
+
* Your client ID. Optional: when omitted, it is resolved from the API key on first use and cached.
|
|
15
16
|
*/
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
sessionToken?: string;
|
|
19
|
-
/** Адрес API. По умолчанию `https://monitoring.v3.finance` */
|
|
17
|
+
clientId?: string;
|
|
18
|
+
/** API base URL. Defaults to `https://monitoring.v3.finance`. */
|
|
20
19
|
baseUrl?: string;
|
|
21
|
-
/**
|
|
20
|
+
/** Request timeout in milliseconds. Defaults to `30000`. */
|
|
22
21
|
timeoutMs?: number;
|
|
23
22
|
/**
|
|
24
|
-
*
|
|
23
|
+
* Maximum number of retries for transient errors. Defaults to `2`.
|
|
25
24
|
*
|
|
26
|
-
*
|
|
27
|
-
*
|
|
28
|
-
* `Retry-After`, иначе экспоненциальная с разбросом.
|
|
25
|
+
* `429` and `503` responses are retried for every request, honoring `Retry-After`. Network errors and timeouts are
|
|
26
|
+
* retried only for requests that are safe to repeat. Backoff is exponential with jitter.
|
|
29
27
|
*/
|
|
30
28
|
maxRetries?: number;
|
|
31
|
-
/**
|
|
29
|
+
/** Custom `fetch` implementation, e.g. for proxies or instrumentation. Defaults to the global `fetch`. */
|
|
32
30
|
fetch?: typeof fetch;
|
|
33
|
-
/**
|
|
31
|
+
/** Additional headers sent with every request. */
|
|
34
32
|
headers?: Record<string, string>;
|
|
35
33
|
}
|
|
36
34
|
type Query = Record<string, string | number | boolean | null | undefined>;
|
|
37
|
-
/**
|
|
35
|
+
/** @internal A request to the API. */
|
|
38
36
|
export interface Call {
|
|
39
37
|
method: 'GET' | 'POST' | 'PATCH' | 'DELETE';
|
|
40
38
|
path: string;
|
|
41
39
|
query?: Query;
|
|
42
40
|
body?: unknown;
|
|
43
|
-
/**
|
|
41
|
+
/** The request can be repeated after a network failure without changing the outcome. */
|
|
44
42
|
idempotent: boolean;
|
|
45
|
-
/**
|
|
43
|
+
/** Statuses returned as data rather than thrown. */
|
|
46
44
|
acceptStatuses?: number[];
|
|
47
|
-
/** false — запрос без учётных данных (вход) */
|
|
48
|
-
auth?: boolean;
|
|
49
45
|
options?: RequestOptions | undefined;
|
|
50
46
|
}
|
|
51
|
-
/**
|
|
47
|
+
/** @internal Transport: base URL, authentication, timeouts, retries and error mapping. */
|
|
52
48
|
export declare class HttpClient {
|
|
53
49
|
#private;
|
|
54
50
|
readonly baseUrl: string;
|
|
55
51
|
constructor(options: ClientOptions, defaultBaseUrl: string);
|
|
56
|
-
/**
|
|
52
|
+
/** Sends a request and returns the parsed JSON response. */
|
|
57
53
|
request<T>(call: Call): Promise<T>;
|
|
58
54
|
}
|
|
59
|
-
/**
|
|
55
|
+
/** @internal Encodes a path segment. */
|
|
60
56
|
export declare const seg: (value: string | number) => string;
|
|
61
57
|
export {};
|
|
62
58
|
//# sourceMappingURL=http.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../src/core/http.ts"],"names":[],"mappings":"AAGA,
|
|
1
|
+
{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../../src/core/http.ts"],"names":[],"mappings":"AAGA,0EAA0E;AAC1E,MAAM,WAAW,cAAc;IAC7B,sDAAsD;IACtD,MAAM,CAAC,EAAE,WAAW,CAAA;IACpB,2FAA2F;IAC3F,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,8FAA8F;IAC9F,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,2CAA2C;AAC3C,MAAM,WAAW,aAAa;IAC5B,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,iEAAiE;IACjE,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,0GAA0G;IAC1G,KAAK,CAAC,EAAE,OAAO,KAAK,CAAA;IACpB,kDAAkD;IAClD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC;AAED,KAAK,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,SAAS,CAAC,CAAA;AAEzE,sCAAsC;AACtC,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,CAAA;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,wFAAwF;IACxF,UAAU,EAAE,OAAO,CAAA;IACnB,oDAAoD;IACpD,cAAc,CAAC,EAAE,MAAM,EAAE,CAAA;IACzB,OAAO,CAAC,EAAE,cAAc,GAAG,SAAS,CAAA;CACrC;AAKD,0FAA0F;AAC1F,qBAAa,UAAU;;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IAOxB,YAAY,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,EAUzD;IAED,4DAA4D;IACtD,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAmCvC;CA6BF;AAuCD,wCAAwC;AACxC,eAAO,MAAM,GAAG,UAAW,MAAM,GAAG,MAAM,WAAsC,CAAA"}
|
package/dist/cjs/core/http.js
CHANGED
|
@@ -5,56 +5,62 @@ const version_js_1 = require("../version.js");
|
|
|
5
5
|
const errors_js_1 = require("./errors.js");
|
|
6
6
|
const DEFAULTS = { timeoutMs: 30_000, maxRetries: 2 };
|
|
7
7
|
const MAX_RETRY_DELAY_MS = 60_000;
|
|
8
|
-
/**
|
|
8
|
+
/** @internal Transport: base URL, authentication, timeouts, retries and error mapping. */
|
|
9
9
|
class HttpClient {
|
|
10
10
|
baseUrl;
|
|
11
11
|
#apiKey;
|
|
12
|
-
#sessionToken;
|
|
13
12
|
#timeoutMs;
|
|
14
13
|
#maxRetries;
|
|
15
14
|
#fetch;
|
|
16
15
|
#headers;
|
|
17
16
|
constructor(options, defaultBaseUrl) {
|
|
18
|
-
if (options
|
|
19
|
-
throw new errors_js_1.MonitoringError('
|
|
17
|
+
if (!options?.apiKey)
|
|
18
|
+
throw new errors_js_1.MonitoringError('apiKey is required');
|
|
20
19
|
this.baseUrl = (options.baseUrl ?? defaultBaseUrl).replace(/\/+$/, '');
|
|
21
20
|
this.#apiKey = options.apiKey;
|
|
22
|
-
this.#sessionToken = options.sessionToken;
|
|
23
21
|
this.#timeoutMs = options.timeoutMs ?? DEFAULTS.timeoutMs;
|
|
24
22
|
this.#maxRetries = options.maxRetries ?? DEFAULTS.maxRetries;
|
|
25
23
|
const f = options.fetch ?? globalThis.fetch;
|
|
26
24
|
if (typeof f !== 'function')
|
|
27
|
-
throw new errors_js_1.MonitoringError('fetch is not available: use Node.js 20
|
|
25
|
+
throw new errors_js_1.MonitoringError('fetch is not available: use Node.js 20 or later, or pass options.fetch');
|
|
28
26
|
this.#fetch = f;
|
|
29
27
|
this.#headers = { ...options.headers };
|
|
30
28
|
}
|
|
31
|
-
/**
|
|
29
|
+
/** Sends a request and returns the parsed JSON response. */
|
|
32
30
|
async request(call) {
|
|
33
31
|
const url = this.#url(call.path, call.query);
|
|
34
|
-
const headers =
|
|
32
|
+
const headers = {
|
|
33
|
+
accept: 'application/json',
|
|
34
|
+
'user-agent': `@v3finance/monitoring-sdk/${version_js_1.SDK_VERSION}`,
|
|
35
|
+
...this.#headers,
|
|
36
|
+
'x-api-key': this.#apiKey,
|
|
37
|
+
};
|
|
38
|
+
if (call.body !== undefined)
|
|
39
|
+
headers['content-type'] = 'application/json';
|
|
35
40
|
const body = call.body === undefined ? undefined : JSON.stringify(call.body);
|
|
36
41
|
const maxRetries = call.options?.maxRetries ?? this.#maxRetries;
|
|
37
42
|
const timeoutMs = call.options?.timeoutMs ?? this.#timeoutMs;
|
|
43
|
+
const signal = call.options?.signal;
|
|
38
44
|
for (let attempt = 0;; attempt++) {
|
|
39
45
|
let res;
|
|
40
46
|
try {
|
|
41
|
-
res = await this.#send(url, { method: call.method, headers, body }, timeoutMs,
|
|
47
|
+
res = await this.#send(url, { method: call.method, headers, body }, timeoutMs, signal);
|
|
42
48
|
}
|
|
43
|
-
catch (
|
|
44
|
-
if (
|
|
45
|
-
throw
|
|
49
|
+
catch (error) {
|
|
50
|
+
if (signal?.aborted)
|
|
51
|
+
throw signal.reason;
|
|
46
52
|
if (call.idempotent && attempt < maxRetries) {
|
|
47
|
-
await sleep(backoff(attempt),
|
|
53
|
+
await sleep(backoff(attempt), signal);
|
|
48
54
|
continue;
|
|
49
55
|
}
|
|
50
|
-
throw
|
|
56
|
+
throw error;
|
|
51
57
|
}
|
|
52
58
|
if ((res.status >= 200 && res.status < 300) || call.acceptStatuses?.includes(res.status))
|
|
53
59
|
return res.data;
|
|
54
60
|
const error = (0, errors_js_1.apiErrorFrom)(res.status, res.data, res.headers.get('cf-ray') ?? undefined);
|
|
55
|
-
// 429
|
|
61
|
+
// 429 and 503 mean the request was not processed, so retrying is safe for any method
|
|
56
62
|
if (error.retryable && attempt < maxRetries) {
|
|
57
|
-
await sleep(retryAfter(res.headers) ?? backoff(attempt),
|
|
63
|
+
await sleep(retryAfter(res.headers) ?? backoff(attempt), signal);
|
|
58
64
|
continue;
|
|
59
65
|
}
|
|
60
66
|
throw error;
|
|
@@ -67,21 +73,7 @@ class HttpClient {
|
|
|
67
73
|
url.searchParams.set(k, String(v));
|
|
68
74
|
return url.toString();
|
|
69
75
|
}
|
|
70
|
-
|
|
71
|
-
const headers = { accept: 'application/json', 'user-agent': `@v3finance/monitoring-sdk/${version_js_1.SDK_VERSION}`, ...this.#headers };
|
|
72
|
-
if (call.body !== undefined)
|
|
73
|
-
headers['content-type'] = 'application/json';
|
|
74
|
-
if (call.auth !== false) {
|
|
75
|
-
if (this.#apiKey)
|
|
76
|
-
headers['x-api-key'] = this.#apiKey;
|
|
77
|
-
else if (this.#sessionToken)
|
|
78
|
-
headers.authorization = `Bearer ${this.#sessionToken}`;
|
|
79
|
-
else
|
|
80
|
-
throw new errors_js_1.MonitoringError('credentials required: pass apiKey or sessionToken to MonitoringClient');
|
|
81
|
-
}
|
|
82
|
-
return headers;
|
|
83
|
-
}
|
|
84
|
-
/** Один запрос с таймаутом на всё — и соединение, и чтение тела */
|
|
76
|
+
/** One attempt, with a single timeout covering both the connection and the response body. */
|
|
85
77
|
async #send(url, init, timeoutMs, signal) {
|
|
86
78
|
const controller = new AbortController();
|
|
87
79
|
const timer = setTimeout(() => controller.abort(new errors_js_1.MonitoringTimeoutError(timeoutMs)), timeoutMs);
|
|
@@ -94,13 +86,13 @@ class HttpClient {
|
|
|
94
86
|
const text = await res.text();
|
|
95
87
|
return { status: res.status, headers: res.headers, data: text ? parseJson(text) : undefined };
|
|
96
88
|
}
|
|
97
|
-
catch (
|
|
89
|
+
catch (error) {
|
|
98
90
|
const reason = controller.signal.reason;
|
|
99
91
|
if (reason instanceof errors_js_1.MonitoringTimeoutError)
|
|
100
92
|
throw reason;
|
|
101
93
|
if (signal?.aborted)
|
|
102
94
|
throw signal.reason;
|
|
103
|
-
throw new errors_js_1.MonitoringConnectionError(`request to ${new URL(url).origin} failed: ${
|
|
95
|
+
throw new errors_js_1.MonitoringConnectionError(`request to ${new URL(url).origin} failed: ${error.message}`, { cause: error });
|
|
104
96
|
}
|
|
105
97
|
finally {
|
|
106
98
|
clearTimeout(timer);
|
|
@@ -117,11 +109,11 @@ function parseJson(text) {
|
|
|
117
109
|
return text;
|
|
118
110
|
}
|
|
119
111
|
}
|
|
120
|
-
/**
|
|
112
|
+
/** Exponential backoff with jitter: ~0.5 s, 1 s, 2 s… capped at 8 s. */
|
|
121
113
|
function backoff(attempt) {
|
|
122
114
|
return Math.min(8_000, 500 * 2 ** attempt) * (0.5 + Math.random() / 2);
|
|
123
115
|
}
|
|
124
|
-
/**
|
|
116
|
+
/** Delay from a `Retry-After` header: seconds or an HTTP date. */
|
|
125
117
|
function retryAfter(headers) {
|
|
126
118
|
const raw = headers.get('retry-after');
|
|
127
119
|
if (!raw)
|
|
@@ -145,7 +137,7 @@ function sleep(ms, signal) {
|
|
|
145
137
|
signal?.addEventListener('abort', onAbort, { once: true });
|
|
146
138
|
});
|
|
147
139
|
}
|
|
148
|
-
/**
|
|
140
|
+
/** @internal Encodes a path segment. */
|
|
149
141
|
const seg = (value) => encodeURIComponent(String(value));
|
|
150
142
|
exports.seg = seg;
|
|
151
143
|
//# sourceMappingURL=http.js.map
|