@redocly/openapi-core 1.18.1 → 1.19.0

package/lib/types/{asyncapi.js → asyncapi2.js}

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AsyncApi2Types = void 0;
+exports.AsyncApi2Types = exports.AsyncApi2Bindings = exports.Dependencies = exports.SecuritySchemeFlows = exports.Discriminator = exports.DiscriminatorMapping = exports.SchemaProperties = exports.Schema = exports.MessageExample = exports.CorrelationId = exports.License = exports.Contact = exports.ServerVariable = exports.ServerMap = exports.ExternalDocs = exports.Tag = void 0;
 const _1 = require(".");
 const ref_utils_1 = require("../ref-utils");
 const Root = {
     properties: {
-        asyncapi: null,
+        asyncapi: null, // TODO: validate semver format and supported version
         info: 'Info',
         id: { type: 'string' },
         servers: 'ServerMap',
@@ -59,7 +59,7 @@ const ChannelBindings = {
     },
     additionalProperties: { type: 'object' },
 };
-const Tag = {
+exports.Tag = {
     properties: {
         name: { type: 'string' },
         description: { type: 'string' },
@@ -67,7 +67,7 @@ const Tag = {
     },
     required: ['name'],
 };
-const ExternalDocs = {
+exports.ExternalDocs = {
     properties: {
         description: { type: 'string' },
         url: { type: 'string' },
@@ -119,11 +119,11 @@ const Server = {
     },
     required: ['url', 'protocol'],
 };
-const ServerMap = {
+exports.ServerMap = {
     properties: {},
     additionalProperties: (_value, key) => key.match(/^[A-Za-z0-9_\-]+$/) ? 'Server' : undefined,
 };
-const ServerVariable = {
+exports.ServerVariable = {
     properties: {
         enum: {
             type: 'array',
@@ -149,14 +149,14 @@ const Info = {
     },
     required: ['title', 'version'],
 };
-const Contact = {
+exports.Contact = {
     properties: {
         name: { type: 'string' },
         url: { type: 'string' },
         email: { type: 'string' },
     },
 };
-const License = {
+exports.License = {
     properties: {
         name: { type: 'string' },
         url: { type: 'string' },
@@ -170,7 +170,7 @@ const Parameter = {
         location: { type: 'string' },
     },
 };
-const CorrelationId = {
+exports.CorrelationId = {
     properties: {
         description: { type: 'string' },
         location: { type: 'string' },
@@ -181,9 +181,9 @@ const Message = {
     properties: {
         messageId: { type: 'string' },
         headers: 'Schema',
-        payload: 'Schema',
+        payload: 'Schema', // TODO: strictly this does not cover all cases
         correlationId: 'CorrelationId',
-        schemaFormat: { type: 'string' },
+        schemaFormat: { type: 'string' }, // TODO: support official list of schema formats and custom values
         contentType: { type: 'string' },
         name: { type: 'string' },
         title: { type: 'string' },
@@ -192,7 +192,7 @@ const Message = {
         tags: 'TagList',
         externalDocs: 'ExternalDocs',
         bindings: 'MessageBindings',
-        // examples: 'MessageExampleList', // TODO: add support for message examples
+        examples: 'MessageExampleList',
         traits: 'MessageTraitList',
     },
     additionalProperties: {},
@@ -279,7 +279,7 @@ const MessageTrait = {
         tags: 'TagList',
         externalDocs: 'ExternalDocs',
         bindings: 'MessageBindings',
-        // examples: 'MessageExampleList', // TODO: support examples for message traits
+        examples: 'MessageExampleList',
     },
     additionalProperties: {},
 };
@@ -297,7 +297,7 @@ const Operation = {
     },
     required: [],
 };
-const MessageExample = {
+exports.MessageExample = {
     properties: {
         payload: { isExample: true },
         summary: { type: 'string' },
@@ -305,7 +305,7 @@ const MessageExample = {
         headers: { type: 'object' },
     },
 };
-const Schema = {
+exports.Schema = {
     properties: {
         $id: { type: 'string' },
         $schema: { type: 'string' },
@@ -374,13 +374,13 @@ const Schema = {
         dependencies: 'Dependencies',
     },
 };
-const SchemaProperties = {
+exports.SchemaProperties = {
     properties: {},
     additionalProperties: (value) => {
         return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
     },
 };
-const DiscriminatorMapping = {
+exports.DiscriminatorMapping = {
     properties: {},
     additionalProperties: (value) => {
         if ((0, ref_utils_1.isMappingRef)(value)) {
@@ -391,7 +391,7 @@ const DiscriminatorMapping = {
         }
     },
 };
-const Discriminator = {
+exports.Discriminator = {
     properties: {
         propertyName: { type: 'string' },
         mapping: 'DiscriminatorMapping',
@@ -406,7 +406,6 @@ const Components = {
         correlationIds: 'NamedCorrelationIds',
         messageTraits: 'NamedMessageTraits',
         operationTraits: 'NamedOperationTraits',
-        streamHeaders: 'NamedStreamHeaders',
         securitySchemes: 'NamedSecuritySchemes',
         servers: 'ServerMap',
         serverVariables: 'ServerVariablesMap',
@@ -420,7 +419,7 @@ const Components = {
 const ImplicitFlow = {
     properties: {
         refreshUrl: { type: 'string' },
-        scopes: { type: 'object', additionalProperties: { type: 'string' } },
+        scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
         authorizationUrl: { type: 'string' },
     },
     required: ['authorizationUrl', 'scopes'],
@@ -428,7 +427,7 @@ const ImplicitFlow = {
 const PasswordFlow = {
     properties: {
         refreshUrl: { type: 'string' },
-        scopes: { type: 'object', additionalProperties: { type: 'string' } },
+        scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
         tokenUrl: { type: 'string' },
     },
     required: ['tokenUrl', 'scopes'],
@@ -436,7 +435,7 @@ const PasswordFlow = {
 const ClientCredentials = {
     properties: {
         refreshUrl: { type: 'string' },
-        scopes: { type: 'object', additionalProperties: { type: 'string' } },
+        scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
         tokenUrl: { type: 'string' },
     },
     required: ['tokenUrl', 'scopes'],
@@ -445,12 +444,12 @@ const AuthorizationCode = {
     properties: {
         refreshUrl: { type: 'string' },
         authorizationUrl: { type: 'string' },
-        scopes: { type: 'object', additionalProperties: { type: 'string' } },
+        scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
         tokenUrl: { type: 'string' },
     },
     required: ['authorizationUrl', 'tokenUrl', 'scopes'],
 };
-const SecuritySchemeFlows = {
+exports.SecuritySchemeFlows = {
     properties: {
         implicit: 'ImplicitFlow',
         password: 'PasswordFlow',
@@ -486,7 +485,7 @@ const SecurityScheme = {
         openIdConnectUrl: { type: 'string' },
     },
     required(value) {
-        switch (value === null || value === void 0 ? void 0 : value.type) {
+        switch (value?.type) {
             case 'apiKey':
                 return ['type', 'in'];
             case 'httpApiKey':
@@ -502,7 +501,7 @@ const SecurityScheme = {
         }
     },
     allowed(value) {
-        switch (value === null || value === void 0 ? void 0 : value.type) {
+        switch (value?.type) {
             case 'apiKey':
                 return ['type', 'in', 'description'];
             case 'httpApiKey':
@@ -519,7 +518,7 @@ const SecurityScheme = {
     },
     extensionsPrefix: 'x-',
 };
-const Dependencies = {
+exports.Dependencies = {
     properties: {},
     additionalProperties: (value) => {
         return Array.isArray(value) ? { type: 'array', items: { type: 'string' } } : 'Schema';
@@ -602,7 +601,7 @@ const KafkaServerBinding = {
 ServerBindings.properties.kafka = KafkaServerBinding;
 const KafkaMessageBinding = {
     properties: {
-        key: 'Schema',
+        key: 'Schema', // TODO: add avro support
         schemaIdLocation: { type: 'string' },
         schemaIdPayloadEncoding: { type: 'string' },
         schemaLookupStrategy: { type: 'string' },
@@ -666,7 +665,7 @@ const AmqpOperationBinding = {
         userId: { type: 'string' },
         cc: { type: 'array', items: { type: 'string' } },
         priority: { type: 'integer' },
-        deliveryMode: { type: 'integer' },
+        deliveryMode: { type: 'integer' }, // TODO: enum: [1, 2]
         mandatory: { type: 'boolean' },
         bcc: { type: 'array', items: { type: 'string' } },
         replyTo: { type: 'string' },
@@ -890,20 +889,7 @@ OperationBindings.properties.mercure = MercureOperationBinding;
 // googlepubsub
 // pulsar
 // --- End per-protocol node types
-exports.AsyncApi2Types = {
-    Root,
-    Tag,
-    TagList: (0, _1.listOf)('Tag'),
-    ServerMap,
-    ExternalDocs,
-    Server,
-    ServerVariable,
-    ServerVariablesMap: (0, _1.mapOf)('ServerVariable'),
-    SecurityRequirement,
-    SecurityRequirementList: (0, _1.listOf)('SecurityRequirement'),
-    Info,
-    Contact,
-    License,
+exports.AsyncApi2Bindings = {
     HttpServerBinding,
     HttpChannelBinding,
     HttpMessageBinding,
@@ -965,16 +951,34 @@ exports.AsyncApi2Types = {
     MercureOperationBinding,
     ServerBindings,
     ChannelBindings,
+    MessageBindings,
+    OperationBindings,
+};
+exports.AsyncApi2Types = {
+    ...exports.AsyncApi2Bindings,
+    Root,
+    Tag: exports.Tag,
+    TagList: (0, _1.listOf)('Tag'),
+    ServerMap: exports.ServerMap,
+    ExternalDocs: exports.ExternalDocs,
+    Server,
+    ServerVariable: exports.ServerVariable,
+    ServerVariablesMap: (0, _1.mapOf)('ServerVariable'),
+    SecurityRequirement,
+    SecurityRequirementList: (0, _1.listOf)('SecurityRequirement'),
+    Info,
+    Contact: exports.Contact,
+    License: exports.License,
     ChannelMap,
     Channel,
     Parameter,
     ParametersMap: (0, _1.mapOf)('Parameter'),
     Operation,
-    Schema,
-    MessageExample,
-    SchemaProperties,
-    DiscriminatorMapping,
-    Discriminator,
+    Schema: exports.Schema,
+    MessageExample: exports.MessageExample,
+    SchemaProperties: exports.SchemaProperties,
+    DiscriminatorMapping: exports.DiscriminatorMapping,
+    Discriminator: exports.Discriminator,
     Components,
     NamedSchemas: (0, _1.mapOf)('Schema'),
     NamedMessages: (0, _1.mapOf)('Message'),
@@ -983,12 +987,11 @@ exports.AsyncApi2Types = {
     NamedParameters: (0, _1.mapOf)('Parameter'),
     NamedSecuritySchemes: (0, _1.mapOf)('SecurityScheme'),
     NamedCorrelationIds: (0, _1.mapOf)('CorrelationId'),
-    NamedStreamHeaders: (0, _1.mapOf)('StreamHeader'),
     ImplicitFlow,
     PasswordFlow,
     ClientCredentials,
     AuthorizationCode,
-    SecuritySchemeFlows,
+    SecuritySchemeFlows: exports.SecuritySchemeFlows,
     SecurityScheme,
     Message,
     MessageBindings,
@@ -997,6 +1000,7 @@ exports.AsyncApi2Types = {
     OperationTraitList: (0, _1.listOf)('OperationTrait'),
     MessageTrait,
     MessageTraitList: (0, _1.listOf)('MessageTrait'),
-    CorrelationId,
-    Dependencies,
+    MessageExampleList: (0, _1.listOf)('MessageExample'),
+    CorrelationId: exports.CorrelationId,
+    Dependencies: exports.Dependencies,
 };

package/lib/types/asyncapi3.d.ts

@@ -0,0 +1,2 @@
+import { NodeType } from '.';
+export declare const AsyncApi3Types: Record<string, NodeType>;

package/lib/types/asyncapi3.js

@@ -0,0 +1,347 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AsyncApi3Types = void 0;
+const _1 = require(".");
+const asyncapi2_1 = require("./asyncapi2");
+const Root = {
+    properties: {
+        asyncapi: { type: 'string', enum: ['3.0.0'] },
+        info: 'Info',
+        id: { type: 'string' },
+        servers: 'ServerMap',
+        channels: 'NamedChannels',
+        components: 'Components',
+        operations: 'NamedOperations',
+        defaultContentType: { type: 'string' },
+    },
+    required: ['asyncapi', 'info'],
+};
+const Channel = {
+    properties: {
+        address: { type: 'string' },
+        messages: 'NamedMessages',
+        title: { type: 'string' },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        servers: 'ServerList',
+        parameters: 'ParametersMap',
+        bindings: 'ChannelBindings',
+        tags: 'TagList',
+        externalDocs: 'ExternalDocs',
+    },
+};
+const Server = {
+    properties: {
+        host: { type: 'string' },
+        pathname: { type: 'string' },
+        protocol: { type: 'string' },
+        protocolVersion: { type: 'string' },
+        description: { type: 'string' },
+        variables: 'ServerVariablesMap',
+        security: 'SecuritySchemeList',
+        bindings: 'ServerBindings',
+        externalDocs: 'ExternalDocs',
+        tags: 'TagList',
+    },
+    required: ['host', 'protocol'],
+};
+const Info = {
+    properties: {
+        title: { type: 'string' },
+        version: { type: 'string' },
+        description: { type: 'string' },
+        termsOfService: { type: 'string' },
+        contact: 'Contact',
+        license: 'License',
+        tags: 'TagList',
+        externalDocs: 'ExternalDocs',
+    },
+    required: ['title', 'version'],
+};
+const Parameter = {
+    properties: {
+        description: { type: 'string' },
+        enum: { type: 'array', items: { type: 'string' } },
+        default: { type: 'string' },
+        examples: { type: 'array', items: { type: 'string' } },
+        location: { type: 'string' },
+    },
+};
+const Message = {
+    properties: {
+        headers: 'Schema',
+        payload: (value) => {
+            if (!!value && value?.['schemaFormat']) {
+                return {
+                    properties: {
+                        schema: 'Schema',
+                        schemaFormat: { type: 'string' },
+                    },
+                    required: ['schema', 'schemaFormat'],
+                };
+            }
+            else {
+                return 'Schema';
+            }
+        },
+        correlationId: 'CorrelationId',
+        contentType: { type: 'string' },
+        name: { type: 'string' },
+        title: { type: 'string' },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        tags: 'TagList',
+        externalDocs: 'ExternalDocs',
+        bindings: 'MessageBindings',
+        examples: 'MessageExampleList',
+        traits: 'MessageTraitList',
+    },
+    additionalProperties: {},
+};
+const OperationTrait = {
+    properties: {
+        tags: 'TagList',
+        title: { type: 'string' },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        externalDocs: 'ExternalDocs',
+        security: 'SecuritySchemeList',
+        bindings: 'OperationBindings',
+    },
+    required: [],
+};
+const MessageTrait = {
+    properties: {
+        headers: (value) => {
+            if (typeof value === 'function' || (typeof value === 'object' && !!value)) {
+                return {
+                    properties: {
+                        schema: 'Schema',
+                        schemaFormat: { type: 'string' },
+                    },
+                };
+            }
+            else {
+                return 'Schema';
+            }
+        },
+        correlationId: 'CorrelationId',
+        contentType: { type: 'string' },
+        name: { type: 'string' },
+        title: { type: 'string' },
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        tags: 'TagList',
+        externalDocs: 'ExternalDocs',
+        bindings: 'MessageBindings',
+        examples: 'MessageExampleList',
+    },
+    additionalProperties: {},
+};
+const Operation = {
+    properties: {
+        action: { type: 'string', enum: ['send', 'receive'] },
+        channel: 'Channel',
+        title: { type: 'string' },
+        tags: 'TagList',
+        summary: { type: 'string' },
+        description: { type: 'string' },
+        externalDocs: 'ExternalDocs',
+        operationId: { type: 'string' },
+        security: 'SecuritySchemeList',
+        bindings: 'OperationBindings',
+        traits: 'OperationTraitList',
+        messages: 'MessageList',
+        reply: 'OperationReply',
+    },
+    required: ['action', 'channel'],
+};
+const OperationReply = {
+    properties: {
+        channel: 'Channel',
+        messages: 'MessageList',
+        address: 'OperationReplyAddress',
+    },
+};
+const OperationReplyAddress = {
+    properties: {
+        location: { type: 'string' },
+        description: { type: 'string' },
+    },
+    required: ['location'],
+};
+const Components = {
+    properties: {
+        messages: 'NamedMessages',
+        parameters: 'NamedParameters',
+        schemas: 'NamedSchemas',
+        replies: 'NamedOperationReplies',
+        replyAddresses: 'NamedOperationRelyAddresses',
+        correlationIds: 'NamedCorrelationIds',
+        messageTraits: 'NamedMessageTraits',
+        operationTraits: 'NamedOperationTraits',
+        tags: 'NamedTags',
+        externalDocs: 'NamedExternalDocs',
+        securitySchemes: 'NamedSecuritySchemes',
+        servers: 'ServerMap',
+        serverVariables: 'ServerVariablesMap',
+        channels: 'NamedChannels',
+        operations: 'NamedOperations',
+        serverBindings: 'ServerBindings',
+        channelBindings: 'ChannelBindings',
+        operationBindings: 'OperationBindings',
+        messageBindings: 'MessageBindings',
+    },
+};
+const ImplicitFlow = {
+    properties: {
+        refreshUrl: { type: 'string' },
+        availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
+        authorizationUrl: { type: 'string' },
+    },
+    required: ['authorizationUrl', 'availableScopes'],
+};
+const PasswordFlow = {
+    properties: {
+        refreshUrl: { type: 'string' },
+        availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
+        tokenUrl: { type: 'string' },
+    },
+    required: ['tokenUrl', 'availableScopes'],
+};
+const ClientCredentials = {
+    properties: {
+        refreshUrl: { type: 'string' },
+        availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
+        tokenUrl: { type: 'string' },
+    },
+    required: ['tokenUrl', 'availableScopes'],
+};
+const AuthorizationCode = {
+    properties: {
+        refreshUrl: { type: 'string' },
+        authorizationUrl: { type: 'string' },
+        availableScopes: { type: 'object', additionalProperties: { type: 'string' } },
+        tokenUrl: { type: 'string' },
+    },
+    required: ['authorizationUrl', 'tokenUrl', 'availableScopes'],
+};
+const SecurityScheme = {
+    properties: {
+        type: {
+            enum: [
+                'userPassword',
+                'apiKey',
+                'X509',
+                'symmetricEncryption',
+                'asymmetricEncryption',
+                'httpApiKey',
+                'http',
+                'oauth2',
+                'openIdConnect',
+                'plain',
+                'scramSha256',
+                'scramSha512',
+                'gssapi',
+            ],
+        },
+        description: { type: 'string' },
+        name: { type: 'string' },
+        in: { type: 'string', enum: ['query', 'header', 'cookie', 'user', 'password'] },
+        scheme: { type: 'string' },
+        bearerFormat: { type: 'string' },
+        flows: 'SecuritySchemeFlows',
+        openIdConnectUrl: { type: 'string' },
+        scopes: { type: 'array', items: { type: 'string' } },
+    },
+    required(value) {
+        switch (value?.type) {
+            case 'apiKey':
+                return ['type', 'in'];
+            case 'httpApiKey':
+                return ['type', 'name', 'in'];
+            case 'http':
+                return ['type', 'scheme'];
+            case 'oauth2':
+                return ['type', 'flows'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl'];
+            default:
+                return ['type'];
+        }
+    },
+    allowed(value) {
+        switch (value?.type) {
+            case 'apiKey':
+                return ['type', 'in', 'description'];
+            case 'httpApiKey':
+                return ['type', 'name', 'in', 'description'];
+            case 'http':
+                return ['type', 'scheme', 'bearerFormat', 'description'];
+            case 'oauth2':
+                return ['type', 'flows', 'description', 'scopes'];
+            case 'openIdConnect':
+                return ['type', 'openIdConnectUrl', 'description', 'scopes'];
+            default:
+                return ['type', 'description'];
+        }
+    },
+    extensionsPrefix: 'x-',
+};
+exports.AsyncApi3Types = {
+    // from asyncapi2
+    ...asyncapi2_1.AsyncApi2Bindings,
+    CorrelationId: asyncapi2_1.CorrelationId,
+    SecuritySchemeFlows: asyncapi2_1.SecuritySchemeFlows,
+    ServerVariable: asyncapi2_1.ServerVariable,
+    Contact: asyncapi2_1.Contact,
+    License: asyncapi2_1.License,
+    MessageExample: asyncapi2_1.MessageExample,
+    Tag: asyncapi2_1.Tag,
+    Dependencies: asyncapi2_1.Dependencies,
+    Schema: asyncapi2_1.Schema,
+    Discriminator: asyncapi2_1.Discriminator,
+    DiscriminatorMapping: asyncapi2_1.DiscriminatorMapping,
+    SchemaProperties: asyncapi2_1.SchemaProperties,
+    ServerMap: asyncapi2_1.ServerMap,
+    ExternalDocs: asyncapi2_1.ExternalDocs,
+    Root,
+    Channel,
+    Parameter,
+    Info,
+    Server,
+    MessageTrait,
+    Operation,
+    OperationReply,
+    OperationReplyAddress,
+    Components,
+    ImplicitFlow,
+    PasswordFlow,
+    ClientCredentials,
+    AuthorizationCode,
+    SecurityScheme,
+    Message,
+    OperationTrait,
+    ServerVariablesMap: (0, _1.mapOf)('ServerVariable'),
+    NamedTags: (0, _1.mapOf)('Tag'),
+    NamedExternalDocs: (0, _1.mapOf)('ExternalDocs'),
+    NamedChannels: (0, _1.mapOf)('Channel'),
+    ParametersMap: (0, _1.mapOf)('Parameter'),
+    NamedOperations: (0, _1.mapOf)('Operation'),
+    NamedOperationReplies: (0, _1.mapOf)('OperationReply'),
+    NamedOperationRelyAddresses: (0, _1.mapOf)('OperationReplyAddress'),
+    NamedSchemas: (0, _1.mapOf)('Schema'),
+    NamedMessages: (0, _1.mapOf)('Message'),
+    NamedMessageTraits: (0, _1.mapOf)('MessageTrait'),
+    NamedOperationTraits: (0, _1.mapOf)('OperationTrait'),
+    NamedParameters: (0, _1.mapOf)('Parameter'),
+    NamedSecuritySchemes: (0, _1.mapOf)('SecurityScheme'),
+    NamedCorrelationIds: (0, _1.mapOf)('CorrelationId'),
+    ServerList: (0, _1.listOf)('Server'),
+    SecuritySchemeList: (0, _1.listOf)('SecurityScheme'),
+    MessageList: (0, _1.listOf)('Message'),
+    OperationTraitList: (0, _1.listOf)('OperationTrait'),
+    MessageTraitList: (0, _1.listOf)('MessageTrait'),
+    MessageExampleList: (0, _1.listOf)('MessageExample'),
+    TagList: (0, _1.listOf)('Tag'),
+};