@redocly/cli 1.18.1 → 1.20.0

package/lib/commands/preview-docs/preview-server/preview-server.js

@@ -1,14 +1,6 @@
 "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.default = startPreviewServer;
 const handlebars_1 = require("handlebars");
 const colorette = require("colorette");
 const get_port_please_1 = require("get-port-please");
@@ -47,79 +39,75 @@ function getPageHTML(htmlTemplate, redocOptions = {}, useRedocPro, wsPort, host)
   </script>`,
     });
 }
-function startPreviewServer(port, host, { getBundle, getOptions, useRedocPro, }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const defaultTemplate = path.join(__dirname, 'default.hbs');
-        const handler = (request, response) => __awaiter(this, void 0, void 0, function* () {
-            var _a;
-            console.time(colorette.dim(`GET ${request.url}`));
-            const { htmlTemplate } = getOptions() || {};
-            if (((_a = request.url) === null || _a === void 0 ? void 0 : _a.endsWith('/')) || path.extname(request.url) === '') {
-                (0, server_1.respondWithGzip)(getPageHTML(htmlTemplate || defaultTemplate, getOptions(), useRedocPro, wsPort, host), request, response, {
-                    'Content-Type': 'text/html',
+async function startPreviewServer(port, host, { getBundle, getOptions, useRedocPro, }) {
+    const defaultTemplate = path.join(__dirname, 'default.hbs');
+    const handler = async (request, response) => {
+        console.time(colorette.dim(`GET ${request.url}`));
+        const { htmlTemplate } = getOptions() || {};
+        if (request.url?.endsWith('/') || path.extname(request.url) === '') {
+            (0, server_1.respondWithGzip)(getPageHTML(htmlTemplate || defaultTemplate, getOptions(), useRedocPro, wsPort, host), request, response, {
+                'Content-Type': 'text/html',
+            });
+        }
+        else if (request.url === '/openapi.json') {
+            const bundle = await getBundle();
+            if (bundle === undefined) {
+                (0, server_1.respondWithGzip)(JSON.stringify({
+                    openapi: '3.0.0',
+                    info: {
+                        description: '<code> Failed to generate bundle: check out console output for more details </code>',
+                    },
+                    paths: {},
+                }), request, response, {
+                    'Content-Type': 'application/json',
                 });
             }
-            else if (request.url === '/openapi.json') {
-                const bundle = yield getBundle();
-                if (bundle === undefined) {
-                    (0, server_1.respondWithGzip)(JSON.stringify({
-                        openapi: '3.0.0',
-                        info: {
-                            description: '<code> Failed to generate bundle: check out console output for more details </code>',
-                        },
-                        paths: {},
-                    }), request, response, {
-                        'Content-Type': 'application/json',
-                    });
-                }
-                else {
-                    (0, server_1.respondWithGzip)(JSON.stringify(bundle), request, response, {
-                        'Content-Type': 'application/json',
-                    });
-                }
-            }
             else {
-                let filePath = 
-                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-                // @ts-ignore
-                {
-                    '/hot.js': path.join(__dirname, 'hot.js'),
-                    '/oauth2-redirect.html': path.join(__dirname, 'oauth2-redirect.html'),
-                    '/simplewebsocket.min.js': require.resolve('simple-websocket/simplewebsocket.min.js'),
-                }[request.url || ''];
-                if (!filePath) {
-                    const basePath = htmlTemplate ? path.dirname(htmlTemplate) : process.cwd();
-                    filePath = path.resolve(basePath, `.${request.url}`);
-                    if (!(0, miscellaneous_1.isSubdir)(basePath, filePath)) {
-                        (0, server_1.respondWithGzip)('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
-                        console.timeEnd(colorette.dim(`GET ${request.url}`));
-                        return;
-                    }
+                (0, server_1.respondWithGzip)(JSON.stringify(bundle), request, response, {
+                    'Content-Type': 'application/json',
+                });
+            }
+        }
+        else {
+            let filePath = 
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            {
+                '/hot.js': path.join(__dirname, 'hot.js'),
+                '/oauth2-redirect.html': path.join(__dirname, 'oauth2-redirect.html'),
+                '/simplewebsocket.min.js': require.resolve('simple-websocket/simplewebsocket.min.js'),
+            }[request.url || ''];
+            if (!filePath) {
+                const basePath = htmlTemplate ? path.dirname(htmlTemplate) : process.cwd();
+                filePath = path.resolve(basePath, `.${request.url}`);
+                if (!(0, miscellaneous_1.isSubdir)(basePath, filePath)) {
+                    (0, server_1.respondWithGzip)('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
+                    console.timeEnd(colorette.dim(`GET ${request.url}`));
+                    return;
                 }
-                const extname = String(path.extname(filePath)).toLowerCase();
-                const contentType = server_1.mimeTypes[extname] || 'application/octet-stream';
-                try {
-                    (0, server_1.respondWithGzip)(yield fs_1.promises.readFile(filePath), request, response, {
-                        'Content-Type': contentType,
-                    });
+            }
+            const extname = String(path.extname(filePath)).toLowerCase();
+            const contentType = server_1.mimeTypes[extname] || 'application/octet-stream';
+            try {
+                (0, server_1.respondWithGzip)(await fs_1.promises.readFile(filePath), request, response, {
+                    'Content-Type': contentType,
+                });
+            }
+            catch (e) {
+                if (e.code === 'ENOENT') {
+                    (0, server_1.respondWithGzip)('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
                 }
-                catch (e) {
-                    if (e.code === 'ENOENT') {
-                        (0, server_1.respondWithGzip)('404 Not Found', request, response, { 'Content-Type': 'text/html' }, 404);
-                    }
-                    else {
-                        (0, server_1.respondWithGzip)(`Something went wrong: ${e.code || e.message}...\n`, request, response, {}, 500);
-                    }
+                else {
+                    (0, server_1.respondWithGzip)(`Something went wrong: ${e.code || e.message}...\n`, request, response, {}, 500);
                 }
             }
-            console.timeEnd(colorette.dim(`GET ${request.url}`));
-        });
-        const wsPort = yield (0, get_port_please_1.getPort)({ port: 32201, portRange: [32201, 32301], host });
-        const server = (0, server_1.startHttpServer)(port, host, handler);
-        server.on('listening', () => {
-            process.stdout.write(`\n  🔎  Preview server running at ${colorette.blue(`http://${host}:${port}\n`)}`);
-        });
-        return (0, server_1.startWsServer)(wsPort, host);
+        }
+        console.timeEnd(colorette.dim(`GET ${request.url}`));
+    };
+    const wsPort = await (0, get_port_please_1.getPort)({ port: 32201, portRange: [32201, 32301], host });
+    const server = (0, server_1.startHttpServer)(port, host, handler);
+    server.on('listening', () => {
+        process.stdout.write(`\n  🔎  Preview server running at ${colorette.blue(`http://${host}:${port}\n`)}`);
     });
+    return (0, server_1.startWsServer)(wsPort, host);
 }
-exports.default = startPreviewServer;

package/lib/commands/preview-docs/preview-server/server.d.ts

@@ -1,8 +1,5 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/// <reference types="node" />
 import * as http from 'http';
-import { ReadStream } from 'fs';
+import type { ReadStream } from 'fs';
 export declare const mimeTypes: {
     '.html': string;
     '.js': string;

package/lib/commands/preview-docs/preview-server/server.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.startWsServer = exports.startHttpServer = exports.respondWithGzip = exports.mimeTypes = void 0;
+exports.mimeTypes = void 0;
+exports.respondWithGzip = respondWithGzip;
+exports.startHttpServer = startHttpServer;
+exports.startWsServer = startWsServer;
 const http = require("http");
 const zlib = require("zlib");
 const SocketServer = require('simple-websocket/server.js');
@@ -26,11 +29,11 @@ function respondWithGzip(contents, request, response, headers = {}, code = 200)
     let compressedStream;
     const acceptEncoding = request.headers['accept-encoding'] || '';
     if (acceptEncoding.match(/\bdeflate\b/)) {
-        response.writeHead(code, Object.assign(Object.assign({}, headers), { 'content-encoding': 'deflate' }));
+        response.writeHead(code, { ...headers, 'content-encoding': 'deflate' });
         compressedStream = zlib.createDeflate();
     }
     else if (acceptEncoding.match(/\bgzip\b/)) {
-        response.writeHead(code, Object.assign(Object.assign({}, headers), { 'content-encoding': 'gzip' }));
+        response.writeHead(code, { ...headers, 'content-encoding': 'gzip' });
         compressedStream = zlib.createGzip();
     }
     else {
@@ -53,11 +56,9 @@ function respondWithGzip(contents, request, response, headers = {}, code = 200)
         contents.pipe(compressedStream).pipe(response);
     }
 }
-exports.respondWithGzip = respondWithGzip;
 function startHttpServer(port, host, handler) {
     return http.createServer(handler).listen(port, host);
 }
-exports.startHttpServer = startHttpServer;
 function startWsServer(port, host) {
     const socketServer = new SocketServer({ port, host, clientTracking: true });
     socketServer.on('connection', (socket) => {
@@ -82,4 +83,3 @@ function startWsServer(port, host) {
     };
     return socketServer;
 }
-exports.startWsServer = startWsServer;

package/lib/commands/preview-project/constants.d.ts

@@ -1,4 +1,4 @@
-import { Product } from './types';
+import type { Product } from './types';
 export declare const PRODUCT_PACKAGES: {
     realm: string;
     'redoc-revel': string;

package/lib/commands/preview-project/index.d.ts

@@ -1,2 +1,3 @@
 import type { PreviewProjectOptions } from './types';
-export declare const previewProject: (args: PreviewProjectOptions) => Promise<void>;
+import type { CommandArgs } from '../../wrapper';
+export declare const previewProject: ({ argv }: CommandArgs<PreviewProjectOptions>) => Promise<void>;

package/lib/commands/preview-project/index.js

@@ -1,23 +1,14 @@
 "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.previewProject = void 0;
 const path = require("path");
 const fs_1 = require("fs");
 const child_process_1 = require("child_process");
 const constants_1 = require("./constants");
-const previewProject = (args) => __awaiter(void 0, void 0, void 0, function* () {
-    const { plan, port } = args;
-    const projectDir = args['source-dir'];
-    const product = args.product || tryGetProductFromPackageJson(projectDir);
+const previewProject = async ({ argv }) => {
+    const { plan, port } = argv;
+    const projectDir = argv['source-dir'];
+    const product = argv.product || tryGetProductFromPackageJson(projectDir);
     if (!isValidProduct(product)) {
         process.stderr.write(`Invalid product ${product}`);
         throw new Error(`Project preview launch failed`);
@@ -30,7 +21,7 @@ const previewProject = (args) => __awaiter(void 0, void 0, void 0, function* ()
         stdio: 'inherit',
         cwd: projectDir,
     });
-});
+};
 exports.previewProject = previewProject;
 const isValidProduct = (product) => {
     if (!product) {

package/lib/commands/preview-project/types.d.ts

@@ -1,4 +1,4 @@
-import { PRODUCT_PACKAGES, PRODUCT_PLANS } from './constants';
+import type { PRODUCT_PACKAGES, PRODUCT_PLANS } from './constants';
 export type Product = keyof typeof PRODUCT_PACKAGES;
 export type ProductPlan = typeof PRODUCT_PLANS[number];
 export type PreviewProjectOptions = {

package/lib/commands/push.d.ts

@@ -1,5 +1,6 @@
-import { Config, Region } from '@redocly/openapi-core';
 import { handlePush as handleCMSPush } from '../cms/commands/push';
+import type { Config, Region } from '@redocly/openapi-core';
+import type { CommandArgs } from '../wrapper';
 export declare const DESTINATION_REGEX: RegExp;
 export type PushOptions = {
     api?: string;
@@ -18,14 +19,10 @@ export type PushOptions = {
 export declare function commonPushHandler({ project, 'mount-path': mountPath, }: {
     project?: string;
     'mount-path'?: string;
-}): typeof handleCMSPush | (({ apis, branch, "batch-id": batchId, "job-id": jobId, ...rest }: Omit<PushOptions, "destination" | "branchName"> & {
-    apis?: string[] | undefined;
-    branch?: string | undefined;
-    destination?: string | undefined;
-} & {
-    'batch-id'?: string | undefined;
-}, config: Config) => Promise<void>);
-export declare function handlePush(argv: PushOptions, config: Config): Promise<void>;
+}): typeof handleCMSPush | (({ argv: { apis, branch, "batch-id": batchId, "job-id": jobId, ...rest }, config, version, }: CommandArgs<BarePushArgs & {
+    "batch-id"?: string;
+}>) => Promise<void>);
+export declare function handlePush({ argv, config }: CommandArgs<PushOptions>): Promise<void>;
 export declare function getDestinationProps(destination: string | undefined, organization: string | undefined): {
     organizationId: string | undefined;
     name: string | undefined;
@@ -36,9 +33,9 @@ type BarePushArgs = Omit<PushOptions, 'destination' | 'branchName'> & {
     branch?: string;
     destination?: string;
 };
-export declare const transformPush: (callback: typeof handlePush) => ({ apis, branch, "batch-id": batchId, "job-id": jobId, ...rest }: BarePushArgs & {
-    'batch-id'?: string;
-}, config: Config) => Promise<void>;
+export declare const transformPush: (callback: typeof handlePush) => ({ argv: { apis, branch, "batch-id": batchId, "job-id": jobId, ...rest }, config, version, }: CommandArgs<BarePushArgs & {
+    "batch-id"?: string;
+}>) => Promise<void>;
 export declare function getApiRoot({ name, version, config: { apis }, }: {
     name: string;
     version: string;