@redocly/openapi-core 1.1.0 → 1.2.1

package/lib/types/oas3_1.js

@@ -135,7 +135,14 @@ const Schema = {
         maxContains: { type: 'integer', minimum: 0 },
         patternProperties: { type: 'object' },
         propertyNames: 'Schema',
-        unevaluatedItems: 'Schema',
+        unevaluatedItems: (value) => {
+            if (typeof value === 'boolean') {
+                return { type: 'boolean' };
+            }
+            else {
+                return 'Schema';
+            }
+        },
         unevaluatedProperties: (value) => {
             if (typeof value === 'boolean') {
                 return { type: 'boolean' };

package/lib/types/redocly-yaml.js

@@ -61,6 +61,8 @@ const builtInRulesList = [
     'required-string-property-missing-min-length',
     'spec-strict-refs',
     'component-name-unique',
+    'channels-kebab-case',
+    'no-channel-trailing-slash',
 ];
 const nodeTypesList = [
     'any',
@@ -122,6 +124,7 @@ const nodeTypesList = [
     'XCodeSampleList',
     'WebhooksMap',
     'SpecExtension',
+    'Message',
 ];
 const ConfigStyleguide = {
     properties: {

package/lib/typings/asyncapi.d.ts

@@ -0,0 +1,21 @@
+export interface Async2Definition {
+    asyncapi: string;
+    info?: Async2Info;
+}
+export interface Async2Info {
+    title: string;
+    version: string;
+    description?: string;
+    termsOfService?: string;
+    contact?: Async2Contact;
+    license?: Async2License;
+}
+export interface Async2Contact {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+export interface Async2License {
+    name: string;
+    url?: string;
+}

package/lib/typings/asyncapi.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/visitors.d.ts

@@ -4,6 +4,7 @@ import { NormalizedNodeType } from './types';
 import type { Stack } from './utils';
 import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
+import { Async2Definition } from './typings/asyncapi';
 export declare type SkipFunctionContext = Pick<UserContext, 'location' | 'rawNode' | 'resolve' | 'rawLocation'>;
 export declare type VisitFunction<T> = (node: T, ctx: UserContext & {
     ignoreNextVisitorsOnNode: () => void;
@@ -134,16 +135,24 @@ declare type Oas2FlatVisitor = {
     SecurityScheme?: VisitFunctionOrObject<Oas2SecurityScheme>;
     SpecExtension?: VisitFunctionOrObject<unknown>;
 };
+declare type Async2FlatVisitor = {
+    Root?: VisitFunctionOrObject<Async2Definition>;
+};
 declare type Oas3NestedVisitor = {
     [T in keyof Oas3FlatVisitor]: Oas3FlatVisitor[T] extends Function ? Oas3FlatVisitor[T] : Oas3FlatVisitor[T] & NestedVisitor<Oas3NestedVisitor>;
 };
 declare type Oas2NestedVisitor = {
     [T in keyof Oas2FlatVisitor]: Oas2FlatVisitor[T] extends Function ? Oas2FlatVisitor[T] : Oas2FlatVisitor[T] & NestedVisitor<Oas2NestedVisitor>;
 };
+declare type Async2NestedVisitor = {
+    [T in keyof Async2FlatVisitor]: Async2FlatVisitor[T] extends Function ? Async2FlatVisitor[T] : Async2FlatVisitor[T] & NestedVisitor<Async2NestedVisitor>;
+};
 export declare type Oas3Visitor = BaseVisitor & Oas3NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas3NestedVisitor>>;
 export declare type Oas2Visitor = BaseVisitor & Oas2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Oas2NestedVisitor>>;
+export declare type Async2Visitor = BaseVisitor & Async2NestedVisitor & Record<string, VisitFunction<any> | NestedVisitObject<any, Async2NestedVisitor>>;
 export declare type Oas3TransformVisitor = BaseVisitor & Oas3FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
 export declare type Oas2TransformVisitor = BaseVisitor & Oas2FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
+export declare type Async2TransformVisitor = BaseVisitor & Async2FlatVisitor & Record<string, VisitFunction<any> | VisitObject<any>>;
 export declare type NestedVisitor<T> = Exclude<T, 'any' | 'ref' | 'Root'>;
 export declare type NormalizedOasVisitors<T extends BaseVisitor> = {
     [V in keyof T]-?: {
@@ -162,10 +171,13 @@ export declare type NormalizedOasVisitors<T extends BaseVisitor> = {
 };
 export declare type Oas3Rule = (options: Record<string, any>) => Oas3Visitor | Oas3Visitor[];
 export declare type Oas2Rule = (options: Record<string, any>) => Oas2Visitor | Oas2Visitor[];
+export declare type Async2Rule = (options: Record<string, any>) => Async2Visitor | Async2Visitor[];
 export declare type Oas3Preprocessor = (options: Record<string, any>) => Oas3TransformVisitor;
 export declare type Oas2Preprocessor = (options: Record<string, any>) => Oas2TransformVisitor;
+export declare type Async2Preprocessor = (options: Record<string, any>) => Async2TransformVisitor;
 export declare type Oas3Decorator = (options: Record<string, any>) => Oas3TransformVisitor;
 export declare type Oas2Decorator = (options: Record<string, any>) => Oas2TransformVisitor;
+export declare type Async2Decorator = (options: Record<string, any>) => Async2TransformVisitor;
 export declare type OasRule = Oas3Rule;
 export declare type OasPreprocessor = Oas3Preprocessor;
 export declare type OasDecorator = Oas3Decorator;

package/lib/walk.d.ts

@@ -5,7 +5,7 @@ import type { NormalizedNodeType } from './types';
 import type { RuleSeverity } from './config';
 import { Location } from './ref-utils';
 import { ResolveError, YamlParseError, Source } from './resolve';
-import { OasVersion } from './oas-types';
+import { SpecVersion } from './oas-types';
 declare type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
 export declare type ResolveResult<T extends NonUndefined> = {
     node: T;
@@ -27,7 +27,7 @@ export declare type UserContext = {
     type: NormalizedNodeType;
     key: string | number;
     parent: any;
-    oasVersion: OasVersion;
+    oasVersion: SpecVersion;
     getVisitorData: () => Record<string, unknown>;
 };
 export declare type Loc = {
@@ -65,7 +65,7 @@ export declare type NormalizedProblem = {
 };
 export declare type WalkContext = {
     problems: NormalizedProblem[];
-    oasVersion: OasVersion;
+    oasVersion: SpecVersion;
     visitorsData: Record<string, Record<string, unknown>>;
     refTypes?: Map<string, NormalizedNodeType>;
 };

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "",
   "main": "lib/index.js",
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=14.19.0",
+    "npm": ">=7.0.0"
   },
   "engineStrict": true,
   "license": "MIT",
@@ -26,6 +27,7 @@
     "Swagger",
     "OpenAPI linter",
     "Swagger linter",
+    "AsyncAPI linter",
     "oas"
   ],
   "contributors": [

package/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -308,7 +308,7 @@ components:
 
 `;
 
-exports[`bundle should not place referened schema inline when component in question is not of type "schemas" 1`] = `
+exports[`bundle should not place referenced schema inline when component in question is not of type "schemas" 1`] = `
 openapi: 3.0.0
 paths:
   /pet:

package/src/__tests__/bundle.test.ts

@@ -1,11 +1,32 @@
 import outdent from 'outdent';
 import * as path from 'path';
 
-import { bundleDocument, bundle } from '../bundle';
+import { bundleDocument, bundle, bundleFromString } from '../bundle';
 import { parseYamlToDocument, yamlSerializer, makeConfig } from '../../__tests__/utils';
-import { StyleguideConfig, Config, ResolvedConfig } from '../config';
+import { StyleguideConfig, Config, ResolvedConfig, createConfig, loadConfig } from '../config';
 import { BaseResolver } from '../resolve';
 
+const stringDocument = outdent`
+  openapi: 3.0.0
+  paths:
+    /pet:
+      get:
+        operationId: get
+        parameters:
+          - $ref: '#/components/parameters/shared_a'
+          - name: get_b
+      post:
+        operationId: post
+        parameters:
+          - $ref: '#/components/parameters/shared_a'
+  components:
+    parameters:
+      shared_a:
+        name: shared-a
+`;
+
+const testDocument = parseYamlToDocument(stringDocument, '');
+
 describe('bundle', () => {
   const fetchMock = jest.fn(() =>
     Promise.resolve({
@@ -19,28 +40,6 @@ describe('bundle', () => {
 
   expect.addSnapshotSerializer(yamlSerializer);
 
-  const testDocument = parseYamlToDocument(
-    outdent`
-      openapi: 3.0.0
-      paths:
-        /pet:
-          get:
-            operationId: get
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-              - name: get_b
-          post:
-            operationId: post
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-      components:
-        parameters:
-          shared_a:
-            name: shared-a
-    `,
-    ''
-  );
-
   it('change nothing with only internal refs', async () => {
     const { bundle, problems } = await bundleDocument({
       document: testDocument,
@@ -97,7 +96,7 @@ describe('bundle', () => {
     expect(res.parsed).toMatchSnapshot();
   });
 
-  it('should not place referened schema inline when component in question is not of type "schemas"', async () => {
+  it('should not place referenced schema inline when component in question is not of type "schemas"', async () => {
     const { bundle: res, problems } = await bundle({
       config: new Config({} as ResolvedConfig),
       ref: path.join(__dirname, 'fixtures/refs/external-request-body.yaml'),
@@ -233,4 +232,45 @@ describe('bundle', () => {
 
     `);
   });
+
+  it('should throw an error when there is no document to bundle', () => {
+    const wrapper = () =>
+      bundle({
+        config: new Config({} as ResolvedConfig),
+      });
+
+    expect(wrapper()).rejects.toThrowError('Document or reference is required.\n');
+  });
+
+  it('should bundle with a doc provided', async () => {
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundle({
+      config: await loadConfig({ configPath: path.join(__dirname, 'fixtures/redocly.yaml') }),
+      doc: testDocument,
+    });
+
+    const origCopy = JSON.parse(JSON.stringify(testDocument.parsed));
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toEqual(origCopy);
+  });
+});
+
+describe('bundleFromString', () => {
+  it('should bundle from string using bundleFromString', async () => {
+    const {
+      bundle: { parsed, ...rest },
+      problems,
+    } = await bundleFromString({
+      config: await createConfig(`
+        extends:
+        - recommended
+      `),
+      source: testDocument.source.body,
+    });
+    expect(problems).toHaveLength(0);
+    expect(rest.source.body).toEqual(stringDocument);
+  });
 });

package/src/__tests__/fixtures/lint/openapi.yaml

@@ -0,0 +1,10 @@
+openapi: 3.0.0
+info:
+  title: Test API
+  version: '1.0'
+  description: Test
+  license: Fail
+
+servers:
+  - url: http://redocly-example.com
+paths: {}

package/src/__tests__/fixtures/redocly.yaml

@@ -0,0 +1,2 @@
+extends:
+  - recommended

package/src/__tests__/lint.test.ts

@@ -1,11 +1,11 @@
 import * as path from 'path';
 import { outdent } from 'outdent';
 
-import { lintFromString, lintConfig, lintDocument } from '../lint';
+import { lintFromString, lintConfig, lintDocument, lint } from '../lint';
 import { BaseResolver } from '../resolve';
 import { loadConfig } from '../config/load';
 import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
-import { detectOpenAPI } from '../oas-types';
+import { detectSpec } from '../oas-types';
 
 describe('lint', () => {
   it('lintFromString should work', async () => {
@@ -20,7 +20,7 @@ describe('lint', () => {
           license: Fail
 
         servers:
-          - url: http://example.com
+          - url: http://redocly-example.com
         paths: {}
     `,
       config: await loadConfig(),
@@ -46,6 +46,35 @@ describe('lint', () => {
     `);
   });
 
+  it('lint should work', async () => {
+    const results = await lint({
+      ref: path.join(__dirname, 'fixtures/lint/openapi.yaml'),
+      config: await loadConfig({
+        configPath: path.join(__dirname, 'fixtures/redocly.yaml'),
+      }),
+    });
+
+    expect(replaceSourceWithRef(results, path.join(__dirname, 'fixtures/lint/')))
+      .toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/info/license",
+              "reportOnKey": false,
+              "source": "openapi.yaml",
+            },
+          ],
+          "message": "Expected type \`License\` (object) but got \`string\`",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
   it('lintConfig should work', async () => {
     const document = parseYamlToDocument(
       outdent`
@@ -61,12 +90,12 @@ describe('lint', () => {
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
           rule/operation-summary-length:
-            subject: 
+            subject:
               type: Operation
               property: summary
             message: Operation summary should start with an active verb
             assertions:
-              local/checkWordsCount: 
+              local/checkWordsCount:
                 min: 3
       theme:
         openapi:
@@ -189,8 +218,8 @@ describe('lint', () => {
   it('lintConfig should work with legacy fields - referenceDocs', async () => {
     const document = parseYamlToDocument(
       outdent`
-        apis: 
-          entry: 
+        apis:
+          entry:
             root: ./file.yaml
         rules:
           operation-2xx-response: warn
@@ -304,11 +333,41 @@ describe('lint', () => {
       `,
       ''
     );
-    expect(() => detectOpenAPI(testDocument.parsed)).toThrow(
+    expect(() => detectSpec(testDocument.parsed)).toThrow(
       `Invalid OpenAPI version: should be a string but got "number"`
     );
   });
 
+  it('detect unsupported OpenAPI version', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        openapi: 1.0.4
+      `,
+      ''
+    );
+    expect(() => detectSpec(testDocument.parsed)).toThrow(`Unsupported OpenAPI version: 1.0.4`);
+  });
+
+  it('detect unsupported AsyncAPI version', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        asyncapi: 1.0.4
+      `,
+      ''
+    );
+    expect(() => detectSpec(testDocument.parsed)).toThrow(`Unsupported AsyncAPI version: 1.0.4`);
+  });
+
+  it('detect unsupported spec format', () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        notapi: 3.1.0
+      `,
+      ''
+    );
+    expect(() => detectSpec(testDocument.parsed)).toThrow(`Unsupported specification`);
+  });
+
   it("spec rule shouldn't throw an error for named callback", async () => {
     const document = parseYamlToDocument(
       outdent`

package/src/bundle.ts

@@ -1,12 +1,16 @@
 import isEqual = require('lodash.isequal');
-import { BaseResolver, resolveDocument, Document, ResolvedRefMap, makeRefId } from './resolve';
+import {
+  BaseResolver,
+  resolveDocument,
+  Document,
+  ResolvedRefMap,
+  makeRefId,
+  makeDocumentFromString,
+} from './resolve';
 import { Oas3Rule, normalizeVisitors, Oas3Visitor, Oas2Visitor } from './visitors';
-import { Oas3Types } from './types/oas3';
-import { Oas2Types } from './types/oas2';
-import { Oas3_1Types } from './types/oas3_1';
 import { NormalizedNodeType, normalizeTypes, NodeType } from './types';
 import { WalkContext, walkDocument, UserContext, ResolveResult, NormalizedProblem } from './walk';
-import { detectOpenAPI, openAPIMajor, OasMajorVersion } from './oas-types';
+import { detectSpec, getTypes, getMajorSpecVersion, SpecMajorVersion } from './oas-types';
 import { isAbsoluteUrl, isRef, Location, refBaseName } from './ref-utils';
 import { initRules } from './config/rules';
 import { reportUnresolvedRef } from './rules/no-unresolved-refs';
@@ -25,10 +29,7 @@ export enum OasVersion {
   Version3_0 = 'oas3_0',
   Version3_1 = 'oas3_1',
 }
-
-export async function bundle(opts: {
-  ref?: string;
-  doc?: Document;
+export type BundleOptions = {
   externalRefResolver?: BaseResolver;
   config: Config;
   dereference?: boolean;
@@ -36,7 +37,14 @@ export async function bundle(opts: {
   skipRedoclyRegistryRefs?: boolean;
   removeUnusedComponents?: boolean;
   keepUrlRefs?: boolean;
-}) {
+};
+
+export async function bundle(
+  opts: {
+    ref?: string;
+    doc?: Document;
+  } & BundleOptions
+) {
   const {
     ref,
     doc,
@@ -48,7 +56,7 @@ export async function bundle(opts: {
   }
 
   const document =
-    doc !== undefined ? doc : await externalRefResolver.resolveDocument(base, ref!, true);
+    doc === undefined ? await externalRefResolver.resolveDocument(base, ref!, true) : doc;
 
   if (document instanceof Error) {
     throw document;
@@ -62,6 +70,23 @@ export async function bundle(opts: {
   });
 }
 
+export async function bundleFromString(
+  opts: {
+    source: string;
+    absoluteRef?: string;
+  } & BundleOptions
+) {
+  const { source, absoluteRef, externalRefResolver = new BaseResolver(opts.config.resolve) } = opts;
+  const document = makeDocumentFromString(source, absoluteRef || '/');
+
+  return bundleDocument({
+    document,
+    ...opts,
+    externalRefResolver,
+    config: opts.config.styleguide,
+  });
+}
+
 type BundleContext = WalkContext;
 
 export type BundleResult = {
@@ -93,27 +118,20 @@ export async function bundleDocument(opts: {
     removeUnusedComponents = false,
     keepUrlRefs = false,
   } = opts;
-  const oasVersion = detectOpenAPI(document.parsed);
-  const oasMajorVersion = openAPIMajor(oasVersion);
-  const rules = config.getRulesForOasVersion(oasMajorVersion);
+  const specVersion = detectSpec(document.parsed);
+  const specMajorVersion = getMajorSpecVersion(specVersion);
+  const rules = config.getRulesForOasVersion(specMajorVersion);
   const types = normalizeTypes(
-    config.extendTypes(
-      customTypes ?? oasMajorVersion === OasMajorVersion.Version3
-        ? oasVersion === OasVersion.Version3_1
-          ? Oas3_1Types
-          : Oas3Types
-        : Oas2Types,
-      oasVersion
-    ),
+    config.extendTypes(customTypes ?? getTypes(specVersion), specVersion),
     config
   );
 
-  const preprocessors = initRules(rules as any, config, 'preprocessors', oasVersion);
-  const decorators = initRules(rules as any, config, 'decorators', oasVersion);
+  const preprocessors = initRules(rules as any, config, 'preprocessors', specVersion);
+  const decorators = initRules(rules as any, config, 'decorators', specVersion);
 
   const ctx: BundleContext = {
     problems: [],
-    oasVersion: oasVersion,
+    oasVersion: specVersion,
     refTypes: new Map<string, NormalizedNodeType>(),
     visitorsData: {},
   };
@@ -123,7 +141,7 @@ export async function bundleDocument(opts: {
       severity: 'error',
       ruleId: 'remove-unused-components',
       visitor:
-        oasMajorVersion === OasMajorVersion.Version2
+        specMajorVersion === SpecMajorVersion.OAS2
           ? RemoveUnusedComponentsOas2({})
           : RemoveUnusedComponentsOas3({}),
     });
@@ -157,7 +175,7 @@ export async function bundleDocument(opts: {
         severity: 'error',
         ruleId: 'bundler',
         visitor: makeBundleVisitor(
-          oasMajorVersion,
+          specMajorVersion,
           dereference,
           skipRedoclyRegistryRefs,
           document,
@@ -188,9 +206,9 @@ export async function bundleDocument(opts: {
   };
 }
 
-export function mapTypeToComponent(typeName: string, version: OasMajorVersion) {
+export function mapTypeToComponent(typeName: string, version: SpecMajorVersion) {
   switch (version) {
-    case OasMajorVersion.Version3:
+    case SpecMajorVersion.OAS3:
       switch (typeName) {
         case 'Schema':
           return 'schemas';
@@ -213,7 +231,7 @@ export function mapTypeToComponent(typeName: string, version: OasMajorVersion) {
         default:
           return null;
       }
-    case OasMajorVersion.Version2:
+    case SpecMajorVersion.OAS2:
       switch (typeName) {
         case 'Schema':
           return 'definitions';
@@ -224,13 +242,22 @@ export function mapTypeToComponent(typeName: string, version: OasMajorVersion) {
         default:
           return null;
       }
+    case SpecMajorVersion.Async2:
+      switch (typeName) {
+        case 'Schema':
+          return 'schemas';
+        case 'Parameter':
+          return 'parameters';
+        default:
+          return null;
+      }
   }
 }
 
 // function oas3Move
 
 function makeBundleVisitor(
-  version: OasMajorVersion,
+  version: SpecMajorVersion,
   dereference: boolean,
   skipRedoclyRegistryRefs: boolean,
   rootDocument: Document,
@@ -282,16 +309,16 @@ function makeBundleVisitor(
     Root: {
       enter(root: any, ctx: any) {
         rootLocation = ctx.location;
-        if (version === OasMajorVersion.Version3) {
+        if (version === SpecMajorVersion.OAS3) {
           components = root.components = root.components || {};
-        } else if (version === OasMajorVersion.Version2) {
+        } else if (version === SpecMajorVersion.OAS2) {
           components = root;
         }
       },
     },
   };
 
-  if (version === OasMajorVersion.Version3) {
+  if (version === SpecMajorVersion.OAS3) {
     visitor.DiscriminatorMapping = {
       leave(mapping: Record<string, string>, ctx: any) {
         for (const name of Object.keys(mapping)) {
@@ -345,7 +372,7 @@ function makeBundleVisitor(
     components[componentType] = components[componentType] || {};
     const name = getComponentName(target, componentType, ctx);
     components[componentType][name] = target.node;
-    if (version === OasMajorVersion.Version3) {
+    if (version === SpecMajorVersion.OAS3) {
       return `#/components/${componentType}/${name}`;
     } else {
       return `#/${componentType}/${name}`;

package/src/config/__tests__/__snapshots__/config.test.ts.snap

@@ -6,6 +6,11 @@ StyleguideConfig {
   "_usedVersions": Set {},
   "configFile": undefined,
   "decorators": Object {
+    "async2": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
     "oas2": Object {
       "oas2": Object {},
       "oas3_0": Object {},
@@ -39,6 +44,11 @@ StyleguideConfig {
   "pluginPaths": Array [],
   "plugins": Array [],
   "preprocessors": Object {
+    "async2": Object {
+      "oas2": Object {},
+      "oas3_0": Object {},
+      "oas3_1": Object {},
+    },
     "oas2": Object {
       "oas2": Object {},
       "oas3_0": Object {},
@@ -97,6 +107,20 @@ StyleguideConfig {
   },
   "recommendedFallback": false,
   "rules": Object {
+    "async2": Object {
+      "oas2": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_0": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+      "oas3_1": Object {
+        "no-empty-servers": "error",
+        "operation-summary": "error",
+      },
+    },
     "oas2": Object {
       "oas2": Object {
         "no-empty-servers": "error",