@redocly/openapi-core 1.18.0 → 1.19.0

package/lib/types/arazzo.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArazzoTypes = exports.arazzoSchema = exports.ARAZZO_ROOT_TYPE = void 0;
+exports.ArazzoTypes = exports.arazzoSchema = exports.workflow = exports.step = exports.inherit = exports.criteriaObject = exports.requestBody = exports.replacement = exports.infoObject = exports.parameter = exports.sourceDescriptionSchema = exports.expectSchema = exports.operationMethod = exports.ARAZZO_ROOT_TYPE = void 0;
 const json_schema_adapter_1 = require("./json-schema-adapter");
 exports.ARAZZO_ROOT_TYPE = 'Root';
-const operationMethod = {
+exports.operationMethod = {
     type: 'string',
     enum: ['get', 'post', 'put', 'delete', 'patch'],
 };
-const expectSchema = {
+exports.expectSchema = {
     type: 'object',
     properties: {
         statusCode: { type: 'number' },
@@ -57,7 +57,7 @@ const arazzoSourceDescriptionSchema = {
     additionalProperties: false,
     required: ['name', 'type', 'url'],
 };
-const sourceDescriptionSchema = {
+exports.sourceDescriptionSchema = {
     type: 'object',
     oneOf: [
         openAPISourceDescriptionSchema,
@@ -67,20 +67,20 @@ const sourceDescriptionSchema = {
 };
 const sourceDescriptionsSchema = {
     type: 'array',
-    items: sourceDescriptionSchema,
+    items: exports.sourceDescriptionSchema,
 };
 const extendedOperation = {
     type: 'object',
     properties: {
         path: { type: 'string' },
-        method: operationMethod,
+        method: exports.operationMethod,
         sourceDescriptionName: { type: 'string' },
         serverUrl: { type: 'string' },
     },
     additionalProperties: false,
     required: ['path', 'method'],
 };
-const parameter = {
+exports.parameter = {
     type: 'object',
     oneOf: [
         {
@@ -95,17 +95,6 @@ const parameter = {
             required: ['name', 'value'],
             additionalProperties: false,
         },
-        {
-            type: 'object',
-            properties: {
-                $ref: { type: 'string' },
-                value: {
-                    oneOf: [{ type: 'string' }, { type: 'number' }, { type: 'boolean' }],
-                },
-            },
-            required: ['$ref'],
-            additionalProperties: false,
-        },
         {
             type: 'object',
             properties: {
@@ -121,9 +110,9 @@ const parameter = {
 };
 const parameters = {
     type: 'array',
-    items: parameter,
+    items: exports.parameter,
 };
-const infoObject = {
+exports.infoObject = {
     type: 'object',
     properties: {
         title: { type: 'string' },
@@ -134,7 +123,7 @@ const infoObject = {
     additionalProperties: false,
     required: ['title', 'version'],
 };
-const replacement = {
+exports.replacement = {
     type: 'object',
     properties: {
         target: { type: 'string' },
@@ -149,7 +138,7 @@ const replacement = {
         },
     },
 };
-const requestBody = {
+exports.requestBody = {
     type: 'object',
     properties: {
         contentType: { type: 'string' },
@@ -165,13 +154,13 @@ const requestBody = {
         encoding: { type: 'string' },
         replacements: {
             type: 'array',
-            items: replacement,
+            items: exports.replacement,
         },
     },
     additionalProperties: false,
     required: ['payload'],
 };
-const criteriaObject = {
+exports.criteriaObject = {
     type: 'object',
     properties: {
         condition: { type: 'string' },
@@ -201,9 +190,9 @@ const criteriaObject = {
 };
 const criteriaObjects = {
     type: 'array',
-    items: criteriaObject,
+    items: exports.criteriaObject,
 };
-const inherit = {
+exports.inherit = {
     type: 'string',
     enum: ['auto', 'none'],
 };
@@ -241,7 +230,7 @@ const onFailureList = {
     type: 'array',
     items: onFailureObject,
 };
-const step = {
+exports.step = {
     type: 'object',
     properties: {
         stepId: { type: 'string' },
@@ -256,14 +245,30 @@ const step = {
         outputs: {
             type: 'object',
             additionalProperties: {
-                type: 'string',
+                oneOf: [
+                    {
+                        type: 'string',
+                    },
+                    {
+                        type: 'object',
+                    },
+                    {
+                        type: 'array',
+                    },
+                    {
+                        type: 'boolean',
+                    },
+                    {
+                        type: 'number',
+                    },
+                ],
             },
         },
-        'x-inherit': inherit,
-        'x-expect': expectSchema,
+        'x-inherit': exports.inherit,
+        'x-expect': exports.expectSchema,
         'x-assert': { type: 'string' },
         'x-operation': extendedOperation,
-        requestBody: requestBody,
+        requestBody: exports.requestBody,
     },
     required: ['stepId'],
     oneOf: [
@@ -275,7 +280,7 @@ const step = {
 };
 const steps = {
     type: 'array',
-    items: step,
+    items: exports.step,
 };
 const JSONSchema = {
     type: 'object',
@@ -300,7 +305,7 @@ const JSONSchema = {
     required: ['type'],
     additionalProperties: true,
 };
-const workflow = {
+exports.workflow = {
     type: 'object',
     properties: {
         workflowId: { type: 'string' },
@@ -330,13 +335,13 @@ const workflow = {
 };
 const workflows = {
     type: 'array',
-    items: workflow,
+    items: exports.workflow,
 };
 exports.arazzoSchema = {
     type: 'object',
     properties: {
         arazzo: { type: 'string', enum: ['1.0.0'] },
-        info: infoObject,
+        info: exports.infoObject,
         sourceDescriptions: sourceDescriptionsSchema,
         'x-parameters': parameters,
         workflows: workflows,
@@ -362,7 +367,7 @@ exports.arazzoSchema = {
                 },
                 parameters: {
                     type: 'object',
-                    additionalProperties: parameter,
+                    additionalProperties: exports.parameter,
                 },
                 successActions: {
                     type: 'object',

package/lib/types/asyncapi2.d.ts

@@ -0,0 +1,17 @@
+import { NodeType } from '.';
+export declare const Tag: NodeType;
+export declare const ExternalDocs: NodeType;
+export declare const ServerMap: NodeType;
+export declare const ServerVariable: NodeType;
+export declare const Contact: NodeType;
+export declare const License: NodeType;
+export declare const CorrelationId: NodeType;
+export declare const MessageExample: NodeType;
+export declare const Schema: NodeType;
+export declare const SchemaProperties: NodeType;
+export declare const DiscriminatorMapping: NodeType;
+export declare const Discriminator: NodeType;
+export declare const SecuritySchemeFlows: NodeType;
+export declare const Dependencies: NodeType;
+export declare const AsyncApi2Bindings: Record<string, NodeType>;
+export declare const AsyncApi2Types: Record<string, NodeType>;

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,14 +305,11 @@ const MessageExample = {
         headers: { type: 'object' },
     },
 };
-const Schema = {
+exports.Schema = {
     properties: {
         $id: { type: 'string' },
-        id: { type: 'string' },
         $schema: { type: 'string' },
         definitions: 'NamedSchemas',
-        $defs: 'NamedSchemas',
-        $vocabulary: { type: 'string' },
         externalDocs: 'ExternalDocs',
         discriminator: 'Discriminator',
         myArbitraryKeyword: { type: 'boolean' },
@@ -333,17 +330,14 @@ const Schema = {
         required: { type: 'array', items: { type: 'string' } },
         enum: { type: 'array' },
         type: (value) => {
-            if (Array.isArray(value)) {
-                return {
+            return Array.isArray(value)
+                ? {
                     type: 'array',
                     items: { enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'] },
-                };
-            }
-            else {
-                return {
+                }
+                : {
                     enum: ['object', 'array', 'string', 'number', 'integer', 'boolean', 'null'],
                 };
-            }
         },
         allOf: (0, _1.listOf)('Schema'),
         anyOf: (0, _1.listOf)('Schema'),
@@ -352,38 +346,12 @@ const Schema = {
         if: 'Schema',
         then: 'Schema',
         else: 'Schema',
-        dependentSchemas: (0, _1.listOf)('Schema'),
-        prefixItems: (0, _1.listOf)('Schema'),
         contains: 'Schema',
-        minContains: { type: 'integer', minimum: 0 },
-        maxContains: { type: 'integer', minimum: 0 },
         patternProperties: { type: 'object' },
         propertyNames: 'Schema',
-        unevaluatedItems: (value) => {
-            if (typeof value === 'boolean') {
-                return { type: 'boolean' };
-            }
-            else {
-                return 'Schema';
-            }
-        },
-        unevaluatedProperties: (value) => {
-            if (typeof value === 'boolean') {
-                return { type: 'boolean' };
-            }
-            else {
-                return 'Schema';
-            }
-        },
-        summary: { type: 'string' },
         properties: 'SchemaProperties',
         items: (value) => {
-            if (typeof value === 'boolean') {
-                return { type: 'boolean' };
-            }
-            else {
-                return 'Schema';
-            }
+            return Array.isArray(value) ? (0, _1.listOf)('Schema') : 'Schema';
         },
         additionalProperties: (value) => {
             return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
@@ -395,25 +363,24 @@ const Schema = {
         default: null,
         readOnly: { type: 'boolean' },
         writeOnly: { type: 'boolean' },
-        // xml: 'Xml',
         examples: { type: 'array' },
         example: { isExample: true },
         deprecated: { type: 'boolean' },
         const: null,
         $comment: { type: 'string' },
-        dependencies: { type: 'object' }, // TODO
+        additionalItems: (value) => {
+            return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
+        },
+        dependencies: 'Dependencies',
     },
 };
-const SchemaProperties = {
+exports.SchemaProperties = {
     properties: {},
     additionalProperties: (value) => {
-        if (typeof value === 'boolean') {
-            return { type: 'boolean' };
-        }
-        return 'Schema';
+        return typeof value === 'boolean' ? { type: 'boolean' } : 'Schema';
     },
 };
-const DiscriminatorMapping = {
+exports.DiscriminatorMapping = {
     properties: {},
     additionalProperties: (value) => {
         if ((0, ref_utils_1.isMappingRef)(value)) {
@@ -424,7 +391,7 @@ const DiscriminatorMapping = {
         }
     },
 };
-const Discriminator = {
+exports.Discriminator = {
     properties: {
         propertyName: { type: 'string' },
         mapping: 'DiscriminatorMapping',
@@ -439,7 +406,6 @@ const Components = {
         correlationIds: 'NamedCorrelationIds',
         messageTraits: 'NamedMessageTraits',
         operationTraits: 'NamedOperationTraits',
-        streamHeaders: 'NamedStreamHeaders',
         securitySchemes: 'NamedSecuritySchemes',
         servers: 'ServerMap',
         serverVariables: 'ServerVariablesMap',
@@ -453,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'],
@@ -461,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'],
@@ -469,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'],
@@ -478,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',
@@ -519,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':
@@ -535,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':
@@ -552,6 +518,12 @@ const SecurityScheme = {
     },
     extensionsPrefix: 'x-',
 };
+exports.Dependencies = {
+    properties: {},
+    additionalProperties: (value) => {
+        return Array.isArray(value) ? { type: 'array', items: { type: 'string' } } : 'Schema';
+    },
+};
 // --- Per-protocol node types
 // http
 const HttpChannelBinding = {
@@ -629,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' },
@@ -693,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' },
@@ -917,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,
@@ -992,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'),
@@ -1010,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,
@@ -1024,5 +1000,7 @@ exports.AsyncApi2Types = {
     OperationTraitList: (0, _1.listOf)('OperationTrait'),
     MessageTrait,
     MessageTraitList: (0, _1.listOf)('MessageTrait'),
-    CorrelationId,
+    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>;