@redocly/cli 1.7.0 → 1.8.1

package/lib/__tests__/utils.test.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../utils");
+const miscellaneous_1 = require("../utils/miscellaneous");
 const openapi_core_1 = require("@redocly/openapi-core");
 const colorette_1 = require("colorette");
 const fs_1 = require("fs");
@@ -31,7 +31,7 @@ describe('isSubdir', () => {
             ['/foo', './bar', false],
             ['/foo', '/foo/..bar', true],
         ].forEach(([parent, child, expectRes]) => {
-            expect((0, utils_1.isSubdir)(parent, child)).toBe(expectRes);
+            expect((0, miscellaneous_1.isSubdir)(parent, child)).toBe(expectRes);
         });
     });
     it('can correctly determine if subdir for windows-based paths', () => {
@@ -42,7 +42,7 @@ describe('isSubdir', () => {
             ['C:\\Foo', 'C:\\Bar', false],
             ['C:\\Foo', 'D:\\Foo\\Bar', false],
         ].forEach(([parent, child, expectRes]) => {
-            expect((0, utils_1.isSubdir)(parent, child)).toBe(expectRes);
+            expect((0, miscellaneous_1.isSubdir)(parent, child)).toBe(expectRes);
         });
     });
     afterEach(() => {
@@ -51,14 +51,14 @@ describe('isSubdir', () => {
 });
 describe('pathToFilename', () => {
     it('should use correct path separator', () => {
-        const processedPath = (0, utils_1.pathToFilename)('/user/createWithList', '_');
+        const processedPath = (0, miscellaneous_1.pathToFilename)('/user/createWithList', '_');
         expect(processedPath).toEqual('user_createWithList');
     });
 });
 describe('getFallbackApisOrExit', () => {
     it('should find alias by filename', () => __awaiter(void 0, void 0, void 0, function* () {
         fs_1.existsSync.mockImplementationOnce(() => true);
-        const entry = yield (0, utils_1.getFallbackApisOrExit)(['./test.yaml'], {
+        const entry = yield (0, miscellaneous_1.getFallbackApisOrExit)(['./test.yaml'], {
             apis: {
                 main: {
                     root: 'test.yaml',
@@ -82,17 +82,17 @@ describe('printConfigLintTotals', () => {
         jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
     });
     it('should print errors if such exist', () => {
-        (0, utils_1.printConfigLintTotals)(totalProblemsMock);
+        (0, miscellaneous_1.printConfigLintTotals)(totalProblemsMock);
         expect(process.stderr.write).toHaveBeenCalledWith('❌ Your config has 1 error.');
         expect(redColoretteMocks).toHaveBeenCalledWith('❌ Your config has 1 error.');
     });
     it('should print warnign if no error', () => {
-        (0, utils_1.printConfigLintTotals)(Object.assign(Object.assign({}, totalProblemsMock), { errors: 0, warnings: 2 }));
+        (0, miscellaneous_1.printConfigLintTotals)(Object.assign(Object.assign({}, 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, utils_1.printConfigLintTotals)(Object.assign(Object.assign({}, totalProblemsMock), { errors: 0 }));
+        const result = (0, miscellaneous_1.printConfigLintTotals)(Object.assign(Object.assign({}, totalProblemsMock), { errors: 0 }));
         expect(result).toBeUndefined();
         expect(process.stderr.write).toHaveBeenCalledTimes(0);
         expect(yellowColoretteMocks).toHaveBeenCalledTimes(0);
@@ -124,7 +124,7 @@ describe('getFallbackApisOrExit', () => {
         };
         expect.assertions(1);
         try {
-            yield (0, utils_1.getFallbackApisOrExit)([''], apisConfig);
+            yield (0, miscellaneous_1.getFallbackApisOrExit)([''], apisConfig);
         }
         catch (e) {
             expect(e.message).toEqual('Path cannot be empty.');
@@ -134,7 +134,7 @@ describe('getFallbackApisOrExit', () => {
         fs_1.existsSync.mockImplementationOnce(() => false);
         expect.assertions(3);
         try {
-            yield (0, utils_1.getFallbackApisOrExit)(undefined, config);
+            yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, config);
         }
         catch (e) {
             expect(process.stderr.write).toHaveBeenCalledWith('\nsomeFile.yaml does not exist or is invalid.\n\n');
@@ -145,7 +145,7 @@ describe('getFallbackApisOrExit', () => {
     it('should return valid array with results if such file exist', () => __awaiter(void 0, void 0, void 0, function* () {
         fs_1.existsSync.mockImplementationOnce(() => true);
         jest.spyOn(path, 'resolve').mockImplementationOnce((_, path) => path);
-        const result = yield (0, utils_1.getFallbackApisOrExit)(undefined, config);
+        const result = yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, config);
         expect(process.stderr.write).toHaveBeenCalledTimes(0);
         expect(process.exit).toHaveBeenCalledTimes(0);
         expect(result).toStrictEqual([
@@ -162,7 +162,7 @@ describe('getFallbackApisOrExit', () => {
         fs_1.existsSync.mockImplementationOnce(() => false);
         expect.assertions(3);
         try {
-            yield (0, utils_1.getFallbackApisOrExit)(['someFile.yaml'], apisConfig);
+            yield (0, miscellaneous_1.getFallbackApisOrExit)(['someFile.yaml'], apisConfig);
         }
         catch (e) {
             expect(process.stderr.write).toHaveBeenCalledWith('\nsomeFile.yaml does not exist or is invalid.\n\n');
@@ -177,7 +177,7 @@ describe('getFallbackApisOrExit', () => {
         fs_1.existsSync.mockImplementationOnce(() => false);
         expect.assertions(3);
         try {
-            yield (0, utils_1.getFallbackApisOrExit)(['someFile.yaml', 'someFile2.yaml'], apisConfig);
+            yield (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');
@@ -194,7 +194,7 @@ describe('getFallbackApisOrExit', () => {
         const existSyncMock = fs_1.existsSync.mockImplementation((path) => path.endsWith('someFile.yaml'));
         expect.assertions(4);
         try {
-            yield (0, utils_1.getFallbackApisOrExit)(undefined, configStub);
+            yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, configStub);
         }
         catch (e) {
             expect(process.stderr.write).toHaveBeenCalledWith('\nnotExist.yaml does not exist or is invalid.\n\n');
@@ -215,7 +215,7 @@ describe('getFallbackApisOrExit', () => {
                 },
             },
         };
-        const result = yield (0, utils_1.getFallbackApisOrExit)(undefined, apisConfig);
+        const result = yield (0, miscellaneous_1.getFallbackApisOrExit)(undefined, apisConfig);
         expect(process.stderr.write).toHaveBeenCalledTimes(0);
         expect(result).toStrictEqual([
             {
@@ -254,10 +254,10 @@ describe('langToExt', () => {
         ['typescript', '.ts'],
         ['tsx', '.tsx'],
     ])('should infer file extension from lang - %s', (lang, expected) => {
-        expect((0, utils_1.langToExt)(lang)).toBe(expected);
+        expect((0, miscellaneous_1.langToExt)(lang)).toBe(expected);
     });
     it('should ignore case when inferring file extension', () => {
-        expect((0, utils_1.langToExt)('JavaScript')).toBe('.js');
+        expect((0, miscellaneous_1.langToExt)('JavaScript')).toBe('.js');
     });
 });
 describe('sorTopLevelKeysForOas', () => {
@@ -288,7 +288,7 @@ describe('sorTopLevelKeysForOas', () => {
             'x-webhooks',
             'components',
         ];
-        const result = (0, utils_1.sortTopLevelKeysForOas)(openApi);
+        const result = (0, miscellaneous_1.sortTopLevelKeysForOas)(openApi);
         Object.keys(result).forEach((key, index) => {
             expect(key).toEqual(orderedKeys[index]);
         });
@@ -328,7 +328,7 @@ describe('sorTopLevelKeysForOas', () => {
             'responses',
             'securityDefinitions',
         ];
-        const result = (0, utils_1.sortTopLevelKeysForOas)(openApi);
+        const result = (0, miscellaneous_1.sortTopLevelKeysForOas)(openApi);
         Object.keys(result).forEach((key, index) => {
             expect(key).toEqual(orderedKeys[index]);
         });
@@ -349,31 +349,31 @@ describe('handleErrors', () => {
     });
     it('should handle ResolveError', () => {
         const resolveError = new openapi_core_1.ResolveError(new Error('File not found'));
-        expect(() => (0, utils_1.handleError)(resolveError, ref)).toThrowError(utils_1.HandledError);
+        expect(() => (0, miscellaneous_1.handleError)(resolveError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(redColoretteMocks).toHaveBeenCalledTimes(1);
         expect(process.stderr.write).toHaveBeenCalledWith(`Failed to resolve API description at openapi/test.yaml:\n\n  - File not found.\n\n`);
     });
     it('should handle YamlParseError', () => {
         const yamlParseError = new openapi_core_1.YamlParseError(new Error('Invalid yaml'), {});
-        expect(() => (0, utils_1.handleError)(yamlParseError, ref)).toThrowError(utils_1.HandledError);
+        expect(() => (0, miscellaneous_1.handleError)(yamlParseError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(redColoretteMocks).toHaveBeenCalledTimes(1);
         expect(process.stderr.write).toHaveBeenCalledWith(`Failed to parse API description at openapi/test.yaml:\n\n  - Invalid yaml.\n\n`);
     });
     it('should handle CircularJSONNotSupportedError', () => {
-        const circularError = new utils_1.CircularJSONNotSupportedError(new Error('Circular json'));
-        expect(() => (0, utils_1.handleError)(circularError, ref)).toThrowError(utils_1.HandledError);
+        const circularError = new miscellaneous_1.CircularJSONNotSupportedError(new Error('Circular json'));
+        expect(() => (0, miscellaneous_1.handleError)(circularError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(process.stderr.write).toHaveBeenCalledWith(`Detected circular reference which can't be converted to JSON.\n` +
             `Try to use ${(0, colorette_1.blue)('yaml')} output or remove ${(0, colorette_1.blue)('--dereferenced')}.\n\n`);
     });
     it('should handle SyntaxError', () => {
         const testError = new SyntaxError('Unexpected identifier');
         testError.stack = 'test stack';
-        expect(() => (0, utils_1.handleError)(testError, ref)).toThrowError(utils_1.HandledError);
+        expect(() => (0, miscellaneous_1.handleError)(testError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(process.stderr.write).toHaveBeenCalledWith('Syntax error: Unexpected identifier test stack\n\n');
     });
     it('should throw unknown error', () => {
         const testError = new Error('Test error');
-        expect(() => (0, utils_1.handleError)(testError, ref)).toThrowError(utils_1.HandledError);
+        expect(() => (0, miscellaneous_1.handleError)(testError, ref)).toThrowError(miscellaneous_1.HandledError);
         expect(process.stderr.write).toHaveBeenCalledWith(`Something went wrong when processing openapi/test.yaml:\n\n  - Test error.\n\n`);
     });
 });
@@ -391,7 +391,7 @@ describe('checkIfRulesetExist', () => {
             oas3_1: {},
             async2: {},
         };
-        expect(() => (0, utils_1.checkIfRulesetExist)(rules)).toThrowError('⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/');
+        expect(() => (0, miscellaneous_1.checkIfRulesetExist)(rules)).toThrowError('⚠️ No rules were configured. Learn how to configure rules: https://redocly.com/docs/cli/rules/');
     });
     it('should not throw an error if rules are provided', () => {
         const rules = {
@@ -399,13 +399,13 @@ describe('checkIfRulesetExist', () => {
             oas3_0: {},
             oas3_1: {},
         };
-        (0, utils_1.checkIfRulesetExist)(rules);
+        (0, miscellaneous_1.checkIfRulesetExist)(rules);
     });
 });
 describe('cleanColors', () => {
     it('should remove colors from string', () => {
         const stringWithColors = `String for ${(0, colorette_1.red)('test')}`;
-        const result = (0, utils_1.cleanColors)(stringWithColors);
+        const result = (0, miscellaneous_1.cleanColors)(stringWithColors);
         expect(result).not.toMatch(/\x1b\[\d+m/g);
     });
 });
@@ -427,7 +427,7 @@ describe('cleanArgs', () => {
             apis: ['main@v1', 'fixtures/openapi.yaml', 'http://some.url/openapi.yaml'],
             format: 'codeframe',
         };
-        expect((0, utils_1.cleanArgs)(testArgs)).toEqual({
+        expect((0, miscellaneous_1.cleanArgs)(testArgs)).toEqual({
             config: 'file-yaml',
             apis: ['api-name@api-version', 'file-yaml', 'http://url'],
             format: 'codeframe',
@@ -437,7 +437,7 @@ describe('cleanArgs', () => {
         const testArgs = {
             destination: '@org/name@version',
         };
-        expect((0, utils_1.cleanArgs)(testArgs)).toEqual({
+        expect((0, miscellaneous_1.cleanArgs)(testArgs)).toEqual({
             destination: '@organization/api-name@api-version',
         });
     });
@@ -465,7 +465,7 @@ describe('cleanRawInput', () => {
             '--output',
             'fixtures',
         ];
-        expect((0, utils_1.cleanRawInput)(rawInput)).toEqual('redocly bundle api-name@api-version file-yaml http://url --config=file-yaml --output folder');
+        expect((0, miscellaneous_1.cleanRawInput)(rawInput)).toEqual('redocly bundle api-name@api-version file-yaml http://url --config=file-yaml --output folder');
     });
     it('should preserve safe data from raw CLI input', () => {
         const rawInput = [
@@ -478,16 +478,16 @@ describe('cleanRawInput', () => {
             '--skip-rule',
             'operation-4xx-response',
         ];
-        expect((0, utils_1.cleanRawInput)(rawInput)).toEqual('redocly lint file-json --format stylish --extends=minimal --skip-rule operation-4xx-response');
+        expect((0, miscellaneous_1.cleanRawInput)(rawInput)).toEqual('redocly lint file-json --format stylish --extends=minimal --skip-rule operation-4xx-response');
     });
     describe('validateFileExtension', () => {
         it('should return current file extension', () => {
-            expect((0, utils_1.getAndValidateFileExtension)('test.json')).toEqual('json');
+            expect((0, miscellaneous_1.getAndValidateFileExtension)('test.json')).toEqual('json');
         });
         it('should return yaml and print warning if file extension does not supported', () => {
             const stderrMock = jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
             colorette_1.yellow.mockImplementation((text) => text);
-            expect((0, utils_1.getAndValidateFileExtension)('test.xml')).toEqual('yaml');
+            expect((0, miscellaneous_1.getAndValidateFileExtension)('test.xml')).toEqual('yaml');
             expect(stderrMock).toHaveBeenCalledWith(`Unsupported file extension: xml. Using yaml.\n`);
         });
     });
@@ -500,13 +500,13 @@ describe('cleanRawInput', () => {
             jest.restoreAllMocks();
         });
         it('should call stringifyYaml function', () => {
-            (0, utils_1.writeToFileByExtension)('test data', 'test.yaml');
+            (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, utils_1.writeToFileByExtension)('test data', 'test.json');
+            (0, miscellaneous_1.writeToFileByExtension)('test data', 'test.json');
             expect(stringifySpy).toHaveBeenCalledWith('test data', null, 2);
             expect(process.stderr.write).toHaveBeenCalledWith(`test data`);
         });

package/lib/__tests__/wrapper.test.js

@@ -9,13 +9,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("../utils");
+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");
 jest.mock('node-fetch');
-jest.mock('../utils', () => ({
+jest.mock('../utils/miscellaneous', () => ({
     sendTelemetry: jest.fn(),
     loadConfigAndHandleErrors: jest.fn(),
 }));
@@ -25,29 +25,29 @@ jest.mock('../commands/lint', () => ({
 }));
 describe('commandWrapper', () => {
     it('should send telemetry if there is "telemetry: on" in the config', () => __awaiter(void 0, void 0, void 0, function* () {
-        utils_1.loadConfigAndHandleErrors.mockImplementation(() => {
+        miscellaneous_1.loadConfigAndHandleErrors.mockImplementation(() => {
             return { telemetry: 'on', styleguide: { recommendedFallback: true } };
         });
         process.env.REDOCLY_TELEMETRY = 'on';
         const wrappedHandler = (0, wrapper_1.commandWrapper)(lint_1.handleLint);
         yield wrappedHandler({});
         expect(lint_1.handleLint).toHaveBeenCalledTimes(1);
-        expect(utils_1.sendTelemetry).toHaveBeenCalledTimes(1);
-        expect(utils_1.sendTelemetry).toHaveBeenCalledWith({}, 0, false);
+        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* () {
-        utils_1.loadConfigAndHandleErrors.mockImplementation(() => {
+        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({});
         expect(lint_1.handleLint).toHaveBeenCalledTimes(1);
-        expect(utils_1.sendTelemetry).toHaveBeenCalledTimes(0);
+        expect(miscellaneous_1.sendTelemetry).toHaveBeenCalledTimes(0);
     }));
     it('should pass files from arguments to config', () => __awaiter(void 0, void 0, void 0, function* () {
         const filesToPush = ['test1.yaml', 'test2.yaml'];
-        const loadConfigMock = utils_1.loadConfigAndHandleErrors;
+        const loadConfigMock = miscellaneous_1.loadConfigAndHandleErrors;
         const argv = {
             files: filesToPush,
         };

package/lib/cms/api/__tests__/api-keys.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/cms/api/__tests__/api-keys.test.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const api_keys_1 = require("../api-keys");
+const fs = require("fs");
+describe('getApiKeys()', () => {
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+    it('should return api key from environment variable', () => {
+        process.env.REDOCLY_AUTHORIZATION = 'test-api-key';
+        expect((0, api_keys_1.getApiKeys)('test-domain')).toEqual('test-api-key');
+    });
+    it('should return api key from credentials file', () => {
+        process.env.REDOCLY_AUTHORIZATION = '';
+        jest.spyOn(fs, 'existsSync').mockReturnValue(true);
+        jest.spyOn(fs, 'readFileSync').mockReturnValue(JSON.stringify({
+            ['test-domain']: 'test-api-key-from-credentials-file',
+        }));
+        expect((0, api_keys_1.getApiKeys)('test-domain')).toEqual('test-api-key-from-credentials-file');
+    });
+    it('should throw an error if no api key provided', () => {
+        process.env.REDOCLY_AUTHORIZATION = '';
+        jest.spyOn(fs, 'existsSync').mockReturnValue(false);
+        expect(() => (0, api_keys_1.getApiKeys)('test-domain')).toThrowError('No api key provided, please use environment variable REDOCLY_AUTHORIZATION.');
+    });
+});

package/lib/cms/api/__tests__/api.client.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,217 @@
+"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");
+const api_client_1 = require("../api-client");
+jest.mock('node-fetch', () => ({
+    default: jest.fn(),
+}));
+function mockFetchResponse(response) {
+    node_fetch_1.default.mockResolvedValue(response);
+}
+describe('ApiClient', () => {
+    const testToken = 'test-token';
+    const testDomain = 'test-domain.com';
+    const testOrg = 'test-org';
+    const testProject = 'test-project';
+    describe('getDefaultBranch()', () => {
+        let apiClient;
+        beforeEach(() => {
+            apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
+        });
+        it('should get default project branch', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockFetchResponse({
+                ok: true,
+                json: jest.fn().mockResolvedValue({
+                    branchName: 'test-branch',
+                }),
+            });
+            const result = yield apiClient.remotes.getDefaultBranch(testOrg, testProject);
+            expect(node_fetch_1.default).toHaveBeenCalledWith(`${testDomain}/api/orgs/${testOrg}/projects/${testProject}/source`, {
+                method: 'GET',
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${testToken}`,
+                },
+            });
+            expect(result).toEqual('test-branch');
+        }));
+        it('should throw parsed error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockFetchResponse({
+                ok: false,
+                json: jest.fn().mockResolvedValue({
+                    type: 'about:blank',
+                    title: 'Project source not found',
+                    status: 404,
+                    detail: 'Not Found',
+                    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* () {
+            mockFetchResponse({
+                ok: false,
+                statusText: 'Not found',
+                json: jest.fn().mockResolvedValue({
+                    unknownField: 'unknown-error',
+                }),
+            });
+            yield expect(apiClient.remotes.getDefaultBranch(testOrg, testProject)).rejects.toThrow(new Error('Failed to fetch default branch: Not found'));
+        }));
+    });
+    describe('upsert()', () => {
+        const remotePayload = {
+            mountBranchName: 'remote-mount-branch-name',
+            mountPath: 'remote-mount-path',
+        };
+        let apiClient;
+        beforeEach(() => {
+            apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
+        });
+        it('should upsert remote', () => __awaiter(void 0, void 0, void 0, function* () {
+            const responseMock = {
+                id: 'remote-id',
+                type: 'CICD',
+                mountPath: 'remote-mount-path',
+                mountBranchName: 'remote-mount-branch-name',
+                organizationId: testOrg,
+                projectId: testProject,
+            };
+            mockFetchResponse({
+                ok: true,
+                json: jest.fn().mockResolvedValue(responseMock),
+            });
+            const result = yield apiClient.remotes.upsert(testOrg, testProject, remotePayload);
+            expect(node_fetch_1.default).toHaveBeenCalledWith(`${testDomain}/api/orgs/${testOrg}/projects/${testProject}/remotes`, {
+                method: 'POST',
+                headers: {
+                    'Content-Type': 'application/json',
+                    Authorization: `Bearer ${testToken}`,
+                },
+                body: JSON.stringify({
+                    mountPath: remotePayload.mountPath,
+                    mountBranchName: remotePayload.mountBranchName,
+                    type: 'CICD',
+                    autoMerge: true,
+                }),
+            });
+            expect(result).toEqual(responseMock);
+        }));
+        it('should throw parsed error if response is not ok', () => __awaiter(void 0, void 0, void 0, function* () {
+            mockFetchResponse({
+                ok: false,
+                json: jest.fn().mockResolvedValue({
+                    type: 'about:blank',
+                    title: 'Not allowed to mount remote outside of project content path: /docs',
+                    status: 403,
+                    detail: 'Forbidden',
+                    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* () {
+            mockFetchResponse({
+                ok: false,
+                statusText: 'Not found',
+                json: jest.fn().mockResolvedValue({
+                    unknownField: 'unknown-error',
+                }),
+            });
+            yield expect(apiClient.remotes.upsert(testOrg, testProject, remotePayload)).rejects.toThrow(new Error('Failed to upsert remote: Not found'));
+        }));
+    });
+    describe('push()', () => {
+        const testRemoteId = 'test-remote-id';
+        const pushPayload = {
+            remoteId: testRemoteId,
+            commit: {
+                message: 'test-message',
+                author: {
+                    name: 'test-name',
+                    email: 'test-email',
+                },
+                branchName: 'test-branch-name',
+            },
+        };
+        const filesMock = [{ path: 'some-file.yaml', stream: Buffer.from('fefef') }];
+        const responseMock = {
+            branchName: 'rem/cicd/rem_01he7sr6ys2agb7w0g9t7978fn-main',
+            hasChanges: true,
+            files: [
+                {
+                    type: 'file',
+                    name: 'some-file.yaml',
+                    path: 'docs/remotes/some-file.yaml',
+                    lastModified: 1698925132394.2993,
+                    mimeType: 'text/yaml',
+                },
+            ],
+            commitSha: 'bb23a2f8e012ac0b7b9961b57fb40d8686b21b43',
+            outdated: false,
+        };
+        let apiClient;
+        beforeEach(() => {
+            apiClient = new api_client_1.ReuniteApiClient(testDomain, testToken);
+        });
+        it('should push to remote', () => __awaiter(void 0, void 0, void 0, function* () {
+            let passedFormData = new FormData();
+            node_fetch_1.default.mockImplementationOnce((_, options) => __awaiter(void 0, void 0, void 0, function* () {
+                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);
+            formData.append('commit[author][name]', pushPayload.commit.author.name);
+            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);
+            expect(node_fetch_1.default).toHaveBeenCalledWith(`${testDomain}/api/orgs/${testOrg}/projects/${testProject}/pushes`, expect.objectContaining({
+                method: 'POST',
+                headers: {
+                    Authorization: `Bearer ${testToken}`,
+                },
+            }));
+            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* () {
+            mockFetchResponse({
+                ok: false,
+                json: jest.fn().mockResolvedValue({
+                    type: 'about:blank',
+                    title: 'Cannot push to remote',
+                    status: 403,
+                    detail: 'Forbidden',
+                    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* () {
+            mockFetchResponse({
+                ok: false,
+                statusText: 'Not found',
+                json: jest.fn().mockResolvedValue({
+                    unknownField: 'unknown-error',
+                }),
+            });
+            yield expect(apiClient.remotes.push(testOrg, testProject, pushPayload, filesMock)).rejects.toThrow(new Error('Failed to push: Not found'));
+        }));
+    });
+});

package/lib/cms/api/__tests__/domains.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const domains_1 = require("../domains");
+describe('getDomain()', () => {
+    it('should return the domain from environment variable', () => {
+        process.env.REDOCLY_DOMAIN = 'test-domain';
+        expect((0, domains_1.getDomain)()).toBe('test-domain');
+    });
+    it('should return the default domain if no domain provided', () => {
+        process.env.REDOCLY_DOMAIN = '';
+        expect((0, domains_1.getDomain)()).toBe('https://app.cloud.redocly.com');
+    });
+});

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

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import type { ReadStream } from 'fs';
+import type { ListRemotesResponse, PushResponse, UpsertRemoteResponse } from './types';
+declare class RemotesApiClient {
+    private readonly domain;
+    private readonly apiKey;
+    constructor(domain: string, apiKey: string);
+    private getParsedResponse;
+    getDefaultBranch(organizationId: string, projectId: string): Promise<string>;
+    upsert(organizationId: string, projectId: string, remote: {
+        mountPath: string;
+        mountBranchName: string;
+    }): Promise<UpsertRemoteResponse>;
+    push(organizationId: string, projectId: string, payload: PushPayload, files: {
+        path: string;
+        stream: ReadStream | Buffer;
+    }[]): Promise<PushResponse>;
+    getRemotesList(organizationId: string, projectId: string, mountPath: string): Promise<ListRemotesResponse>;
+    getPush({ organizationId, projectId, pushId, }: {
+        organizationId: string;
+        projectId: string;
+        pushId: string;
+    }): Promise<PushResponse>;
+}
+export declare class ReuniteApiClient {
+    domain: string;
+    private readonly apiKey;
+    remotes: RemotesApiClient;
+    constructor(domain: string, apiKey: string);
+}
+export type PushPayload = {
+    remoteId: string;
+    commit: {
+        message: string;
+        branchName: string;
+        sha?: string;
+        url?: string;
+        createdAt?: string;
+        namespace?: string;
+        repository?: string;
+        author: {
+            name: string;
+            email: string;
+            image?: string;
+        };
+    };
+    isMainBranch?: boolean;
+};
+export {};