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

package/lib/commands/split/index.js

@@ -198,8 +198,8 @@ function gatherComponentsFiles(components, componentsFiles, componentType, compo
     let inherits = [];
     if (componentType === types_1.OPENAPI3_COMPONENT.Schemas) {
         inherits = (((_b = (_a = components === null || components === void 0 ? void 0 : components[componentType]) === null || _a === void 0 ? void 0 : _a[componentName]) === null || _b === void 0 ? void 0 : _b.allOf) || [])
-            .map((s) => s.$ref)
-            .filter(Boolean);
+            .map(({ $ref }) => $ref)
+            .filter(openapi_core_1.isTruthy);
     }
     componentsFiles[componentType] = componentsFiles[componentType] || {};
     componentsFiles[componentType][componentName] = { inherits, filename };
@@ -225,6 +225,7 @@ function iteratePathItems(pathItems, openapiDir, outDir, componentsFiles, pathSe
                 const sampleFileName = path.join(openapiDir, 'code_samples', utils_1.escapeLanguageName(sample.lang), codeSamplesPathPrefix + utils_1.pathToFilename(pathName, pathSeparator), method + langToExt(sample.lang));
                 fs.mkdirSync(path.dirname(sampleFileName), { recursive: true });
                 fs.writeFileSync(sampleFileName, sample.source);
+                // eslint-disable-next-line @typescript-eslint/ban-ts-comment
                 // @ts-ignore
                 sample.source = {
                     $ref: openapi_core_1.slash(path.relative(outDir, sampleFileName)),
@@ -247,6 +248,7 @@ function iterateComponents(openapi, openapiDir, componentsFiles) {
         const componentTypes = findComponentTypes(components);
         componentTypes.forEach(iterateAndGatherComponentsFiles);
         componentTypes.forEach(iterateComponentTypes);
+        // eslint-disable-next-line no-inner-declarations
         function iterateAndGatherComponentsFiles(componentType) {
             const componentDirPath = path.join(componentsDir, componentType);
             for (const componentName of Object.keys((components === null || components === void 0 ? void 0 : components[componentType]) || {})) {
@@ -254,6 +256,7 @@ function iterateComponents(openapi, openapiDir, componentsFiles) {
                 gatherComponentsFiles(components, componentsFiles, componentType, componentName, filename);
             }
         }
+        // eslint-disable-next-line no-inner-declarations
         function iterateComponentTypes(componentType) {
             var _a, _b, _c;
             const componentDirPath = path.join(componentsDir, componentType);

package/lib/commands/split/types.d.ts

@@ -12,15 +12,15 @@ export declare const PATHS = "paths";
 export declare const WEBHOOKS = "webhooks";
 export declare const xWEBHOOKS = "x-webhooks";
 export declare const componentsPath: string;
-declare enum OPENAPI3_METHOD {
-    Get = "get",
-    Put = "put",
-    Post = "post",
-    Delete = "delete",
-    Options = "options",
-    Head = "head",
-    Patch = "patch",
-    Trace = "trace"
+export declare enum OPENAPI3_METHOD {
+    get = "get",
+    put = "put",
+    post = "post",
+    delete = "delete",
+    options = "options",
+    head = "head",
+    patch = "patch",
+    trace = "trace"
 }
 export declare const OPENAPI3_METHOD_NAMES: OPENAPI3_METHOD[];
 export declare enum OPENAPI3_COMPONENT {

package/lib/commands/split/types.js

@@ -1,6 +1,6 @@
 "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.OPENAPI3_COMPONENT_NAMES = exports.OPENAPI3_COMPONENT = exports.OPENAPI3_METHOD_NAMES = exports.OPENAPI3_METHOD = exports.componentsPath = exports.xWEBHOOKS = exports.WEBHOOKS = exports.PATHS = exports.COMPONENTS = void 0;
 exports.COMPONENTS = 'components';
 exports.PATHS = 'paths';
 exports.WEBHOOKS = 'webhooks';
@@ -8,24 +8,24 @@ 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 = {}));
+    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 = exports.OPENAPI3_METHOD || (exports.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,
+    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) {

package/lib/commands/stats.js

@@ -70,7 +70,7 @@ function handleStats(argv) {
         };
         const resolvedRefMap = yield openapi_core_1.resolveDocument({
             rootDocument: document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             externalRefResolver,
         });
         const statsVisitor = openapi_core_1.normalizeVisitors([
@@ -82,7 +82,7 @@ function handleStats(argv) {
         ], types);
         openapi_core_1.walkDocument({
             document,
-            rootType: types.DefinitionRoot,
+            rootType: types.Root,
             normalizedVisitors: statsVisitor,
             resolvedRefMap,
             ctx,

package/lib/index.js

@@ -33,7 +33,10 @@ yargs
         choices: ['stylish', 'json'],
         default: 'stylish',
     },
-}), stats_1.handleStats)
+}), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'stats';
+    stats_1.handleStats(argv);
+})
     .command('split [api]', 'Split definition into a multi-file structure.', (yargs) => yargs
     .positional('api', {
     description: 'API definition file that you want to split',
@@ -52,7 +55,10 @@ yargs
         default: '_',
     },
 })
-    .demandOption('api'), split_1.handleSplit)
+    .demandOption('api'), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'split';
+    split_1.handleSplit(argv);
+})
     .command('join [apis...]', 'Join definitions [experimental].', (yargs) => yargs
     .positional('apis', {
     array: true,
@@ -81,6 +87,7 @@ yargs
         type: 'boolean',
     },
 }), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'join';
     join_1.handleJoin(argv, version);
 })
     .command('push [maybeApiOrDestination] [maybeDestination] [maybeBranchName]', 'Push an API definition to the Redocly API registry.', (yargs) => yargs
@@ -112,7 +119,10 @@ yargs
     },
 })
     .implies('batch-id', 'batch-size')
-    .implies('batch-size', 'batch-id'), push_1.transformPush(push_1.handlePush))
+    .implies('batch-size', 'batch-id'), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'push';
+    push_1.transformPush(push_1.handlePush)(argv);
+})
     .command('lint [apis...]', 'Lint definition.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).option({
     format: {
         description: 'Use a specific output format.',
@@ -122,6 +132,7 @@ yargs
             'json',
             'checkstyle',
             'codeclimate',
+            'summary',
         ],
         default: 'codeframe',
     },
@@ -162,6 +173,7 @@ yargs
         type: 'string',
     },
 }), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'lint';
     lint_1.handleLint(argv, version);
 })
     .command('bundle [apis...]', 'Bundle definition.', (yargs) => yargs.positional('apis', { array: true, type: 'string', demandOption: true }).options({
@@ -232,6 +244,7 @@ yargs
         default: false,
     },
 }), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'bundle';
     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* () {
@@ -246,8 +259,12 @@ yargs
             choices: types_1.regionChoices,
         },
     });
-}), login_1.handleLogin)
+}), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'login';
+    login_1.handleLogin(argv);
+})
     .command('logout', 'Clear your stored credentials for the Redocly API registry.', (yargs) => yargs, () => __awaiter(void 0, void 0, void 0, function* () {
+    process.env.REDOCLY_CLI_COMMAND = 'logout';
     const client = new openapi_core_1.RedoclyClient();
     client.logout();
     process.stdout.write('Logged out from the Redocly account. ✋\n');
@@ -288,7 +305,10 @@ yargs
         description: 'Specify path to the config file.',
         type: 'string',
     },
-}), preview_docs_1.previewDocs)
+}), (argv) => {
+    process.env.REDOCLY_CLI_COMMAND = 'preview-docs';
+    preview_docs_1.previewDocs(argv);
+})
     .completion('completion', 'Generate completion script.')
     .demandCommand(1)
     .strict().argv;

package/lib/js-utils.d.ts

@@ -1,3 +1,4 @@
 export declare function isObject(obj: any): boolean;
 export declare function isEmptyObject(obj: any): boolean;
 export declare function isString(str: string): boolean;
+export declare function keysOf<T>(obj: T): (keyof T)[];

package/lib/js-utils.js

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

package/lib/utils.js

@@ -106,6 +106,7 @@ function dumpBundle(obj, format, dereference) {
     else {
         return openapi_core_1.stringifyYaml(obj, {
             noRefs: !dereference,
+            lineWidth: -1,
         });
     }
 }
@@ -175,7 +176,6 @@ function handleError(e, ref) {
         // TODO: codeframe
     }
     else {
-        // @ts-ignore
         if (e instanceof CircularJSONNotSupportedError) {
             process.stderr.write(colorette_1.red(`Detected circular reference which can't be converted to JSON.\n`) +
                 `Try to use ${colorette_1.blue('yaml')} output or remove ${colorette_1.blue('--dereferenced')}.\n\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.0.0-beta.106",
+  "version": "1.0.0-beta.109",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -35,7 +35,7 @@
     "Andriy Leliv <andriy@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.0.0-beta.106",
+    "@redocly/openapi-core": "1.0.0-beta.109",
     "assert-node-version": "^1.0.3",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",

package/src/__mocks__/@redocly/openapi-core.ts

@@ -1,4 +1,6 @@
 import { ConfigFixture } from './../../__tests__/fixtures/config';
+import { Document, ResolveError } from '@redocly/openapi-core';
+import { firstDocument, secondDocument } from '../documents';
 
 export const __redoclyClient = {
   isAuthorizedWithRedocly: jest.fn().mockResolvedValue(true),
@@ -25,3 +27,39 @@ export const formatProblems = jest.fn();
 export const slash = jest.fn();
 export const findConfig = jest.fn();
 export const doesYamlFileExist = jest.fn();
+export const bundleDocument = jest.fn(() => Promise.resolve({ problems: {} }));
+export const detectOpenAPI = jest.fn();
+
+export class BaseResolver {
+  cache = new Map<string, Promise<Document | ResolveError>>();
+
+  getFiles = jest.fn();
+  resolveExternalRef = jest.fn();
+  loadExternalRef = jest.fn;
+  parseDocument = jest.fn();
+  resolveDocument = jest
+    .fn()
+    .mockImplementationOnce(() =>
+      Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: firstDocument })
+    )
+    .mockImplementationOnce(() =>
+      Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: secondDocument })
+    );
+}
+
+export enum OasVersion {
+  Version2 = 'oas2',
+  Version3_0 = 'oas3_0',
+  Version3_1 = 'oas3_1',
+}
+
+export enum Oas3Operations {
+  get = 'get',
+  put = 'put',
+  post = 'post',
+  delete = 'delete',
+  options = 'options',
+  head = 'head',
+  patch = 'patch',
+  trace = 'trace',
+}

package/src/__mocks__/documents.ts

@@ -0,0 +1,63 @@
+export const firstDocument = {
+  openapi: '3.0.0',
+  servers: [{ url: 'http://localhost:8080' }],
+  info: {
+    description: 'example test',
+    version: '1.0.0',
+    title: 'Swagger Petstore',
+    termsOfService: 'http://swagger.io/terms/',
+    license: {
+      name: 'Apache 2.0',
+      url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+    },
+  },
+  paths: {
+    '/GETUser/{userId}': {
+      summary: 'get user by id',
+      description: 'user info',
+      servers: [{ url: '/user' }, { url: '/pet', description: 'pet server' }],
+
+      get: {
+        tags: ['pet'],
+        summary: 'Find pet by ID',
+        description: 'Returns a single pet',
+        operationId: 'getPetById',
+        servers: [{ url: '/pet' }],
+      },
+      parameters: [{ name: 'param1', in: 'header', schema: { description: 'string' } }],
+    },
+  },
+  components: {},
+};
+
+export const secondDocument = {
+  openapi: '3.0.0',
+  servers: [{ url: 'http://localhost:8080' }],
+  info: {
+    description: 'example test',
+    version: '1.0.0',
+    title: 'Swagger Petstore',
+    termsOfService: 'http://swagger.io/terms/',
+    license: {
+      name: 'Apache 2.0',
+      url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+    },
+  },
+  post: {
+    '/GETUser/{userId}': {
+      summary: 'get user',
+      description: 'user information',
+      servers: [{ url: '/user' }, { url: '/pet', description: '' }],
+
+      get: {
+        tags: ['pet'],
+        summary: 'Find pet by ID',
+        description: 'Returns a single pet',
+        operationId: 'getPetById',
+        servers: [{ url: '/pet' }],
+      },
+      parameters: [{ name: 'param1', in: 'header', schema: { description: 'string' } }],
+    },
+  },
+  components: {},
+};

package/src/__mocks__/utils.ts

@@ -11,3 +11,4 @@ export const printLintTotals = jest.fn();
 export const getOutputFileName = jest.fn(() => ({ outputFile: 'test.yaml', ext: 'yaml' }));
 export const handleError = jest.fn();
 export const exitWithError = jest.fn();
+export const writeYaml = jest.fn();

package/src/__tests__/commands/join.test.ts

@@ -1,6 +1,7 @@
 import { handleJoin } from '../../commands/join';
-import { exitWithError } from '../../utils';
+import { exitWithError, writeYaml } from '../../utils';
 import { yellow } from 'colorette';
+import { detectOpenAPI } from '@redocly/openapi-core';
 
 jest.mock('../../utils');
 jest.mock('colorette');
@@ -44,4 +45,25 @@ describe('handleJoin fails', () => {
       `You use prefix-tags-with-filename, without-x-tag-groups together.\nPlease choose only one! \n\n`
     );
   });
+
+  it('should call exitWithError because Only OpenAPI 3 is supported', async () => {
+    await handleJoin(
+      {
+        apis: ['first.yaml', 'second.yaml'],
+      },
+      'cli-version'
+    );
+    expect(exitWithError).toHaveBeenCalledWith('Only OpenAPI 3 is supported: undefined \n\n');
+  });
+
+  it('should call writeYaml function', async () => {
+    (detectOpenAPI as jest.Mock).mockReturnValue('oas3_0');
+    await handleJoin(
+      {
+        apis: ['first.yaml', 'second.yaml'],
+      },
+      'cli-version'
+    );
+    expect(writeYaml).toHaveBeenCalled();
+  });
 });