npm - @redocly/cli - Versions diffs - 1.0.0-beta.109 → 1.0.0-beta.111 - Mend

@redocly/cli 1.0.0-beta.109 → 1.0.0-beta.111

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

package/lib/__mocks__/fs.d.ts +2 -0
package/lib/__mocks__/fs.js +3 -1
package/lib/__mocks__/redoc.d.ts +7 -0
package/lib/__mocks__/redoc.js +5 -0
package/lib/__tests__/commands/build-docs.test.d.ts +1 -0
package/lib/__tests__/commands/build-docs.test.js +61 -0
package/lib/__tests__/commands/lint.test.js +10 -2
package/lib/__tests__/commands/push.test.js +28 -0
package/lib/__tests__/utils.test.js +21 -0
package/lib/commands/build-docs/index.d.ts +2 -0
package/lib/commands/build-docs/index.js +50 -0
package/lib/commands/build-docs/template.hbs +23 -0
package/lib/commands/build-docs/types.d.ts +25 -0
package/lib/commands/build-docs/types.js +2 -0
package/lib/commands/build-docs/utils.d.ts +8 -0
package/lib/commands/build-docs/utils.js +100 -0
package/lib/commands/bundle.js +1 -1
package/lib/commands/lint.js +5 -1
package/lib/commands/preview-docs/index.d.ts +1 -1
package/lib/commands/preview-docs/index.js +1 -1
package/lib/commands/push.d.ts +1 -0
package/lib/commands/push.js +15 -3
package/lib/commands/stats.js +1 -1
package/lib/index.js +59 -0
package/lib/utils.js +8 -2
package/package.json +13 -6
package/src/__mocks__/fs.ts +2 -0
package/src/__mocks__/redoc.ts +2 -0
package/src/__tests__/commands/build-docs.test.ts +61 -0
package/src/__tests__/commands/lint.test.ts +10 -2
package/src/__tests__/commands/push.test.ts +33 -1
package/src/__tests__/utils.test.ts +14 -1
package/src/commands/build-docs/index.ts +49 -0
package/src/commands/build-docs/template.hbs +23 -0
package/src/commands/build-docs/types.ts +26 -0
package/src/commands/build-docs/utils.ts +112 -0
package/src/commands/bundle.ts +1 -1
package/src/commands/lint.ts +5 -5
package/src/commands/preview-docs/index.ts +2 -2
package/src/commands/push.ts +17 -3
package/src/commands/stats.ts +1 -1
package/src/custom.d.ts +1 -0
package/src/index.ts +67 -0
package/src/utils.ts +8 -1
package/tsconfig.tsbuildinfo +1 -1

package/lib/__mocks__/fs.d.ts CHANGED Viewed

@@ -5,3 +5,5 @@ export declare const statSync: jest.Mock<{
     size: number;
 }, []>;
 export declare const createReadStream: jest.Mock<any, any>;
+export declare const writeFileSync: jest.Mock<any, any>;
+export declare const mkdirSync: jest.Mock<any, any>;

package/lib/__mocks__/fs.js CHANGED Viewed

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createReadStream = exports.statSync = exports.readFileSync = exports.existsSync = void 0;
+exports.mkdirSync = exports.writeFileSync = exports.createReadStream = exports.statSync = exports.readFileSync = exports.existsSync = void 0;
 exports.existsSync = jest.fn();
 exports.readFileSync = jest.fn(() => '');
 exports.statSync = jest.fn(() => ({ size: 0 }));
 exports.createReadStream = jest.fn();
+exports.writeFileSync = jest.fn();
+exports.mkdirSync = jest.fn();

package/lib/__mocks__/redoc.d.ts ADDED Viewed

@@ -0,0 +1,7 @@
+/// <reference types="jest" />
+export declare const loadAndBundleSpec: jest.Mock<Promise<{
+    openapi: string;
+}>, []>;
+export declare const createStore: jest.Mock<Promise<{
+    toJS: jest.Mock<string, []>;
+}>, []>;

package/lib/__mocks__/redoc.js ADDED Viewed

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStore = exports.loadAndBundleSpec = void 0;
+exports.loadAndBundleSpec = jest.fn(() => Promise.resolve({ openapi: '3.0.0' }));
+exports.createStore = jest.fn(() => Promise.resolve({ toJS: jest.fn(() => '{}') }));

package/lib/__tests__/commands/build-docs.test.d.ts ADDED Viewed

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

package/lib/__tests__/commands/build-docs.test.js ADDED Viewed

@@ -0,0 +1,61 @@
+"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 redoc_1 = require("redoc");
+const server_1 = require("react-dom/server");
+const build_docs_1 = require("../../commands/build-docs");
+const utils_1 = require("../../commands/build-docs/utils");
+const utils_2 = require("../../utils");
+jest.mock('redoc');
+jest.mock('fs');
+jest.mock('../../utils');
+const config = {
+    output: '',
+    cdn: false,
+    title: 'Test',
+    disableGoogleFont: false,
+    templateFileName: '',
+    templateOptions: {},
+    redocOptions: {},
+};
+jest.mock('react-dom/server', () => ({
+    renderToString: jest.fn(),
+}));
+jest.mock('handlebars', () => ({
+    compile: jest.fn(() => jest.fn(() => '<html></html>')),
+}));
+jest.mock('mkdirp', () => ({
+    sync: jest.fn(),
+}));
+describe('build-docs', () => {
+    it('should return correct html and call function for ssr', () => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield utils_1.getPageHTML({}, '../some-path/openapi.yaml', Object.assign(Object.assign({}, config), { redocCurrentVersion: '2.0.0' }));
+        expect(server_1.renderToString).toBeCalledTimes(1);
+        expect(redoc_1.createStore).toBeCalledTimes(1);
+        expect(result).toBe('<html></html>');
+    }));
+    it('should work correctly when calling handlerBuildCommand', () => __awaiter(void 0, void 0, void 0, function* () {
+        const processExitMock = jest.spyOn(process, 'exit').mockImplementation();
+        yield build_docs_1.handlerBuildCommand({
+            o: '',
+            cdn: false,
+            title: 'test',
+            disableGoogleFont: false,
+            template: '',
+            templateOptions: {},
+            features: { openapi: {} },
+            api: '../some-path/openapi.yaml',
+        });
+        expect(redoc_1.loadAndBundleSpec).toBeCalledTimes(1);
+        expect(utils_2.getFallbackApisOrExit).toBeCalledTimes(1);
+        expect(processExitMock).toBeCalledTimes(0);
+    }));
+});

package/lib/__tests__/commands/lint.test.js CHANGED Viewed

@@ -49,12 +49,20 @@ describe('handleLint', () => {
         }));
         it('should call loadConfig and getFallbackApisOrExit', () => __awaiter(void 0, void 0, void 0, function* () {
             yield lint_1.handleLint(argvMock, versionMock);
-            expect(openapi_core_1.loadConfig).toHaveBeenCalledWith(undefined, undefined, undefined);
+            expect(openapi_core_1.loadConfig).toHaveBeenCalledWith({
+                configPath: undefined,
+                customExtends: undefined,
+                processRawConfig: undefined,
+            });
             expect(utils_1.getFallbackApisOrExit).toHaveBeenCalled();
         }));
         it('should call loadConfig with args if such exist', () => __awaiter(void 0, void 0, void 0, function* () {
             yield lint_1.handleLint(Object.assign(Object.assign({}, argvMock), { config: 'redocly.yaml', extends: ['some/path'] }), versionMock);
-            expect(openapi_core_1.loadConfig).toHaveBeenCalledWith('redocly.yaml', ['some/path'], undefined);
+            expect(openapi_core_1.loadConfig).toHaveBeenCalledWith({
+                configPath: 'redocly.yaml',
+                customExtends: ['some/path'],
+                processRawConfig: undefined,
+            });
         }));
         it('should call mergedConfig with clear ignore if `generate-ignore-file` argv', () => __awaiter(void 0, void 0, void 0, function* () {
             yield lint_1.handleLint(Object.assign(Object.assign({}, argvMock), { 'generate-ignore-file': true }), versionMock);

package/lib/__tests__/commands/push.test.js CHANGED Viewed

@@ -9,9 +9,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
 const openapi_core_1 = require("@redocly/openapi-core");
 const utils_1 = require("../../utils");
 const push_1 = require("../../commands/push");
+const config_1 = require("../fixtures/config");
 jest.mock('fs');
 jest.mock('node-fetch', () => ({
     default: jest.fn(() => ({
@@ -76,6 +78,32 @@ describe('push', () => {
         });
         expect(utils_1.exitWithError).toBeCalledTimes(1);
     }));
+    it('push with --files', () => __awaiter(void 0, void 0, void 0, function* () {
+        openapi_core_1.loadConfig.mockImplementation(({ files }) => {
+            return Object.assign(Object.assign({}, config_1.ConfigFixture), { files });
+        });
+        //@ts-ignore
+        fs.statSync.mockImplementation(() => {
+            return { isDirectory: () => false, size: 10 };
+        });
+        yield push_1.handlePush({
+            upsert: true,
+            api: 'spec.json',
+            destination: '@org/my-api@1.0.0',
+            public: true,
+            files: ['./resouces/1.md', './resouces/2.md'],
+        });
+        expect(redoclyClient.registryApi.pushApi).toHaveBeenLastCalledWith({
+            filePaths: ['filePath', 'filePath', 'filePath'],
+            isUpsert: true,
+            isPublic: true,
+            name: 'my-api',
+            organizationId: 'org',
+            rootFilePath: 'filePath',
+            version: '1.0.0',
+        });
+        expect(redoclyClient.registryApi.prepareFileUpload).toBeCalledTimes(3);
+    }));
 });
 describe('transformPush', () => {
     it('should adapt the existing syntax', () => {

package/lib/__tests__/utils.test.js CHANGED Viewed

@@ -1,4 +1,13 @@
 "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 utils_1 = require("../utils");
 const colorette_1 = require("colorette");
@@ -41,6 +50,18 @@ describe('pathToFilename', () => {
         expect(processedPath).toEqual('user_createWithList');
     });
 });
+describe('getFallbackApisOrExit', () => {
+    it('should find alias by filename', () => __awaiter(void 0, void 0, void 0, function* () {
+        const entry = yield utils_1.getFallbackApisOrExit(['./test.yaml'], {
+            apis: {
+                main: {
+                    root: 'test.yaml',
+                },
+            },
+        });
+        expect(entry).toEqual([{ path: './test.yaml', alias: 'main' }]);
+    }));
+});
 describe('printConfigLintTotals', () => {
     const totalProblemsMock = {
         errors: 1,

package/lib/commands/build-docs/index.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ import type { BuildDocsArgv } from './types';
2	+ export declare const handlerBuildCommand: (argv: BuildDocsArgv) => Promise<void>;

package/lib/commands/build-docs/index.js ADDED Viewed

@@ -0,0 +1,50 @@
+"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 });
+exports.handlerBuildCommand = void 0;
+const redoc_1 = require("redoc");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const perf_hooks_1 = require("perf_hooks");
+const utils_1 = require("./utils");
+const utils_2 = require("../../utils");
+const openapi_core_1 = require("@redocly/openapi-core");
+const handlerBuildCommand = (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    const startedAt = perf_hooks_1.performance.now();
+    const configFromFile = yield openapi_core_1.loadConfig({ configPath: argv.config });
+    const config = openapi_core_1.getMergedConfig(configFromFile, argv.api);
+    const apis = yield utils_2.getFallbackApisOrExit(argv.api ? [argv.api] : [], config);
+    const { path: pathToApi } = apis[0];
+    const options = {
+        output: argv.o,
+        cdn: argv.cdn,
+        title: argv.title,
+        disableGoogleFont: argv.disableGoogleFont,
+        templateFileName: argv.template,
+        templateOptions: argv.templateOptions || {},
+        redocOptions: utils_1.getObjectOrJSON((_a = argv.features) === null || _a === void 0 ? void 0 : _a.openapi, config),
+    };
+    const redocCurrentVersion = require('../../../package.json').dependencies.redoc.substring(1); // remove ~
+    try {
+        const elapsed = utils_2.getExecutionTime(startedAt);
+        const api = yield redoc_1.loadAndBundleSpec(utils_1.isURL(pathToApi) ? pathToApi : path_1.resolve(argv.config ? path_1.dirname(argv.config) : '', pathToApi));
+        const pageHTML = yield utils_1.getPageHTML(api, pathToApi, Object.assign(Object.assign({}, options), { redocCurrentVersion }));
+        fs_1.mkdirSync(path_1.dirname(options.output), { recursive: true });
+        fs_1.writeFileSync(options.output, pageHTML);
+        const sizeInKiB = Math.ceil(Buffer.byteLength(pageHTML) / 1024);
+        process.stderr.write(`\n🎉 bundled successfully in: ${options.output} (${sizeInKiB} KiB) [⏱ ${elapsed}].\n`);
+    }
+    catch (e) {
+        utils_2.exitWithError(e);
+    }
+});
+exports.handlerBuildCommand = handlerBuildCommand;

package/lib/commands/build-docs/template.hbs ADDED Viewed

@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf8" />
+  <title>{{title}}</title>
+  <!-- needed for adaptive design -->
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <style>
+    body {
+      padding: 0;
+      margin: 0;
+    }
+  </style>
+  {{{redocHead}}}
+  {{#unless disableGoogleFont}}<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">{{/unless}}
+</head>
+<body>
+  {{{redocHTML}}}
+</body>
+</html>

package/lib/commands/build-docs/types.d.ts ADDED Viewed

@@ -0,0 +1,25 @@
+export declare type BuildDocsOptions = {
+    watch?: boolean;
+    cdn?: boolean;
+    output?: string;
+    title?: string;
+    disableGoogleFont?: boolean;
+    port?: number;
+    templateFileName?: string;
+    templateOptions?: any;
+    redocOptions?: any;
+    redocCurrentVersion: string;
+};
+export declare type BuildDocsArgv = {
+    api: string;
+    o: string;
+    cdn: boolean;
+    title?: string;
+    disableGoogleFont?: boolean;
+    template?: string;
+    templateOptions: Record<string, any>;
+    features: {
+        openapi: string | Record<string, unknown>;
+    };
+    config?: string;
+};

package/lib/commands/build-docs/types.js ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ "use strict";
2	+ Object.defineProperty(exports, "__esModule", { value: true });

package/lib/commands/build-docs/utils.d.ts ADDED Viewed

@@ -0,0 +1,8 @@
+import type { BuildDocsOptions } from './types';
+import type { Config } from '@redocly/openapi-core';
+export declare function getObjectOrJSON(openapiOptions: string | Record<string, unknown>, config: Config): JSON | Record<string, unknown> | Config;
+export declare function getPageHTML(api: any, pathToApi: string, { cdn, title, disableGoogleFont, templateFileName, templateOptions, redocOptions, redocCurrentVersion, }: BuildDocsOptions): Promise<string>;
+export declare function isURL(str: string): boolean;
+export declare function sanitizeJSONString(str: string): string;
+export declare function escapeClosingScriptTag(str: string): string;
+export declare function escapeUnicode(str: string): string;

package/lib/commands/build-docs/utils.js ADDED Viewed

@@ -0,0 +1,100 @@
+"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 });
+exports.escapeUnicode = exports.escapeClosingScriptTag = exports.sanitizeJSONString = exports.isURL = exports.getPageHTML = exports.getObjectOrJSON = void 0;
+const React = require("react");
+const redoc_1 = require("redoc");
+const server_1 = require("react-dom/server");
+const styled_components_1 = require("styled-components");
+const handlebars_1 = require("handlebars");
+const path_1 = require("path");
+const fs_1 = require("fs");
+const colorette_1 = require("colorette");
+const utils_1 = require("../../utils");
+function getObjectOrJSON(openapiOptions, config) {
+    switch (typeof openapiOptions) {
+        case 'object':
+            return openapiOptions;
+        case 'string':
+            try {
+                if (fs_1.existsSync(openapiOptions) && fs_1.lstatSync(openapiOptions).isFile()) {
+                    return JSON.parse(fs_1.readFileSync(openapiOptions, 'utf-8'));
+                }
+                else {
+                    return JSON.parse(openapiOptions);
+                }
+            }
+            catch (e) {
+                process.stderr.write(colorette_1.red(`Encountered error:\n\n${openapiOptions}\n\nis neither a file with a valid JSON object neither a stringified JSON object.`));
+                utils_1.exitWithError(e);
+            }
+            break;
+        default: {
+            if (config) {
+                process.stderr.write(`Found ${config.configFile} and using features.openapi options`);
+                return config['features.openapi'];
+            }
+            return {};
+        }
+    }
+    return {};
+}
+exports.getObjectOrJSON = getObjectOrJSON;
+function getPageHTML(api, pathToApi, { cdn, title, disableGoogleFont, templateFileName, templateOptions, redocOptions = {}, redocCurrentVersion, }) {
+    return __awaiter(this, void 0, void 0, function* () {
+        process.stderr.write('Prerendering docs');
+        const apiUrl = redocOptions.specUrl || (isURL(pathToApi) ? pathToApi : undefined);
+        const store = yield redoc_1.createStore(api, apiUrl, redocOptions);
+        const sheet = new styled_components_1.ServerStyleSheet();
+        const html = server_1.renderToString(sheet.collectStyles(React.createElement(redoc_1.Redoc, { store })));
+        const state = yield store.toJS();
+        const css = sheet.getStyleTags();
+        templateFileName = templateFileName ? templateFileName : path_1.join(__dirname, './template.hbs');
+        const template = handlebars_1.compile(fs_1.readFileSync(templateFileName).toString());
+        return template({
+            redocHTML: `
+      <div id="redoc">${html || ''}</div>
+      <script>
+      ${`const __redoc_state = ${sanitizeJSONString(JSON.stringify(state))};` || ''}
+      var container = document.getElementById('redoc');
+      Redoc.${'hydrate(__redoc_state, container)'};
+      </script>`,
+            redocHead: (cdn
+                ? '<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>'
+                : `<script src="https://cdn.redoc.ly/redoc/v${redocCurrentVersion}/bundles/redoc.standalone.js"></script>`) +
+                css,
+            title: title || api.info.title || 'ReDoc documentation',
+            disableGoogleFont,
+            templateOptions,
+        });
+    });
+}
+exports.getPageHTML = getPageHTML;
+function isURL(str) {
+    return /^(https?:)\/\//m.test(str);
+}
+exports.isURL = isURL;
+function sanitizeJSONString(str) {
+    return escapeClosingScriptTag(escapeUnicode(str));
+}
+exports.sanitizeJSONString = sanitizeJSONString;
+// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/
+function escapeClosingScriptTag(str) {
+    return str.replace(/<\/script>/g, '<\\/script>');
+}
+exports.escapeClosingScriptTag = escapeClosingScriptTag;
+// see http://www.thespanner.co.uk/2011/07/25/the-json-specification-is-now-wrong/
+function escapeUnicode(str) {
+    return str.replace(/\u2028|\u2029/g, (m) => '\\u202' + (m === '\u2028' ? '8' : '9'));
+}
+exports.escapeUnicode = escapeUnicode;

package/lib/commands/bundle.js CHANGED Viewed

@@ -29,7 +29,7 @@ const fs_1 = require("fs");
 function handleBundle(argv, version) {
     var _a, _b, _c, _d;
     return __awaiter(this, void 0, void 0, function* () {
-        const config = yield openapi_core_1.loadConfig(argv.config, argv.extends);
+        const config = yield openapi_core_1.loadConfig({ configPath: argv.config, customExtends: argv.extends });
         const removeUnusedComponents = argv['remove-unused-components'] &&
             !((_b = (_a = config.rawConfig.styleguide) === null || _a === void 0 ? void 0 : _a.decorators) === null || _b === void 0 ? void 0 : _b.hasOwnProperty('remove-unused-components'));
         const apis = yield utils_1.getFallbackApisOrExit(argv.apis, config);

package/lib/commands/lint.js CHANGED Viewed

@@ -19,7 +19,11 @@ function handleLint(argv, version) {
         if (argv.config && !openapi_core_1.doesYamlFileExist(argv.config)) {
             return utils_1.exitWithError('Please, provide valid path to the configuration file');
         }
-        const config = yield openapi_core_1.loadConfig(argv.config, argv.extends, lintConfigCallback(argv, version));
+        const config = yield openapi_core_1.loadConfig({
+            configPath: argv.config,
+            customExtends: argv.extends,
+            processRawConfig: lintConfigCallback(argv, version),
+        });
         const apis = yield utils_1.getFallbackApisOrExit(argv.apis, config);
         if (argv['generate-ignore-file']) {
             config.styleguide.ignore = {}; // clear ignore

package/lib/commands/preview-docs/index.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import type { Skips } from 'cli/src/types';
+import type { Skips } from '../../types';
 export declare function previewDocs(argv: {
     port: number;
     host: string;

package/lib/commands/preview-docs/index.js CHANGED Viewed

@@ -94,7 +94,7 @@ function previewDocs(argv) {
         });
         function reloadConfig() {
             return __awaiter(this, void 0, void 0, function* () {
-                const config = yield openapi_core_1.loadConfig(argv.config);
+                const config = yield openapi_core_1.loadConfig({ configPath: argv.config });
                 const redoclyClient = new openapi_core_1.RedoclyClient();
                 isAuthorizedWithRedocly = yield redoclyClient.isAuthorizedWithRedocly();
                 const resolvedConfig = openapi_core_1.getMergedConfig(config, argv.api);

package/lib/commands/push.d.ts CHANGED Viewed

@@ -9,6 +9,7 @@ declare type PushArgs = {
     region?: Region;
     'skip-decorator'?: string[];
     public?: boolean;
+    files?: string[];
 };
 export declare function handlePush(argv: PushArgs): Promise<void>;
 export declare function getDestinationProps(destination: string | undefined, organization: string | undefined): (string | undefined)[];

package/lib/commands/push.js CHANGED Viewed

@@ -33,9 +33,8 @@ const login_1 = require("./login");
 const DEFAULT_VERSION = 'latest';
 function handlePush(argv) {
     return __awaiter(this, void 0, void 0, function* () {
-        const config = yield openapi_core_1.loadConfig();
-        const region = argv.region || config.region;
-        const client = new openapi_core_1.RedoclyClient(region);
+        const config = yield openapi_core_1.loadConfig({ region: argv.region, files: argv.files });
+        const client = new openapi_core_1.RedoclyClient(config.region);
         const isAuthorized = yield client.isAuthorizedWithRedoclyByRegion();
         if (!isAuthorized) {
             const clientToken = yield login_1.promptClientToken(client.domain);
@@ -182,6 +181,19 @@ function collectFilesToUpload(api, config) {
             }
             files.push(...filterPluginFilesByExt(Array.from(pluginFiles)).map((f) => getFileEntry(f)));
         }
+        if (config.files) {
+            const otherFiles = new Set();
+            for (const file of config.files) {
+                if (fs.statSync(file).isDirectory()) {
+                    const fileList = getFilesList(file, []);
+                    fileList.forEach((f) => otherFiles.add(f));
+                }
+                else {
+                    otherFiles.add(file);
+                }
+            }
+            files.push(...Array.from(otherFiles).map((f) => getFileEntry(f)));
+        }
         return {
             files,
             root: path.resolve(apiPath),

package/lib/commands/stats.js CHANGED Viewed

@@ -54,7 +54,7 @@ function printStats(statsAccumulator, api, format) {
 }
 function handleStats(argv) {
     return __awaiter(this, void 0, void 0, function* () {
-        const config = yield openapi_core_1.loadConfig(argv.config);
+        const config = yield openapi_core_1.loadConfig({ configPath: argv.config });
         const [{ path }] = yield utils_1.getFallbackApisOrExit(argv.api ? [argv.api] : [], config);
         const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
         const { bundle: document } = yield openapi_core_1.bundle({ config, ref: path });

package/lib/index.js CHANGED Viewed

@@ -22,6 +22,7 @@ const push_1 = require("./commands/push");
 const lint_1 = require("./commands/lint");
 const bundle_1 = require("./commands/bundle");
 const login_1 = require("./commands/login");
+const build_docs_1 = require("./commands/build-docs");
 const version = require('../package.json').version;
 yargs
     .version('version', 'Show version number.', version)
@@ -117,6 +118,11 @@ yargs
         description: 'Make API registry available to the public',
         type: 'boolean',
     },
+    files: {
+        description: 'List of other folders and files to upload',
+        array: true,
+        type: 'string',
+    },
 })
     .implies('batch-id', 'batch-size')
     .implies('batch-size', 'batch-id'), (argv) => {
@@ -243,6 +249,11 @@ yargs
         type: 'boolean',
         default: false,
     },
+    'keep-url-references': {
+        description: 'Keep absolute url references.',
+        type: 'boolean',
+        alias: 'k',
+    },
 }), (argv) => {
     process.env.REDOCLY_CLI_COMMAND = 'bundle';
     bundle_1.handleBundle(argv, version);
@@ -309,6 +320,54 @@ yargs
     process.env.REDOCLY_CLI_COMMAND = 'preview-docs';
     preview_docs_1.previewDocs(argv);
 })
+    .command('build-docs [api]', 'build definition into zero-dependency HTML-file', (yargs) => yargs
+    .positional('api', { type: 'string' })
+    .options({
+    o: {
+        describe: 'Output file',
+        alias: 'output',
+        type: 'string',
+        default: 'redoc-static.html',
+    },
+    title: {
+        describe: 'Page Title',
+        type: 'string',
+    },
+    disableGoogleFont: {
+        describe: 'Disable Google Font',
+        type: 'boolean',
+        default: false,
+    },
+    cdn: {
+        describe: 'Do not include Redoc source code into html page, use link to CDN instead',
+        type: 'boolean',
+        default: false,
+    },
+    t: {
+        alias: 'template',
+        describe: 'Path to handlebars page template, see https://git.io/vh8fP for the example',
+        type: 'string',
+    },
+    templateOptions: {
+        describe: 'Additional options that you want pass to template. Use dot notation, e.g. templateOptions.metaDescription',
+    },
+    features: {
+        describe: 'Redoc features.openapi, use dot notation, e.g. features.openapi.nativeScrollbars',
+    },
+    config: {
+        describe: 'Specify path to the config file.',
+        type: 'string',
+    },
+})
+    .check((argv) => {
+    var _a;
+    if (argv.features && !((_a = argv.features) === null || _a === void 0 ? void 0 : _a.openapi))
+        throw Error('Invalid option: features.openapi not set');
+    return true;
+}), (argv) => __awaiter(void 0, void 0, void 0, function* () {
+    process.env.REDOCLY_CLI_COMMAND = 'build-docs';
+    build_docs_1.handlerBuildCommand(argv);
+}))
     .completion('completion', 'Generate completion script.')
     .demandCommand(1)
     .strict().argv;

package/lib/utils.js CHANGED Viewed

@@ -45,10 +45,16 @@ function isNotEmptyArray(args) {
     return Array.isArray(args) && !!args.length;
 }
 function getAliasOrPath(config, aliasOrPath) {
-    var _a;
+    var _a, _b, _c;
     return config.apis[aliasOrPath]
         ? { path: (_a = config.apis[aliasOrPath]) === null || _a === void 0 ? void 0 : _a.root, alias: aliasOrPath }
-        : { path: aliasOrPath };
+        : {
+            path: aliasOrPath,
+            // find alias by path, take the first match
+            alias: (_c = (_b = Object.entries(config.apis).find(([_alias, api]) => {
+                return path.resolve(api.root) === path.resolve(aliasOrPath);
+            })) === null || _b === void 0 ? void 0 : _b[0]) !== null && _c !== void 0 ? _c : undefined,
+        };
 }
 function expandGlobsInEntrypoints(args, config) {
     return __awaiter(this, void 0, void 0, function* () {