@redocly/cli 1.9.0 → 1.10.0

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/fetch-with-timeout.ts

@@ -1,5 +1,6 @@
 import nodeFetch from 'node-fetch';
 import AbortController from 'abort-controller';
+import { getProxyAgent } from '@redocly/openapi-core';
 
 const TIMEOUT = 3000;
 
@@ -10,7 +11,11 @@ export default async (url: string, options = {}) => {
       controller.abort();
     }, TIMEOUT);
 
-    const res = await nodeFetch(url, { signal: controller.signal, ...options });
+    const res = await nodeFetch(url, {
+      signal: controller.signal,
+      ...options,
+      agent: getProxyAgent(),
+    });
     clearTimeout(timeout);
     return res;
   } catch (e) {

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);
 }