@redocly/openapi-core 1.3.0 → 1.4.0

package/src/rules/oas3/__tests__/spec/spec.test.ts

@@ -45,11 +45,11 @@ describe('Oas3 Structural visitor basic', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/info/contact/url",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -58,12 +58,12 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Expected type \`string\` but got \`array\`.",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/info/contact/email",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -72,12 +72,12 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Expected type \`string\` but got \`boolean\`.",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/info/license",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -86,15 +86,15 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Expected type \`License\` (object) but got \`string\`",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "from": Object {
+        {
+          "from": {
             "pointer": "#/servers/0/url",
             "source": "foobar.yaml",
           },
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/servers/0/variables/a",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -103,12 +103,12 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "The \`a\` variable is not used in the server's \`url\` field.",
           "ruleId": "no-undefined-server-variable",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/servers/0/variables/a/enum/0",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -117,12 +117,12 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Expected type \`string\` but got \`integer\`.",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/tags/0",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -131,12 +131,12 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Expected type \`Tag\` (object) but got \`number\`",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/tags/1",
               "reportOnKey": false,
               "source": "foobar.yaml",
@@ -145,7 +145,7 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Expected type \`Tag\` (object) but got \`string\`",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -179,11 +179,11 @@ describe('Oas3 Structural visitor basic', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/components1",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -192,13 +192,13 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Property \`components1\` is not expected here.",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [
+          "suggest": [
             "components",
           ],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/openapi",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -207,12 +207,12 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Servers must be present.",
           "ruleId": "no-empty-servers",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/info/contact/test",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -221,7 +221,7 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Property \`test\` is not expected here.",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -250,11 +250,11 @@ describe('Oas3 Structural visitor basic', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -263,11 +263,11 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "The field \`paths\` must be present on this level.",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/openapi",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -276,12 +276,12 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "Servers must be present.",
           "ruleId": "no-empty-servers",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/info",
               "reportOnKey": true,
               "source": "foobar.yaml",
@@ -290,7 +290,7 @@ describe('Oas3 Structural visitor basic', () => {
           "message": "The field \`title\` must be present on this level.",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);

package/src/rules/oas3/__tests__/spec-components-invalid-map-name.test.ts

@@ -36,10 +36,10 @@ describe('Oas3 spec-components-invalid-map-name', () => {
     });
 
     expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/components/parameters/my Param",
               "reportOnKey": true,
               "source": Source {
@@ -68,14 +68,14 @@ describe('Oas3 spec-components-invalid-map-name', () => {
               },
             },
           ],
-          "message": "The map key in parameters \\"my Param\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "message": "The map key in parameters "my Param" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
           "ruleId": "spec-components-invalid-map-name",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/components/schemas/first schema",
               "reportOnKey": true,
               "source": Source {
@@ -104,14 +104,14 @@ describe('Oas3 spec-components-invalid-map-name', () => {
               },
             },
           ],
-          "message": "The map key in schemas \\"first schema\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "message": "The map key in schemas "first schema" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
           "ruleId": "spec-components-invalid-map-name",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/components/responses/400 status",
               "reportOnKey": true,
               "source": Source {
@@ -140,14 +140,14 @@ describe('Oas3 spec-components-invalid-map-name', () => {
               },
             },
           ],
-          "message": "The map key in responses \\"400 status\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "message": "The map key in responses "400 status" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
           "ruleId": "spec-components-invalid-map-name",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
-          "location": Array [
-            Object {
+        {
+          "location": [
+            {
               "pointer": "#/components/examples/invalid identifier",
               "reportOnKey": true,
               "source": Source {
@@ -176,10 +176,10 @@ describe('Oas3 spec-components-invalid-map-name', () => {
               },
             },
           ],
-          "message": "The map key in examples \\"invalid identifier\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "message": "The map key in examples "invalid identifier" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
           "ruleId": "spec-components-invalid-map-name",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -212,7 +212,7 @@ describe('Oas3 spec-components-invalid-map-name', () => {
       }),
     });
 
-    expect(results).toMatchInlineSnapshot(`Array []`);
+    expect(results).toMatchInlineSnapshot(`[]`);
   });
 
   it('should not report invalid keys inside nested examples', async () => {
@@ -240,10 +240,10 @@ describe('Oas3 spec-components-invalid-map-name', () => {
     });
 
     expect(results).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
+      [
+        {
+          "location": [
+            {
               "pointer": "#/components/parameters/my Param",
               "reportOnKey": true,
               "source": Source {
@@ -265,10 +265,10 @@ describe('Oas3 spec-components-invalid-map-name', () => {
               },
             },
           ],
-          "message": "The map key in parameters \\"my Param\\" does not match the regular expression \\"^[a-zA-Z0-9\\\\.\\\\-_]+$\\"",
+          "message": "The map key in parameters "my Param" does not match the regular expression "^[a-zA-Z0-9\\.\\-_]+$"",
           "ruleId": "spec-components-invalid-map-name",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);

package/src/rules/oas3/index.ts

@@ -53,7 +53,7 @@ import { RequiredStringPropertyMissingMinLength } from '../common/required-strin
 import { SpecStrictRefs } from '../common/spec-strict-refs';
 import { ComponentNameUnique } from './component-name-unique';
 
-export const rules = {
+export const rules: Oas3RuleSet<'built-in'> = {
   spec: Spec,
   'info-contact': InfoContact,
   'info-license': InfoLicense,
@@ -64,7 +64,6 @@ export const rules = {
   assertions: Assertions,
   'operation-operationId-unique': OperationIdUnique,
   'operation-parameters-unique': OperationParametersUnique,
-  'path-parameters-defined': PathParamsDefined,
   'operation-tag-defined': OperationTagDefined,
   'no-example-value-and-externalValue': NoExampleValueAndExternalValue,
   'no-enum-type-mismatch': NoEnumTypeMismatch,
@@ -81,6 +80,7 @@ export const rules = {
   'operation-description': OperationDescription,
   'no-unused-components': NoUnusedComponents,
   'path-not-include-query': PathNotIncludeQuery,
+  'path-parameters-defined': PathParamsDefined,
   'path-params-defined': PathParamsDefined,
   'parameter-description': ParameterDescription,
   'operation-singular-tag': OperationSingularTag,
@@ -108,6 +108,6 @@ export const rules = {
   'required-string-property-missing-min-length': RequiredStringPropertyMissingMinLength,
   'spec-strict-refs': SpecStrictRefs,
   'component-name-unique': ComponentNameUnique,
-} as Oas3RuleSet;
+};
 
 export const preprocessors = {};

package/src/types/redocly-yaml.ts

@@ -4,64 +4,96 @@ import { NodeType, listOf } from '.';
 import { Oas3_1Types } from './oas3_1';
 import { omitObjectProps, pickObjectProps, isCustomRuleId } from '../utils';
 
-const builtInRulesList = [
+const builtInCommonRules = [
   'spec',
   'info-contact',
-  'info-license',
+  'operation-operationId',
+  'tag-description',
+  'tags-alphabetical',
+] as const;
+
+export type BuiltInCommonRuleId = typeof builtInCommonRules[number];
+
+const builtInCommonOASRules = [
   'info-license-url',
+  'info-license',
+  'no-ambiguous-paths',
+  'no-enum-type-mismatch',
+  'no-http-verbs-in-paths',
+  'no-identical-paths',
+  'no-invalid-parameter-examples',
+  'no-invalid-schema-examples',
+  'no-path-trailing-slash',
   'operation-2xx-response',
   'operation-4xx-response',
-  'operation-4xx-problem-details-rfc7807',
-  'assertions',
+  'operation-description',
   'operation-operationId-unique',
+  'operation-operationId-url-safe',
   'operation-parameters-unique',
-  'path-parameters-defined',
+  'operation-singular-tag',
+  'operation-summary',
   'operation-tag-defined',
-  'no-example-value-and-externalValue',
-  'no-enum-type-mismatch',
-  'no-path-trailing-slash',
-  'no-empty-servers',
+  'parameter-description',
   'path-declaration-must-exist',
-  'operation-operationId-url-safe',
-  'operation-operationId',
-  'operation-summary',
-  'tags-alphabetical',
-  'no-server-example.com',
-  'no-server-trailing-slash',
-  'tag-description',
-  'operation-description',
-  'no-unused-components',
+  'path-excludes-patterns',
+  'path-http-verbs-order',
   'path-not-include-query',
   'path-params-defined',
-  'parameter-description',
-  'operation-singular-tag',
+  'path-parameters-defined',
+  'path-segment-plural',
+  'paths-kebab-case',
+  'required-string-property-missing-min-length',
+  'response-contains-header',
+  'scalar-property-missing-example',
   'security-defined',
+  'spec-strict-refs',
   'no-unresolved-refs',
-  'paths-kebab-case',
+] as const;
+
+export type BuiltInCommonOASRuleId = typeof builtInCommonOASRules[number];
+
+const builtInOAS2Rules = [
   'boolean-parameter-prefixes',
-  'path-http-verbs-order',
+  'request-mime-type',
+  'response-contains-property',
+  'response-mime-type',
+] as const;
+
+export type BuiltInOAS2RuleId = typeof builtInOAS2Rules[number];
+
+const builtInOAS3Rules = [
+  'boolean-parameter-prefixes',
+  'component-name-unique',
+  'no-empty-servers',
+  'no-example-value-and-externalValue',
   'no-invalid-media-type-examples',
-  'no-identical-paths',
-  'no-ambiguous-paths',
-  'no-undefined-server-variable',
+  'no-server-example.com',
+  'no-server-trailing-slash',
   'no-server-variables-empty-enum',
-  'no-http-verbs-in-paths',
-  'path-excludes-patterns',
+  'no-undefined-server-variable',
+  'no-unused-components',
+  'operation-4xx-problem-details-rfc7807',
   'request-mime-type',
-  'response-mime-type',
-  'path-segment-plural',
-  'no-invalid-schema-examples',
-  'no-invalid-parameter-examples',
-  'response-contains-header',
   'response-contains-property',
-  'scalar-property-missing-example',
+  'response-mime-type',
   'spec-components-invalid-map-name',
-  'required-string-property-missing-min-length',
-  'spec-strict-refs',
-  'component-name-unique',
-  'channels-kebab-case',
-  'no-channel-trailing-slash',
-];
+] as const;
+
+export type BuiltInOAS3RuleId = typeof builtInOAS3Rules[number];
+
+const builtInAsync2Rules = ['channels-kebab-case', 'no-channel-trailing-slash'] as const;
+
+export type BuiltInAsync2RuleId = typeof builtInAsync2Rules[number];
+
+const builtInRules = [
+  ...builtInCommonRules,
+  ...builtInCommonOASRules,
+  ...builtInOAS2Rules,
+  ...builtInOAS3Rules,
+  ...builtInAsync2Rules,
+] as const;
+
+type BuiltInRuleId = typeof builtInRules[number];
 
 const nodeTypesList = [
   'any',
@@ -138,14 +170,17 @@ const ConfigStyleguide: NodeType = {
     oas2Rules: 'Rules',
     oas3_0Rules: 'Rules',
     oas3_1Rules: 'Rules',
+    async2Rules: 'Rules',
     preprocessors: { type: 'object' },
     oas2Preprocessors: { type: 'object' },
     oas3_0Preprocessors: { type: 'object' },
     oas3_1Preprocessors: { type: 'object' },
+    async2Preprocessors: { type: 'object' },
     decorators: { type: 'object' },
     oas2Decorators: { type: 'object' },
     oas3_0Decorators: { type: 'object' },
     oas3_1Decorators: { type: 'object' },
+    async2Decorators: { type: 'object' },
   },
 };
 
@@ -243,7 +278,7 @@ const Rules: NodeType = {
     } else if (key.startsWith('assert/')) {
       // keep the old assert/ prefix as an alias
       return 'Assert';
-    } else if (builtInRulesList.includes(key) || isCustomRuleId(key)) {
+    } else if (builtInRules.includes(key as BuiltInRuleId) || isCustomRuleId(key)) {
       if (typeof value === 'string') {
         return { enum: ['error', 'warn', 'off'] };
       } else {

package/src/visitors.ts

@@ -73,11 +73,11 @@ type VisitObject<T> = {
   skip?: SkipFunction<T>;
 };
 
-type NestedVisitObject<T, P> = VisitObject<T> & NestedVisitor<P>;
+export type NestedVisitObject<T, P> = VisitObject<T> & NestedVisitor<P>;
 
 type VisitFunctionOrObject<T> = VisitFunction<T> | VisitObject<T>;
 
-type VisitorNode<T> = {
+export type VisitorNode<T> = {
   ruleId: string;
   severity: ProblemSeverity;
   context: VisitorLevelContext | VisitorSkippedLevelContext;
@@ -113,7 +113,7 @@ export type VisitorSkippedLevelContext = {
   seen: Set<any>;
 };
 
-type NormalizeVisitor<Fn> = Fn extends VisitFunction<infer T> ? VisitorNode<T> : never;
+export type NormalizeVisitor<Fn> = Fn extends VisitFunction<infer T> ? VisitorNode<T> : never;
 
 export type BaseVisitor = {
   any?:

package/src/walk.ts

@@ -4,6 +4,9 @@ import type {
   NormalizedOasVisitors,
   VisitorSkippedLevelContext,
   VisitFunction,
+  BaseVisitor,
+  NormalizeVisitor,
+  VisitorNode,
 } from './visitors';
 import type { ResolvedRefMap, Document } from './resolve';
 import type { NormalizedNodeType } from './types';
@@ -15,13 +18,23 @@ import { ResolveError, YamlParseError, Source, makeRefId } from './resolve';
 import { SpecVersion } from './oas-types';
 import { isNamedType, SpecExtension } from './types';
 
-type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
+export type NonUndefined =
+  | string
+  | number
+  | boolean
+  | symbol
+  | bigint
+  | object
+  | Record<string, any>;
 
 export type ResolveResult<T extends NonUndefined> =
   | { node: T; location: Location; error?: ResolveError | YamlParseError }
   | { node: undefined; location: undefined; error?: ResolveError | YamlParseError };
 
-export type ResolveFn = <T>(node: Referenced<T>, from?: string) => ResolveResult<T>;
+export type ResolveFn = <T extends NonUndefined>(
+  node: Referenced<T>,
+  from?: string
+) => ResolveResult<T>;
 
 export type UserContext = {
   report(problem: Problem): void;
@@ -85,7 +98,7 @@ export type WalkContext = {
 };
 
 function collectParents(ctx: VisitorLevelContext) {
-  const parents: Record<string, any> = {};
+  const parents: Record<string, unknown> = {};
   while (ctx.parent) {
     parents[ctx.parent.type.name] = ctx.parent.activatedOn?.value.node;
     ctx = ctx.parent;
@@ -104,7 +117,7 @@ function collectParentsLocations(ctx: VisitorLevelContext) {
   return locations;
 }
 
-export function walkDocument<T>(opts: {
+export function walkDocument<T extends BaseVisitor>(opts: {
   document: Document;
   rootType: NormalizedNodeType;
   normalizedVisitors: NormalizedOasVisitors<T>;
@@ -112,7 +125,7 @@ export function walkDocument<T>(opts: {
   ctx: WalkContext;
 }) {
   const { document, rootType, normalizedVisitors, resolvedRefMap, ctx } = opts;
-  const seenNodesPerType: Record<string, Set<any>> = {};
+  const seenNodesPerType: Record<string, Set<unknown>> = {};
   const ignoredNodes = new Set<string>();
 
   walkNode(document.parsed, rootType, new Location(document.source, '#/'), undefined, '');
@@ -185,7 +198,7 @@ export function walkDocument<T>(opts: {
 
       const anyEnterVisitors = normalizedVisitors.any.enter;
       const currentEnterVisitors = anyEnterVisitors.concat(
-        normalizedVisitors[type.name]?.enter || []
+        (normalizedVisitors[type.name]?.enter as NormalizeVisitor<VisitorNode<unknown>[]>) || []
       );
 
       const activatedContexts: Array<VisitorSkippedLevelContext | VisitorLevelContext> = [];
@@ -328,7 +341,7 @@ export function walkDocument<T>(opts: {
         if (context.isSkippedLevel) {
           context.seen.delete(resolvedNode);
         } else {
-          context.activatedOn = popStack(context.activatedOn) as any;
+          context.activatedOn = popStack(context.activatedOn);
           if (context.parent) {
             let ctx: VisitorLevelContext | null = context.parent;
             while (ctx) {
@@ -378,9 +391,9 @@ export function walkDocument<T>(opts: {
 
     // returns true ignores all the next visitors on the specific node
     function visitWithContext(
-      visit: VisitFunction<any>,
-      resolvedNode: any,
-      node: any,
+      visit: VisitFunction<unknown>,
+      resolvedNode: unknown,
+      node: unknown,
       context: VisitorLevelContext,
       ruleId: string,
       severity: ProblemSeverity