@redocly/cli 1.18.0 → 1.19.0

package/lib/__tests__/commands/push-region.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 openapi_core_1 = require("@redocly/openapi-core");
 const push_1 = require("../../commands/push");
@@ -31,26 +22,34 @@ describe('push-with-region', () => {
     beforeAll(() => {
         jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
     });
-    it('should call login with default domain when region is US', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should call login with default domain when region is US', async () => {
         redoclyClient.domain = 'redoc.ly';
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: '@org/my-api@1.0.0',
-            branchName: 'test',
-        }, config_1.ConfigFixture);
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: '@org/my-api@1.0.0',
+                branchName: 'test',
+            },
+            config: config_1.ConfigFixture,
+            version: 'cli-version',
+        });
         expect(mockPromptClientToken).toBeCalledTimes(1);
         expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
-    }));
-    it('should call login with EU domain when region is EU', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('should call login with EU domain when region is EU', async () => {
         redoclyClient.domain = 'eu.redocly.com';
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: '@org/my-api@1.0.0',
-            branchName: 'test',
-        }, config_1.ConfigFixture);
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: '@org/my-api@1.0.0',
+                branchName: 'test',
+            },
+            config: config_1.ConfigFixture,
+            version: 'cli-version',
+        });
         expect(mockPromptClientToken).toBeCalledTimes(1);
         expect(mockPromptClientToken).toHaveBeenCalledWith(redoclyClient.domain);
-    }));
+    });
 });

package/lib/__tests__/commands/push.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 fs = require("fs");
 const openapi_core_1 = require("@redocly/openapi-core");
@@ -30,16 +21,20 @@ describe('push', () => {
     beforeEach(() => {
         jest.spyOn(process.stdout, 'write').mockImplementation(() => true);
     });
-    it('pushes definition', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: '@org/my-api@1.0.0',
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, config_1.ConfigFixture);
+    it('pushes definition', async () => {
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: '@org/my-api@1.0.0',
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: config_1.ConfigFixture,
+            version: 'cli-version',
+        });
         expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(1);
         expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
         expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
@@ -54,43 +49,55 @@ describe('push', () => {
             batchId: '123',
             batchSize: 2,
         });
-    }));
-    it('fails if jobId value is an empty string', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: '@org/my-api@1.0.0',
-            branchName: 'test',
-            public: true,
-            'job-id': ' ',
-            'batch-size': 2,
-        }, config_1.ConfigFixture);
+    });
+    it('fails if jobId value is an empty string', async () => {
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: '@org/my-api@1.0.0',
+                branchName: 'test',
+                public: true,
+                'job-id': ' ',
+                'batch-size': 2,
+            },
+            config: config_1.ConfigFixture,
+            version: 'cli-version',
+        });
         expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
-    }));
-    it('fails if batchSize value is less than 2', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: '@org/my-api@1.0.0',
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 1,
-        }, config_1.ConfigFixture);
+    });
+    it('fails if batchSize value is less than 2', async () => {
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: '@org/my-api@1.0.0',
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 1,
+            },
+            config: config_1.ConfigFixture,
+            version: 'cli-version',
+        });
         expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
-    }));
-    it('push with --files', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockConfig = Object.assign(Object.assign({}, config_1.ConfigFixture), { files: ['./resouces/1.md', './resouces/2.md'] });
+    });
+    it('push with --files', async () => {
+        const mockConfig = { ...config_1.ConfigFixture, files: ['./resouces/1.md', './resouces/2.md'] };
         fs.statSync.mockImplementation(() => {
             return { isDirectory: () => false, size: 10 };
         });
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: '@org/my-api@1.0.0',
-            public: true,
-            files: ['./resouces/1.md', './resouces/2.md'],
-        }, mockConfig);
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: '@org/my-api@1.0.0',
+                public: true,
+                files: ['./resouces/1.md', './resouces/2.md'],
+            },
+            config: mockConfig,
+            version: 'cli-version',
+        });
         expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
             filePaths: ['filePath', 'filePath', 'filePath'],
             isUpsert: true,
@@ -101,31 +108,39 @@ describe('push', () => {
             version: '1.0.0',
         });
         expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(3);
-    }));
-    it('push should fail if organization not provided', () => __awaiter(void 0, void 0, void 0, function* () {
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: 'test@v1',
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, config_1.ConfigFixture);
+    });
+    it('push should fail if organization not provided', async () => {
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: 'test@v1',
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: config_1.ConfigFixture,
+            version: 'cli-version',
+        });
         expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
         expect(miscellaneous_1.exitWithError).toBeCalledWith(`No organization provided, please use --organization option or specify the 'organization' field in the config file.`);
-    }));
-    it('push should work with organization in config', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockConfig = Object.assign(Object.assign({}, config_1.ConfigFixture), { organization: 'test_org' });
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'spec.json',
-            destination: 'my-api@1.0.0',
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, mockConfig);
+    });
+    it('push should work with organization in config', async () => {
+        const mockConfig = { ...config_1.ConfigFixture, organization: 'test_org' };
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'spec.json',
+                destination: 'my-api@1.0.0',
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: mockConfig,
+            version: 'cli-version',
+        });
         expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
         expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
             branch: 'test',
@@ -139,153 +154,237 @@ describe('push', () => {
             batchId: '123',
             batchSize: 2,
         });
-    }));
-    it('push should work if destination not provided but api in config is provided', () => __awaiter(void 0, void 0, void 0, function* () {
-        const mockConfig = Object.assign(Object.assign({}, config_1.ConfigFixture), { organization: 'test_org', apis: { 'my-api@1.0.0': { root: 'path' } } });
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, mockConfig);
+    });
+    it('push should work if destination not provided but api in config is provided', async () => {
+        const mockConfig = {
+            ...config_1.ConfigFixture,
+            organization: 'test_org',
+            apis: { 'my-api@1.0.0': { root: 'path' } },
+        };
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: mockConfig,
+            version: 'cli-version',
+        });
         expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-    }));
-    it('push should fail if apis not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('push should fail if apis not provided', async () => {
         const mockConfig = { organization: 'test_org', apis: {} };
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, mockConfig);
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: mockConfig,
+            version: 'cli-version',
+        });
         expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
         expect(miscellaneous_1.exitWithError).toHaveBeenLastCalledWith('Api not found. Please make sure you have provided the correct data in the config file.');
-    }));
-    it('push should fail if destination not provided', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('push should fail if destination not provided', async () => {
         const mockConfig = { organization: 'test_org', apis: {} };
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            api: 'api.yaml',
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, mockConfig);
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                api: 'api.yaml',
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: mockConfig,
+            version: 'cli-version',
+        });
         expect(miscellaneous_1.exitWithError).toBeCalledTimes(1);
         expect(miscellaneous_1.exitWithError).toHaveBeenLastCalledWith('No destination provided, please use --destination option to provide destination.');
-    }));
-    it('push should fail if destination format is not valid', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('push should fail if destination format is not valid', async () => {
         const mockConfig = { organization: 'test_org', apis: {} };
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            destination: 'name/v1',
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, mockConfig);
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                destination: 'name/v1',
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: mockConfig,
+            version: 'cli-version',
+        });
         expect(miscellaneous_1.exitWithError).toHaveBeenCalledWith(`Destination argument value is not valid, please use the right format: ${(0, colorette_1.yellow)('<api-name@api-version>')}.`);
-    }));
-    it('push should work and encode name with spaces', () => __awaiter(void 0, void 0, void 0, function* () {
+    });
+    it('push should work and encode name with spaces', async () => {
         const encodeURIComponentSpy = jest.spyOn(global, 'encodeURIComponent');
-        const mockConfig = Object.assign(Object.assign({}, config_1.ConfigFixture), { organization: 'test_org', apis: { 'my test api@v1': { root: 'path' } } });
-        yield (0, push_1.handlePush)({
-            upsert: true,
-            destination: 'my test api@v1',
-            branchName: 'test',
-            public: true,
-            'job-id': '123',
-            'batch-size': 2,
-        }, mockConfig);
+        const mockConfig = {
+            ...config_1.ConfigFixture,
+            organization: 'test_org',
+            apis: { 'my test api@v1': { root: 'path' } },
+        };
+        await (0, push_1.handlePush)({
+            argv: {
+                upsert: true,
+                destination: 'my test api@v1',
+                branchName: 'test',
+                public: true,
+                'job-id': '123',
+                'batch-size': 2,
+            },
+            config: mockConfig,
+            version: 'cli-version',
+        });
         expect(encodeURIComponentSpy).toHaveReturnedWith('my%20test%20api');
         expect(redoclyClient.registryApi.pushApi).toBeCalledTimes(1);
-    }));
+    });
 });
 describe('transformPush', () => {
     it('should adapt the existing syntax', () => {
         const cb = jest.fn();
         (0, push_1.transformPush)(cb)({
-            apis: ['openapi.yaml', '@testing_org/main@v1'],
-        }, {});
+            argv: {
+                apis: ['openapi.yaml', '@testing_org/main@v1'],
+            },
+            config: {},
+            version: 'cli-version',
+        });
         expect(cb).toBeCalledWith({
-            api: 'openapi.yaml',
-            destination: '@testing_org/main@v1',
-        }, {});
+            argv: {
+                api: 'openapi.yaml',
+                destination: '@testing_org/main@v1',
+            },
+            config: {},
+            version: 'cli-version',
+        });
     });
     it('should adapt the existing syntax (including branchName)', () => {
         const cb = jest.fn();
         (0, push_1.transformPush)(cb)({
-            apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
-        }, {});
+            argv: {
+                apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
+            },
+            config: {},
+            version: 'cli-version',
+        });
         expect(cb).toBeCalledWith({
-            api: 'openapi.yaml',
-            destination: '@testing_org/main@v1',
-            branchName: 'other',
-        }, {});
+            argv: {
+                api: 'openapi.yaml',
+                destination: '@testing_org/main@v1',
+                branchName: 'other',
+            },
+            config: {},
+            version: 'cli-version',
+        });
     });
     it('should use --branch option firstly', () => {
         const cb = jest.fn();
         (0, push_1.transformPush)(cb)({
-            apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
-            branch: 'priority-branch',
-        }, {});
+            argv: {
+                apis: ['openapi.yaml', '@testing_org/main@v1', 'other'],
+                branch: 'priority-branch',
+            },
+            config: {},
+            version: 'cli-version',
+        });
         expect(cb).toBeCalledWith({
-            api: 'openapi.yaml',
-            destination: '@testing_org/main@v1',
-            branchName: 'priority-branch',
-        }, {});
+            argv: {
+                api: 'openapi.yaml',
+                destination: '@testing_org/main@v1',
+                branchName: 'priority-branch',
+            },
+            config: {},
+            version: 'cli-version',
+        });
     });
     it('should work for a destination only', () => {
         const cb = jest.fn();
         (0, push_1.transformPush)(cb)({
-            apis: ['main@v1'],
-        }, {});
+            argv: {
+                apis: ['main@v1'],
+            },
+            config: {},
+            version: 'cli-version',
+        });
         expect(cb).toBeCalledWith({
-            destination: 'main@v1',
-        }, {});
+            argv: {
+                destination: 'main@v1',
+            },
+            config: {},
+            version: 'cli-version',
+        });
     });
     it('should work for a api only', () => {
         const cb = jest.fn();
         (0, push_1.transformPush)(cb)({
-            apis: ['test.yaml'],
-        }, {});
+            argv: {
+                apis: ['test.yaml'],
+            },
+            config: {},
+            version: 'cli-version',
+        });
         expect(cb).toBeCalledWith({
-            api: 'test.yaml',
-        }, {});
+            argv: {
+                api: 'test.yaml',
+            },
+            config: {},
+            version: 'cli-version',
+        });
     });
     it('should use destination from option', () => {
         const cb = jest.fn();
         (0, push_1.transformPush)(cb)({
-            apis: ['test.yaml', 'test@v1'],
-            destination: 'main@v1',
-        }, {});
+            argv: {
+                apis: ['test.yaml', 'test@v1'],
+                destination: 'main@v1',
+            },
+            config: {},
+            version: 'cli-version',
+        });
         expect(cb).toBeCalledWith({
-            destination: 'main@v1',
-            api: 'test.yaml',
-        }, {});
+            argv: {
+                destination: 'main@v1',
+                api: 'test.yaml',
+            },
+            config: {},
+            version: 'cli-version',
+        });
     });
     it('should use --job-id option firstly', () => {
         const cb = jest.fn();
         (0, push_1.transformPush)(cb)({
-            'batch-id': 'b-123',
-            'job-id': 'j-123',
-            apis: ['test'],
-            branch: 'test',
-            destination: 'main@v1',
-        }, {});
+            argv: {
+                'batch-id': 'b-123',
+                'job-id': 'j-123',
+                apis: ['test'],
+                branch: 'test',
+                destination: 'main@v1',
+            },
+            config: {},
+            version: 'cli-version',
+        });
         expect(cb).toBeCalledWith({
-            'job-id': 'j-123',
-            api: 'test',
-            branchName: 'test',
-            destination: 'main@v1',
-        }, {});
+            argv: {
+                'job-id': 'j-123',
+                api: 'test',
+                branchName: 'test',
+                destination: 'main@v1',
+            },
+            config: {},
+            version: 'cli-version',
+        });
     });
     it('should accept no arguments at all', () => {
         const cb = jest.fn();
-        (0, push_1.transformPush)(cb)({}, {});
-        expect(cb).toBeCalledWith({}, {});
+        (0, push_1.transformPush)(cb)({ argv: {}, config: {}, version: 'cli-version' });
+        expect(cb).toBeCalledWith({ argv: {}, config: {}, version: 'cli-version' });
     });
 });
 describe('getDestinationProps', () => {

package/lib/__tests__/fetch-with-timeout.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 abort_controller_1 = require("abort-controller");
 const fetch_with_timeout_1 = require("../utils/fetch-with-timeout");
@@ -17,13 +8,13 @@ describe('fetchWithTimeout', () => {
     afterEach(() => {
         jest.clearAllMocks();
     });
-    it('should call node-fetch with signal', () => __awaiter(void 0, void 0, void 0, function* () {
+    it('should call node-fetch with signal', async () => {
         // @ts-ignore
         global.setTimeout = jest.fn();
         global.clearTimeout = jest.fn();
-        yield (0, fetch_with_timeout_1.default)('url');
+        await (0, fetch_with_timeout_1.default)('url');
         expect(global.setTimeout).toHaveBeenCalledTimes(1);
         expect(node_fetch_1.default).toHaveBeenCalledWith('url', { signal: new abort_controller_1.default().signal });
         expect(global.clearTimeout).toHaveBeenCalledTimes(1);
-    }));
+    });
 });

package/lib/__tests__/fixtures/config.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="jest" />
 export declare const ConfigFixture: {
     configFile: null;
     styleguide: {