@redocly/cli 1.18.1 → 1.20.0

package/lib/__tests__/utils.test.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const miscellaneous_1 = require("../utils/miscellaneous");
 const openapi_core_1 = require("@redocly/openapi-core");
@@ -56,9 +47,9 @@ describe('pathToFilename', () => {
     });
 });
 describe('getFallbackApisOrExit', () => {
-    it('should find alias by filename', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should find alias by filename', async () => {
         fs_1.existsSync.mockImplementationOnce(() => true);
-        const entry = yield (0, miscellaneous_1.getFallbackApisOrExit)(['./test.yaml'], {
+        const entry = await (0, miscellaneous_1.getFallbackApisOrExit)(['./test.yaml'], {
             apis: {
                 main: {
                     root: 'test.yaml',
@@ -66,7 +57,7 @@ describe('getFallbackApisOrExit', () => {
             },
         });
         expect(entry).toEqual([{ path: './test.yaml', alias: 'main' }]);
-    }));
+    });
 });
 describe('printConfigLintTotals', () => {
     const totalProblemsMock = {
@@ -87,12 +78,12 @@ describe('printConfigLintTotals', () => {
         expect(redColoretteMocks).toHaveBeenCalledWith('❌ Your config has 1 error.');
     });
     it('should print warnign if no error', () => {
-        (0, miscellaneous_1.printConfigLintTotals)(Object.assign(Object.assign({}, totalProblemsMock), { errors: 0, warnings: 2 }));
+        (0, miscellaneous_1.printConfigLintTotals)({ ...totalProblemsMock, errors: 0, warnings: 2 });
         expect(process.stderr.write).toHaveBeenCalledWith('⚠️ Your config has 2 warnings.\n');
         expect(yellowColoretteMocks).toHaveBeenCalledWith('⚠️ Your config has 2 warnings.\n');
     });
     it('should print nothing if no error and no warnings', () => {
-        const result = (0, miscellaneous_1.printConfigLintTotals)(Object.assign(Object.assign({}, totalProblemsMock), { errors: 0 }));
+        const result = (0, miscellaneous_1.printConfigLintTotals)({ ...totalProblemsMock, errors: 0 });
         expect(result).toBeUndefined();
         expect(process.stderr.write).toHaveBeenCalledTimes(0);
         expect(yellowColoretteMocks).toHaveBeenCalledTimes(0);
@@ -118,34 +109,34 @@ describe('getFallbackApisOrExit', () => {
     afterEach(() => {
         jest.clearAllMocks();
     });
-    it('should exit with error because no path provided', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should exit with error because no path provided', async () => {
         const apisConfig = {
             apis: {},
         };
         expect.assertions(1);
         try {
-            yield (0, miscellaneous_1.getFallbackApisOrExit)([''], apisConfig);
+            await (0, miscellaneous_1.getFallbackApisOrExit)([''], apisConfig);
         }
         catch (e) {
             expect(e.message).toEqual('Path cannot be empty.');
         }
-    }));
-    it('should error if file from config do not exist', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('should error if file from config do not exist', async () => {
         fs_1.existsSync.mockImplementationOnce(() => false);
         expect.assertions(3);
         try {
-            yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, config);
+            await (0, miscellaneous_1.getFallbackApisOrExit)(undefined, config);
         }
         catch (e) {
             expect(process.stderr.write).toHaveBeenCalledWith('\nsomeFile.yaml does not exist or is invalid.\n\n');
             expect(process.stderr.write).toHaveBeenCalledWith('Please provide a valid path.\n\n');
             expect(e.message).toEqual('Please provide a valid path.');
         }
-    }));
-    it('should return valid array with results if such file exist', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('should return valid array with results if such file exist', async () => {
         fs_1.existsSync.mockImplementationOnce(() => true);
         jest.spyOn(path, 'resolve').mockImplementationOnce((_, path) => path);
-        const result = yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, config);
+        const result = await (0, miscellaneous_1.getFallbackApisOrExit)(undefined, config);
         expect(process.stderr.write).toHaveBeenCalledTimes(0);
         expect(process.exit).toHaveBeenCalledTimes(0);
         expect(result).toStrictEqual([
@@ -154,47 +145,50 @@ describe('getFallbackApisOrExit', () => {
                 path: 'someFile.yaml',
             },
         ]);
-    }));
-    it('should exit with error in case if invalid path provided as args', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('should exit with error in case if invalid path provided as args', async () => {
         const apisConfig = {
             apis: {},
         };
         fs_1.existsSync.mockImplementationOnce(() => false);
         expect.assertions(3);
         try {
-            yield (0, miscellaneous_1.getFallbackApisOrExit)(['someFile.yaml'], apisConfig);
+            await (0, miscellaneous_1.getFallbackApisOrExit)(['someFile.yaml'], apisConfig);
         }
         catch (e) {
             expect(process.stderr.write).toHaveBeenCalledWith('\nsomeFile.yaml does not exist or is invalid.\n\n');
             expect(process.stderr.write).toHaveBeenCalledWith('Please provide a valid path.\n\n');
             expect(e.message).toEqual('Please provide a valid path.');
         }
-    }));
-    it('should exit with error in case if invalid 2 path provided as args', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('should exit with error in case if invalid 2 path provided as args', async () => {
         const apisConfig = {
             apis: {},
         };
         fs_1.existsSync.mockImplementationOnce(() => false);
         expect.assertions(3);
         try {
-            yield (0, miscellaneous_1.getFallbackApisOrExit)(['someFile.yaml', 'someFile2.yaml'], apisConfig);
+            await (0, miscellaneous_1.getFallbackApisOrExit)(['someFile.yaml', 'someFile2.yaml'], apisConfig);
         }
         catch (e) {
             expect(process.stderr.write).toHaveBeenCalledWith('\nsomeFile.yaml does not exist or is invalid.\n\n');
             expect(process.stderr.write).toHaveBeenCalledWith('Please provide a valid path.\n\n');
             expect(e.message).toEqual('Please provide a valid path.');
         }
-    }));
-    it('should exit with error if only one file exist ', () => __awaiter(void 0, void 0, void 0, function* () {
-        const apisStub = Object.assign(Object.assign({}, apis), { notExist: {
+    });
+    it('should exit with error if only one file exist ', async () => {
+        const apisStub = {
+            ...apis,
+            notExist: {
                 root: 'notExist.yaml',
                 styleguide: {},
-            } });
+            },
+        };
         const configStub = { apis: apisStub };
         const existSyncMock = fs_1.existsSync.mockImplementation((path) => path.endsWith('someFile.yaml'));
         expect.assertions(4);
         try {
-            yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, configStub);
+            await (0, miscellaneous_1.getFallbackApisOrExit)(undefined, configStub);
         }
         catch (e) {
             expect(process.stderr.write).toHaveBeenCalledWith('\nnotExist.yaml does not exist or is invalid.\n\n');
@@ -203,8 +197,8 @@ describe('getFallbackApisOrExit', () => {
             expect(e.message).toEqual('Please provide a valid path.');
         }
         existSyncMock.mockClear();
-    }));
-    it('should work ok if it is url passed', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('should work ok if it is url passed', async () => {
         fs_1.existsSync.mockImplementationOnce(() => false);
         openapi_core_1.isAbsoluteUrl.mockImplementation(() => true);
         const apisConfig = {
@@ -215,7 +209,7 @@ describe('getFallbackApisOrExit', () => {
                 },
             },
         };
-        const result = yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, apisConfig);
+        const result = await (0, miscellaneous_1.getFallbackApisOrExit)(undefined, apisConfig);
         expect(process.stderr.write).toHaveBeenCalledTimes(0);
         expect(result).toStrictEqual([
             {
@@ -223,7 +217,7 @@ describe('getFallbackApisOrExit', () => {
                 path: 'https://someLinkt/petstore.yaml?main',
             },
         ]);
-    }));
+    });
 });
 describe('langToExt', () => {
     it.each([
@@ -390,6 +384,7 @@ describe('checkIfRulesetExist', () => {
             oas3_0: {},
             oas3_1: {},
             async2: {},
+            async3: {},
             arazzo: {},
         };
         expect(() => (0, miscellaneous_1.checkIfRulesetExist)(rules)).toThrowError('⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/');

package/lib/__tests__/wrapper.test.js

@@ -1,57 +1,68 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const miscellaneous_1 = require("../utils/miscellaneous");
 const process = require("process");
 const wrapper_1 = require("../wrapper");
 const lint_1 = require("../commands/lint");
 const push_1 = require("../commands/push");
+const openapi_core_1 = require("@redocly/openapi-core");
 jest.mock('node-fetch');
 jest.mock('../utils/miscellaneous', () => ({
     sendTelemetry: jest.fn(),
     loadConfigAndHandleErrors: jest.fn(),
 }));
 jest.mock('../commands/lint', () => ({
-    handleLint: jest.fn(),
+    handleLint: jest.fn().mockImplementation(({ collectSpecData }) => {
+        collectSpecData({ openapi: '3.1.0' });
+    }),
     lintConfigCallback: jest.fn(),
 }));
 describe('commandWrapper', () => {
-    it('should send telemetry if there is "telemetry: on" in the config', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should send telemetry if there is "telemetry: on" in the config', async () => {
+        miscellaneous_1.loadConfigAndHandleErrors.mockImplementation(() => {
+            return { telemetry: 'on', styleguide: { recommendedFallback: true } };
+        });
+        openapi_core_1.detectSpec.mockImplementationOnce(() => {
+            return 'oas3_1';
+        });
+        process.env.REDOCLY_TELEMETRY = 'on';
+        const wrappedHandler = (0, wrapper_1.commandWrapper)(lint_1.handleLint);
+        await wrappedHandler({});
+        expect(lint_1.handleLint).toHaveBeenCalledTimes(1);
+        expect(miscellaneous_1.sendTelemetry).toHaveBeenCalledTimes(1);
+        expect(miscellaneous_1.sendTelemetry).toHaveBeenCalledWith({}, 0, false, 'oas3_1', 'openapi', '3.1.0');
+    });
+    it('should not collect spec version if the file is not parsed to json', async () => {
         miscellaneous_1.loadConfigAndHandleErrors.mockImplementation(() => {
             return { telemetry: 'on', styleguide: { recommendedFallback: true } };
         });
+        lint_1.handleLint.mockImplementation(({ collectSpecData }) => {
+            collectSpecData();
+        });
         process.env.REDOCLY_TELEMETRY = 'on';
         const wrappedHandler = (0, wrapper_1.commandWrapper)(lint_1.handleLint);
-        yield wrappedHandler({});
+        await wrappedHandler({});
         expect(lint_1.handleLint).toHaveBeenCalledTimes(1);
         expect(miscellaneous_1.sendTelemetry).toHaveBeenCalledTimes(1);
-        expect(miscellaneous_1.sendTelemetry).toHaveBeenCalledWith({}, 0, false);
-    }));
-    it('should NOT send telemetry if there is "telemetry: off" in the config', () => __awaiter(void 0, void 0, void 0, function* () {
+        expect(miscellaneous_1.sendTelemetry).toHaveBeenCalledWith({}, 0, false, undefined, undefined, undefined);
+    });
+    it('should NOT send telemetry if there is "telemetry: off" in the config', async () => {
         miscellaneous_1.loadConfigAndHandleErrors.mockImplementation(() => {
             return { telemetry: 'off', styleguide: { recommendedFallback: true } };
         });
         process.env.REDOCLY_TELEMETRY = 'on';
         const wrappedHandler = (0, wrapper_1.commandWrapper)(lint_1.handleLint);
-        yield wrappedHandler({});
+        await wrappedHandler({});
         expect(lint_1.handleLint).toHaveBeenCalledTimes(1);
         expect(miscellaneous_1.sendTelemetry).toHaveBeenCalledTimes(0);
-    }));
-    it('should pass files from arguments to config', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('should pass files from arguments to config', async () => {
         const filesToPush = ['test1.yaml', 'test2.yaml'];
         const loadConfigMock = miscellaneous_1.loadConfigAndHandleErrors;
         const argv = {
             files: filesToPush,
         };
-        yield (0, wrapper_1.commandWrapper)(push_1.handlePush)(argv);
+        await (0, wrapper_1.commandWrapper)(push_1.handlePush)(argv);
         expect(loadConfigMock).toHaveBeenCalledWith(expect.objectContaining({ files: filesToPush }));
-    }));
+    });
 });

package/lib/cms/api/__tests__/api.client.test.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const node_fetch_1 = require("node-fetch");
 const FormData = require("form-data");
@@ -28,14 +19,14 @@ describe('ApiClient', () => {
         beforeEach(() => {
             apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
         });
-        it('should get default project branch', () => __awaiter(void 0, void 0, void 0, function* () {
+        it('should get default project branch', async () => {
             mockFetchResponse({
                 ok: true,
                 json: jest.fn().mockResolvedValue({
                     branchName: 'test-branch',
                 }),
             });
-            const result = yield apiClient.remotes.getDefaultBranch(testOrg, testProject);
+            const result = await apiClient.remotes.getDefaultBranch(testOrg, testProject);
             expect(node_fetch_1.default).toHaveBeenCalledWith(`${testDomain}/api/orgs/${testOrg}/projects/${testProject}/source`, {
                 method: 'GET',
                 headers: {
@@ -45,8 +36,8 @@ describe('ApiClient', () => {
                 signal: expect.any(Object),
             });
             expect(result).toEqual('test-branch');
-        }));
-        it('should throw parsed error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+        });
+        it('should throw parsed error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
                 json: jest.fn().mockResolvedValue({
@@ -57,9 +48,9 @@ describe('ApiClient', () => {
                     object: 'problem',
                 }),
             });
-            yield expect(apiClient.remotes.getDefaultBranch(testOrg, testProject)).rejects.toThrow(new Error('Failed to fetch default branch: Project source not found'));
-        }));
-        it('should throw statusText error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+            await expect(apiClient.remotes.getDefaultBranch(testOrg, testProject)).rejects.toThrow(new Error('Failed to fetch default branch: Project source not found'));
+        });
+        it('should throw statusText error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
                 statusText: 'Not found',
@@ -67,8 +58,8 @@ describe('ApiClient', () => {
                     unknownField: 'unknown-error',
                 }),
             });
-            yield expect(apiClient.remotes.getDefaultBranch(testOrg, testProject)).rejects.toThrow(new Error('Failed to fetch default branch: Not found'));
-        }));
+            await expect(apiClient.remotes.getDefaultBranch(testOrg, testProject)).rejects.toThrow(new Error('Failed to fetch default branch: Not found'));
+        });
     });
     describe('upsert()', () => {
         const remotePayload = {
@@ -79,7 +70,7 @@ describe('ApiClient', () => {
         beforeEach(() => {
             apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
         });
-        it('should upsert remote', () => __awaiter(void 0, void 0, void 0, function* () {
+        it('should upsert remote', async () => {
             const responseMock = {
                 id: 'remote-id',
                 type: 'CICD',
@@ -92,7 +83,7 @@ describe('ApiClient', () => {
                 ok: true,
                 json: jest.fn().mockResolvedValue(responseMock),
             });
-            const result = yield apiClient.remotes.upsert(testOrg, testProject, remotePayload);
+            const result = await apiClient.remotes.upsert(testOrg, testProject, remotePayload);
             expect(node_fetch_1.default).toHaveBeenCalledWith(`${testDomain}/api/orgs/${testOrg}/projects/${testProject}/remotes`, {
                 method: 'POST',
                 headers: {
@@ -109,8 +100,8 @@ describe('ApiClient', () => {
                 agent: undefined,
             });
             expect(result).toEqual(responseMock);
-        }));
-        it('should throw parsed error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+        });
+        it('should throw parsed error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
                 json: jest.fn().mockResolvedValue({
@@ -121,9 +112,9 @@ describe('ApiClient', () => {
                     object: 'problem',
                 }),
             });
-            yield expect(apiClient.remotes.upsert(testOrg, testProject, remotePayload)).rejects.toThrow(new Error('Failed to upsert remote: Not allowed to mount remote outside of project content path: /docs'));
-        }));
-        it('should throw statusText error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+            await expect(apiClient.remotes.upsert(testOrg, testProject, remotePayload)).rejects.toThrow(new Error('Failed to upsert remote: Not allowed to mount remote outside of project content path: /docs'));
+        });
+        it('should throw statusText error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
                 statusText: 'Not found',
@@ -131,8 +122,8 @@ describe('ApiClient', () => {
                     unknownField: 'unknown-error',
                 }),
             });
-            yield expect(apiClient.remotes.upsert(testOrg, testProject, remotePayload)).rejects.toThrow(new Error('Failed to upsert remote: Not found'));
-        }));
+            await expect(apiClient.remotes.upsert(testOrg, testProject, remotePayload)).rejects.toThrow(new Error('Failed to upsert remote: Not found'));
+        });
     });
     describe('push()', () => {
         const testRemoteId = 'test-remote-id';
@@ -167,15 +158,15 @@ describe('ApiClient', () => {
         beforeEach(() => {
             apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
         });
-        it('should push to remote', () => __awaiter(void 0, void 0, void 0, function* () {
+        it('should push to remote', async () => {
             let passedFormData = new FormData();
-            node_fetch_1.default.mockImplementationOnce((_, options) => __awaiter(void 0, void 0, void 0, function* () {
+            node_fetch_1.default.mockImplementationOnce(async (_, options) => {
                 passedFormData = options.body;
                 return {
                     ok: true,
                     json: jest.fn().mockResolvedValue(responseMock),
                 };
-            }));
+            });
             const formData = new FormData();
             formData.append('remoteId', testRemoteId);
             formData.append('commit[message]', pushPayload.commit.message);
@@ -183,7 +174,7 @@ describe('ApiClient', () => {
             formData.append('commit[author][email]', pushPayload.commit.author.email);
             formData.append('commit[branchName]', pushPayload.commit.branchName);
             formData.append('files[some-file.yaml]', filesMock[0].stream);
-            const result = yield apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock);
+            const result = await apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock);
             expect(node_fetch_1.default).toHaveBeenCalledWith(`${testDomain}/api/orgs/${testOrg}/projects/${testProject}/pushes`, expect.objectContaining({
                 method: 'POST',
                 headers: {
@@ -192,8 +183,8 @@ describe('ApiClient', () => {
             }));
             expect(JSON.stringify(passedFormData).replace(new RegExp(passedFormData.getBoundary(), 'g'), '')).toEqual(JSON.stringify(formData).replace(new RegExp(formData.getBoundary(), 'g'), ''));
             expect(result).toEqual(responseMock);
-        }));
-        it('should throw parsed error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+        });
+        it('should throw parsed error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
                 json: jest.fn().mockResolvedValue({
@@ -204,9 +195,9 @@ describe('ApiClient', () => {
                     object: 'problem',
                 }),
             });
-            yield expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new Error('Failed to push: Cannot push to remote'));
-        }));
-        it('should throw statusText error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+            await expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new Error('Failed to push: Cannot push to remote'));
+        });
+        it('should throw statusText error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
                 statusText: 'Not found',
@@ -214,7 +205,7 @@ describe('ApiClient', () => {
                     unknownField: 'unknown-error',
                 }),
             });
-            yield expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new Error('Failed to push: Not found'));
-        }));
+            await expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new Error('Failed to push: Not found'));
+        });
     });
 });

package/lib/cms/api/api-client.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import type { ReadStream } from 'fs';
 import type { ListRemotesResponse, PushResponse, UpsertRemoteResponse } from './types';
 declare class RemotesApiClient {