scorecard-ai 1.0.0 → 1.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 +53 -0
- package/README.md +52 -24
- package/client.d.mts +13 -13
- package/client.d.mts.map +1 -1
- package/client.d.ts +13 -13
- package/client.d.ts.map +1 -1
- package/client.js +26 -22
- package/client.js.map +1 -1
- package/client.mjs +15 -11
- package/client.mjs.map +1 -1
- package/core/resource.d.mts +1 -1
- package/core/resource.d.mts.map +1 -1
- package/core/resource.d.ts +1 -1
- package/core/resource.d.ts.map +1 -1
- package/core/resource.js.map +1 -1
- package/core/resource.mjs.map +1 -1
- package/internal/headers.d.mts.map +1 -1
- package/internal/headers.d.ts.map +1 -1
- package/internal/headers.js +4 -4
- package/internal/headers.js.map +1 -1
- package/internal/headers.mjs +4 -4
- package/internal/headers.mjs.map +1 -1
- package/internal/request-options.d.mts +1 -0
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts +1 -0
- package/internal/request-options.d.ts.map +1 -1
- package/internal/request-options.js.map +1 -1
- package/internal/request-options.mjs.map +1 -1
- package/internal/uploads.js +1 -1
- package/internal/uploads.js.map +1 -1
- package/internal/uploads.mjs +1 -1
- package/internal/uploads.mjs.map +1 -1
- package/internal/utils/log.js +1 -1
- package/internal/utils/log.js.map +1 -1
- package/internal/utils/log.mjs +1 -1
- package/internal/utils/log.mjs.map +1 -1
- package/internal/utils/path.d.mts.map +1 -1
- package/internal/utils/path.d.ts.map +1 -1
- package/internal/utils/path.js.map +1 -1
- package/internal/utils/path.mjs +1 -1
- package/internal/utils/path.mjs.map +1 -1
- package/internal/utils/values.d.mts +2 -0
- package/internal/utils/values.d.mts.map +1 -1
- package/internal/utils/values.d.ts +2 -0
- package/internal/utils/values.d.ts.map +1 -1
- package/internal/utils/values.js +4 -1
- package/internal/utils/values.js.map +1 -1
- package/internal/utils/values.mjs +2 -0
- package/internal/utils/values.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +1 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/metrics.d.mts +192 -2
- package/resources/metrics.d.mts.map +1 -1
- package/resources/metrics.d.ts +192 -2
- package/resources/metrics.d.ts.map +1 -1
- package/resources/metrics.js +20 -1
- package/resources/metrics.js.map +1 -1
- package/resources/metrics.mjs +20 -1
- package/resources/metrics.mjs.map +1 -1
- package/resources/records.d.mts +18 -7
- package/resources/records.d.mts.map +1 -1
- package/resources/records.d.ts +18 -7
- package/resources/records.d.ts.map +1 -1
- package/resources/records.js.map +1 -1
- package/resources/records.mjs.map +1 -1
- package/resources/scores.d.mts +6 -2
- package/resources/scores.d.mts.map +1 -1
- package/resources/scores.d.ts +6 -2
- package/resources/scores.d.ts.map +1 -1
- package/resources/shared.d.mts +3 -1
- package/resources/shared.d.mts.map +1 -1
- package/resources/shared.d.ts +3 -1
- package/resources/shared.d.ts.map +1 -1
- package/resources/systems/systems.d.mts +27 -9
- package/resources/systems/systems.d.mts.map +1 -1
- package/resources/systems/systems.d.ts +27 -9
- package/resources/systems/systems.d.ts.map +1 -1
- package/resources/systems/versions.d.mts +6 -2
- package/resources/systems/versions.d.mts.map +1 -1
- package/resources/systems/versions.d.ts +6 -2
- package/resources/systems/versions.d.ts.map +1 -1
- package/resources/testcases.d.mts +15 -5
- package/resources/testcases.d.mts.map +1 -1
- package/resources/testcases.d.ts +15 -5
- package/resources/testcases.d.ts.map +1 -1
- package/resources/testsets.d.mts +9 -3
- package/resources/testsets.d.mts.map +1 -1
- package/resources/testsets.d.ts +9 -3
- package/resources/testsets.d.ts.map +1 -1
- package/src/client.ts +42 -23
- package/src/core/resource.ts +1 -1
- package/src/internal/headers.ts +5 -5
- package/src/internal/request-options.ts +1 -0
- package/src/internal/uploads.ts +1 -1
- package/src/internal/utils/log.ts +1 -1
- package/src/internal/utils/path.ts +1 -1
- package/src/internal/utils/values.ts +3 -0
- package/src/resources/index.ts +1 -1
- package/src/resources/metrics.ts +245 -2
- package/src/resources/records.ts +6 -7
- package/src/resources/scores.ts +2 -2
- package/src/resources/shared.ts +1 -1
- package/src/resources/systems/systems.ts +9 -9
- package/src/resources/systems/versions.ts +2 -2
- package/src/resources/testcases.ts +5 -5
- package/src/resources/testsets.ts +3 -3
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,58 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 1.2.0 (2025-06-24)
|
|
4
|
+
|
|
5
|
+
Full Changelog: [v1.1.0...v1.2.0](https://github.com/scorecard-ai/scorecard-node/compare/v1.1.0...v1.2.0)
|
|
6
|
+
|
|
7
|
+
### Features
|
|
8
|
+
|
|
9
|
+
* **api:** api update ([a882c45](https://github.com/scorecard-ai/scorecard-node/commit/a882c45df73b0dc4854d0922de2202c672f526de))
|
|
10
|
+
* **client:** add support for endpoint-specific base URLs ([b2321da](https://github.com/scorecard-ai/scorecard-node/commit/b2321da0938526fe28f41eea50199463a281a0b9))
|
|
11
|
+
* **mcp:** set X-Stainless-MCP header ([12e61c2](https://github.com/scorecard-ai/scorecard-node/commit/12e61c2e9875a592cc60472deba4d94371bf2c85))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Bug Fixes
|
|
15
|
+
|
|
16
|
+
* **auth:** Use bearer auth for API keys ([db2f132](https://github.com/scorecard-ai/scorecard-node/commit/db2f13247584f167b984eb5c791df776af636f6e))
|
|
17
|
+
* **client:** explicitly copy fetch in withOptions ([acd9531](https://github.com/scorecard-ai/scorecard-node/commit/acd953180b4c22962464b1ba435132a71e19ded3))
|
|
18
|
+
* publish script — handle NPM errors correctly ([862309d](https://github.com/scorecard-ai/scorecard-node/commit/862309d31da4807bfc106666e8a10619b775fdf9))
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### Chores
|
|
22
|
+
|
|
23
|
+
* **ci:** enable for pull requests ([7fc40c6](https://github.com/scorecard-ai/scorecard-node/commit/7fc40c6fdd7839fd045027dc4814c83cba5833eb))
|
|
24
|
+
* **client:** refactor imports ([47ab4a2](https://github.com/scorecard-ai/scorecard-node/commit/47ab4a2f84198fdc9450e325f8580a636a6398c2))
|
|
25
|
+
* **internal:** add pure annotations, make base APIResource abstract ([507c372](https://github.com/scorecard-ai/scorecard-node/commit/507c372bce850ad5af615f05cbf5ef637ffafca2))
|
|
26
|
+
* **internal:** codegen related update ([1d07a29](https://github.com/scorecard-ai/scorecard-node/commit/1d07a298cfc7bbd997ba41c852184f5c34f0e739))
|
|
27
|
+
* **readme:** update badges ([bb0aef2](https://github.com/scorecard-ai/scorecard-node/commit/bb0aef287db5e1f8421153afac49759a82d59c2c))
|
|
28
|
+
* **readme:** use better example snippet for undocumented params ([62d2bf0](https://github.com/scorecard-ai/scorecard-node/commit/62d2bf00cf0147a6ee649c32cdcb25ae06bcedcb))
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
### Refactors
|
|
32
|
+
|
|
33
|
+
* **types:** replace Record with mapped types ([9aed086](https://github.com/scorecard-ai/scorecard-node/commit/9aed0866ef19e1b068bd960663ade0c4d5763be0))
|
|
34
|
+
|
|
35
|
+
## 1.1.0 (2025-06-13)
|
|
36
|
+
|
|
37
|
+
Full Changelog: [v1.0.0...v1.1.0](https://github.com/scorecard-ai/scorecard-node/compare/v1.0.0...v1.1.0)
|
|
38
|
+
|
|
39
|
+
### Features
|
|
40
|
+
|
|
41
|
+
* **api:** api update ([8ce317e](https://github.com/scorecard-ai/scorecard-node/commit/8ce317e5b754b04853c6371919f02aba4a85d125))
|
|
42
|
+
* **api:** api update ([c84cb8f](https://github.com/scorecard-ai/scorecard-node/commit/c84cb8f3bbc399adfa26b0171beda31f2dfc4941))
|
|
43
|
+
* **sdk:** Support Clerk API Keys in SDK ([10ff885](https://github.com/scorecard-ai/scorecard-node/commit/10ff885b8130ad7ce4387e1ff6a61185a3fc2359))
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Bug Fixes
|
|
47
|
+
|
|
48
|
+
* **tests:** Fix API key tests ([7d5809f](https://github.com/scorecard-ai/scorecard-node/commit/7d5809f85f51871b90d80533b1d4c923d98253c5))
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
### Chores
|
|
52
|
+
|
|
53
|
+
* **auth:** Add backwards-compatibility for bearer token auth ([1aea8fd](https://github.com/scorecard-ai/scorecard-node/commit/1aea8fd2787abb4d682dabbb78d46bbf72859ba2))
|
|
54
|
+
* **mcp:** provides high-level initMcpServer function and exports known clients ([f3857b2](https://github.com/scorecard-ai/scorecard-node/commit/f3857b22ac26f422e0eda1c36828c46e95fc6df5))
|
|
55
|
+
|
|
3
56
|
## 1.0.0 (2025-06-10)
|
|
4
57
|
|
|
5
58
|
Full Changelog: [v1.0.0-alpha.9...v1.0.0](https://github.com/scorecard-ai/scorecard-node/compare/v1.0.0-alpha.9...v1.0.0)
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Scorecard TypeScript API Library
|
|
2
2
|
|
|
3
|
-
[](https://npmjs.org/package/scorecard-ai) 
|
|
3
|
+
[>)](https://npmjs.org/package/scorecard-ai) 
|
|
4
4
|
|
|
5
5
|
This library provides convenient access to the Scorecard REST API from server-side TypeScript or JavaScript.
|
|
6
6
|
|
|
@@ -11,7 +11,7 @@ It is generated with [Stainless](https://www.stainless.com/).
|
|
|
11
11
|
## Installation
|
|
12
12
|
|
|
13
13
|
```sh
|
|
14
|
-
npm install scorecard-ai
|
|
14
|
+
npm install scorecard-ai
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
## Usage
|
|
@@ -20,30 +20,28 @@ The full API of this library can be found in [api.md](api.md).
|
|
|
20
20
|
|
|
21
21
|
<!-- prettier-ignore -->
|
|
22
22
|
```js
|
|
23
|
-
import Scorecard from 'scorecard-ai';
|
|
23
|
+
import Scorecard, { runAndEvaluate } from 'scorecard-ai';
|
|
24
|
+
|
|
25
|
+
async function runSystem(testcaseInput) {
|
|
26
|
+
// Replace with a call to your LLM system
|
|
27
|
+
return { response: testcaseInput.original.toUpperCase() };
|
|
28
|
+
}
|
|
24
29
|
|
|
25
30
|
const client = new Scorecard({
|
|
26
|
-
apiKey: process.env['SCORECARD_API_KEY'],
|
|
31
|
+
apiKey: process.env['SCORECARD_API_KEY'],
|
|
27
32
|
});
|
|
28
33
|
|
|
29
|
-
const
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
},
|
|
39
|
-
idealAnswer: {
|
|
40
|
-
type: 'string',
|
|
41
|
-
},
|
|
42
|
-
},
|
|
43
|
-
},
|
|
44
|
-
});
|
|
34
|
+
const run = await runAndEvaluate(
|
|
35
|
+
client,
|
|
36
|
+
{
|
|
37
|
+
projectId: '314', // Scorecard Project
|
|
38
|
+
testsetId: '246', // Scorecard Testset
|
|
39
|
+
metricIds: ['789', '101'], // Scorecard Metrics
|
|
40
|
+
system: runSystem, // Your LLM system
|
|
41
|
+
}
|
|
42
|
+
);
|
|
45
43
|
|
|
46
|
-
console.log(
|
|
44
|
+
console.log(`Go to ${run.url} to view your Run's scorecard.`);
|
|
47
45
|
```
|
|
48
46
|
|
|
49
47
|
### Request & Response types
|
|
@@ -137,6 +135,37 @@ On timeout, an `APIConnectionTimeoutError` is thrown.
|
|
|
137
135
|
|
|
138
136
|
Note that requests which time out will be [retried twice by default](#retries).
|
|
139
137
|
|
|
138
|
+
## Auto-pagination
|
|
139
|
+
|
|
140
|
+
List methods in the Scorecard API are paginated.
|
|
141
|
+
You can use the `for await … of` syntax to iterate through items across all pages:
|
|
142
|
+
|
|
143
|
+
```ts
|
|
144
|
+
async function fetchAllTestcases(params) {
|
|
145
|
+
const allTestcases = [];
|
|
146
|
+
// Automatically fetches more pages as needed.
|
|
147
|
+
for await (const testcase of client.testcases.list('246', { limit: 30 })) {
|
|
148
|
+
allTestcases.push(testcase);
|
|
149
|
+
}
|
|
150
|
+
return allTestcases;
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Alternatively, you can request a single page at a time:
|
|
155
|
+
|
|
156
|
+
```ts
|
|
157
|
+
let page = await client.testcases.list('246', { limit: 30 });
|
|
158
|
+
for (const testcase of page.data) {
|
|
159
|
+
console.log(testcase);
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
// Convenience methods are provided for manually paginating:
|
|
163
|
+
while (page.hasNextPage()) {
|
|
164
|
+
page = await page.getNextPage();
|
|
165
|
+
// ...
|
|
166
|
+
}
|
|
167
|
+
```
|
|
168
|
+
|
|
140
169
|
## Advanced Usage
|
|
141
170
|
|
|
142
171
|
### Accessing raw Response data (e.g., headers)
|
|
@@ -237,9 +266,8 @@ parameter. This library doesn't validate at runtime that the request matches the
|
|
|
237
266
|
send will be sent as-is.
|
|
238
267
|
|
|
239
268
|
```ts
|
|
240
|
-
client.
|
|
241
|
-
|
|
242
|
-
bar: 12,
|
|
269
|
+
client.runs.create({
|
|
270
|
+
// ...
|
|
243
271
|
// @ts-expect-error baz is not yet public
|
|
244
272
|
baz: 'undocumented option',
|
|
245
273
|
});
|
package/client.d.mts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { RequestInit, RequestInfo } from "./internal/builtin-types.mjs";
|
|
2
2
|
import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.mjs";
|
|
3
|
-
import { type Logger, type LogLevel } from "./internal/utils/log.mjs";
|
|
4
3
|
export type { Logger, LogLevel } from "./internal/utils/log.mjs";
|
|
5
4
|
import * as Opts from "./internal/request-options.mjs";
|
|
6
5
|
import * as Errors from "./core/error.mjs";
|
|
@@ -9,17 +8,18 @@ import { type PaginatedResponseParams, PaginatedResponseResponse } from "./core/
|
|
|
9
8
|
import * as Uploads from "./core/uploads.mjs";
|
|
10
9
|
import * as API from "./resources/index.mjs";
|
|
11
10
|
import { APIPromise } from "./core/api-promise.mjs";
|
|
12
|
-
import {
|
|
13
|
-
import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";
|
|
14
|
-
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";
|
|
15
|
-
import { Metric, MetricCreateParams, Metrics } from "./resources/metrics.mjs";
|
|
11
|
+
import { Metric, MetricCreateParams, MetricUpdateParams, Metrics } from "./resources/metrics.mjs";
|
|
16
12
|
import { Project, ProjectCreateParams, ProjectListParams, Projects, ProjectsPaginatedResponse } from "./resources/projects.mjs";
|
|
17
|
-
import { Record
|
|
13
|
+
import { Record, RecordCreateParams, Records } from "./resources/records.mjs";
|
|
18
14
|
import { Run, RunCreateParams, Runs } from "./resources/runs.mjs";
|
|
19
15
|
import { Score, ScoreUpsertParams, Scores } from "./resources/scores.mjs";
|
|
20
16
|
import { Testcase, TestcaseCreateParams, TestcaseCreateResponse, TestcaseDeleteParams, TestcaseDeleteResponse, TestcaseListParams, TestcaseUpdateParams, Testcases, TestcasesPaginatedResponse } from "./resources/testcases.mjs";
|
|
21
17
|
import { Testset, TestsetCreateParams, TestsetDeleteResponse, TestsetListParams, TestsetUpdateParams, Testsets, TestsetsPaginatedResponse } from "./resources/testsets.mjs";
|
|
22
18
|
import { System, SystemCreateParams, SystemDeleteResponse, SystemListParams, SystemUpdateParams, Systems, SystemsPaginatedResponse } from "./resources/systems/systems.mjs";
|
|
19
|
+
import { type Fetch, type Record as BuiltinRecord } from "./internal/builtin-types.mjs";
|
|
20
|
+
import { HeadersLike, NullableHeaders } from "./internal/headers.mjs";
|
|
21
|
+
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.mjs";
|
|
22
|
+
import { type LogLevel, type Logger } from "./internal/utils/log.mjs";
|
|
23
23
|
declare const environments: {
|
|
24
24
|
production: string;
|
|
25
25
|
staging: string;
|
|
@@ -85,7 +85,7 @@ export interface ClientOptions {
|
|
|
85
85
|
* These can be removed in individual requests by explicitly setting the
|
|
86
86
|
* param to `undefined` in request options.
|
|
87
87
|
*/
|
|
88
|
-
defaultQuery?:
|
|
88
|
+
defaultQuery?: BuiltinRecord<string, string | undefined> | undefined;
|
|
89
89
|
/**
|
|
90
90
|
* Set the log level.
|
|
91
91
|
*
|
|
@@ -126,24 +126,24 @@ export declare class Scorecard {
|
|
|
126
126
|
* @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
127
127
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
128
128
|
* @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
129
|
-
* @param {
|
|
129
|
+
* @param {BuiltinRecord<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
130
130
|
*/
|
|
131
131
|
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
|
132
132
|
/**
|
|
133
133
|
* Create a new client instance re-using the same options given to the current client with optional overriding.
|
|
134
134
|
*/
|
|
135
135
|
withOptions(options: Partial<ClientOptions>): this;
|
|
136
|
-
protected defaultQuery():
|
|
136
|
+
protected defaultQuery(): BuiltinRecord<string, string | undefined> | undefined;
|
|
137
137
|
protected validateHeaders({ values, nulls }: NullableHeaders): void;
|
|
138
138
|
protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined;
|
|
139
139
|
/**
|
|
140
140
|
* Basic re-implementation of `qs.stringify` for primitive types.
|
|
141
141
|
*/
|
|
142
|
-
protected stringifyQuery(query:
|
|
142
|
+
protected stringifyQuery(query: BuiltinRecord<string, unknown>): string;
|
|
143
143
|
private getUserAgent;
|
|
144
144
|
protected defaultIdempotencyKey(): string;
|
|
145
145
|
protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
|
|
146
|
-
buildURL(path: string, query:
|
|
146
|
+
buildURL(path: string, query: BuiltinRecord<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
|
|
147
147
|
/**
|
|
148
148
|
* Used as a callback for mutating the given `FinalRequestOptions` object.
|
|
149
149
|
*/
|
|
@@ -214,8 +214,8 @@ export declare namespace Scorecard {
|
|
|
214
214
|
export { Testsets as Testsets, type Testset as Testset, type TestsetDeleteResponse as TestsetDeleteResponse, type TestsetsPaginatedResponse as TestsetsPaginatedResponse, type TestsetCreateParams as TestsetCreateParams, type TestsetUpdateParams as TestsetUpdateParams, type TestsetListParams as TestsetListParams, };
|
|
215
215
|
export { Testcases as Testcases, type Testcase as Testcase, type TestcaseCreateResponse as TestcaseCreateResponse, type TestcaseDeleteResponse as TestcaseDeleteResponse, type TestcasesPaginatedResponse as TestcasesPaginatedResponse, type TestcaseCreateParams as TestcaseCreateParams, type TestcaseUpdateParams as TestcaseUpdateParams, type TestcaseListParams as TestcaseListParams, type TestcaseDeleteParams as TestcaseDeleteParams, };
|
|
216
216
|
export { Runs as Runs, type Run as Run, type RunCreateParams as RunCreateParams };
|
|
217
|
-
export { Metrics as Metrics, type Metric as Metric, type MetricCreateParams as MetricCreateParams };
|
|
218
|
-
export { Records as Records, type
|
|
217
|
+
export { Metrics as Metrics, type Metric as Metric, type MetricCreateParams as MetricCreateParams, type MetricUpdateParams as MetricUpdateParams, };
|
|
218
|
+
export { Records as Records, type Record as Record, type RecordCreateParams as RecordCreateParams };
|
|
219
219
|
export { Scores as Scores, type Score as Score, type ScoreUpsertParams as ScoreUpsertParams };
|
|
220
220
|
export { Systems as Systems, type System as System, type SystemDeleteResponse as SystemDeleteResponse, type SystemsPaginatedResponse as SystemsPaginatedResponse, type SystemCreateParams as SystemCreateParams, type SystemUpdateParams as SystemUpdateParams, type SystemListParams as SystemListParams, };
|
|
221
221
|
export type APIError = API.APIError;
|
package/client.d.mts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.mts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;
|
|
1
|
+
{"version":3,"file":"client.d.mts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAET,KAAK,MAAM;OACX,KAAK,UAAU;OACf,EAAgB,KAAK,uBAAuB,EAAE,yBAAyB,EAAE;OACzE,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,OAAO,EAAE;OAC3D,EACL,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,yBAAyB,EAC1B;OACM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE;OACvC,EAAE,GAAG,EAAE,eAAe,EAAE,IAAI,EAAE;OAC9B,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE;OACpC,EACL,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,0BAA0B,EAC3B;OACM,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,yBAAyB,EAC1B;OACM,EACL,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,wBAAwB,EACzB;OACM,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,IAAI,aAAa,EAAE;OAC5C,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,QAAA,MAAM,YAAY;;;;CAIjB,CAAC;AACF,KAAK,WAAW,GAAG,MAAM,OAAO,YAAY,CAAC;AAc7C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAErE;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAS;;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;OAYG;gBACS,EACV,OAAuC,EACvC,MAAqC,EACrC,GAAG,IAAI,EACR,GAAE,aAAkB;IAyCrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD,SAAS,CAAC,YAAY,IAAI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAI/E,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;IAI5D,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,GAAG,SAAS;IAI7E;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAiBvE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACxD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAmBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA2JzB,UAAU,CAAC,IAAI,EAAE,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAC9F,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,SAAS,EACvC,IAAI,CAAC,EAAE,cAAc,GACpB,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAI1C,cAAc,CACZ,IAAI,GAAG,OAAO,EACd,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAE/E,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,SAAS,EACvF,OAAO,EAAE,mBAAmB,GAC3B,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAKpC,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;IA8BpB,OAAO,CAAC,WAAW;YAuBL,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAe1C,YAAY,CACV,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IAwB9D,OAAO,CAAC,YAAY;IAqCpB,OAAO,CAAC,SAAS;IAqCjB,MAAM,CAAC,SAAS,mBAAQ;IACxB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;CAC9C;AASD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAC/D,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;IAElF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEpG,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;IAE9F,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;CACrC"}
|
package/client.d.ts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import type { RequestInit, RequestInfo } from "./internal/builtin-types.js";
|
|
2
2
|
import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js";
|
|
3
|
-
import { type Logger, type LogLevel } from "./internal/utils/log.js";
|
|
4
3
|
export type { Logger, LogLevel } from "./internal/utils/log.js";
|
|
5
4
|
import * as Opts from "./internal/request-options.js";
|
|
6
5
|
import * as Errors from "./core/error.js";
|
|
@@ -9,17 +8,18 @@ import { type PaginatedResponseParams, PaginatedResponseResponse } from "./core/
|
|
|
9
8
|
import * as Uploads from "./core/uploads.js";
|
|
10
9
|
import * as API from "./resources/index.js";
|
|
11
10
|
import { APIPromise } from "./core/api-promise.js";
|
|
12
|
-
import {
|
|
13
|
-
import { HeadersLike, NullableHeaders } from "./internal/headers.js";
|
|
14
|
-
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
|
|
15
|
-
import { Metric, MetricCreateParams, Metrics } from "./resources/metrics.js";
|
|
11
|
+
import { Metric, MetricCreateParams, MetricUpdateParams, Metrics } from "./resources/metrics.js";
|
|
16
12
|
import { Project, ProjectCreateParams, ProjectListParams, Projects, ProjectsPaginatedResponse } from "./resources/projects.js";
|
|
17
|
-
import { Record
|
|
13
|
+
import { Record, RecordCreateParams, Records } from "./resources/records.js";
|
|
18
14
|
import { Run, RunCreateParams, Runs } from "./resources/runs.js";
|
|
19
15
|
import { Score, ScoreUpsertParams, Scores } from "./resources/scores.js";
|
|
20
16
|
import { Testcase, TestcaseCreateParams, TestcaseCreateResponse, TestcaseDeleteParams, TestcaseDeleteResponse, TestcaseListParams, TestcaseUpdateParams, Testcases, TestcasesPaginatedResponse } from "./resources/testcases.js";
|
|
21
17
|
import { Testset, TestsetCreateParams, TestsetDeleteResponse, TestsetListParams, TestsetUpdateParams, Testsets, TestsetsPaginatedResponse } from "./resources/testsets.js";
|
|
22
18
|
import { System, SystemCreateParams, SystemDeleteResponse, SystemListParams, SystemUpdateParams, Systems, SystemsPaginatedResponse } from "./resources/systems/systems.js";
|
|
19
|
+
import { type Fetch, type Record as BuiltinRecord } from "./internal/builtin-types.js";
|
|
20
|
+
import { HeadersLike, NullableHeaders } from "./internal/headers.js";
|
|
21
|
+
import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js";
|
|
22
|
+
import { type LogLevel, type Logger } from "./internal/utils/log.js";
|
|
23
23
|
declare const environments: {
|
|
24
24
|
production: string;
|
|
25
25
|
staging: string;
|
|
@@ -85,7 +85,7 @@ export interface ClientOptions {
|
|
|
85
85
|
* These can be removed in individual requests by explicitly setting the
|
|
86
86
|
* param to `undefined` in request options.
|
|
87
87
|
*/
|
|
88
|
-
defaultQuery?:
|
|
88
|
+
defaultQuery?: BuiltinRecord<string, string | undefined> | undefined;
|
|
89
89
|
/**
|
|
90
90
|
* Set the log level.
|
|
91
91
|
*
|
|
@@ -126,24 +126,24 @@ export declare class Scorecard {
|
|
|
126
126
|
* @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
127
127
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
128
128
|
* @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
129
|
-
* @param {
|
|
129
|
+
* @param {BuiltinRecord<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
130
130
|
*/
|
|
131
131
|
constructor({ baseURL, apiKey, ...opts }?: ClientOptions);
|
|
132
132
|
/**
|
|
133
133
|
* Create a new client instance re-using the same options given to the current client with optional overriding.
|
|
134
134
|
*/
|
|
135
135
|
withOptions(options: Partial<ClientOptions>): this;
|
|
136
|
-
protected defaultQuery():
|
|
136
|
+
protected defaultQuery(): BuiltinRecord<string, string | undefined> | undefined;
|
|
137
137
|
protected validateHeaders({ values, nulls }: NullableHeaders): void;
|
|
138
138
|
protected authHeaders(opts: FinalRequestOptions): NullableHeaders | undefined;
|
|
139
139
|
/**
|
|
140
140
|
* Basic re-implementation of `qs.stringify` for primitive types.
|
|
141
141
|
*/
|
|
142
|
-
protected stringifyQuery(query:
|
|
142
|
+
protected stringifyQuery(query: BuiltinRecord<string, unknown>): string;
|
|
143
143
|
private getUserAgent;
|
|
144
144
|
protected defaultIdempotencyKey(): string;
|
|
145
145
|
protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError;
|
|
146
|
-
buildURL(path: string, query:
|
|
146
|
+
buildURL(path: string, query: BuiltinRecord<string, unknown> | null | undefined, defaultBaseURL?: string | undefined): string;
|
|
147
147
|
/**
|
|
148
148
|
* Used as a callback for mutating the given `FinalRequestOptions` object.
|
|
149
149
|
*/
|
|
@@ -214,8 +214,8 @@ export declare namespace Scorecard {
|
|
|
214
214
|
export { Testsets as Testsets, type Testset as Testset, type TestsetDeleteResponse as TestsetDeleteResponse, type TestsetsPaginatedResponse as TestsetsPaginatedResponse, type TestsetCreateParams as TestsetCreateParams, type TestsetUpdateParams as TestsetUpdateParams, type TestsetListParams as TestsetListParams, };
|
|
215
215
|
export { Testcases as Testcases, type Testcase as Testcase, type TestcaseCreateResponse as TestcaseCreateResponse, type TestcaseDeleteResponse as TestcaseDeleteResponse, type TestcasesPaginatedResponse as TestcasesPaginatedResponse, type TestcaseCreateParams as TestcaseCreateParams, type TestcaseUpdateParams as TestcaseUpdateParams, type TestcaseListParams as TestcaseListParams, type TestcaseDeleteParams as TestcaseDeleteParams, };
|
|
216
216
|
export { Runs as Runs, type Run as Run, type RunCreateParams as RunCreateParams };
|
|
217
|
-
export { Metrics as Metrics, type Metric as Metric, type MetricCreateParams as MetricCreateParams };
|
|
218
|
-
export { Records as Records, type
|
|
217
|
+
export { Metrics as Metrics, type Metric as Metric, type MetricCreateParams as MetricCreateParams, type MetricUpdateParams as MetricUpdateParams, };
|
|
218
|
+
export { Records as Records, type Record as Record, type RecordCreateParams as RecordCreateParams };
|
|
219
219
|
export { Scores as Scores, type Score as Score, type ScoreUpsertParams as ScoreUpsertParams };
|
|
220
220
|
export { Systems as Systems, type System as System, type SystemDeleteResponse as SystemDeleteResponse, type SystemsPaginatedResponse as SystemsPaginatedResponse, type SystemCreateParams as SystemCreateParams, type SystemUpdateParams as SystemUpdateParams, type SystemListParams as SystemListParams, };
|
|
221
221
|
export type APIError = API.APIError;
|
package/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["src/client.ts"],"names":[],"mappings":"OAEO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAY;OAC3C,KAAK,EAAc,cAAc,EAAE,iBAAiB,EAAE,oBAAoB,EAAE;YAIvE,EAAE,MAAM,EAAE,QAAQ,EAAE;OAKzB,KAAK,IAAI;OAET,KAAK,MAAM;OACX,KAAK,UAAU;OACf,EAAgB,KAAK,uBAAuB,EAAE,yBAAyB,EAAE;OACzE,KAAK,OAAO;OACZ,KAAK,GAAG;OACR,EAAE,UAAU,EAAE;OACd,EAAE,MAAM,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,OAAO,EAAE;OAC3D,EACL,OAAO,EACP,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,yBAAyB,EAC1B;OACM,EAAE,MAAM,EAAE,kBAAkB,EAAE,OAAO,EAAE;OACvC,EAAE,GAAG,EAAE,eAAe,EAAE,IAAI,EAAE;OAC9B,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE;OACpC,EACL,QAAQ,EACR,oBAAoB,EACpB,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,kBAAkB,EAClB,oBAAoB,EACpB,SAAS,EACT,0BAA0B,EAC3B;OACM,EACL,OAAO,EACP,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,QAAQ,EACR,yBAAyB,EAC1B;OACM,EACL,MAAM,EACN,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,wBAAwB,EACzB;OACM,EAAE,KAAK,KAAK,EAAE,KAAK,MAAM,IAAI,aAAa,EAAE;OAC5C,EAAE,WAAW,EAAE,eAAe,EAAgB;OAC9C,EAAE,mBAAmB,EAAE,cAAc,EAAE;OAEvC,EACL,KAAK,QAAQ,EACb,KAAK,MAAM,EAIZ;AAGD,QAAA,MAAM,YAAY;;;;CAIjB,CAAC;AACF,KAAK,WAAW,GAAG,MAAM,OAAO,YAAY,CAAC;AAc7C,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE5B;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC;IAEpC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B;;;OAGG;IACH,YAAY,CAAC,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE7C;;;;OAIG;IACH,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;IAE1B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAEhC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,YAAY,CAAC,EAAE,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS,CAAC;IAErE;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAC;IAEhC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B;AAED;;GAEG;AACH,qBAAa,SAAS;;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,QAAQ,EAAE,QAAQ,GAAG,SAAS,CAAC;IAC/B,YAAY,EAAE,iBAAiB,GAAG,SAAS,CAAC;IAE5C,OAAO,CAAC,KAAK,CAAQ;IAErB,SAAS,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAgB;IAEhC;;;;;;;;;;;;OAYG;gBACS,EACV,OAAuC,EACvC,MAAqC,EACrC,GAAG,IAAI,EACR,GAAE,aAAkB;IAyCrB;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAuBlD,SAAS,CAAC,YAAY,IAAI,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,GAAG,SAAS;IAI/E,SAAS,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,eAAe;IAI5D,SAAS,CAAC,WAAW,CAAC,IAAI,EAAE,mBAAmB,GAAG,eAAe,GAAG,SAAS;IAI7E;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,KAAK,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM;IAiBvE,OAAO,CAAC,YAAY;IAIpB,SAAS,CAAC,qBAAqB,IAAI,MAAM;IAIzC,SAAS,CAAC,eAAe,CACvB,MAAM,EAAE,MAAM,EACd,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,GAAG,SAAS,EAC3B,OAAO,EAAE,OAAO,GACf,MAAM,CAAC,QAAQ;IAIlB,QAAQ,CACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,aAAa,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,GAAG,SAAS,EACxD,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,GAClC,MAAM;IAmBT;;OAEG;cACa,cAAc,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAE3E;;;;;OAKG;cACa,cAAc,CAC5B,OAAO,EAAE,WAAW,EACpB,EAAE,GAAG,EAAE,OAAO,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,mBAAmB,CAAA;KAAE,GAC9D,OAAO,CAAC,IAAI,CAAC;IAEhB,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/E,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIhF,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAI9E,MAAM,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,cAAc,CAAC,cAAc,CAAC,GAAG,UAAU,CAAC,GAAG,CAAC;IAIjF,OAAO,CAAC,aAAa;IAYrB,OAAO,CAAC,GAAG,EACT,OAAO,EAAE,cAAc,CAAC,mBAAmB,CAAC,EAC5C,gBAAgB,GAAE,MAAM,GAAG,IAAW,GACrC,UAAU,CAAC,GAAG,CAAC;YAIJ,WAAW;IA2JzB,UAAU,CAAC,IAAI,EAAE,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAC9F,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,SAAS,EACvC,IAAI,CAAC,EAAE,cAAc,GACpB,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAI1C,cAAc,CACZ,IAAI,GAAG,OAAO,EACd,SAAS,SAAS,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,YAAY,CAAC,IAAI,CAAC,EAE/E,IAAI,EAAE,KAAK,GAAG,IAAI,EAAE,qBAAqB,CAAC,OAAO,UAAU,CAAC,YAAY,CAAC,KAAK,SAAS,EACvF,OAAO,EAAE,mBAAmB,GAC3B,UAAU,CAAC,WAAW,CAAC,SAAS,EAAE,IAAI,CAAC;IAKpC,gBAAgB,CACpB,GAAG,EAAE,WAAW,EAChB,IAAI,EAAE,WAAW,GAAG,SAAS,EAC7B,EAAE,EAAE,MAAM,EACV,UAAU,EAAE,eAAe,GAC1B,OAAO,CAAC,QAAQ,CAAC;IA8BpB,OAAO,CAAC,WAAW;YAuBL,YAAY;IAuC1B,OAAO,CAAC,kCAAkC;IAe1C,YAAY,CACV,YAAY,EAAE,mBAAmB,EACjC,EAAE,UAAc,EAAE,GAAE;QAAE,UAAU,CAAC,EAAE,MAAM,CAAA;KAAO,GAC/C;QAAE,GAAG,EAAE,oBAAoB,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IAwB9D,OAAO,CAAC,YAAY;IAqCpB,OAAO,CAAC,SAAS;IAqCjB,MAAM,CAAC,SAAS,mBAAQ;IACxB,MAAM,CAAC,eAAe,SAAS;IAE/B,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,QAAQ,yBAAmB;IAClC,MAAM,CAAC,kBAAkB,mCAA6B;IACtD,MAAM,CAAC,yBAAyB,0CAAoC;IACpE,MAAM,CAAC,iBAAiB,kCAA4B;IACpD,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,aAAa,8BAAwB;IAC5C,MAAM,CAAC,cAAc,+BAAyB;IAC9C,MAAM,CAAC,eAAe,gCAA0B;IAChD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,mBAAmB,oCAA8B;IACxD,MAAM,CAAC,qBAAqB,sCAAgC;IAC5D,MAAM,CAAC,wBAAwB,yCAAmC;IAElE,MAAM,CAAC,MAAM,wBAAkB;IAE/B,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAA0B;IAChD,SAAS,EAAE,GAAG,CAAC,SAAS,CAA2B;IACnD,IAAI,EAAE,GAAG,CAAC,IAAI,CAAsB;IACpC,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;IAC7C,MAAM,EAAE,GAAG,CAAC,MAAM,CAAwB;IAC1C,OAAO,EAAE,GAAG,CAAC,OAAO,CAAyB;CAC9C;AASD,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC;IAEjD,MAAM,QAAQ,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAC/D,OAAO,EACL,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,yBAAyB,IAAI,yBAAyB,GAC5D,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,QAAQ,IAAI,QAAQ,EACpB,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;IAEF,OAAO,EACL,SAAS,IAAI,SAAS,EACtB,KAAK,QAAQ,IAAI,QAAQ,EACzB,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,GAClD,CAAC;IAEF,OAAO,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,GAAG,IAAI,GAAG,EAAE,KAAK,eAAe,IAAI,eAAe,EAAE,CAAC;IAElF,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;IAEF,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,KAAK,MAAM,IAAI,MAAM,EAAE,KAAK,kBAAkB,IAAI,kBAAkB,EAAE,CAAC;IAEpG,OAAO,EAAE,MAAM,IAAI,MAAM,EAAE,KAAK,KAAK,IAAI,KAAK,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;IAE9F,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;IAEF,MAAM,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC;CACrC"}
|
package/client.js
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
-
var _a, _Scorecard_encoder;
|
|
3
|
+
var _Scorecard_instances, _a, _Scorecard_encoder, _Scorecard_baseURLOverridden;
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
5
|
exports.Scorecard = void 0;
|
|
6
6
|
const tslib_1 = require("./internal/tslib.js");
|
|
7
7
|
const uuid_1 = require("./internal/utils/uuid.js");
|
|
8
8
|
const values_1 = require("./internal/utils/values.js");
|
|
9
9
|
const sleep_1 = require("./internal/utils/sleep.js");
|
|
10
|
-
const log_1 = require("./internal/utils/log.js");
|
|
11
10
|
const errors_1 = require("./internal/errors.js");
|
|
12
11
|
const detect_platform_1 = require("./internal/detect-platform.js");
|
|
13
12
|
const Shims = tslib_1.__importStar(require("./internal/shims.js"));
|
|
@@ -18,7 +17,6 @@ const Pagination = tslib_1.__importStar(require("./core/pagination.js"));
|
|
|
18
17
|
const Uploads = tslib_1.__importStar(require("./core/uploads.js"));
|
|
19
18
|
const API = tslib_1.__importStar(require("./resources/index.js"));
|
|
20
19
|
const api_promise_1 = require("./core/api-promise.js");
|
|
21
|
-
const headers_1 = require("./internal/headers.js");
|
|
22
20
|
const metrics_1 = require("./resources/metrics.js");
|
|
23
21
|
const projects_1 = require("./resources/projects.js");
|
|
24
22
|
const records_1 = require("./resources/records.js");
|
|
@@ -26,10 +24,11 @@ const runs_1 = require("./resources/runs.js");
|
|
|
26
24
|
const scores_1 = require("./resources/scores.js");
|
|
27
25
|
const testcases_1 = require("./resources/testcases.js");
|
|
28
26
|
const testsets_1 = require("./resources/testsets.js");
|
|
27
|
+
const systems_1 = require("./resources/systems/systems.js");
|
|
28
|
+
const headers_1 = require("./internal/headers.js");
|
|
29
29
|
const env_1 = require("./internal/utils/env.js");
|
|
30
|
-
const
|
|
30
|
+
const log_1 = require("./internal/utils/log.js");
|
|
31
31
|
const values_2 = require("./internal/utils/values.js");
|
|
32
|
-
const systems_1 = require("./resources/systems/systems.js");
|
|
33
32
|
const environments = {
|
|
34
33
|
production: 'https://api2.scorecard.io/api/v2',
|
|
35
34
|
staging: 'https://staging.api2.scorecard.io/api/v2',
|
|
@@ -64,9 +63,10 @@ class Scorecard {
|
|
|
64
63
|
* @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation.
|
|
65
64
|
* @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request.
|
|
66
65
|
* @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API.
|
|
67
|
-
* @param {
|
|
66
|
+
* @param {BuiltinRecord<string, string | undefined>} opts.defaultQuery - Default query parameters to include with every request to the API.
|
|
68
67
|
*/
|
|
69
68
|
constructor({ baseURL = (0, env_1.readEnv)('SCORECARD_BASE_URL'), apiKey = (0, env_1.readEnv)('SCORECARD_API_KEY'), ...opts } = {}) {
|
|
69
|
+
_Scorecard_instances.add(this);
|
|
70
70
|
_Scorecard_encoder.set(this, void 0);
|
|
71
71
|
this.projects = new API.Projects(this);
|
|
72
72
|
this.testsets = new API.Testsets(this);
|
|
@@ -118,6 +118,7 @@ class Scorecard {
|
|
|
118
118
|
timeout: this.timeout,
|
|
119
119
|
logger: this.logger,
|
|
120
120
|
logLevel: this.logLevel,
|
|
121
|
+
fetch: this.fetch,
|
|
121
122
|
fetchOptions: this.fetchOptions,
|
|
122
123
|
apiKey: this.apiKey,
|
|
123
124
|
...options,
|
|
@@ -158,10 +159,11 @@ class Scorecard {
|
|
|
158
159
|
makeStatusError(status, error, message, headers) {
|
|
159
160
|
return Errors.APIError.generate(status, error, message, headers);
|
|
160
161
|
}
|
|
161
|
-
buildURL(path, query) {
|
|
162
|
+
buildURL(path, query, defaultBaseURL) {
|
|
163
|
+
const baseURL = (!tslib_1.__classPrivateFieldGet(this, _Scorecard_instances, "m", _Scorecard_baseURLOverridden).call(this) && defaultBaseURL) || this.baseURL;
|
|
162
164
|
const url = (0, values_1.isAbsoluteURL)(path) ?
|
|
163
165
|
new URL(path)
|
|
164
|
-
: new URL(
|
|
166
|
+
: new URL(baseURL + (baseURL.endsWith('/') && path.startsWith('/') ? path.slice(1) : path));
|
|
165
167
|
const defaultQuery = this.defaultQuery();
|
|
166
168
|
if (!(0, values_2.isEmptyObj)(defaultQuery)) {
|
|
167
169
|
query = { ...defaultQuery, ...query };
|
|
@@ -218,7 +220,7 @@ class Scorecard {
|
|
|
218
220
|
const requestLogID = 'log_' + ((Math.random() * (1 << 24)) | 0).toString(16).padStart(6, '0');
|
|
219
221
|
const retryLogStr = retryOfRequestLogID === undefined ? '' : `, retryOf: ${retryOfRequestLogID}`;
|
|
220
222
|
const startTime = Date.now();
|
|
221
|
-
(0,
|
|
223
|
+
(0, log_1.loggerFor)(this).debug(`[${requestLogID}] sending request`, (0, log_1.formatRequestDetails)({
|
|
222
224
|
retryOfRequestLogID,
|
|
223
225
|
method: options.method,
|
|
224
226
|
url,
|
|
@@ -243,8 +245,8 @@ class Scorecard {
|
|
|
243
245
|
const isTimeout = (0, errors_1.isAbortError)(response) ||
|
|
244
246
|
/timed? ?out/i.test(String(response) + ('cause' in response ? String(response.cause) : ''));
|
|
245
247
|
if (retriesRemaining) {
|
|
246
|
-
(0,
|
|
247
|
-
(0,
|
|
248
|
+
(0, log_1.loggerFor)(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - ${retryMessage}`);
|
|
249
|
+
(0, log_1.loggerFor)(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (${retryMessage})`, (0, log_1.formatRequestDetails)({
|
|
248
250
|
retryOfRequestLogID,
|
|
249
251
|
url,
|
|
250
252
|
durationMs: headersTime - startTime,
|
|
@@ -252,8 +254,8 @@ class Scorecard {
|
|
|
252
254
|
}));
|
|
253
255
|
return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID);
|
|
254
256
|
}
|
|
255
|
-
(0,
|
|
256
|
-
(0,
|
|
257
|
+
(0, log_1.loggerFor)(this).info(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} - error; no more retries left`);
|
|
258
|
+
(0, log_1.loggerFor)(this).debug(`[${requestLogID}] connection ${isTimeout ? 'timed out' : 'failed'} (error; no more retries left)`, (0, log_1.formatRequestDetails)({
|
|
257
259
|
retryOfRequestLogID,
|
|
258
260
|
url,
|
|
259
261
|
durationMs: headersTime - startTime,
|
|
@@ -271,8 +273,8 @@ class Scorecard {
|
|
|
271
273
|
const retryMessage = `retrying, ${retriesRemaining} attempts remaining`;
|
|
272
274
|
// We don't need the body of this response.
|
|
273
275
|
await Shims.CancelReadableStream(response.body);
|
|
274
|
-
(0,
|
|
275
|
-
(0,
|
|
276
|
+
(0, log_1.loggerFor)(this).info(`${responseInfo} - ${retryMessage}`);
|
|
277
|
+
(0, log_1.loggerFor)(this).debug(`[${requestLogID}] response error (${retryMessage})`, (0, log_1.formatRequestDetails)({
|
|
276
278
|
retryOfRequestLogID,
|
|
277
279
|
url: response.url,
|
|
278
280
|
status: response.status,
|
|
@@ -282,11 +284,11 @@ class Scorecard {
|
|
|
282
284
|
return this.retryRequest(options, retriesRemaining, retryOfRequestLogID ?? requestLogID, response.headers);
|
|
283
285
|
}
|
|
284
286
|
const retryMessage = shouldRetry ? `error; no more retries left` : `error; not retryable`;
|
|
285
|
-
(0,
|
|
287
|
+
(0, log_1.loggerFor)(this).info(`${responseInfo} - ${retryMessage}`);
|
|
286
288
|
const errText = await response.text().catch((err) => (0, errors_1.castToError)(err).message);
|
|
287
289
|
const errJSON = (0, values_1.safeJSON)(errText);
|
|
288
290
|
const errMessage = errJSON ? undefined : errText;
|
|
289
|
-
(0,
|
|
291
|
+
(0, log_1.loggerFor)(this).debug(`[${requestLogID}] response error (${retryMessage})`, (0, log_1.formatRequestDetails)({
|
|
290
292
|
retryOfRequestLogID,
|
|
291
293
|
url: response.url,
|
|
292
294
|
status: response.status,
|
|
@@ -297,8 +299,8 @@ class Scorecard {
|
|
|
297
299
|
const err = this.makeStatusError(response.status, errJSON, errMessage, response.headers);
|
|
298
300
|
throw err;
|
|
299
301
|
}
|
|
300
|
-
(0,
|
|
301
|
-
(0,
|
|
302
|
+
(0, log_1.loggerFor)(this).info(responseInfo);
|
|
303
|
+
(0, log_1.loggerFor)(this).debug(`[${requestLogID}] response start`, (0, log_1.formatRequestDetails)({
|
|
302
304
|
retryOfRequestLogID,
|
|
303
305
|
url: response.url,
|
|
304
306
|
status: response.status,
|
|
@@ -404,8 +406,8 @@ class Scorecard {
|
|
|
404
406
|
}
|
|
405
407
|
buildRequest(inputOptions, { retryCount = 0 } = {}) {
|
|
406
408
|
const options = { ...inputOptions };
|
|
407
|
-
const { method, path, query } = options;
|
|
408
|
-
const url = this.buildURL(path, query);
|
|
409
|
+
const { method, path, query, defaultBaseURL } = options;
|
|
410
|
+
const url = this.buildURL(path, query, defaultBaseURL);
|
|
409
411
|
if ('timeout' in options)
|
|
410
412
|
(0, values_1.validatePositiveInteger)('timeout', options.timeout);
|
|
411
413
|
options.timeout = options.timeout ?? this.timeout;
|
|
@@ -481,7 +483,9 @@ class Scorecard {
|
|
|
481
483
|
}
|
|
482
484
|
}
|
|
483
485
|
exports.Scorecard = Scorecard;
|
|
484
|
-
_a = Scorecard, _Scorecard_encoder = new WeakMap()
|
|
486
|
+
_a = Scorecard, _Scorecard_encoder = new WeakMap(), _Scorecard_instances = new WeakSet(), _Scorecard_baseURLOverridden = function _Scorecard_baseURLOverridden() {
|
|
487
|
+
return this.baseURL !== environments[this._options.environment || 'production'];
|
|
488
|
+
};
|
|
485
489
|
Scorecard.Scorecard = _a;
|
|
486
490
|
Scorecard.DEFAULT_TIMEOUT = 60000; // 1 minute
|
|
487
491
|
Scorecard.ScorecardError = Errors.ScorecardError;
|