@redocly/openapi-core 1.18.1 → 1.19.0

package/src/rules/async3/channels-kebab-case.ts

@@ -0,0 +1,19 @@
+import { Channel } from '../../typings/asyncapi3';
+import { Async3Rule } from '../../visitors';
+import { UserContext } from '../../walk';
+
+export const ChannelsKebabCase: Async3Rule = () => {
+  return {
+    Channel(channel: Channel, { report }: UserContext) {
+      const segments = (channel.address || '')
+        .split(/[/.:]/) // split on / or : as likely channel namespacers
+        .filter((s) => s !== ''); // filter out empty segments
+      if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
+        report({
+          message: `\`${channel.address}\` does not use kebab-case.`,
+          location: { reportOnKey: true },
+        });
+      }
+    },
+  };
+};

package/src/rules/async3/index.ts

@@ -0,0 +1,23 @@
+import { Async3Rule } from '../../visitors';
+import { Assertions } from '../common/assertions';
+import { Spec } from '../common/spec';
+import { InfoContact } from '../common/info-contact';
+import { OperationOperationId } from '../common/operation-operationId';
+import { TagDescription } from '../common/tag-description';
+import { TagsAlphabetical } from '../common/tags-alphabetical';
+import { ChannelsKebabCase } from './channels-kebab-case';
+import { NoChannelTrailingSlash } from './no-channel-trailing-slash';
+import type { Async3RuleSet } from '../../oas-types';
+
+export const rules: Async3RuleSet<'built-in'> = {
+  spec: Spec as Async3Rule,
+  assertions: Assertions as Async3Rule,
+  'info-contact': InfoContact as Async3Rule,
+  'operation-operationId': OperationOperationId as Async3Rule,
+  'channels-kebab-case': ChannelsKebabCase,
+  'no-channel-trailing-slash': NoChannelTrailingSlash,
+  'tag-description': TagDescription as Async3Rule,
+  'tags-alphabetical': TagsAlphabetical as Async3Rule,
+};
+
+export const preprocessors = {};

package/src/rules/async3/no-channel-trailing-slash.ts

@@ -0,0 +1,16 @@
+import { Async3Rule } from '../../visitors';
+import { UserContext } from '../../walk';
+import { Channel } from '../../typings/asyncapi3';
+
+export const NoChannelTrailingSlash: Async3Rule = () => {
+  return {
+    Channel(channel: Channel, { report, location }: UserContext) {
+      if ((channel.address as string).endsWith('/') && channel.address !== '/') {
+        report({
+          message: `\`${channel.address}\` should not have a trailing slash.`,
+          location: location.key(),
+        });
+      }
+    },
+  };
+};

package/src/rules/common/assertions/index.ts

@@ -1,9 +1,17 @@
-import { asserts, AssertionFn } from './asserts';
+import { asserts } from './asserts';
 import { buildSubjectVisitor, buildVisitorObject } from './utils';
-import { Oas2Visitor, Oas3Visitor } from '../../../visitors';
-import { RuleSeverity } from '../../../config';
 import { isString } from '../../../utils';
 
+import type { AssertionFn } from './asserts';
+import type {
+  ArazzoVisitor,
+  Async2Visitor,
+  Async3Visitor,
+  Oas2Visitor,
+  Oas3Visitor,
+} from '../../../visitors';
+import type { RuleSeverity } from '../../../config';
+
 export type AssertionLocators = {
   filterInParentKeys?: (string | number)[];
   filterOutParentKeys?: (string | number)[];
@@ -28,7 +36,8 @@ export type RawAssertion = AssertionDefinition & {
 export type Assertion = RawAssertion & { assertionId: string };
 
 export const Assertions = (opts: Record<string, Assertion>) => {
-  const visitors: (Oas2Visitor | Oas3Visitor)[] = [];
+  const visitors: (Oas2Visitor | Oas3Visitor | Async2Visitor | Async3Visitor | ArazzoVisitor)[] =
+    [];
 
   // As 'Assertions' has an array of asserts,
   // that array spreads into an 'opts' object on init rules phase here

package/src/rules/common/spec.ts

@@ -1,11 +1,11 @@
-import type { Oas3Rule, Oas2Rule, Async2Rule, ArazzoRule } from '../../visitors';
+import type { Oas3Rule, Oas2Rule, Async2Rule, Async3Rule, ArazzoRule } from '../../visitors';
 import { isNamedType, SpecExtension } from '../../types';
 import { oasTypeOf, matchesJsonSchemaType, getSuggest, validateSchemaEnumType } from '../utils';
 import { isRef } from '../../ref-utils';
 import { isPlainObject } from '../../utils';
 import { UserContext } from '../../walk';
 
-export const Spec: Oas3Rule | Oas2Rule | Async2Rule | ArazzoRule = () => {
+export const Spec: Oas3Rule | Oas2Rule | Async2Rule | Async3Rule | ArazzoRule = () => {
   return {
     any(
       node: any,

package/src/rules/oas2/index.ts

@@ -86,10 +86,10 @@ export const rules: Oas2RuleSet<'built-in'> = {
   'path-segment-plural': PathSegmentPlural as Oas2Rule,
   'response-contains-header': ResponseContainsHeader as Oas2Rule,
   'response-contains-property': ResponseContainsProperty as Oas2Rule,
-  'scalar-property-missing-example': ScalarPropertyMissingExample,
-  'required-string-property-missing-min-length': RequiredStringPropertyMissingMinLength,
-  'spec-strict-refs': SpecStrictRefs,
-  'no-required-schema-properties-undefined': NoRequiredSchemaPropertiesUndefined,
+  'scalar-property-missing-example': ScalarPropertyMissingExample as Oas2Rule,
+  'required-string-property-missing-min-length': RequiredStringPropertyMissingMinLength as Oas2Rule,
+  'spec-strict-refs': SpecStrictRefs as Oas2Rule,
+  'no-required-schema-properties-undefined': NoRequiredSchemaPropertiesUndefined as Oas2Rule,
 };
 
 export const preprocessors = {};

package/src/rules/oas3/index.ts

@@ -55,63 +55,65 @@ import { ComponentNameUnique } from './component-name-unique';
 import { ArrayParameterSerialization } from './array-parameter-serialization';
 import { NoRequiredSchemaPropertiesUndefined } from '../common/no-required-schema-properties-undefined';
 
+import type { Oas3Rule } from '../../visitors';
+
 export const rules: Oas3RuleSet<'built-in'> = {
-  spec: Spec,
-  'info-contact': InfoContact,
-  'info-license': InfoLicense,
-  'info-license-url': InfoLicenseUrl,
-  'operation-2xx-response': Operation2xxResponse,
-  'operation-4xx-response': Operation4xxResponse,
+  spec: Spec as Oas3Rule,
+  'info-contact': InfoContact as Oas3Rule,
+  'info-license': InfoLicense as Oas3Rule,
+  'info-license-url': InfoLicenseUrl as Oas3Rule,
+  'operation-2xx-response': Operation2xxResponse as Oas3Rule,
+  'operation-4xx-response': Operation4xxResponse as Oas3Rule,
   'operation-4xx-problem-details-rfc7807': Operation4xxProblemDetailsRfc7807,
-  assertions: Assertions,
-  'operation-operationId-unique': OperationIdUnique,
-  'operation-parameters-unique': OperationParametersUnique,
-  'operation-tag-defined': OperationTagDefined,
+  assertions: Assertions as Oas3Rule,
+  'operation-operationId-unique': OperationIdUnique as Oas3Rule,
+  'operation-parameters-unique': OperationParametersUnique as Oas3Rule,
+  'operation-tag-defined': OperationTagDefined as Oas3Rule,
   'no-example-value-and-externalValue': NoExampleValueAndExternalValue,
-  'no-enum-type-mismatch': NoEnumTypeMismatch,
-  'no-path-trailing-slash': NoPathTrailingSlash,
+  'no-enum-type-mismatch': NoEnumTypeMismatch as Oas3Rule,
+  'no-path-trailing-slash': NoPathTrailingSlash as Oas3Rule,
   'no-empty-servers': NoEmptyServers,
-  'path-declaration-must-exist': PathDeclarationMustExist,
-  'operation-operationId-url-safe': OperationIdUrlSafe,
-  'operation-operationId': OperationOperationId,
-  'operation-summary': OperationSummary,
-  'tags-alphabetical': TagsAlphabetical,
+  'path-declaration-must-exist': PathDeclarationMustExist as Oas3Rule,
+  'operation-operationId-url-safe': OperationIdUrlSafe as Oas3Rule,
+  'operation-operationId': OperationOperationId as Oas3Rule,
+  'operation-summary': OperationSummary as Oas3Rule,
+  'tags-alphabetical': TagsAlphabetical as Oas3Rule,
   'no-server-example.com': NoServerExample,
   'no-server-trailing-slash': NoServerTrailingSlash,
-  'tag-description': TagDescription,
-  'operation-description': OperationDescription,
+  'tag-description': TagDescription as Oas3Rule,
+  'operation-description': OperationDescription as Oas3Rule,
   'no-unused-components': NoUnusedComponents,
-  'path-not-include-query': PathNotIncludeQuery,
-  'path-parameters-defined': PathParamsDefined,
-  'path-params-defined': PathParamsDefined,
-  'parameter-description': ParameterDescription,
-  'operation-singular-tag': OperationSingularTag,
-  'security-defined': SecurityDefined,
+  'path-not-include-query': PathNotIncludeQuery as Oas3Rule,
+  'path-parameters-defined': PathParamsDefined as Oas3Rule,
+  'path-params-defined': PathParamsDefined as Oas3Rule,
+  'parameter-description': ParameterDescription as Oas3Rule,
+  'operation-singular-tag': OperationSingularTag as Oas3Rule,
+  'security-defined': SecurityDefined as Oas3Rule,
   'no-unresolved-refs': NoUnresolvedRefs,
-  'paths-kebab-case': PathsKebabCase,
+  'paths-kebab-case': PathsKebabCase as Oas3Rule,
   'boolean-parameter-prefixes': BooleanParameterPrefixes,
-  'path-http-verbs-order': PathHttpVerbsOrder,
+  'path-http-verbs-order': PathHttpVerbsOrder as Oas3Rule,
   'no-invalid-media-type-examples': ValidContentExamples,
-  'no-identical-paths': NoIdenticalPaths,
-  'no-ambiguous-paths': NoAmbiguousPaths,
+  'no-identical-paths': NoIdenticalPaths as Oas3Rule,
+  'no-ambiguous-paths': NoAmbiguousPaths as Oas3Rule,
   'no-undefined-server-variable': NoUndefinedServerVariable,
   'no-server-variables-empty-enum': NoServerVariablesEmptyEnum,
-  'no-http-verbs-in-paths': NoHttpVerbsInPaths,
-  'path-excludes-patterns': PathExcludesPatterns,
+  'no-http-verbs-in-paths': NoHttpVerbsInPaths as Oas3Rule,
+  'path-excludes-patterns': PathExcludesPatterns as Oas3Rule,
   'request-mime-type': RequestMimeType,
   'response-mime-type': ResponseMimeType,
-  'path-segment-plural': PathSegmentPlural,
+  'path-segment-plural': PathSegmentPlural as Oas3Rule,
   'no-invalid-schema-examples': NoInvalidSchemaExamples,
   'no-invalid-parameter-examples': NoInvalidParameterExamples,
-  'response-contains-header': ResponseContainsHeader,
+  'response-contains-header': ResponseContainsHeader as Oas3Rule,
   'response-contains-property': ResponseContainsProperty,
-  'scalar-property-missing-example': ScalarPropertyMissingExample,
+  'scalar-property-missing-example': ScalarPropertyMissingExample as Oas3Rule,
   'spec-components-invalid-map-name': SpecComponentsInvalidMapName,
   'required-string-property-missing-min-length': RequiredStringPropertyMissingMinLength,
-  'spec-strict-refs': SpecStrictRefs,
-  'component-name-unique': ComponentNameUnique,
+  'spec-strict-refs': SpecStrictRefs as Oas3Rule,
+  'component-name-unique': ComponentNameUnique as Oas3Rule,
   'array-parameter-serialization': ArrayParameterSerialization,
-  'no-required-schema-properties-undefined': NoRequiredSchemaPropertiesUndefined,
+  'no-required-schema-properties-undefined': NoRequiredSchemaPropertiesUndefined as Oas3Rule,
 };
 
 export const preprocessors = {};

package/src/types/{asyncapi.ts → asyncapi2.ts}

@@ -61,7 +61,7 @@ const ChannelBindings: NodeType = {
   additionalProperties: { type: 'object' },
 };
 
-const Tag: NodeType = {
+export const Tag: NodeType = {
   properties: {
     name: { type: 'string' },
     description: { type: 'string' },
@@ -70,7 +70,7 @@ const Tag: NodeType = {
   required: ['name'],
 };
 
-const ExternalDocs: NodeType = {
+export const ExternalDocs: NodeType = {
   properties: {
     description: { type: 'string' },
     url: { type: 'string' },
@@ -126,13 +126,13 @@ const Server: NodeType = {
   required: ['url', 'protocol'],
 };
 
-const ServerMap: NodeType = {
+export const ServerMap: NodeType = {
   properties: {},
   additionalProperties: (_value: any, key: string) =>
     key.match(/^[A-Za-z0-9_\-]+$/) ? 'Server' : undefined,
 };
 
-const ServerVariable: NodeType = {
+export const ServerVariable: NodeType = {
   properties: {
     enum: {
       type: 'array',
@@ -160,7 +160,7 @@ const Info: NodeType = {
   required: ['title', 'version'],
 };
 
-const Contact: NodeType = {
+export const Contact: NodeType = {
   properties: {
     name: { type: 'string' },
     url: { type: 'string' },
@@ -168,7 +168,7 @@ const Contact: NodeType = {
   },
 };
 
-const License: NodeType = {
+export const License: NodeType = {
   properties: {
     name: { type: 'string' },
     url: { type: 'string' },
@@ -184,7 +184,7 @@ const Parameter: NodeType = {
   },
 };
 
-const CorrelationId: NodeType = {
+export const CorrelationId: NodeType = {
   properties: {
     description: { type: 'string' },
     location: { type: 'string' },
@@ -208,7 +208,7 @@ const Message: NodeType = {
     tags: 'TagList',
     externalDocs: 'ExternalDocs',
     bindings: 'MessageBindings',
-    // examples: 'MessageExampleList', // TODO: add support for message examples
+    examples: 'MessageExampleList',
     traits: 'MessageTraitList',
   },
   additionalProperties: {},
@@ -301,7 +301,7 @@ const MessageTrait: NodeType = {
     tags: 'TagList',
     externalDocs: 'ExternalDocs',
     bindings: 'MessageBindings',
-    // examples: 'MessageExampleList', // TODO: support examples for message traits
+    examples: 'MessageExampleList',
   },
   additionalProperties: {},
 };
@@ -322,7 +322,7 @@ const Operation: NodeType = {
   required: [],
 };
 
-const MessageExample: NodeType = {
+export const MessageExample: NodeType = {
   properties: {
     payload: { isExample: true },
     summary: { type: 'string' },
@@ -331,7 +331,7 @@ const MessageExample: NodeType = {
   },
 };
 
-const Schema: NodeType = {
+export const Schema: NodeType = {
   properties: {
     $id: { type: 'string' },
     $schema: { type: 'string' },
@@ -401,14 +401,14 @@ const Schema: NodeType = {
   },
 };
 
-const SchemaProperties: NodeType = {
+export const SchemaProperties: NodeType = {
   properties: {},
   additionalProperties: (value: any) => {
     return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
   },
 };
 
-const DiscriminatorMapping: NodeType = {
+export const DiscriminatorMapping: NodeType = {
   properties: {},
   additionalProperties: (value: any) => {
     if (isMappingRef(value)) {
@@ -419,7 +419,7 @@ const DiscriminatorMapping: NodeType = {
   },
 };
 
-const Discriminator: NodeType = {
+export const Discriminator: NodeType = {
   properties: {
     propertyName: { type: 'string' },
     mapping: 'DiscriminatorMapping',
@@ -435,7 +435,6 @@ const Components: NodeType = {
     correlationIds: 'NamedCorrelationIds',
     messageTraits: 'NamedMessageTraits',
     operationTraits: 'NamedOperationTraits',
-    streamHeaders: 'NamedStreamHeaders',
     securitySchemes: 'NamedSecuritySchemes',
     servers: 'ServerMap',
     serverVariables: 'ServerVariablesMap',
@@ -484,7 +483,7 @@ const AuthorizationCode: NodeType = {
   required: ['authorizationUrl', 'tokenUrl', 'scopes'],
 };
 
-const SecuritySchemeFlows: NodeType = {
+export const SecuritySchemeFlows: NodeType = {
   properties: {
     implicit: 'ImplicitFlow',
     password: 'PasswordFlow',
@@ -555,7 +554,7 @@ const SecurityScheme: NodeType = {
   extensionsPrefix: 'x-',
 };
 
-const Dependencies: NodeType = {
+export const Dependencies: NodeType = {
   properties: {},
   additionalProperties: (value: any) => {
     return Array.isArray(value) ? { type: 'array', items: { type: 'string' } } : 'Schema';
@@ -987,22 +986,7 @@ OperationBindings.properties.mercure = MercureOperationBinding;
 // pulsar
 
 // --- End per-protocol node types
-
-export const AsyncApi2Types: Record<string, NodeType> = {
-  Root,
-  Tag,
-  TagList: listOf('Tag'),
-  ServerMap,
-  ExternalDocs,
-  Server,
-  ServerVariable,
-  ServerVariablesMap: mapOf('ServerVariable'),
-  SecurityRequirement,
-  SecurityRequirementList: listOf('SecurityRequirement'),
-  Info,
-  Contact,
-  License,
-
+export const AsyncApi2Bindings: Record<string, NodeType> = {
   HttpServerBinding,
   HttpChannelBinding,
   HttpMessageBinding,
@@ -1078,6 +1062,25 @@ export const AsyncApi2Types: Record<string, NodeType> = {
 
   ServerBindings,
   ChannelBindings,
+  MessageBindings,
+  OperationBindings,
+};
+
+export const AsyncApi2Types: Record<string, NodeType> = {
+  ...AsyncApi2Bindings,
+  Root,
+  Tag,
+  TagList: listOf('Tag'),
+  ServerMap,
+  ExternalDocs,
+  Server,
+  ServerVariable,
+  ServerVariablesMap: mapOf('ServerVariable'),
+  SecurityRequirement,
+  SecurityRequirementList: listOf('SecurityRequirement'),
+  Info,
+  Contact,
+  License,
   ChannelMap,
   Channel,
   Parameter,
@@ -1096,7 +1099,6 @@ export const AsyncApi2Types: Record<string, NodeType> = {
   NamedParameters: mapOf('Parameter'),
   NamedSecuritySchemes: mapOf('SecurityScheme'),
   NamedCorrelationIds: mapOf('CorrelationId'),
-  NamedStreamHeaders: mapOf('StreamHeader'),
   ImplicitFlow,
   PasswordFlow,
   ClientCredentials,
@@ -1110,6 +1112,7 @@ export const AsyncApi2Types: Record<string, NodeType> = {
   OperationTraitList: listOf('OperationTrait'),
   MessageTrait,
   MessageTraitList: listOf('MessageTrait'),
+  MessageExampleList: listOf('MessageExample'),
   CorrelationId,
   Dependencies,
 };