@redocly/cli 2.0.1 → 2.0.3
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 +5 -0
- package/lib/commands/respect/index.d.ts.map +1 -1
- package/lib/commands/respect/index.js +3 -2
- package/lib/commands/respect/index.js.map +1 -1
- package/lib/utils/json-stringify-with-array-buffer.d.ts +2 -0
- package/lib/utils/json-stringify-with-array-buffer.d.ts.map +1 -0
- package/lib/utils/json-stringify-with-array-buffer.js +32 -0
- package/lib/utils/json-stringify-with-array-buffer.js.map +1 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -11,6 +11,11 @@ Supports OpenAPI 3.1, 3.0 and OpenAPI 2.0 (legacy Swagger), AsyncAPI 3.0 and 2.6
|
|
|
11
11
|
|
|
12
12
|

|
|
13
13
|
|
|
14
|
+
## Migration
|
|
15
|
+
|
|
16
|
+
Migrating from Redocly CLI v1 to v2?
|
|
17
|
+
Here's the [guide](https://redocly.com/docs/cli/guides/migrate-to-v2) to make the transition smoother.
|
|
18
|
+
|
|
14
19
|
## Usage
|
|
15
20
|
|
|
16
21
|
### Node
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/respect/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/respect/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAC;AAajD,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,mBAAmB,EAAE,MAAM,CAAC;CAC7B,CAAC;AAEF,wBAAsB,aAAa,CAAC,EAClC,IAAI,EACJ,MAAM,EACN,OAAO,EACP,eAAe,GAChB,EAAE,WAAW,CAAC,WAAW,CAAC,iBAqH1B"}
|
|
@@ -9,6 +9,7 @@ import { resolveMtlsCertificates } from './mtls/resolve-mtls-certificates.js';
|
|
|
9
9
|
import { withMtlsClientIfNeeded } from './mtls/create-mtls-client.js';
|
|
10
10
|
import { withHar } from './har-logs/index.js';
|
|
11
11
|
import { createHarLog } from './har-logs/har-logs.js';
|
|
12
|
+
import { jsonStringifyWithArrayBuffer } from '../../utils/json-stringify-with-array-buffer.js';
|
|
12
13
|
export async function handleRespect({ argv, config, version, collectSpecData, }) {
|
|
13
14
|
let mtlsCerts;
|
|
14
15
|
let harLogs;
|
|
@@ -83,7 +84,7 @@ export async function handleRespect({ argv, config, version, collectSpecData, })
|
|
|
83
84
|
status: hasProblems ? 'error' : hasWarnings ? 'warn' : 'success',
|
|
84
85
|
totalTime: performance.now() - startedAt,
|
|
85
86
|
};
|
|
86
|
-
writeFileSync(argv['json-output'],
|
|
87
|
+
writeFileSync(argv['json-output'], jsonStringifyWithArrayBuffer(jsonOutputData, 2), 'utf-8');
|
|
87
88
|
logger.output(blue(logger.indent(`JSON logs saved in ${green(argv['json-output'])}`, 2)));
|
|
88
89
|
logger.printNewLine();
|
|
89
90
|
logger.printNewLine();
|
|
@@ -92,7 +93,7 @@ export async function handleRespect({ argv, config, version, collectSpecData, })
|
|
|
92
93
|
// TODO: implement multiple run files HAR output
|
|
93
94
|
for (const result of runAllFilesResult) {
|
|
94
95
|
const parsedHarLogs = maskSecrets(harLogs, result.ctx.secretFields || new Set());
|
|
95
|
-
writeFileSync(argv['har-output'],
|
|
96
|
+
writeFileSync(argv['har-output'], jsonStringifyWithArrayBuffer(parsedHarLogs, 2), 'utf-8');
|
|
96
97
|
logger.output(blue(`Har logs saved in ${green(argv['har-output'])}`));
|
|
97
98
|
logger.printNewLine();
|
|
98
99
|
logger.printNewLine();
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/respect/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/respect/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAE7D,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AACxC,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AAC9E,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAC;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAC9C,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,4BAA4B,EAAE,MAAM,iDAAiD,CAAC;AAqB/F,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,IAAI,EACJ,MAAM,EACN,OAAO,EACP,eAAe,GACU;IACzB,IAAI,SAAS,CAAC;IACd,IAAI,OAAO,CAAC;IAEZ,IAAI,CAAC;QACH,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,MAAM,MAAM,CAAC,uBAAuB,CAAC,CAAC;QACnE,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;QAElF,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YACjE,SAAS;gBACP,IAAI,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,SAAS,CAAC;oBAC1D,CAAC,CAAC,uBAAuB,CACrB;wBACE,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC;wBAC/B,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC;wBAC7B,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC;qBACxB,EACD,UAAU,CACX;oBACH,CAAC,CAAC,SAAS,CAAC;QAClB,CAAC;QAED,IAAI,WAAW,GAAG,sBAAsB,CAAC,SAAS,CAAC,CAAC;QACpD,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACvB,OAAO,GAAG,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YACpC,WAAW,GAAG,OAAO,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,MAAM,OAAO,GAAG;YACd,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,MAAM,EAAE,IAAI,CAAC,MAAM;YACnB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,MAAM;YACN,OAAO;YACP,eAAe;YACf,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC;YAC3B,eAAe,EAAE,IAAI,CAAC,mBAAmB,CAAC;YAC1C,gBAAgB,EAAE,IAAI,CAAC,mBAAmB,CAAC;YAC3C,iBAAiB,EAAE;gBACjB,WAAW,EAAE,KAAK,EAAE,QAAgB,EAAE,EAAE;oBACtC,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;wBAC1B,MAAM,IAAI,KAAK,CAAC,QAAQ,QAAQ,mCAAmC,CAAC,CAAC;oBACvE,CAAC;oBAED,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,CAAC;oBACtC,OAAO,IAAI,IAAI,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAChD,CAAC;aACF;YACD,YAAY,EAAE,gBAAgB,CAAC,UAAU,CAAC,IAAI,EAAE;YAChD,MAAM;YACN,KAAK,EAAE,WAAsC;SAC9C,CAAC;QAEF,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACnF,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAChE,CAAC;QAED,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;QAED,IAAI,OAAO,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACnD,gDAAgD;YAChD,MAAM,IAAI,KAAK,CACb,gGAAgG,CACjG,CAAC;QACJ,CAAC;QAED,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,iBAAiB,GAAG,MAAM,GAAG,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM,CAAC,YAAY,EAAE,CAAC;QACtB,wBAAwB,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;QACpD,MAAM,CAAC,YAAY,EAAE,CAAC;QAEtB,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC3E,MAAM,WAAW,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAE3E,IAAI,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACxB,MAAM,cAAc,GAAG;gBACrB,KAAK,EAAE,oBAAoB,CAAC,iBAAiB,CAAC;gBAC9C,MAAM,EAAE,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;gBAChE,SAAS,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS;aAC7B,CAAC;YAEd,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,4BAA4B,CAAC,cAAc,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;YAE7F,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,sBAAsB,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1F,MAAM,CAAC,YAAY,EAAE,CAAC;YACtB,MAAM,CAAC,YAAY,EAAE,CAAC;QACxB,CAAC;QAED,IAAI,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC;YACvB,gDAAgD;YAChD,KAAK,MAAM,MAAM,IAAI,iBAAiB,EAAE,CAAC;gBACvC,MAAM,aAAa,GAAG,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,GAAG,CAAC,YAAY,IAAI,IAAI,GAAG,EAAE,CAAC,CAAC;gBACjF,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,4BAA4B,CAAC,aAAa,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBAC3F,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;gBACtE,MAAM,CAAC,YAAY,EAAE,CAAC;gBACtB,MAAM,CAAC,YAAY,EAAE,CAAC;YACxB,CAAC;QACH,CAAC;QAED,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,YAAY,CAAE,KAAe,EAAE,OAAO,IAAI,KAAK,CAAC,CAAC;IAC7D,CAAC;AACH,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"json-stringify-with-array-buffer.d.ts","sourceRoot":"","sources":["../../src/utils/json-stringify-with-array-buffer.ts"],"names":[],"mappings":"AAAA,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,CAsCtF"}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
export function jsonStringifyWithArrayBuffer(obj, space) {
|
|
2
|
+
const MAX_SIZE = 1024 * 1024; // 1MB
|
|
3
|
+
return JSON.stringify(obj, (key, value) => {
|
|
4
|
+
if (value instanceof ArrayBuffer) {
|
|
5
|
+
if (value.byteLength > MAX_SIZE) {
|
|
6
|
+
return {
|
|
7
|
+
__type: 'ArrayBuffer',
|
|
8
|
+
data: `File too large to serialize (${value.byteLength} bytes). Maximum allowed size is ${MAX_SIZE} bytes.`,
|
|
9
|
+
byteLength: value.byteLength,
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
const uint8Array = new Uint8Array(value);
|
|
13
|
+
const base64 = Buffer.from(uint8Array).toString('base64');
|
|
14
|
+
return {
|
|
15
|
+
__type: 'ArrayBuffer',
|
|
16
|
+
data: base64,
|
|
17
|
+
byteLength: value.byteLength,
|
|
18
|
+
};
|
|
19
|
+
}
|
|
20
|
+
if (value instanceof File) {
|
|
21
|
+
return {
|
|
22
|
+
__type: 'File',
|
|
23
|
+
name: value.name || '[File Object]',
|
|
24
|
+
size: value.size || 0,
|
|
25
|
+
type: value.type || '',
|
|
26
|
+
lastModified: value.lastModified || 0,
|
|
27
|
+
};
|
|
28
|
+
}
|
|
29
|
+
return value;
|
|
30
|
+
}, space);
|
|
31
|
+
}
|
|
32
|
+
//# sourceMappingURL=json-stringify-with-array-buffer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"json-stringify-with-array-buffer.js","sourceRoot":"","sources":["../../src/utils/json-stringify-with-array-buffer.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,4BAA4B,CAAC,GAAQ,EAAE,KAAuB;IAC5E,MAAM,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC,MAAM;IAEpC,OAAO,IAAI,CAAC,SAAS,CACnB,GAAG,EACH,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QACb,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,IAAI,KAAK,CAAC,UAAU,GAAG,QAAQ,EAAE,CAAC;gBAChC,OAAO;oBACL,MAAM,EAAE,aAAa;oBACrB,IAAI,EAAE,gCAAgC,KAAK,CAAC,UAAU,oCAAoC,QAAQ,SAAS;oBAC3G,UAAU,EAAE,KAAK,CAAC,UAAU;iBAC7B,CAAC;YACJ,CAAC;YAED,MAAM,UAAU,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;YACzC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAC1D,OAAO;gBACL,MAAM,EAAE,aAAa;gBACrB,IAAI,EAAE,MAAM;gBACZ,UAAU,EAAE,KAAK,CAAC,UAAU;aAC7B,CAAC;QACJ,CAAC;QAED,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;YAC1B,OAAO;gBACL,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,eAAe;gBACnC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC;gBACrB,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;gBACtB,YAAY,EAAE,KAAK,CAAC,YAAY,IAAI,CAAC;aACtC,CAAC;QACJ,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC,EACD,KAAK,CACN,CAAC;AACJ,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@redocly/cli",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.3",
|
|
4
4
|
"description": "",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"bin": {
|
|
@@ -42,8 +42,8 @@
|
|
|
42
42
|
"@opentelemetry/resources": "2.0.1",
|
|
43
43
|
"@opentelemetry/sdk-trace-node": "2.0.1",
|
|
44
44
|
"@opentelemetry/semantic-conventions": "1.34.0",
|
|
45
|
-
"@redocly/openapi-core": "2.0.
|
|
46
|
-
"@redocly/respect-core": "2.0.
|
|
45
|
+
"@redocly/openapi-core": "2.0.3",
|
|
46
|
+
"@redocly/respect-core": "2.0.3",
|
|
47
47
|
"abort-controller": "^3.0.0",
|
|
48
48
|
"chokidar": "^3.5.1",
|
|
49
49
|
"colorette": "^1.2.0",
|