@redocly/openapi-core 1.0.0-beta.105 → 1.0.0-beta.108

package/src/rules/other/stats.ts

@@ -4,10 +4,26 @@ import { StatsAccumulator } from '../../typings/common';
 
 export const Stats = (statsAccumulator: StatsAccumulator) => {
   return {
-    ExternalDocs: { leave() { statsAccumulator.externalDocs.total++; }},
-    ref: { enter(ref: OasRef) { statsAccumulator.refs.items!.add(ref['$ref']); }},
-    Tag: { leave(tag: Oas3Tag) { statsAccumulator.tags.items!.add(tag.name); }},
-    Link: { leave(link: any) { statsAccumulator.links.items!.add(link.operationId); }},
+    ExternalDocs: {
+      leave() {
+        statsAccumulator.externalDocs.total++;
+      },
+    },
+    ref: {
+      enter(ref: OasRef) {
+        statsAccumulator.refs.items!.add(ref['$ref']);
+      },
+    },
+    Tag: {
+      leave(tag: Oas3Tag) {
+        statsAccumulator.tags.items!.add(tag.name);
+      },
+    },
+    Link: {
+      leave(link: any) {
+        statsAccumulator.links.items!.add(link.operationId);
+      },
+    },
     DefinitionRoot: {
       leave() {
         statsAccumulator.parameters.total = statsAccumulator.parameters.items!.size;
@@ -19,26 +35,39 @@ export const Stats = (statsAccumulator: StatsAccumulator) => {
     WebhooksMap: {
       Operation: {
         leave(operation: any) {
-          operation.tags.forEach((tag: string) => { statsAccumulator.tags.items!.add(tag); })
-        }
-      }
+          operation.tags.forEach((tag: string) => {
+            statsAccumulator.tags.items!.add(tag);
+          });
+        },
+      },
     },
     PathMap: {
       PathItem: {
-        leave() { statsAccumulator.pathItems.total++; },
+        leave() {
+          statsAccumulator.pathItems.total++;
+        },
         Operation: {
           leave(operation: any) {
             statsAccumulator.operations.total++;
-            operation.tags && operation.tags.forEach((tag: string) => { statsAccumulator.tags.items!.add(tag); })
-          }
+            operation.tags &&
+              operation.tags.forEach((tag: string) => {
+                statsAccumulator.tags.items!.add(tag);
+              });
+          },
+        },
+        Parameter: {
+          leave(parameter: Oas2Parameter | Oas3Parameter) {
+            statsAccumulator.parameters.items!.add(parameter.name);
+          },
         },
-        Parameter: { leave(parameter: Oas2Parameter | Oas3Parameter) {
-          statsAccumulator.parameters.items!.add(parameter.name)
-        }},
       },
     },
     NamedSchemas: {
-      Schema: { leave() { statsAccumulator.schemas.total++; }}
-    }
-  }
-}
+      Schema: {
+        leave() {
+          statsAccumulator.schemas.total++;
+        },
+      },
+    },
+  };
+};

package/src/rules/utils.ts

@@ -3,12 +3,15 @@ import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
 import { validateJsonSchema } from './ajv';
 import { Oas3Schema, Referenced } from '../typings/openapi';
+import { showErrorForDeprecatedField, showWarningForDeprecatedField } from '../utils';
 
 export function oasTypeOf(value: unknown) {
   if (Array.isArray(value)) {
     return 'array';
   } else if (value === null) {
     return 'null';
+  } else if (Number.isInteger(value)) {
+    return 'integer';
   } else {
     return typeof value;
   }
@@ -23,7 +26,7 @@ export function oasTypeOf(value: unknown) {
  */
 export function matchesJsonSchemaType(value: unknown, type: string, nullable: boolean): boolean {
   if (nullable && value === null) {
-    return value === null;
+    return true;
   }
 
   switch (type) {
@@ -89,7 +92,7 @@ export function validateExample(
   schema: Referenced<Oas3Schema>,
   dataLoc: Location,
   { resolve, location, report }: UserContext,
-  disallowAdditionalProperties: boolean,
+  allowAdditionalProperties: boolean
 ) {
   try {
     const { valid, errors } = validateJsonSchema(
@@ -98,10 +101,10 @@ export function validateExample(
       location.child('schema'),
       dataLoc.pointer,
       resolve,
-      disallowAdditionalProperties,
+      allowAdditionalProperties
     );
     if (!valid) {
-      for (let error of errors) {
+      for (const error of errors) {
         report({
           message: `Example value must conform to the schema: ${error.message}.`,
           location: {
@@ -121,3 +124,16 @@ export function validateExample(
     });
   }
 }
+
+export function getAdditionalPropertiesOption(opts: Record<string, any>): boolean {
+  if (opts.disallowAdditionalProperties === undefined) {
+    return opts.allowAdditionalProperties;
+  }
+
+  if (opts.allowAdditionalProperties !== undefined) {
+    showErrorForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties');
+  }
+
+  showWarningForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties');
+  return !opts.disallowAdditionalProperties;
+}

package/src/types/index.ts

@@ -24,7 +24,7 @@ export type NodeType = {
   items?: string;
   required?: string[] | ((value: any, key: string | number | undefined) => string[]);
   requiredOneOf?: string[];
-  allowed?: ((value: any) => string[] | undefined);
+  allowed?: (value: any) => string[] | undefined;
   extensionsPrefix?: string;
 };
 type PropType = string | NodeType | ScalarSchema | undefined | null;
@@ -37,14 +37,14 @@ export type NormalizedNodeType = {
   items?: NormalizedNodeType;
   required?: string[] | ((value: any, key: string | number | undefined) => string[]);
   requiredOneOf?: string[];
-  allowed?: ((value: any) => string[] | undefined);
+  allowed?: (value: any) => string[] | undefined;
   extensionsPrefix?: string;
 };
 
 type NormalizedPropType = NormalizedNodeType | NormalizedScalarSchema | undefined | null;
 type NormalizedResolveTypeFn = (
   value: any,
-  key: string,
+  key: string
 ) => NormalizedNodeType | NormalizedScalarSchema | undefined | null;
 
 export function listOf(typeName: string) {
@@ -65,7 +65,7 @@ export function mapOf(typeName: string) {
 
 export function normalizeTypes(
   types: Record<string, NodeType>,
-  options: { doNotResolveExamples?: boolean } = {},
+  options: { doNotResolveExamples?: boolean } = {}
 ): Record<string, NormalizedNodeType> {
   const normalizedTypes: Record<string, NormalizedNodeType> = {};
 
@@ -132,7 +132,7 @@ export function normalizeTypes(
 }
 
 export function isNamedType(
-  t: NormalizedNodeType | NormalizedScalarSchema | null | undefined,
+  t: NormalizedNodeType | NormalizedScalarSchema | null | undefined
 ): t is NormalizedNodeType {
   return typeof t?.name === 'string';
 }

package/src/types/redocly-yaml.ts

@@ -40,7 +40,7 @@ const builtInRulesList = [
   'no-identical-paths',
   'no-ambiguous-paths',
   'no-undefined-server-variable',
-  'no-servers-empty-enum',
+  'no-server-variables-empty-enum',
   'no-http-verbs-in-paths',
   'path-excludes-patterns',
   'request-mime-type',
@@ -110,7 +110,8 @@ const ConfigRoot: NodeType = {
       properties: {},
       additionalProperties: { properties: { type: 'string' } },
     }, // deprecated
-    lint: 'RootConfigLint',
+    styleguide: 'RootConfigStyleguide',
+    lint: 'RootConfigStyleguide', // deprecated
     'features.openapi': 'ConfigReferenceDocs',
     referenceDocs: 'ConfigReferenceDocs', // deprecated
     'features.mockServer': 'ConfigMockServer',
@@ -137,7 +138,7 @@ const ConfigApisProperties: NodeType = {
         type: 'string',
       },
     },
-    lint: 'ConfigLint',
+    styleguide: 'ConfigStyleguide',
     'features.openapi': 'ConfigReferenceDocs',
     'features.mockServer': 'ConfigMockServer',
   },
@@ -155,7 +156,7 @@ const ConfigHTTP: NodeType = {
   },
 };
 
-const ConfigLint: NodeType = {
+const ConfigStyleguide: NodeType = {
   properties: {
     extends: {
       type: 'array',
@@ -179,13 +180,13 @@ const ConfigLint: NodeType = {
   },
 };
 
-const RootConfigLint: NodeType = {
+const RootConfigStyleguide: NodeType = {
   properties: {
     plugins: {
       type: 'array',
       items: { type: 'string' },
     },
-    ...ConfigLint.properties,
+    ...ConfigStyleguide.properties,
   },
 };
 
@@ -877,8 +878,8 @@ export const ConfigTypes: Record<string, NodeType> = {
   ConfigRoot,
   ConfigApis,
   ConfigApisProperties,
-  RootConfigLint,
-  ConfigLint,
+  RootConfigStyleguide,
+  ConfigStyleguide,
   ConfigReferenceDocs,
   ConfigMockServer,
   ConfigHTTP,

package/src/typings/common.ts

@@ -5,5 +5,13 @@ export interface StatsRow {
   items?: Set<string>;
 }
 
-export type StatsName = 'operations' | 'refs' | 'tags' | 'externalDocs' | 'pathItems' | 'links' | 'schemas' | 'parameters';
+export type StatsName =
+  | 'operations'
+  | 'refs'
+  | 'tags'
+  | 'externalDocs'
+  | 'pathItems'
+  | 'links'
+  | 'schemas'
+  | 'parameters';
 export type StatsAccumulator = Record<StatsName, StatsRow>;

package/src/typings/openapi.ts

@@ -156,7 +156,7 @@ export interface Oas3Schema {
 export type Oas3_1Schema = Oas3Schema & {
   type?: string | string[];
   examples?: any[];
-}
+};
 
 export interface Oas3_1Definition extends Oas3Definition {
   webhooks?: Oas3_1Webhooks;

package/src/utils.ts

@@ -6,7 +6,8 @@ import * as pluralize from 'pluralize';
 import { parseYaml } from './js-yaml';
 import { UserContext } from './walk';
 import { HttpResolveConfig } from './config';
-import { env } from './config';
+import { env } from './env';
+import { logger, colorize } from './logger';
 
 export { parseYaml, stringifyYaml } from './js-yaml';
 
@@ -95,7 +96,7 @@ export function omitObjectProps<T extends Record<string, unknown>>(
 export function splitCamelCaseIntoWords(str: string) {
   const camel = str
     .split(/(?:[-._])|([A-Z][a-z]+)/)
-    .filter(Boolean)
+    .filter(isTruthy)
     .map((item) => item.toLocaleLowerCase());
   const caps = str
     .split(/([A-Z]{2,})/)
@@ -182,7 +183,7 @@ export function isNotString<T>(value: string | T): value is T {
 }
 
 export function assignExisting<T>(target: Record<string, T>, obj: Record<string, T>) {
-  for (let k of Object.keys(obj)) {
+  for (const k of Object.keys(obj)) {
     if (target.hasOwnProperty(k)) {
       target[k] = obj[k];
     }
@@ -204,3 +205,25 @@ export function doesYamlFileExist(filePath: string): boolean {
     fs.existsSync(filePath)
   );
 }
+
+export function showWarningForDeprecatedField(deprecatedField: string, updatedField: string) {
+  logger.warn(
+    `The ${colorize.red(deprecatedField)} field is deprecated. Use ${colorize.green(
+      updatedField
+    )} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`
+  );
+}
+
+export function showErrorForDeprecatedField(deprecatedField: string, updatedField: string) {
+  throw new Error(`Do not use '${deprecatedField}' field. Use '${updatedField}' instead.\n`);
+}
+
+export type Falsy = undefined | null | false | '' | 0;
+
+export function isTruthy<Truthy>(value: Truthy | Falsy): value is Truthy {
+  return !!value;
+}
+
+export function identity<T>(value: T): T {
+  return value;
+}

package/src/visitors.ts

@@ -53,7 +53,7 @@ export type VisitFunction<T> = (
   node: T,
   ctx: UserContext & { ignoreNextVisitorsOnNode: () => void },
   parents?: any,
-  context?: any,
+  context?: any
 ) => void;
 
 type VisitRefFunction = (node: OasRef, ctx: UserContext, resolved: ResolveResult<any>) => void;
@@ -70,7 +70,7 @@ type NestedVisitObject<T, P> = VisitObject<T> & NestedVisitor<P>;
 
 type VisitFunctionOrObject<T> = VisitFunction<T> | VisitObject<T>;
 
-type VisitorNode<T extends any> = {
+type VisitorNode<T> = {
   ruleId: string;
   severity: ProblemSeverity;
   context: VisitorLevelContext | VisitorSkippedLevelContext;
@@ -264,7 +264,7 @@ export type RuleInstanceConfig = {
 
 export function normalizeVisitors<T extends BaseVisitor>(
   visitorsConfig: (RuleInstanceConfig & { visitor: NestedVisitObject<any, T> })[],
-  types: Record<keyof T, NormalizedNodeType>,
+  types: Record<keyof T, NormalizedNodeType>
 ): NormalizedOasVisitors<T> {
   const normalizedVisitors: NormalizedOasVisitors<T> = {} as any;
 
@@ -301,7 +301,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
     from: NormalizedNodeType,
     to: NormalizedNodeType,
     parentContext: VisitorLevelContext,
-    stack: NormalizedNodeType[] = [],
+    stack: NormalizedNodeType[] = []
   ) {
     if (stack.includes(from)) return;
 
@@ -309,7 +309,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
 
     const possibleChildren = new Set<NormalizedNodeType>();
 
-    for (let type of Object.values(from.properties)) {
+    for (const type of Object.values(from.properties)) {
       if (type === to) {
         addWeakFromStack(ruleConf, stack);
         continue;
@@ -333,7 +333,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
       }
     }
 
-    for (let fromType of Array.from(possibleChildren.values())) {
+    for (const fromType of Array.from(possibleChildren.values())) {
       addWeakNodes(ruleConf, fromType, to, parentContext, stack);
     }
 
@@ -350,7 +350,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
           visit: () => undefined,
           depth: 0,
           context: {
-            isSkippedLevel: true as true,
+            isSkippedLevel: true,
             seen: new Set(),
             parent: parentContext,
           },
@@ -363,7 +363,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
     ruleConf: RuleInstanceConfig,
     visitor: NestedVisitObject<any, T>,
     parentContext: VisitorLevelContext | null,
-    depth = 0,
+    depth = 0
   ) {
     const visitorKeys = Object.keys(types) as Array<keyof T | 'any'>;
 
@@ -407,7 +407,7 @@ export function normalizeVisitors<T extends BaseVisitor>(
         activatedOn: null,
         type: types[typeName],
         parent: parentContext,
-        isSkippedLevel: false as false,
+        isSkippedLevel: false,
       };
 
       if (typeof typeVisitor === 'object') {

package/src/walk.ts

@@ -18,6 +18,8 @@ import {
 import { pushStack, popStack } from './utils';
 import { OasVersion } from './oas-types';
 import { NormalizedNodeType, isNamedType } from './types';
+import type { RuleSeverity } from './config';
+
 type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
 
 export type ResolveResult<T extends NonUndefined> =
@@ -66,7 +68,7 @@ export type Problem = {
   suggest?: string[];
   location?: Partial<LocationObject> | Array<Partial<LocationObject>>;
   from?: LocationObject;
-  forceSeverity?: ProblemSeverity;
+  forceSeverity?: RuleSeverity;
   ruleId?: string;
 };
 
@@ -409,17 +411,19 @@ export function walkDocument<T>(opts: {
           : [opts.location]
         : [{ ...currentLocation, reportOnKey: false }];
 
-      ctx.problems.push({
-        ruleId: opts.ruleId || ruleId,
-        severity: opts.forceSeverity || severity,
-        ...opts,
-        suggest: opts.suggest || [],
-        location: loc.map((loc: any) => {
-          return { ...currentLocation, reportOnKey: false, ...loc };
-        }),
-      });
+      const ruleSeverity = opts.forceSeverity || severity;
+      if (ruleSeverity !== 'off') {
+        ctx.problems.push({
+          ruleId: opts.ruleId || ruleId,
+          severity: ruleSeverity,
+          ...opts,
+          suggest: opts.suggest || [],
+          location: loc.map((loc: any) => {
+            return { ...currentLocation, reportOnKey: false, ...loc };
+          }),
+        });
+      }
     }
-
     function getVisitorDataFn(ruleId: string) {
       ctx.visitorsData[ruleId] = ctx.visitorsData[ruleId] || {};
       return ctx.visitorsData[ruleId];