@redocly/cli 1.22.0 → 1.23.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @redocly/cli
 
+## 1.23.0
+
+### Minor Changes
+
+- Added support for the `output` option in the per-API configuration so that the destination file can be specified in configuration.
+
+### Patch Changes
+
+- Fixed the absolute path for importing plugins in Windows.
+- Added the ability to run the `eject` command without specifying components, which displays a selectable list of all available components.
+- Updated @redocly/openapi-core to v1.23.0.
+
+## 1.22.1
+
+### Patch Changes
+
+- Updated @redocly/openapi-core to v1.22.1.
+
 ## 1.22.0
 
 ### Minor Changes

package/lib/__tests__/commands/bundle.test.js

@@ -6,21 +6,28 @@ const miscellaneous_1 = require("../../utils/miscellaneous");
 const wrapper_1 = require("../../wrapper");
 jest.mock('@redocly/openapi-core');
 jest.mock('../../utils/miscellaneous');
+// @ts-ignore
+miscellaneous_1.getOutputFileName = jest.requireActual('../../utils/miscellaneous').getOutputFileName;
 openapi_core_1.getMergedConfig.mockImplementation((config) => config);
 describe('bundle', () => {
     let processExitMock;
     let exitCb;
+    let stderrWriteMock;
+    let stdoutWriteMock;
     beforeEach(() => {
         processExitMock = jest.spyOn(process, 'exit').mockImplementation();
         jest.spyOn(process, 'once').mockImplementation((_e, cb) => {
             exitCb = cb;
             return process.on(_e, cb);
         });
-        jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
+        stderrWriteMock = jest.spyOn(process.stderr, 'write').mockImplementation(jest.fn());
+        stdoutWriteMock = jest.spyOn(process.stdout, 'write').mockImplementation(jest.fn());
     });
     afterEach(() => {
         openapi_core_1.bundle.mockClear();
         openapi_core_1.getTotals.mockReset();
+        stderrWriteMock.mockRestore();
+        stdoutWriteMock.mockRestore();
     });
     it('bundles definitions', async () => {
         const apis = ['foo.yaml', 'bar.yaml'];
@@ -87,4 +94,106 @@ describe('bundle', () => {
         });
         expect(miscellaneous_1.handleError).toHaveBeenCalledTimes(0);
     });
+    it('should store bundled API descriptions in the output files described in the apis section of config IF no positional apis provided AND output is specified for both apis', async () => {
+        const apis = {
+            foo: {
+                root: 'foo.yaml',
+                output: 'output/foo.yaml',
+            },
+            bar: {
+                root: 'bar.yaml',
+                output: 'output/bar.json',
+            },
+        };
+        const config = {
+            apis,
+            styleguide: {
+                skipPreprocessors: jest.fn(),
+                skipDecorators: jest.fn(),
+            },
+        };
+        // @ts-ignore
+        miscellaneous_1.getFallbackApisOrExit = jest
+            .fn()
+            .mockResolvedValueOnce(Object.entries(apis).map(([alias, { root, ...api }]) => ({ ...api, path: root, alias })));
+        openapi_core_1.getTotals.mockReturnValue({
+            errors: 0,
+            warnings: 0,
+            ignored: 0,
+        });
+        await (0, bundle_1.handleBundle)({
+            argv: { apis: [] }, // positional
+            version: 'test',
+            config,
+        });
+        expect(miscellaneous_1.saveBundle).toBeCalledTimes(2);
+        expect(miscellaneous_1.saveBundle).toHaveBeenNthCalledWith(1, 'output/foo.yaml', expect.any(String));
+        expect(miscellaneous_1.saveBundle).toHaveBeenNthCalledWith(2, 'output/bar.json', expect.any(String));
+    });
+    it('should store bundled API descriptions in the output files described in the apis section of config AND print the bundled api without the output specified to the terminal IF no positional apis provided AND output is specified for one api', async () => {
+        const apis = {
+            foo: {
+                root: 'foo.yaml',
+                output: 'output/foo.yaml',
+            },
+            bar: {
+                root: 'bar.yaml',
+            },
+        };
+        const config = {
+            apis,
+            styleguide: {
+                skipPreprocessors: jest.fn(),
+                skipDecorators: jest.fn(),
+            },
+        };
+        // @ts-ignore
+        miscellaneous_1.getFallbackApisOrExit = jest
+            .fn()
+            .mockResolvedValueOnce(Object.entries(apis).map(([alias, { root, ...api }]) => ({ ...api, path: root, alias })));
+        openapi_core_1.getTotals.mockReturnValue({
+            errors: 0,
+            warnings: 0,
+            ignored: 0,
+        });
+        await (0, bundle_1.handleBundle)({
+            argv: { apis: [] }, // positional
+            version: 'test',
+            config,
+        });
+        expect(miscellaneous_1.saveBundle).toBeCalledTimes(1);
+        expect(miscellaneous_1.saveBundle).toHaveBeenCalledWith('output/foo.yaml', expect.any(String));
+        expect(process.stdout.write).toHaveBeenCalledTimes(1);
+    });
+    describe('per api output', () => {
+        it('should NOT store bundled API descriptions in the output files described in the apis section of config IF no there is a positional api provided', async () => {
+            const apis = {
+                foo: {
+                    root: 'foo.yaml',
+                    output: 'output/foo.yaml',
+                },
+            };
+            const config = {
+                apis,
+                styleguide: {
+                    skipPreprocessors: jest.fn(),
+                    skipDecorators: jest.fn(),
+                },
+            };
+            // @ts-ignore
+            miscellaneous_1.getFallbackApisOrExit = jest.fn().mockResolvedValueOnce([{ path: 'openapi.yaml' }]);
+            openapi_core_1.getTotals.mockReturnValue({
+                errors: 0,
+                warnings: 0,
+                ignored: 0,
+            });
+            await (0, bundle_1.handleBundle)({
+                argv: { apis: ['openapi.yaml'] }, // positional
+                version: 'test',
+                config,
+            });
+            expect(miscellaneous_1.saveBundle).toBeCalledTimes(0);
+            expect(process.stdout.write).toHaveBeenCalledTimes(1);
+        });
+    });
 });

package/lib/__tests__/fetch-with-timeout.test.js

@@ -3,18 +3,42 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const abort_controller_1 = require("abort-controller");
 const fetch_with_timeout_1 = require("../utils/fetch-with-timeout");
 const node_fetch_1 = require("node-fetch");
+const openapi_core_1 = require("@redocly/openapi-core");
+const https_proxy_agent_1 = require("https-proxy-agent");
 jest.mock('node-fetch');
+jest.mock('@redocly/openapi-core');
 describe('fetchWithTimeout', () => {
+    beforeAll(() => {
+        // @ts-ignore
+        global.setTimeout = jest.fn();
+        global.clearTimeout = jest.fn();
+    });
+    beforeEach(() => {
+        openapi_core_1.getProxyAgent.mockReturnValueOnce(undefined);
+    });
     afterEach(() => {
         jest.clearAllMocks();
     });
     it('should call node-fetch with signal', async () => {
-        // @ts-ignore
-        global.setTimeout = jest.fn();
-        global.clearTimeout = jest.fn();
-        await (0, fetch_with_timeout_1.default)('url');
+        await (0, fetch_with_timeout_1.default)('url', { timeout: 1000 });
         expect(global.setTimeout).toHaveBeenCalledTimes(1);
-        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { signal: new abort_controller_1.default().signal });
+        expect(node_fetch_1.default).toHaveBeenCalledWith('url', {
+            signal: new abort_controller_1.default().signal,
+            agent: undefined,
+        });
         expect(global.clearTimeout).toHaveBeenCalledTimes(1);
     });
+    it('should call node-fetch with proxy agent', async () => {
+        openapi_core_1.getProxyAgent.mockRestore();
+        const proxyAgent = new https_proxy_agent_1.HttpsProxyAgent('http://localhost');
+        openapi_core_1.getProxyAgent.mockReturnValueOnce(proxyAgent);
+        await (0, fetch_with_timeout_1.default)('url');
+        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { agent: proxyAgent });
+    });
+    it('should call node-fetch without signal when timeout is not passed', async () => {
+        await (0, fetch_with_timeout_1.default)('url');
+        expect(global.setTimeout).not.toHaveBeenCalled();
+        expect(node_fetch_1.default).toHaveBeenCalledWith('url', { agent: undefined });
+        expect(global.clearTimeout).not.toHaveBeenCalled();
+    });
 });

package/lib/__tests__/utils.test.js

@@ -46,19 +46,6 @@ describe('pathToFilename', () => {
         expect(processedPath).toEqual('user_createWithList');
     });
 });
-describe('getFallbackApisOrExit', () => {
-    it('should find alias by filename', async () => {
-        fs_1.existsSync.mockImplementationOnce(() => true);
-        const entry = await (0, miscellaneous_1.getFallbackApisOrExit)(['./test.yaml'], {
-            apis: {
-                main: {
-                    root: 'test.yaml',
-                },
-            },
-        });
-        expect(entry).toEqual([{ path: './test.yaml', alias: 'main' }]);
-    });
-});
 describe('printConfigLintTotals', () => {
     const totalProblemsMock = {
         errors: 1,
@@ -143,6 +130,7 @@ describe('getFallbackApisOrExit', () => {
             {
                 alias: 'main',
                 path: 'someFile.yaml',
+                output: undefined,
             },
         ]);
     });
@@ -215,6 +203,40 @@ describe('getFallbackApisOrExit', () => {
             {
                 alias: 'main',
                 path: 'https://someLinkt/petstore.yaml?main',
+                output: undefined,
+            },
+        ]);
+        openapi_core_1.isAbsoluteUrl.mockReset();
+    });
+    it('should find alias by filename', async () => {
+        fs_1.existsSync.mockImplementationOnce(() => true);
+        const entry = await (0, miscellaneous_1.getFallbackApisOrExit)(['./test.yaml'], {
+            apis: {
+                main: {
+                    root: 'test.yaml',
+                    styleguide: {},
+                },
+            },
+        });
+        expect(entry).toEqual([{ path: './test.yaml', alias: 'main' }]);
+    });
+    it('should return apis from config with paths and outputs resolved relatively to the config location', async () => {
+        fs_1.existsSync.mockImplementationOnce(() => true);
+        const entry = await (0, miscellaneous_1.getFallbackApisOrExit)(undefined, {
+            apis: {
+                main: {
+                    root: 'test.yaml',
+                    output: 'output/test.yaml',
+                    styleguide: {},
+                },
+            },
+            configFile: 'project-folder/redocly.yaml',
+        });
+        expect(entry).toEqual([
+            {
+                path: expect.stringMatching(/project\-folder\/test\.yaml$/),
+                output: expect.stringMatching(/project\-folder\/output\/test\.yaml$/),
+                alias: 'main',
             },
         ]);
     });
@@ -487,24 +509,24 @@ describe('cleanRawInput', () => {
             expect(stderrMock).toHaveBeenCalledWith(`Unsupported file extension: xml. Using yaml.\n`);
         });
     });
-    describe('writeToFileByExtension', () => {
-        beforeEach(() => {
-            jest.spyOn(process.stderr, 'write').mockImplementation(jest.fn());
-            colorette_1.yellow.mockImplementation((text) => text);
-        });
-        afterEach(() => {
-            jest.restoreAllMocks();
-        });
-        it('should call stringifyYaml function', () => {
-            (0, miscellaneous_1.writeToFileByExtension)('test data', 'test.yaml');
-            expect(openapi_core_1.stringifyYaml).toHaveBeenCalledWith('test data', { noRefs: false });
-            expect(process.stderr.write).toHaveBeenCalledWith(`test data`);
-        });
-        it('should call JSON.stringify function', () => {
-            const stringifySpy = jest.spyOn(JSON, 'stringify').mockImplementation((data) => data);
-            (0, miscellaneous_1.writeToFileByExtension)('test data', 'test.json');
-            expect(stringifySpy).toHaveBeenCalledWith('test data', null, 2);
-            expect(process.stderr.write).toHaveBeenCalledWith(`test data`);
-        });
+});
+describe('writeToFileByExtension', () => {
+    beforeEach(() => {
+        jest.spyOn(process.stderr, 'write').mockImplementation(jest.fn());
+        colorette_1.yellow.mockImplementation((text) => text);
+    });
+    afterEach(() => {
+        jest.restoreAllMocks();
+    });
+    it('should call stringifyYaml function', () => {
+        (0, miscellaneous_1.writeToFileByExtension)('test data', 'test.yaml');
+        expect(openapi_core_1.stringifyYaml).toHaveBeenCalledWith('test data', { noRefs: false });
+        expect(process.stderr.write).toHaveBeenCalledWith(`test data`);
+    });
+    it('should call JSON.stringify function', () => {
+        const stringifySpy = jest.spyOn(JSON, 'stringify').mockImplementation((data) => data);
+        (0, miscellaneous_1.writeToFileByExtension)('test data', 'test.json');
+        expect(stringifySpy).toHaveBeenCalledWith('test data', null, 2);
+        expect(process.stderr.write).toHaveBeenCalledWith(`test data`);
     });
 });

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

@@ -14,10 +14,13 @@ describe('ApiClient', () => {
     const testDomain = 'test-domain.com';
     const testOrg = 'test-org';
     const testProject = 'test-project';
+    const version = '1.0.0';
+    const command = 'push';
+    const expectedUserAgent = `redocly-cli/${version} ${command}`;
     describe('getDefaultBranch()', () => {
         let apiClient;
         beforeEach(() => {
-            apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
+            apiClient = new api_client_1.ReuniteApiClient({ domain: testDomain, apiKey: testToken, version, command });
         });
         it('should get default project branch', async () => {
             mockFetchResponse({
@@ -32,6 +35,7 @@ describe('ApiClient', () => {
                 headers: {
                     'Content-Type': 'application/json',
                     Authorization: `Bearer ${testToken}`,
+                    'user-agent': expectedUserAgent,
                 },
                 signal: expect.any(Object),
             });
@@ -48,7 +52,7 @@ describe('ApiClient', () => {
                     object: 'problem',
                 }),
             });
-            await expect(apiClient.remotes.getDefaultBranch(testOrg, testProject)).rejects.toThrow(new Error('Failed to fetch default branch: Project source not found'));
+            await expect(apiClient.remotes.getDefaultBranch(testOrg, testProject)).rejects.toThrow(new api_client_1.ReuniteApiError('Failed to fetch default branch. Project source not found.', 404));
         });
         it('should throw statusText error if response is not ok', async () => {
             mockFetchResponse({
@@ -58,7 +62,7 @@ describe('ApiClient', () => {
                     unknownField: 'unknown-error',
                 }),
             });
-            await 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 api_client_1.ReuniteApiError('Failed to fetch default branch. Not found.', 404));
         });
     });
     describe('upsert()', () => {
@@ -68,7 +72,7 @@ describe('ApiClient', () => {
         };
         let apiClient;
         beforeEach(() => {
-            apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
+            apiClient = new api_client_1.ReuniteApiClient({ domain: testDomain, apiKey: testToken, version, command });
         });
         it('should upsert remote', async () => {
             const responseMock = {
@@ -89,6 +93,7 @@ describe('ApiClient', () => {
                 headers: {
                     'Content-Type': 'application/json',
                     Authorization: `Bearer ${testToken}`,
+                    'user-agent': expectedUserAgent,
                 },
                 body: JSON.stringify({
                     mountPath: remotePayload.mountPath,
@@ -112,17 +117,18 @@ describe('ApiClient', () => {
                     object: 'problem',
                 }),
             });
-            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'));
+            await expect(apiClient.remotes.upsert(testOrg, testProject, remotePayload)).rejects.toThrow(new api_client_1.ReuniteApiError('Failed to upsert remote. Not allowed to mount remote outside of project content path: /docs.', 403));
         });
         it('should throw statusText error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
+                status: 404,
                 statusText: 'Not found',
                 json: jest.fn().mockResolvedValue({
                     unknownField: 'unknown-error',
                 }),
             });
-            await 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 api_client_1.ReuniteApiError('Failed to upsert remote. Not found.', 404));
         });
     });
     describe('push()', () => {
@@ -156,7 +162,7 @@ describe('ApiClient', () => {
         };
         let apiClient;
         beforeEach(() => {
-            apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
+            apiClient = new api_client_1.ReuniteApiClient({ domain: testDomain, apiKey: testToken, version, command });
         });
         it('should push to remote', async () => {
             let passedFormData = new FormData();
@@ -179,6 +185,7 @@ describe('ApiClient', () => {
                 method: 'POST',
                 headers: {
                     Authorization: `Bearer ${testToken}`,
+                    'user-agent': expectedUserAgent,
                 },
             }));
             expect(JSON.stringify(passedFormData).replace(new RegExp(passedFormData.getBoundary(), 'g'), '')).toEqual(JSON.stringify(formData).replace(new RegExp(formData.getBoundary(), 'g'), ''));
@@ -195,17 +202,18 @@ describe('ApiClient', () => {
                     object: 'problem',
                 }),
             });
-            await expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new Error('Failed to push: Cannot push to remote'));
+            await expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new api_client_1.ReuniteApiError('Failed to push. Cannot push to remote.', 403));
         });
         it('should throw statusText error if response is not ok', async () => {
             mockFetchResponse({
                 ok: false,
+                status: 404,
                 statusText: 'Not found',
                 json: jest.fn().mockResolvedValue({
                     unknownField: 'unknown-error',
                 }),
             });
-            await 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 api_client_1.ReuniteApiError('Failed to push. Not found.', 404));
         });
     });
 });

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

@@ -1,10 +1,22 @@
+import { type FetchWithTimeoutOptions } from '../../utils/fetch-with-timeout';
+import type { Response } from 'node-fetch';
 import type { ReadStream } from 'fs';
 import type { ListRemotesResponse, PushResponse, UpsertRemoteResponse } from './types';
-declare class RemotesApiClient {
+export declare class ReuniteApiError extends Error {
+    status: number;
+    constructor(message: string, status: number);
+}
+declare class ReuniteBaseApiClient {
+    protected version: string;
+    protected command: string;
+    constructor(version: string, command: string);
+    protected getParsedResponse<T>(response: Response): Promise<T>;
+    protected request(url: string, options: FetchWithTimeoutOptions): Promise<Response>;
+}
+declare class RemotesApiClient extends ReuniteBaseApiClient {
     private readonly domain;
     private readonly apiKey;
-    constructor(domain: string, apiKey: string);
-    private getParsedResponse;
+    constructor(domain: string, apiKey: string, version: string, command: string);
     getDefaultBranch(organizationId: string, projectId: string): Promise<string>;
     upsert(organizationId: string, projectId: string, remote: {
         mountPath: string;
@@ -14,7 +26,11 @@ declare class RemotesApiClient {
         path: string;
         stream: ReadStream | Buffer;
     }[]): Promise<PushResponse>;
-    getRemotesList(organizationId: string, projectId: string, mountPath: string): Promise<ListRemotesResponse>;
+    getRemotesList({ organizationId, projectId, mountPath, }: {
+        organizationId: string;
+        projectId: string;
+        mountPath: string;
+    }): Promise<ListRemotesResponse>;
     getPush({ organizationId, projectId, pushId, }: {
         organizationId: string;
         projectId: string;
@@ -22,10 +38,13 @@ declare class RemotesApiClient {
     }): Promise<PushResponse>;
 }
 export declare class ReuniteApiClient {
-    domain: string;
-    private readonly apiKey;
     remotes: RemotesApiClient;
-    constructor(domain: string, apiKey: string);
+    constructor({ domain, apiKey, version, command, }: {
+        domain: string;
+        apiKey: string;
+        version: string;
+        command: 'push' | 'push-status';
+    });
 }
 export type PushPayload = {
     remoteId: string;