@redocly/cli 1.0.0-beta.96

package/lib/commands/split/types.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OPENAPI3_COMPONENT_NAMES = exports.OPENAPI3_COMPONENT = exports.OPENAPI3_METHOD_NAMES = exports.componentsPath = exports.xWEBHOOKS = exports.WEBHOOKS = exports.PATHS = exports.COMPONENTS = void 0;
+exports.COMPONENTS = 'components';
+exports.PATHS = 'paths';
+exports.WEBHOOKS = 'webhooks';
+exports.xWEBHOOKS = 'x-webhooks';
+exports.componentsPath = `#/${exports.COMPONENTS}/`;
+var OPENAPI3_METHOD;
+(function (OPENAPI3_METHOD) {
+    OPENAPI3_METHOD["Get"] = "get";
+    OPENAPI3_METHOD["Put"] = "put";
+    OPENAPI3_METHOD["Post"] = "post";
+    OPENAPI3_METHOD["Delete"] = "delete";
+    OPENAPI3_METHOD["Options"] = "options";
+    OPENAPI3_METHOD["Head"] = "head";
+    OPENAPI3_METHOD["Patch"] = "patch";
+    OPENAPI3_METHOD["Trace"] = "trace";
+})(OPENAPI3_METHOD || (OPENAPI3_METHOD = {}));
+exports.OPENAPI3_METHOD_NAMES = [
+    OPENAPI3_METHOD.Get,
+    OPENAPI3_METHOD.Put,
+    OPENAPI3_METHOD.Post,
+    OPENAPI3_METHOD.Delete,
+    OPENAPI3_METHOD.Options,
+    OPENAPI3_METHOD.Head,
+    OPENAPI3_METHOD.Patch,
+    OPENAPI3_METHOD.Trace
+];
+var OPENAPI3_COMPONENT;
+(function (OPENAPI3_COMPONENT) {
+    OPENAPI3_COMPONENT["Schemas"] = "schemas";
+    OPENAPI3_COMPONENT["Responses"] = "responses";
+    OPENAPI3_COMPONENT["Parameters"] = "parameters";
+    OPENAPI3_COMPONENT["Examples"] = "examples";
+    OPENAPI3_COMPONENT["Headers"] = "headers";
+    OPENAPI3_COMPONENT["RequestBodies"] = "requestBodies";
+    OPENAPI3_COMPONENT["Links"] = "links";
+    OPENAPI3_COMPONENT["Callbacks"] = "callbacks";
+    OPENAPI3_COMPONENT["SecuritySchemes"] = "securitySchemes";
+})(OPENAPI3_COMPONENT = exports.OPENAPI3_COMPONENT || (exports.OPENAPI3_COMPONENT = {}));
+exports.OPENAPI3_COMPONENT_NAMES = [
+    OPENAPI3_COMPONENT.RequestBodies,
+    OPENAPI3_COMPONENT.Schemas,
+    OPENAPI3_COMPONENT.Responses,
+    OPENAPI3_COMPONENT.Parameters,
+    OPENAPI3_COMPONENT.Examples,
+    OPENAPI3_COMPONENT.Headers,
+    OPENAPI3_COMPONENT.Links,
+    OPENAPI3_COMPONENT.Callbacks,
+    OPENAPI3_COMPONENT.SecuritySchemes
+];

package/lib/commands/stats.d.ts

@@ -0,0 +1,5 @@
+export declare function handleStats(argv: {
+    config?: string;
+    entrypoint?: string;
+    format: string;
+}): Promise<void>;

package/lib/commands/stats.js

@@ -0,0 +1,92 @@
+"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.handleStats = void 0;
+const perf_hooks_1 = require("perf_hooks");
+const colors = require("colorette");
+const openapi_core_1 = require("@redocly/openapi-core");
+const utils_1 = require("../utils");
+const utils_2 = require("../utils");
+const statsAccumulator = {
+    refs: { metric: '🚗 References', total: 0, color: 'red', items: new Set() },
+    externalDocs: { metric: '📦 External Documents', total: 0, color: 'magenta' },
+    schemas: { metric: '📈 Schemas', total: 0, color: 'white' },
+    parameters: { metric: '👉 Parameters', total: 0, color: 'yellow', items: new Set() },
+    links: { metric: '🔗 Links', total: 0, color: 'cyan', items: new Set() },
+    pathItems: { metric: '➡️ Path Items', total: 0, color: 'green' },
+    operations: { metric: '👷 Operations', total: 0, color: 'yellow' },
+    tags: { metric: '🔖 Tags', total: 0, color: 'white', items: new Set() },
+};
+function printStatsStylish(statsAccumulator) {
+    for (const node in statsAccumulator) {
+        const { metric, total, color } = statsAccumulator[node];
+        process.stderr.write(colors[color](`${metric}: ${total} \n`));
+    }
+}
+function printStatsJson(statsAccumulator) {
+    const json = {};
+    for (const key of Object.keys(statsAccumulator)) {
+        json[key] = {
+            metric: statsAccumulator[key].metric,
+            total: statsAccumulator[key].total,
+        };
+    }
+    process.stdout.write(JSON.stringify(json, null, 2));
+}
+function printStats(statsAccumulator, entrypoint, format) {
+    process.stderr.write(`Document: ${colors.magenta(entrypoint)} stats:\n\n`);
+    switch (format) {
+        case 'stylish':
+            printStatsStylish(statsAccumulator);
+            break;
+        case 'json':
+            printStatsJson(statsAccumulator);
+            break;
+    }
+}
+function handleStats(argv) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const config = yield openapi_core_1.loadConfig(argv.config);
+        const [{ path }] = yield utils_1.getFallbackEntryPointsOrExit(argv.entrypoint ? [argv.entrypoint] : [], config);
+        const externalRefResolver = new openapi_core_1.BaseResolver(config.resolve);
+        const { bundle: document } = yield openapi_core_1.bundle({ config, ref: path });
+        const lintConfig = config.lint;
+        const oasVersion = openapi_core_1.detectOpenAPI(document.parsed);
+        const oasMajorVersion = openapi_core_1.openAPIMajor(oasVersion);
+        const types = openapi_core_1.normalizeTypes(lintConfig.extendTypes(oasMajorVersion === openapi_core_1.OasMajorVersion.Version3 ? openapi_core_1.Oas3Types : openapi_core_1.Oas2Types, oasVersion), lintConfig);
+        const startedAt = perf_hooks_1.performance.now();
+        const ctx = {
+            problems: [],
+            oasVersion: oasVersion,
+            visitorsData: {},
+        };
+        const resolvedRefMap = yield openapi_core_1.resolveDocument({
+            rootDocument: document,
+            rootType: types.DefinitionRoot,
+            externalRefResolver,
+        });
+        const statsVisitor = openapi_core_1.normalizeVisitors([{
+                severity: 'warn',
+                ruleId: 'stats',
+                visitor: openapi_core_1.Stats(statsAccumulator)
+            }], types);
+        openapi_core_1.walkDocument({
+            document,
+            rootType: types.DefinitionRoot,
+            normalizedVisitors: statsVisitor,
+            resolvedRefMap,
+            ctx,
+        });
+        printStats(statsAccumulator, path, argv.format);
+        utils_2.printExecutionTime('stats', startedAt, path);
+    });
+}
+exports.handleStats = handleStats;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import './assert-node-version';

package/lib/index.js

@@ -0,0 +1,269 @@
+#!/usr/bin/env node
+"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 });
+require("./assert-node-version");
+const yargs = require("yargs");
+const types_1 = require("./types");
+const openapi_core_1 = require("@redocly/openapi-core");
+const preview_docs_1 = require("./commands/preview-docs");
+const stats_1 = require("./commands/stats");
+const split_1 = require("./commands/split");
+const join_1 = require("./commands/join");
+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 version = require('../package.json').version;
+yargs
+    .version('version', 'Show version number.', version)
+    .help('help', 'Show help.')
+    .command('stats [entrypoint]', 'Gathering statistics for a document.', (yargs) => yargs.positional('entrypoint', { type: 'string' }).option({
+    config: { description: 'Specify path to the config file.', type: 'string' },
+    format: {
+        description: 'Use a specific output format.',
+        choices: ['stylish', 'json'],
+        default: 'stylish',
+    },
+}), stats_1.handleStats)
+    .command('split [entrypoint]', 'Split definition into a multi-file structure.', (yargs) => yargs
+    .positional('entrypoint', {
+    description: 'API definition file that you want to split',
+    type: 'string',
+})
+    .option({
+    outDir: {
+        description: 'Output directory where files will be saved.',
+        required: true,
+        type: 'string',
+    },
+    separator: {
+        description: 'File path separator used while splitting.',
+        required: false,
+        type: 'string',
+        default: '_',
+    },
+})
+    .demandOption('entrypoint'), split_1.handleSplit)
+    .command('join [entrypoints...]', 'Join definitions [experimental].', (yargs) => yargs
+    .positional('entrypoints', {
+    array: true,
+    type: 'string',
+    demandOption: true,
+})
+    .option({
+    lint: { description: 'Lint definitions', type: 'boolean', default: false },
+    'prefix-tags-with-info-prop': {
+        description: 'Prefix tags with property value from info object.',
+        requiresArg: true,
+        type: 'string',
+    },
+    'prefix-tags-with-filename': {
+        description: 'Prefix tags with property value from file name.',
+        type: 'boolean',
+        default: false,
+    },
+    'prefix-components-with-info-prop': {
+        description: 'Prefix components with property value from info object.',
+        requiresArg: true,
+        type: 'string',
+    },
+}), (argv) => {
+    join_1.handleJoin(argv, version);
+})
+    .command('push [maybeEntrypointOrAliasOrDestination] [maybeDestination] [maybeBranchName]', 'Push an API definition to the Redocly API registry.', (yargs) => yargs
+    .positional('maybeEntrypointOrAliasOrDestination', { type: 'string' })
+    .positional('maybeDestination', { type: 'string' })
+    .positional('maybeBranchName', { type: 'string' })
+    .option({
+    branch: { type: 'string', alias: 'b' },
+    upsert: { type: 'boolean', alias: 'u' },
+    'run-id': { type: 'string', requiresArg: true },
+    region: { description: 'Specify a region.', alias: 'r', choices: types_1.regionChoices },
+    'skip-decorator': {
+        description: 'Ignore certain decorators.',
+        array: true,
+        type: 'string',
+    },
+}), push_1.transformPush(push_1.handlePush))
+    .command('lint [entrypoints...]', 'Lint definition.', (yargs) => yargs.positional('entrypoints', { array: true, type: 'string', demandOption: true }).option({
+    format: {
+        description: 'Use a specific output format.',
+        choices: [
+            'stylish',
+            'codeframe',
+            'json',
+            'checkstyle',
+            'codeclimate',
+        ],
+        default: 'codeframe',
+    },
+    'max-problems': {
+        requiresArg: true,
+        description: 'Reduce output to max N problems.',
+        type: 'number',
+        default: 100,
+    },
+    'generate-ignore-file': {
+        description: 'Generate ignore file.',
+        type: 'boolean',
+    },
+    'skip-rule': {
+        description: 'Ignore certain rules.',
+        array: true,
+        type: 'string',
+    },
+    'skip-preprocessor': {
+        description: 'Ignore certain preprocessors.',
+        array: true,
+        type: 'string',
+    },
+    config: {
+        description: 'Specify path to the config file.',
+        requiresArg: true,
+        type: 'string',
+    },
+    extends: {
+        description: 'Override extends configurations (defaults or config file settings).',
+        requiresArg: true,
+        array: true,
+        type: 'string',
+    },
+}), (argv) => {
+    lint_1.handleLint(argv, version);
+})
+    .command('bundle [entrypoints...]', 'Bundle definition.', (yargs) => yargs.positional('entrypoints', { array: true, type: 'string', demandOption: true }).options({
+    output: { type: 'string', alias: 'o' },
+    format: {
+        description: 'Use a specific output format.',
+        choices: ['stylish', 'codeframe', 'json', 'checkstyle'],
+        default: 'codeframe',
+    },
+    'max-problems': {
+        requiresArg: true,
+        description: 'Reduce output to max N problems.',
+        type: 'number',
+        default: 100,
+    },
+    ext: {
+        description: 'Bundle file extension.',
+        requiresArg: true,
+        choices: types_1.outputExtensions,
+    },
+    'skip-rule': {
+        description: 'Ignore certain rules.',
+        array: true,
+        type: 'string',
+    },
+    'skip-preprocessor': {
+        description: 'Ignore certain preprocessors.',
+        array: true,
+        type: 'string',
+    },
+    'skip-decorator': {
+        description: 'Ignore certain decorators.',
+        array: true,
+        type: 'string',
+    },
+    dereferenced: {
+        alias: 'd',
+        type: 'boolean',
+        description: 'Produce fully dereferenced bundle.',
+    },
+    force: {
+        alias: 'f',
+        type: 'boolean',
+        description: 'Produce bundle output even when errors occur.',
+    },
+    config: {
+        description: 'Specify path to the config file.',
+        type: 'string',
+    },
+    lint: {
+        description: 'Lint definitions',
+        type: 'boolean',
+        default: false,
+    },
+    metafile: {
+        description: 'Produce metadata about the bundle',
+        type: 'string',
+    },
+    extends: {
+        description: 'Override extends configurations (defaults or config file settings).',
+        requiresArg: true,
+        array: true,
+        type: 'string',
+    },
+    'remove-unused-components': {
+        description: 'Remove unused components.',
+        type: 'boolean',
+        default: false,
+    },
+}), (argv) => {
+    bundle_1.handleBundle(argv, version);
+})
+    .command('login', 'Login to the Redocly API registry with an access token.', (yargs) => __awaiter(void 0, void 0, void 0, function* () {
+    return yargs.options({
+        verbose: {
+            description: 'Include additional output.',
+            type: 'boolean',
+        },
+        region: {
+            description: 'Specify a region.',
+            alias: 'r',
+            choices: types_1.regionChoices,
+        },
+    });
+}), login_1.handleLogin)
+    .command('logout', 'Clear your stored credentials for the Redocly API registry.', (yargs) => yargs, () => __awaiter(void 0, void 0, void 0, function* () {
+    const client = new openapi_core_1.RedoclyClient();
+    client.logout();
+}))
+    .command('preview-docs [entrypoint]', 'Preview API reference docs for the specified definition.', (yargs) => yargs.positional('entrypoint', { type: 'string' }).options({
+    port: {
+        alias: 'p',
+        type: 'number',
+        default: 8080,
+        description: 'Preview port.',
+    },
+    host: {
+        alias: 'h',
+        type: 'string',
+        default: '127.0.0.1',
+        description: 'Preview host.',
+    },
+    'skip-preprocessor': {
+        description: 'Ignore certain preprocessors.',
+        array: true,
+        type: 'string',
+    },
+    'skip-decorator': {
+        description: 'Ignore certain decorators.',
+        array: true,
+        type: 'string',
+    },
+    'use-community-edition': {
+        description: 'Force using Redoc CE for docs preview.',
+        type: 'boolean',
+    },
+    force: {
+        alias: 'f',
+        type: 'boolean',
+        description: 'Produce bundle output even when errors occur.',
+    },
+    config: {
+        description: 'Specify path to the config file.',
+        type: 'string',
+    },
+}), preview_docs_1.previewDocs)
+    .completion('completion', 'Generate completion script.')
+    .demandCommand(1)
+    .strict().argv;

package/lib/js-utils.d.ts

@@ -0,0 +1,3 @@
+export declare function isObject(obj: any): boolean;
+export declare function isEmptyObject(obj: any): boolean;
+export declare function isString(str: string): boolean;

package/lib/js-utils.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isString = exports.isEmptyObject = exports.isObject = void 0;
+function isObject(obj) {
+    const type = typeof obj;
+    return type === 'function' || type === 'object' && !!obj;
+}
+exports.isObject = isObject;
+function isEmptyObject(obj) {
+    return !!obj && Object.keys(obj).length === 0;
+}
+exports.isEmptyObject = isEmptyObject;
+function isString(str) {
+    return Object.prototype.toString.call(str) === "[object String]";
+}
+exports.isString = isString;

package/lib/types.d.ts

@@ -0,0 +1,13 @@
+import { BundleOutputFormat, Region } from '@redocly/openapi-core';
+export declare type Totals = {
+    errors: number;
+    warnings: number;
+    ignored: number;
+};
+export declare type Entrypoint = {
+    path: string;
+    alias?: string;
+};
+export declare const outputExtensions: readonly BundleOutputFormat[];
+export declare type OutputExtensions = 'json' | 'yaml' | 'yml' | undefined;
+export declare const regionChoices: readonly Region[];

package/lib/types.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.regionChoices = exports.outputExtensions = void 0;
+exports.outputExtensions = ['json', 'yaml', 'yml'];
+exports.regionChoices = ['us', 'eu'];

package/lib/utils.d.ts

@@ -0,0 +1,28 @@
+import { BundleOutputFormat, Config, LintConfig } from '@redocly/openapi-core';
+import { Totals, Entrypoint } from './types';
+export declare function getFallbackEntryPointsOrExit(argsEntrypoints: string[] | undefined, config: Config): Promise<Entrypoint[]>;
+export declare function getExecutionTime(startedAt: number): string;
+export declare function printExecutionTime(commandName: string, startedAt: number, entrypoint: string): void;
+export declare function pathToFilename(path: string, pathSeparator: string): string;
+export declare class CircularJSONNotSupportedError extends Error {
+    originalError: Error;
+    constructor(originalError: Error);
+}
+export declare function dumpBundle(obj: any, format: BundleOutputFormat, dereference?: boolean): string;
+export declare function saveBundle(filename: string, output: string): void;
+export declare function promptUser(query: string, hideUserInput?: boolean): Promise<string>;
+export declare function readYaml(filename: string): unknown;
+export declare function writeYaml(data: any, filename: string, noRefs?: boolean): void;
+export declare function pluralize(label: string, num: number): string;
+export declare function handleError(e: Error, ref: string): void;
+export declare function printLintTotals(totals: Totals, definitionsCount: number): void;
+export declare function getOutputFileName(entrypoint: string, entries: number, output?: string, ext?: BundleOutputFormat): {
+    outputFile: string;
+    ext: BundleOutputFormat;
+};
+export declare function printUnusedWarnings(config: LintConfig): void;
+export declare function exitWithError(message: string): void;
+/**
+ * Checks if dir is subdir of parent
+ */
+export declare function isSubdir(parent: string, dir: string): boolean;