@redocly/openapi-core 1.0.0-beta.104 → 1.0.0-beta.107

package/src/config/rules.ts

@@ -1,12 +1,12 @@
 import { RuleSet, OasVersion } from '../oas-types';
-import { LintConfig } from './config';
+import { StyleguideConfig } from './config';
 import { notUndefined } from '../utils';
 
 export function initRules<T extends Function, P extends RuleSet<T>>(
   rules: P[],
-  config: LintConfig,
+  config: StyleguideConfig,
   type: 'rules' | 'preprocessors' | 'decorators',
-  oasVersion: OasVersion,
+  oasVersion: OasVersion
 ) {
   return rules
     .flatMap((ruleset) =>
@@ -31,7 +31,7 @@ export function initRules<T extends Function, P extends RuleSet<T>>(
             severity: ruleSettings.severity,
             ruleId,
             visitor: visitor,
-          }))
+          }));
         }
 
         return {
@@ -39,8 +39,8 @@ export function initRules<T extends Function, P extends RuleSet<T>>(
           ruleId,
           visitor: visitors, // note: actually it is only one visitor object
         };
-      }),
+      })
     )
-    .flatMap(visitor => visitor)
+    .flatMap((visitor) => visitor)
     .filter(notUndefined);
 }

package/src/config/types.ts

@@ -29,7 +29,7 @@ export type PreprocessorConfig =
 
 export type DecoratorConfig = PreprocessorConfig;
 
-export type LintRawConfig = {
+export type StyleguideRawConfig = {
   plugins?: (string | Plugin)[];
   extends?: string[];
   doNotResolveExamples?: boolean;
@@ -51,7 +51,9 @@ export type LintRawConfig = {
   oas3_1Decorators?: Record<string, DecoratorConfig>;
 };
 
-export type ResolvedLintConfig = PluginLintConfig & {
+export type ApiStyleguideRawConfig = Omit<StyleguideRawConfig, 'plugins'>;
+
+export type ResolvedStyleguideConfig = PluginStyleguideConfig & {
   plugins?: Plugin[];
   recommendedFallback?: boolean;
   extends?: void | never;
@@ -71,7 +73,7 @@ export type DecoratorsConfig = {
 
 export type TypesExtensionFn = (
   types: Record<string, NodeType>,
-  oasVersion: OasVersion,
+  oasVersion: OasVersion
 ) => Record<string, NodeType>;
 
 export type TypeExtensionsConfig = Partial<Record<OasMajorVersion, TypesExtensionFn>>;
@@ -83,14 +85,14 @@ export type CustomRulesConfig = {
 
 export type Plugin = {
   id: string;
-  configs?: Record<string, PluginLintConfig>;
+  configs?: Record<string, PluginStyleguideConfig>;
   rules?: CustomRulesConfig;
   preprocessors?: PreprocessorsConfig;
   decorators?: DecoratorsConfig;
   typeExtension?: TypeExtensionsConfig;
 };
 
-export type PluginLintConfig = Omit<LintRawConfig, 'plugins' | 'extends'>;
+export type PluginStyleguideConfig = Omit<StyleguideRawConfig, 'plugins' | 'extends'>;
 
 export type ResolveHeader =
   | {
@@ -123,35 +125,42 @@ export type Region = 'us' | 'eu';
 
 export type AccessTokens = { [region in Region]?: string };
 
-export type DeprecatedRawConfig = {
+export type DeprecatedInRawConfig = {
   apiDefinitions?: Record<string, string>;
-  lint?: LintRawConfig;
-  resolve?: RawResolveConfig;
-  region?: Region;
+  lint?: StyleguideRawConfig;
   referenceDocs?: Record<string, any>;
+  apis?: Record<string, Api & DeprecatedInApi>;
 };
 
 export type Api = {
   root: string;
-  lint?: Omit<LintRawConfig, 'plugins'>;
-  'features.openapi'?: Record<string, any>;
-  'features.mockServer'?: Record<string, any>;
+  styleguide?: ApiStyleguideRawConfig;
+} & FeaturesConfig;
+
+export type DeprecatedInApi = {
+  lint?: ApiStyleguideRawConfig;
+};
+
+export type ResolvedApi = Omit<Api, 'styleguide'> & {
+  styleguide: ResolvedStyleguideConfig;
 };
-export type ResolvedApi = Omit<Api, 'lint'> & { lint: Omit<ResolvedLintConfig, 'plugins'>};
 
 export type RawConfig = {
   apis?: Record<string, Api>;
-  lint?: LintRawConfig;
+  styleguide?: StyleguideRawConfig;
   resolve?: RawResolveConfig;
   region?: Region;
-  'features.openapi'?: Record<string, any>;
-  'features.mockServer'?: Record<string, any>;
   organization?: string;
+} & FeaturesConfig;
+
+export type ResolvedConfig = Omit<RawConfig, 'apis' | 'styleguide'> & {
+  apis: Record<string, ResolvedApi>;
+  styleguide: ResolvedStyleguideConfig;
 };
 
-export type ResolvedConfig = Omit<RawConfig, 'lint' | 'apis'> & {
-  lint: ResolvedLintConfig;
-  apis: Record<string,ResolvedApi>
+type FeaturesConfig = {
+  'features.openapi'?: Record<string, any>;
+  'features.mockServer'?: Record<string, any>;
 };
 
 export type RulesFields =

package/src/config/utils.ts

@@ -1,15 +1,20 @@
-import { green, yellow } from 'colorette';
-import { assignExisting } from '../utils';
+import { yellow } from 'colorette';
+import {
+  assignExisting,
+  showErrorForDeprecatedField,
+  showWarningForDeprecatedField,
+} from '../utils';
 import { Config } from './config';
 
 import type {
   Api,
-  DeprecatedRawConfig,
+  DeprecatedInApi,
+  DeprecatedInRawConfig,
   Plugin,
   RawConfig,
   RawResolveConfig,
   ResolveConfig,
-  ResolvedLintConfig,
+  ResolvedStyleguideConfig,
   RulesFields,
 } from './types';
 
@@ -23,15 +28,27 @@ export function parsePresetName(presetName: string): { pluginId: string; configN
 }
 
 export function transformApiDefinitionsToApis(
-  apiDefinitions: Record<string, string> = {},
-): Record<string, Api> {
-  let apis: Record<string, Api> = {};
+  apiDefinitions?: DeprecatedInRawConfig['apiDefinitions']
+): Record<string, Api> | undefined {
+  if (!apiDefinitions) return undefined;
+  const apis: Record<string, Api> = {};
   for (const [apiName, apiPath] of Object.entries(apiDefinitions)) {
     apis[apiName] = { root: apiPath };
   }
   return apis;
 }
 
+function transformApis(
+  legacyApis?: Record<string, Api & DeprecatedInApi>
+): Record<string, Api> | undefined {
+  if (!legacyApis) return undefined;
+  const apis: Record<string, Api> = {};
+  for (const [apiName, { lint, ...apiContent }] of Object.entries(legacyApis)) {
+    apis[apiName] = { styleguide: lint, ...apiContent };
+  }
+  return apis;
+}
+
 export function prefixRules<T extends Record<string, any>>(rules: T, prefix: string) {
   if (!prefix) return rules;
 
@@ -43,9 +60,9 @@ export function prefixRules<T extends Record<string, any>>(rules: T, prefix: str
   return res;
 }
 
-export function mergeExtends(rulesConfList: ResolvedLintConfig[]) {
-  const result: Omit<ResolvedLintConfig, RulesFields> &
-    Required<Pick<ResolvedLintConfig, RulesFields>> = {
+export function mergeExtends(rulesConfList: ResolvedStyleguideConfig[]) {
+  const result: Omit<ResolvedStyleguideConfig, RulesFields> &
+    Required<Pick<ResolvedStyleguideConfig, RulesFields>> = {
     rules: {},
     oas2Rules: {},
     oas3_0Rules: {},
@@ -69,11 +86,7 @@ export function mergeExtends(rulesConfList: ResolvedLintConfig[]) {
   for (let rulesConf of rulesConfList) {
     if (rulesConf.extends) {
       throw new Error(
-        `\`extends\` is not supported in shared configs yet: ${JSON.stringify(
-          rulesConf,
-          null,
-          2,
-        )}.`,
+        `'extends' is not supported in shared configs yet: ${JSON.stringify(rulesConf, null, 2)}.`
       );
     }
 
@@ -109,75 +122,84 @@ export function mergeExtends(rulesConfList: ResolvedLintConfig[]) {
   return result;
 }
 
-export function getMergedConfig(config: Config, entrypointAlias?: string): Config {
+export function getMergedConfig(config: Config, apiName?: string): Config {
   const extendPaths = [
-    ...Object.values(config.apis).map((api) => api?.lint?.extendPaths),
-    config.rawConfig?.lint?.extendPaths,
+    ...Object.values(config.apis).map((api) => api?.styleguide?.extendPaths),
+    config.rawConfig?.styleguide?.extendPaths,
   ]
     .flat()
     .filter(Boolean) as string[];
 
   const pluginPaths = [
-    ...Object.values(config.apis).map((api) => api?.lint?.pluginPaths),
-    config.rawConfig?.lint?.pluginPaths,
+    ...Object.values(config.apis).map((api) => api?.styleguide?.pluginPaths),
+    config.rawConfig?.styleguide?.pluginPaths,
   ]
     .flat()
     .filter(Boolean) as string[];
 
-  return entrypointAlias
+  return apiName
     ? new Config(
         {
           ...config.rawConfig,
-          lint: {
-            ...(config.apis[entrypointAlias]
-              ? config.apis[entrypointAlias].lint
-              : config.rawConfig.lint),
+          styleguide: {
+            ...(config.apis[apiName]
+              ? config.apis[apiName].styleguide
+              : config.rawConfig.styleguide),
             extendPaths,
             pluginPaths,
           },
           'features.openapi': {
             ...config['features.openapi'],
-            ...config.apis[entrypointAlias]?.['features.openapi'],
+            ...config.apis[apiName]?.['features.openapi'],
           },
           'features.mockServer': {
             ...config['features.mockServer'],
-            ...config.apis[entrypointAlias]?.['features.mockServer'],
+            ...config.apis[apiName]?.['features.mockServer'],
           },
           // TODO: merge everything else here
         },
-        config.configFile,
+        config.configFile
       )
     : config;
 }
 
-export function transformConfig(rawConfig: DeprecatedRawConfig | RawConfig): RawConfig {
-  if ((rawConfig as RawConfig).apis && (rawConfig as DeprecatedRawConfig).apiDefinitions) {
-    throw new Error("Do not use 'apiDefinitions' field. Use 'apis' instead.\n");
-  }
-  if (
-    (rawConfig as RawConfig)['features.openapi'] &&
-    (rawConfig as DeprecatedRawConfig).referenceDocs
-  ) {
-    throw new Error("Do not use 'referenceDocs' field. Use 'features.openapi' instead.\n");
-  }
-  const { apiDefinitions, referenceDocs, ...rest } = rawConfig as DeprecatedRawConfig & RawConfig;
-  if (apiDefinitions) {
-    process.stderr.write(
-      `The ${yellow('apiDefinitions')} field is deprecated. Use ${green(
-        'apis',
-      )} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`,
+function checkForDeprecatedFields(
+  deprecatedField: keyof DeprecatedInRawConfig,
+  updatedField: keyof RawConfig,
+  rawConfig: DeprecatedInRawConfig & RawConfig
+): void {
+  const isDeprecatedFieldInApis =
+    rawConfig.apis &&
+    Object.values(rawConfig.apis).some(
+      (api: Api & DeprecatedInApi & DeprecatedInRawConfig) => api[deprecatedField]
     );
+
+  if (rawConfig[deprecatedField] && rawConfig[updatedField]) {
+    showErrorForDeprecatedField(deprecatedField, updatedField);
   }
-  if (referenceDocs) {
-    process.stderr.write(
-      `The ${yellow('referenceDocs')} field is deprecated. Use ${green(
-        'features.openapi',
-      )} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`,
-    );
+
+  if (rawConfig[deprecatedField] || isDeprecatedFieldInApis) {
+    showWarningForDeprecatedField(deprecatedField, updatedField);
+  }
+}
+
+export function transformConfig(rawConfig: DeprecatedInRawConfig & RawConfig): RawConfig {
+  const migratedFields: [keyof DeprecatedInRawConfig, keyof RawConfig][] = [
+    ['apiDefinitions', 'apis'],
+    ['referenceDocs', 'features.openapi'],
+    ['lint', 'styleguide'], // TODO: update docs
+  ];
+
+  for (const [deprecatedField, updatedField] of migratedFields) {
+    checkForDeprecatedFields(deprecatedField, updatedField, rawConfig);
   }
+
+  const { apis, apiDefinitions, referenceDocs, lint, ...rest } = rawConfig;
+
   return {
     'features.openapi': referenceDocs,
-    apis: transformApiDefinitionsToApis(apiDefinitions),
+    apis: transformApis(apis) || transformApiDefinitionsToApis(apiDefinitions),
+    styleguide: lint,
     ...rest,
   };
 }
@@ -199,9 +221,7 @@ export function getUniquePlugins(plugins: Plugin[]): Plugin[] {
       results.push(p);
       seen.add(p.id);
     } else if (p.id) {
-      process.stderr.write(
-        `Duplicate plugin id "${yellow(p.id)}".\n`,
-      );
+      process.stderr.write(`Duplicate plugin id "${yellow(p.id)}".\n`);
     }
   }
   return results;

package/src/decorators/__tests__/filter-out.test.ts

@@ -27,7 +27,8 @@ describe('oas3 filter-out', () => {
               callbacks:
                 x-access: protected
                 orderInProgress:
-                  x-internal: true`);
+                  x-internal: true`
+  );
 
   it('should remove /pet path and y parameter', async () => {
     const testDocument = parseYamlToDocument(
@@ -132,7 +133,8 @@ describe('oas3 filter-out', () => {
                     type: object
       components: {}
             
-        `);
+        `
+    );
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
@@ -185,7 +187,8 @@ describe('oas3 filter-out', () => {
           x:
             name: x
             
-            `);
+            `
+    );
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
@@ -236,7 +239,8 @@ describe('oas3 filter-out', () => {
           x:
             name: x
             
-            `);
+            `
+    );
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),

package/src/decorators/__tests__/remove-x-internal.test.ts

@@ -18,7 +18,7 @@ describe('oas3 remove-x-internal', () => {
         parameters:
           x:
             name: x
-    `,
+    `
   );
 
   it('should use `internalFlagProperty` option to remove internal paths', async () => {
@@ -87,7 +87,7 @@ describe('oas3 remove-x-internal', () => {
               name: x
             y:
               name: y
-      `,
+      `
     );
     const { bundle: res } = await bundleDocument({
       document: testDoc,
@@ -160,7 +160,7 @@ describe('oas3 remove-x-internal', () => {
                     servers:
                       - url: //callback-url.path-level/v1
                         description: Path level server
-      `,
+      `
     );
     const { bundle: res } = await bundleDocument({
       document: testDoc,
@@ -234,7 +234,7 @@ describe('oas3 remove-x-internal', () => {
               schema:
                 type: string
               x-internal: true
-      `,
+      `
     );
     const { bundle: res } = await bundleDocument({
       document: testDoc,
@@ -297,7 +297,7 @@ describe('oas2 remove-x-internal', () => {
                 '200':
                   x-internal: true
                   description: List of recent media entries.
-      `,
+      `
     );
     const { bundle: res } = await bundleDocument({
       document: testDoc,

package/src/decorators/common/filters/filter-helper.ts

@@ -47,7 +47,7 @@ export function checkIfMatchByStrategy(
   decoratorValue: any,
   strategy: 'all' | 'any'
 ): boolean {
-  if (nodeValue===undefined || decoratorValue===undefined) {
+  if (nodeValue === undefined || decoratorValue === undefined) {
     return false;
   }
 

package/src/decorators/common/info-description-override.ts

@@ -8,7 +8,7 @@ export const InfoDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ filePat
       leave(info, { report, location }: UserContext) {
         if (!filePath)
           throw new Error(
-            `Parameter "filePath" is not provided for "info-description-override" rule`,
+            `Parameter "filePath" is not provided for "info-description-override" rule`
           );
         try {
           info.description = readFileAsStringSync(filePath);

package/src/decorators/common/operation-description-override.ts

@@ -11,7 +11,7 @@ export const OperationDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ op
         if (!operation.operationId) return;
         if (!operationIds)
           throw new Error(
-            `Parameter "operationIds" is not provided for "operation-description-override" rule`,
+            `Parameter "operationIds" is not provided for "operation-description-override" rule`
           );
         const operationId = operation.operationId;
         if (operationIds[operationId]) {

package/src/decorators/common/remove-x-internal.ts

@@ -53,7 +53,7 @@ export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({ internalFlagPro
     any: {
       enter: (node, ctx) => {
         removeInternal(node, ctx);
-      }
-    }
-  }
-}
+      },
+    },
+  };
+};

package/src/decorators/common/tag-description-override.ts

@@ -8,7 +8,7 @@ export const TagDescriptionOverride: Oas3Decorator | Oas2Decorator = ({ tagNames
       leave(tag, { report }: UserContext) {
         if (!tagNames)
           throw new Error(
-            `Parameter "tagNames" is not provided for "tag-description-override" rule`,
+            `Parameter "tagNames" is not provided for "tag-description-override" rule`
           );
         if (tagNames[tag.name]) {
           try {

package/src/format/codeframes.ts

@@ -63,7 +63,7 @@ export function getCodeframe(location: LineColLocationObject, color: boolean) {
     line: string,
     startIdx: number = -1,
     endIdx: number = +Infinity,
-    variant = gray,
+    variant = gray
   ) {
     if (!color) return line;
     if (!line) return line;
@@ -84,14 +84,14 @@ function printPrefixedLines(lines: [string, string][]): string {
 
   const padLen = Math.max(...existingLines.map(([prefix]) => prefix.length));
   const dedentLen = Math.min(
-    ...existingLines.map(([_, line]) => (line === '' ? Infinity : padSize(line))),
+    ...existingLines.map(([_, line]) => (line === '' ? Infinity : padSize(line)))
   );
 
   return existingLines
     .map(
       ([prefix, line]) =>
         gray(leftPad(padLen, prefix) + ' |') +
-        (line ? ' ' + limitLineLength(line.substring(dedentLen)) : ''),
+        (line ? ' ' + limitLineLength(line.substring(dedentLen)) : '')
     )
     .join('\n');
 }
@@ -146,7 +146,7 @@ export function getLineColLocation(location: LocationObject): LineColLocationObj
 function positionsToLoc(
   source: string,
   startPos: number,
-  endPos: number,
+  endPos: number
 ): { start: Loc; end: Loc } {
   let currentLine = 1;
   let currentCol = 1;

package/src/format/format.ts

@@ -14,7 +14,7 @@ const coreVersion = require('../../package.json').version;
 
 import { NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject } from '../walk';
 import { getCodeframe, getLineColLocation } from './codeframes';
-import { env } from "../config";
+import { env } from '../config';
 
 export type Totals = {
   errors: number;
@@ -84,7 +84,7 @@ export function formatProblems(
     color?: boolean;
     totals: Totals;
     version: string;
-  },
+  }
 ) {
   const {
     maxProblems = 100,
@@ -120,7 +120,7 @@ export function formatProblems(
     case 'stylish': {
       const groupedByFile = groupByFiles(problems);
       for (const [file, { ruleIdPad, locationPad: positionPad, fileProblems }] of Object.entries(
-        groupedByFile,
+        groupedByFile
       )) {
         process.stderr.write(`${blue(path.relative(cwd, file))}:\n`);
 
@@ -156,8 +156,8 @@ export function formatProblems(
   if (totalProblems - ignoredProblems > maxProblems) {
     process.stderr.write(
       `< ... ${totalProblems - maxProblems} more problems hidden > ${gray(
-        'increase with `--max-problems N`',
-      )}\n`,
+        'increase with `--max-problems N`'
+      )}\n`
     );
   }
 
@@ -243,12 +243,12 @@ export function formatProblems(
   function formatStylish(problem: OnlyLineColProblem, locationPad: number, ruleIdPad: number) {
     const color = COLORS[problem.severity];
     if (!SEVERITY_NAMES[problem.severity]) {
-      return 'Error not found severity. Please check your config file. Allowed values: \`warn,error,off\`'
+      return 'Error not found severity. Please check your config file. Allowed values: `warn,error,off`';
     }
     const severityName = color(SEVERITY_NAMES[problem.severity].toLowerCase().padEnd(7));
     const { start } = problem.location[0];
     return `  ${`${start.line}:${start.col}`.padEnd(
-      locationPad,
+      locationPad
     )}  ${severityName}  ${problem.ruleId.padEnd(ruleIdPad)}  ${problem.message}`;
   }
 
@@ -258,7 +258,7 @@ export function formatProblems(
     const message = xmlEscape(problem.message);
     const source = xmlEscape(problem.ruleId);
     process.stdout.write(
-      `<error line="${line}" column="${col}" severity="${severity}" message="${message}" source="${source}" />\n`,
+      `<error line="${line}" column="${col}" severity="${severity}" message="${message}" source="${source}" />\n`
     );
   }
 }
@@ -307,12 +307,12 @@ const groupByFiles = (problems: NormalizedProblem[]) => {
     fileGroups[absoluteRef].fileProblems.push(mappedProblem);
     fileGroups[absoluteRef].ruleIdPad = Math.max(
       problem.ruleId.length,
-      fileGroups[absoluteRef].ruleIdPad,
+      fileGroups[absoluteRef].ruleIdPad
     );
 
     fileGroups[absoluteRef].locationPad = Math.max(
       Math.max(...mappedProblem.location.map((loc) => `${loc.start.line}:${loc.start.col}`.length)),
-      fileGroups[absoluteRef].locationPad,
+      fileGroups[absoluteRef].locationPad
     );
   }
 

package/src/index.ts

@@ -1,4 +1,4 @@
-export { BundleOutputFormat, readFileFromUrl, slash } from './utils';
+export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
@@ -23,7 +23,7 @@ export { Stats } from './rules/other/stats';
 
 export {
   Config,
-  LintConfig,
+  StyleguideConfig,
   RawConfig,
   IGNORE_FILE,
   Region,
@@ -33,10 +33,9 @@ export {
   getConfig,
   findConfig,
   CONFIG_FILE_NAMES,
-  RuleSeverity
+  RuleSeverity,
 } from './config';
 
-
 export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
 
 export {

package/src/js-yaml/index.ts

@@ -1,18 +1,13 @@
 // TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
 // @ts-ignore
-import { JSON_SCHEMA, types, LoadOptions, DumpOptions, load, dump  } from 'js-yaml';
+import { JSON_SCHEMA, types, LoadOptions, DumpOptions, load, dump } from 'js-yaml';
 
 const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = JSON_SCHEMA.extend({
   implicit: [types.merge],
-  explicit: [
-    types.binary,
-    types.omap,
-    types.pairs,
-    types.set,
-  ],
+  explicit: [types.binary, types.omap, types.pairs, types.set],
 });
 
 export const parseYaml = (str: string, opts?: LoadOptions): unknown =>
-  load(str, {schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts});
+  load(str, { schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts });
 
 export const stringifyYaml = (obj: any, opts?: DumpOptions): string => dump(obj, opts);