@redocly/cli 1.8.2 → 1.9.1

package/src/commands/join.ts

@@ -4,22 +4,16 @@ import { performance } from 'perf_hooks';
 const isEqual = require('lodash.isequal');
 import {
   Config,
-  Oas3Definition,
   SpecVersion,
   BaseResolver,
-  Document,
   StyleguideConfig,
-  Oas3Tag,
   formatProblems,
   getTotals,
   lintDocument,
   detectSpec,
   bundleDocument,
-  Referenced,
   isRef,
-  RuleSeverity,
 } from '@redocly/openapi-core';
-
 import {
   getFallbackApisOrExit,
   printExecutionTime,
@@ -32,16 +26,24 @@ import {
   checkForDeprecatedOptions,
 } from '../utils/miscellaneous';
 import { isObject, isString, keysOf } from '../utils/js-utils';
-import {
+import { COMPONENTS, OPENAPI3_METHOD } from './split/types';
+import { crawl, startsWithComponents } from './split';
+
+import type {
+  Oas3Definition,
+  Document,
+  Oas3Tag,
+  Referenced,
+  RuleSeverity,
+} from '@redocly/openapi-core';
+import type { BundleResult } from '@redocly/openapi-core/lib/bundle';
+import type {
   Oas3Parameter,
   Oas3PathItem,
   Oas3Server,
   Oas3_1Definition,
 } from '@redocly/openapi-core/lib/typings/openapi';
-import { OPENAPI3_METHOD } from './split/types';
-import { BundleResult } from '@redocly/openapi-core/lib/bundle';
 
-const COMPONENTS = 'components';
 const Tags = 'tags';
 const xTagGroups = 'x-tagGroups';
 let potentialConflictsTotal = 0;
@@ -49,6 +51,7 @@ let potentialConflictsTotal = 0;
 type JoinDocumentContext = {
   api: string;
   apiFilename: string;
+  apiTitle?: string;
   tags: Oas3Tag[];
   potentialConflicts: any;
   tagsPrefix: string;
@@ -209,6 +212,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     const context = {
       api,
       apiFilename,
+      apiTitle: info?.title,
       tags,
       potentialConflicts,
       tagsPrefix,
@@ -218,7 +222,6 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
       populateTags(context);
     }
     collectServers(openapi);
-    collectInfoDescriptions(openapi, context);
     collectExternalDocs(openapi, context);
     collectPaths(openapi, context);
     collectComponents(openapi, context);
@@ -242,6 +245,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
   function populateTags({
     api,
     apiFilename,
+    apiTitle,
     tags,
     potentialConflicts,
     tagsPrefix,
@@ -285,9 +289,10 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
       }
 
       if (!withoutXTagGroups) {
-        createXTagGroups(apiFilename);
+        const groupName = apiTitle || apiFilename;
+        createXTagGroups(groupName);
         if (!tagDuplicate) {
-          populateXTagGroups(entrypointTagName, getIndexGroup(apiFilename));
+          populateXTagGroups(entrypointTagName, getIndexGroup(groupName));
         }
       }
 
@@ -302,20 +307,20 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     }
   }
 
-  function getIndexGroup(apiFilename: string): number {
-    return joinedDef[xTagGroups].findIndex((item: any) => item.name === apiFilename);
+  function getIndexGroup(name: string): number {
+    return joinedDef[xTagGroups].findIndex((item: any) => item.name === name);
   }
 
-  function createXTagGroups(apiFilename: string) {
+  function createXTagGroups(name: string) {
     if (!joinedDef.hasOwnProperty(xTagGroups)) {
       joinedDef[xTagGroups] = [];
     }
 
-    if (!joinedDef[xTagGroups].some((g: any) => g.name === apiFilename)) {
-      joinedDef[xTagGroups].push({ name: apiFilename, tags: [] });
+    if (!joinedDef[xTagGroups].some((g: any) => g.name === name)) {
+      joinedDef[xTagGroups].push({ name, tags: [] });
     }
 
-    const indexGroup = getIndexGroup(apiFilename);
+    const indexGroup = getIndexGroup(name);
 
     if (!joinedDef[xTagGroups][indexGroup].hasOwnProperty(Tags)) {
       joinedDef[xTagGroups][indexGroup][Tags] = [];
@@ -344,27 +349,6 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
     }
   }
 
-  function collectInfoDescriptions(
-    openapi: Oas3Definition,
-    { apiFilename, componentsPrefix }: JoinDocumentContext
-  ) {
-    const { info } = openapi;
-    if (info?.description) {
-      const groupIndex = joinedDef[xTagGroups] ? getIndexGroup(apiFilename) : -1;
-      if (
-        joinedDef.hasOwnProperty(xTagGroups) &&
-        groupIndex !== -1 &&
-        joinedDef[xTagGroups][groupIndex]['tags'] &&
-        joinedDef[xTagGroups][groupIndex]['tags'].length
-      ) {
-        joinedDef[xTagGroups][groupIndex]['description'] = addComponentsPrefix(
-          info.description,
-          componentsPrefix!
-        );
-      }
-    }
-  }
-
   function collectExternalDocs(openapi: Oas3Definition, { api }: JoinDocumentContext) {
     const { externalDocs } = openapi;
     if (externalDocs) {
@@ -380,7 +364,14 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
 
   function collectPaths(
     openapi: Oas3Definition,
-    { apiFilename, api, potentialConflicts, tagsPrefix, componentsPrefix }: JoinDocumentContext
+    {
+      apiFilename,
+      apiTitle,
+      api,
+      potentialConflicts,
+      tagsPrefix,
+      componentsPrefix,
+    }: JoinDocumentContext
   ) {
     const { paths } = openapi;
     const operationsSet = new Set(keysOf<typeof OPENAPI3_METHOD>(OPENAPI3_METHOD));
@@ -532,6 +523,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
         populateTags({
           api,
           apiFilename,
+          apiTitle,
           tags: formatTags(tags),
           potentialConflicts,
           tagsPrefix,
@@ -542,6 +534,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
         populateTags({
           api,
           apiFilename,
+          apiTitle,
           tags: formatTags(['other']),
           potentialConflicts,
           tagsPrefix: tagsPrefix || apiFilename,
@@ -599,7 +592,14 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
   function collectWebhooks(
     oasVersion: SpecVersion,
     openapi: Oas3_1Definition,
-    { apiFilename, api, potentialConflicts, tagsPrefix, componentsPrefix }: JoinDocumentContext
+    {
+      apiFilename,
+      apiTitle,
+      api,
+      potentialConflicts,
+      tagsPrefix,
+      componentsPrefix,
+    }: JoinDocumentContext
   ) {
     const webhooks = oasVersion === SpecVersion.OAS3_1 ? 'webhooks' : 'x-webhooks';
     const openapiWebhooks = openapi[webhooks];
@@ -628,6 +628,7 @@ export async function handleJoin(argv: JoinOptions, config: Config, packageVersi
             populateTags({
               api,
               apiFilename,
+              apiTitle,
               tags: formatTags(tags),
               potentialConflicts,
               tagsPrefix,
@@ -757,8 +758,11 @@ function addComponentsPrefix(description: string, componentsPrefix: string) {
 function addSecurityPrefix(security: any, componentsPrefix: string) {
   return componentsPrefix
     ? security?.map((s: any) => {
-        const key = Object.keys(s)[0];
-        return { [componentsPrefix + '_' + key]: s[key] };
+        const joinedSecuritySchema = {};
+        for (const [key, value] of Object.entries(s)) {
+          Object.assign(joinedSecuritySchema, { [componentsPrefix + '_' + key]: value });
+        }
+        return joinedSecuritySchema;
       })
     : security;
 }
@@ -799,30 +803,19 @@ async function validateApi(
   }
 }
 
-function crawl(object: any, visitor: any) {
-  if (!isObject(object)) return;
-  for (const key of Object.keys(object)) {
-    visitor(object, key);
-    crawl(object[key], visitor);
-  }
-}
-
-function replace$Refs(obj: any, componentsPrefix: string) {
-  crawl(obj, (node: any) => {
-    if (node.$ref && isString(node.$ref) && node.$ref.startsWith(`#/${COMPONENTS}/`)) {
+function replace$Refs(obj: unknown, componentsPrefix: string) {
+  crawl(obj, (node: Record<string, unknown>) => {
+    if (node.$ref && typeof node.$ref === 'string' && startsWithComponents(node.$ref)) {
       const name = path.basename(node.$ref);
       node.$ref = node.$ref.replace(name, componentsPrefix + '_' + name);
-    } else if (
-      node.discriminator &&
-      node.discriminator.mapping &&
-      isObject(node.discriminator.mapping)
-    ) {
+    } else if (isObject(node.discriminator) && isObject(node.discriminator.mapping)) {
       const { mapping } = node.discriminator;
       for (const name of Object.keys(mapping)) {
-        if (isString(mapping[name]) && mapping[name].startsWith(`#/${COMPONENTS}/`)) {
-          mapping[name] = mapping[name]
+        const mappingPointer = mapping[name];
+        if (typeof mappingPointer === 'string' && startsWithComponents(mappingPointer)) {
+          mapping[name] = mappingPointer
             .split('/')
-            .map((name: string, i: number, arr: []) => {
+            .map((name, i, arr) => {
               return arr.length - 1 === i && !name.includes(componentsPrefix)
                 ? componentsPrefix + '_' + name
                 : name;

package/src/commands/split/index.ts

@@ -1,11 +1,9 @@
 import { red, blue, yellow, green } from 'colorette';
 import * as fs from 'fs';
 import { parseYaml, slash, isRef, isTruthy } from '@redocly/openapi-core';
-import type { OasRef } from '@redocly/openapi-core';
 import * as path from 'path';
 import { performance } from 'perf_hooks';
 const isEqual = require('lodash.isequal');
-
 import {
   printExecutionTime,
   pathToFilename,
@@ -16,8 +14,16 @@ import {
   writeToFileByExtension,
   getAndValidateFileExtension,
 } from '../../utils/miscellaneous';
-import { isString, isObject, isEmptyObject } from '../../utils/js-utils';
+import { isObject, isEmptyObject } from '../../utils/js-utils';
 import {
+  OPENAPI3_COMPONENT,
+  COMPONENTS,
+  OPENAPI3_METHOD_NAMES,
+  OPENAPI3_COMPONENT_NAMES,
+} from './types';
+
+import type { OasRef } from '@redocly/openapi-core';
+import type {
   Definition,
   Oas2Definition,
   Oas3Schema,
@@ -26,13 +32,8 @@ import {
   Oas3Components,
   Oas3ComponentName,
   ComponentsFiles,
-  refObj,
+  RefObject,
   Oas3PathItem,
-  OPENAPI3_COMPONENT,
-  COMPONENTS,
-  componentsPath,
-  OPENAPI3_METHOD_NAMES,
-  OPENAPI3_COMPONENT_NAMES,
   Referenced,
 } from './types';
 
@@ -93,8 +94,8 @@ function splitDefinition(
   writeToFileByExtension(openapi, path.join(openapiDir, `openapi.${ext}`));
 }
 
-function isStartsWithComponents(node: string) {
-  return node.startsWith(componentsPath);
+export function startsWithComponents(node: string) {
+  return node.startsWith(`#/${COMPONENTS}/`);
 }
 
 function isSupportedExtension(filename: string) {
@@ -144,33 +145,31 @@ function traverseDirectoryDeepCallback(
   writeToFileByExtension(pathData, filename);
 }
 
-function crawl(object: any, visitor: any) {
+export function crawl(object: unknown, visitor: (node: Record<string, unknown>) => void) {
   if (!isObject(object)) return;
+
+  visitor(object);
   for (const key of Object.keys(object)) {
-    visitor(object, key);
     crawl(object[key], visitor);
   }
 }
 
-function replace$Refs(obj: any, relativeFrom: string, componentFiles = {} as ComponentsFiles) {
-  crawl(obj, (node: any) => {
-    if (node.$ref && isString(node.$ref) && isStartsWithComponents(node.$ref)) {
-      replace(node, '$ref');
-    } else if (
-      node.discriminator &&
-      node.discriminator.mapping &&
-      isObject(node.discriminator.mapping)
-    ) {
+function replace$Refs(obj: unknown, relativeFrom: string, componentFiles = {} as ComponentsFiles) {
+  crawl(obj, (node: Record<string, unknown>) => {
+    if (node.$ref && typeof node.$ref === 'string' && startsWithComponents(node.$ref)) {
+      replace(node as RefObject, '$ref');
+    } else if (isObject(node.discriminator) && isObject(node.discriminator.mapping)) {
       const { mapping } = node.discriminator;
       for (const name of Object.keys(mapping)) {
-        if (isString(mapping[name]) && isStartsWithComponents(mapping[name])) {
-          replace(node.discriminator.mapping, name);
+        const mappingPointer = mapping[name];
+        if (typeof mappingPointer === 'string' && startsWithComponents(mappingPointer)) {
+          replace(node.discriminator.mapping as RefObject, name);
         }
       }
     }
   });
 
-  function replace(node: refObj, key: string) {
+  function replace(node: RefObject, key: string) {
     const splittedNode = node[key].split('/');
     const name = splittedNode.pop();
     const groupName = splittedNode[2];

package/src/commands/split/types.ts

@@ -28,7 +28,7 @@ export type Definition = Oas3_1Definition | Oas3Definition | Oas2Definition;
 export interface ComponentsFiles {
   [schemas: string]: any;
 }
-export interface refObj {
+export interface RefObject {
   [$ref: string]: string;
 }
 
@@ -36,8 +36,6 @@ export const COMPONENTS = 'components';
 export const PATHS = 'paths';
 export const WEBHOOKS = 'webhooks';
 export const xWEBHOOKS = 'x-webhooks';
-export const componentsPath = `#/${COMPONENTS}/`;
-
 export enum OPENAPI3_METHOD {
   get = 'get',
   put = 'put',

package/src/utils/js-utils.ts

@@ -1,4 +1,4 @@
-export function isObject(obj: any) {
+export function isObject(obj: unknown): obj is Record<string, unknown> {
   const type = typeof obj;
   return type === 'function' || (type === 'object' && !!obj);
 }
@@ -15,3 +15,10 @@ export function keysOf<T>(obj: T) {
   if (!obj) return [];
   return Object.keys(obj) as (keyof T)[];
 }
+
+export function capitalize(s: string) {
+  if (s?.length > 0) {
+    return s[0].toUpperCase() + s.slice(1);
+  }
+  return s;
+}