@redocly/cli 1.8.2 → 1.9.1

package/lib/commands/split/index.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.iteratePathItems = exports.handleSplit = void 0;
+exports.iteratePathItems = exports.crawl = exports.startsWithComponents = exports.handleSplit = void 0;
 const colorette_1 = require("colorette");
 const fs = require("fs");
 const openapi_core_1 = require("@redocly/openapi-core");
@@ -44,9 +44,10 @@ function splitDefinition(openapi, openapiDir, pathSeparator, ext) {
     replace$Refs(openapi, openapiDir, componentsFiles);
     (0, miscellaneous_1.writeToFileByExtension)(openapi, path.join(openapiDir, `openapi.${ext}`));
 }
-function isStartsWithComponents(node) {
-    return node.startsWith(types_1.componentsPath);
+function startsWithComponents(node) {
+    return node.startsWith(`#/${types_1.COMPONENTS}/`);
 }
+exports.startsWithComponents = startsWithComponents;
 function isSupportedExtension(filename) {
     return filename.endsWith('.yaml') || filename.endsWith('.yml') || filename.endsWith('.json');
 }
@@ -92,22 +93,22 @@ function traverseDirectoryDeepCallback(filename, directory, componentsFiles) {
 function crawl(object, visitor) {
     if (!(0, js_utils_1.isObject)(object))
         return;
+    visitor(object);
     for (const key of Object.keys(object)) {
-        visitor(object, key);
         crawl(object[key], visitor);
     }
 }
+exports.crawl = crawl;
 function replace$Refs(obj, relativeFrom, componentFiles = {}) {
     crawl(obj, (node) => {
-        if (node.$ref && (0, js_utils_1.isString)(node.$ref) && isStartsWithComponents(node.$ref)) {
+        if (node.$ref && typeof node.$ref === 'string' && startsWithComponents(node.$ref)) {
             replace(node, '$ref');
         }
-        else if (node.discriminator &&
-            node.discriminator.mapping &&
-            (0, js_utils_1.isObject)(node.discriminator.mapping)) {
+        else if ((0, js_utils_1.isObject)(node.discriminator) && (0, js_utils_1.isObject)(node.discriminator.mapping)) {
             const { mapping } = node.discriminator;
             for (const name of Object.keys(mapping)) {
-                if ((0, js_utils_1.isString)(mapping[name]) && isStartsWithComponents(mapping[name])) {
+                const mappingPointer = mapping[name];
+                if (typeof mappingPointer === 'string' && startsWithComponents(mappingPointer)) {
                     replace(node.discriminator.mapping, name);
                 }
             }

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

@@ -4,14 +4,13 @@ export type Definition = Oas3_1Definition | Oas3Definition | Oas2Definition;
 export interface ComponentsFiles {
     [schemas: string]: any;
 }
-export interface refObj {
+export interface RefObject {
     [$ref: string]: string;
 }
 export declare const COMPONENTS = "components";
 export declare const PATHS = "paths";
 export declare const WEBHOOKS = "webhooks";
 export declare const xWEBHOOKS = "x-webhooks";
-export declare const componentsPath = "#/components/";
 export declare enum OPENAPI3_METHOD {
     get = "get",
     put = "put",

package/lib/commands/split/types.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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.OPENAPI3_COMPONENT_NAMES = exports.OPENAPI3_COMPONENT = exports.OPENAPI3_METHOD_NAMES = exports.OPENAPI3_METHOD = 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";

package/lib/utils/js-utils.d.ts

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

package/lib/utils/js-utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.keysOf = exports.isString = exports.isEmptyObject = exports.isObject = void 0;
+exports.capitalize = exports.keysOf = exports.isString = exports.isEmptyObject = exports.isObject = void 0;
 function isObject(obj) {
     const type = typeof obj;
     return type === 'function' || (type === 'object' && !!obj);
@@ -20,3 +20,10 @@ function keysOf(obj) {
     return Object.keys(obj);
 }
 exports.keysOf = keysOf;
+function capitalize(s) {
+    if ((s === null || s === void 0 ? void 0 : s.length) > 0) {
+        return s[0].toUpperCase() + s.slice(1);
+    }
+    return s;
+}
+exports.capitalize = capitalize;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/cli",
-  "version": "1.8.2",
+  "version": "1.9.1",
   "description": "",
   "license": "MIT",
   "bin": {
@@ -36,7 +36,7 @@
     "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/openapi-core": "1.8.2",
+    "@redocly/openapi-core": "1.9.1",
     "abort-controller": "^3.0.0",
     "chokidar": "^3.5.1",
     "colorette": "^1.2.0",

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

@@ -1,5 +1,5 @@
 import { ConfigFixture } from './../../__tests__/fixtures/config';
-import { firstDocument, secondDocument } from '../documents';
+import { firstDocument, secondDocument, thirdDocument } from '../documents';
 
 import type { Document } from '@redocly/openapi-core';
 
@@ -47,6 +47,9 @@ export class BaseResolver {
     )
     .mockImplementationOnce(() =>
       Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: secondDocument })
+    )
+    .mockImplementationOnce(() =>
+      Promise.resolve({ source: { absoluteRef: 'ref' }, parsed: thirdDocument })
     );
 }
 

package/src/__mocks__/documents.ts

@@ -4,7 +4,7 @@ export const firstDocument = {
   info: {
     description: 'example test',
     version: '1.0.0',
-    title: 'Swagger Petstore',
+    title: 'First API',
     termsOfService: 'http://swagger.io/terms/',
     license: {
       name: 'Apache 2.0',
@@ -36,7 +36,7 @@ export const secondDocument = {
   info: {
     description: 'example test',
     version: '1.0.0',
-    title: 'Swagger Petstore',
+    title: 'Second API',
     termsOfService: 'http://swagger.io/terms/',
     license: {
       name: 'Apache 2.0',
@@ -61,3 +61,64 @@ export const secondDocument = {
   },
   components: {},
 };
+
+export const thirdDocument = {
+  openapi: '3.0.0',
+  info: {
+    title: 'Third API',
+    version: '1.0',
+  },
+  servers: [
+    {
+      url: 'https://api.server.test/v1',
+    },
+  ],
+  paths: {},
+  components: {
+    schemas: {
+      SchemaWithNull: {
+        type: 'string',
+        default: null,
+        nullable: true,
+      },
+      SchemaWithRef: {
+        type: 'object',
+        properties: {
+          schemaType: {
+            type: 'string',
+            enum: ['foo'],
+          },
+          foo: {
+            $ref: '#/components/schemas/SchemaWithNull',
+          },
+        },
+      },
+      SchemaWithDiscriminator: {
+        discriminator: {
+          propertyName: 'schemaType',
+          mapping: {
+            foo: '#/components/schemas/SchemaWithRef',
+            bar: '#/components/schemas/SchemaWithNull',
+          },
+        },
+        oneOf: [
+          {
+            $ref: '#/components/schemas/SchemaWithRef',
+          },
+          {
+            type: 'object',
+            properties: {
+              schemaType: {
+                type: 'string',
+                enum: ['bar'],
+              },
+              bar: {
+                type: 'string',
+              },
+            },
+          },
+        ],
+      },
+    },
+  },
+};

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

@@ -1,7 +1,7 @@
-import { handleJoin } from '../../commands/join';
-import { exitWithError, writeToFileByExtension, writeYaml } from '../../utils/miscellaneous';
 import { yellow } from 'colorette';
 import { detectSpec } from '@redocly/openapi-core';
+import { handleJoin } from '../../commands/join';
+import { exitWithError, writeToFileByExtension } from '../../utils/miscellaneous';
 import { loadConfig } from '../../__mocks__/@redocly/openapi-core';
 import { ConfigFixture } from '../fixtures/config';
 
@@ -9,7 +9,7 @@ jest.mock('../../utils/miscellaneous');
 
 jest.mock('colorette');
 
-describe('handleJoin fails', () => {
+describe('handleJoin', () => {
   const colloreteYellowMock = yellow as jest.Mock<any, any>;
   colloreteYellowMock.mockImplementation((string: string) => string);
 
@@ -181,4 +181,138 @@ describe('handleJoin fails', () => {
     expect(config.styleguide.skipDecorators).not.toHaveBeenCalled();
     expect(config.styleguide.skipPreprocessors).not.toHaveBeenCalled();
   });
+
+  it('should handle join with prefix-components-with-info-prop and null values', async () => {
+    (detectSpec as jest.Mock).mockReturnValue('oas3_0');
+
+    await handleJoin(
+      {
+        apis: ['first.yaml', 'second.yaml', 'third.yaml'],
+        'prefix-components-with-info-prop': 'title',
+        output: 'join-result.yaml',
+      },
+      ConfigFixture as any,
+      'cli-version'
+    );
+
+    expect(writeToFileByExtension).toHaveBeenCalledWith(
+      {
+        openapi: '3.0.0',
+        info: {
+          description: 'example test',
+          version: '1.0.0',
+          title: 'First API',
+          termsOfService: 'http://swagger.io/terms/',
+          license: {
+            name: 'Apache 2.0',
+            url: 'http://www.apache.org/licenses/LICENSE-2.0.html',
+          },
+        },
+        servers: [
+          {
+            url: 'http://localhost:8080',
+          },
+          {
+            url: 'https://api.server.test/v1',
+          },
+        ],
+        tags: [
+          {
+            name: 'pet',
+            'x-displayName': 'pet',
+          },
+        ],
+        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: {
+          schemas: {
+            'Third API_SchemaWithNull': {
+              type: 'string',
+              default: null,
+              nullable: true,
+            },
+            'Third API_SchemaWithRef': {
+              type: 'object',
+              properties: {
+                schemaType: {
+                  type: 'string',
+                  enum: ['foo'],
+                },
+                foo: {
+                  $ref: '#/components/schemas/Third API_SchemaWithNull',
+                },
+              },
+            },
+            'Third API_SchemaWithDiscriminator': {
+              discriminator: {
+                propertyName: 'schemaType',
+                mapping: {
+                  foo: '#/components/schemas/Third API_SchemaWithRef',
+                  bar: '#/components/schemas/Third API_SchemaWithNull',
+                },
+              },
+              oneOf: [
+                {
+                  $ref: '#/components/schemas/Third API_SchemaWithRef',
+                },
+                {
+                  type: 'object',
+                  properties: {
+                    schemaType: {
+                      type: 'string',
+                      enum: ['bar'],
+                    },
+                    bar: {
+                      type: 'string',
+                    },
+                  },
+                },
+              ],
+            },
+          },
+        },
+        'x-tagGroups': [
+          {
+            name: 'First API',
+            tags: ['pet'],
+          },
+        ],
+      },
+      'join-result.yaml',
+      true
+    );
+  });
 });

package/src/cms/commands/__tests__/push-status.test.ts

@@ -90,7 +90,7 @@ describe('handlePushStatus()', () => {
     );
     expect(process.stdout.write).toHaveBeenCalledTimes(1);
     expect(process.stdout.write).toHaveBeenCalledWith(
-      '🚀 PREVIEW deployment succeeded.\nPreview URL: https://test-url\n'
+      '🚀 Preview deploy success.\nPreview URL: https://test-url\n'
     );
   });
 
@@ -110,10 +110,10 @@ describe('handlePushStatus()', () => {
     );
     expect(process.stdout.write).toHaveBeenCalledTimes(2);
     expect(process.stdout.write).toHaveBeenCalledWith(
-      '🚀 PREVIEW deployment succeeded.\nPreview URL: https://test-url\n'
+      '🚀 Preview deploy success.\nPreview URL: https://test-url\n'
     );
     expect(process.stdout.write).toHaveBeenCalledWith(
-      '🚀 PRODUCTION deployment succeeded.\nPreview URL: https://test-url\n'
+      '🚀 Production deploy success.\nProduction URL: https://test-url\n'
     );
   });
 
@@ -139,7 +139,7 @@ describe('handlePushStatus()', () => {
       mockConfig
     );
     expect(exitWithError).toHaveBeenCalledWith(
-      '❌ PREVIEW deployment failed.\nPreview URL: https://test-url'
+      '❌ Preview deploy fail.\nPreview URL: https://test-url'
     );
   });
 
@@ -176,7 +176,7 @@ describe('handlePushStatus()', () => {
     );
     expect(process.stdout.write).toHaveBeenCalledTimes(4);
     expect(process.stdout.write).toHaveBeenCalledWith(
-      '🚀 PREVIEW deployment succeeded.\nPreview URL: https://test-url\n'
+      '🚀 Preview deploy success.\nPreview URL: https://test-url\n'
     );
     expect(process.stdout.write).toHaveBeenCalledWith('\nScorecard:');
     expect(process.stdout.write).toHaveBeenCalledWith(

package/src/cms/commands/push-status.ts

@@ -5,6 +5,7 @@ import { Spinner } from '../../utils/spinner';
 import { DeploymentError } from '../utils';
 import { yellow } from 'colorette';
 import { ReuniteApiClient, getApiKeys, getDomain } from '../api';
+import { capitalize } from '../../utils/js-utils';
 
 import type { DeploymentStatus, PushResponse, ScorecardItem } from '../api/types';
 
@@ -177,15 +178,15 @@ function displayDeploymentAndBuildStatus({
     case 'success':
       spinner.stop();
       return process.stdout.write(
-        `${colors.green(
-          `🚀 ${buildType.toLocaleUpperCase()} deployment succeeded.`
-        )}\n${colors.magenta('Preview URL')}: ${colors.cyan(previewUrl!)}\n`
+        `${colors.green(`🚀 ${capitalize(buildType)} deploy success.`)}\n${colors.magenta(
+          `${capitalize(buildType)} URL`
+        )}: ${colors.cyan(previewUrl!)}\n`
       );
     case 'failed':
       spinner.stop();
       throw new DeploymentError(
-        `${colors.red(`❌ ${buildType.toLocaleUpperCase()} deployment failed.`)}\n${colors.magenta(
-          'Preview URL'
+        `${colors.red(`❌ ${capitalize(buildType)} deploy fail.`)}\n${colors.magenta(
+          `${capitalize(buildType)} URL`
         )}: ${colors.cyan(previewUrl!)}`
       );
     case 'pending':