Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@asyncapi/parser
Advanced tools
@asyncapi/parser - npm Package Compare versions
Comparing version 1.3.1 to 1.3.2
@@ -12,58 +12,7 @@ const { createMapOfType, getMapValueOfType, mix } = require('../utils'); | ||
| const MixinSpecificationExtensions = require('../mixins/specification-extensions'); | ||
| const {xParserCircle, xParserCircleProps} = require('../constants'); | ||
| const {assignNameToAnonymousMessages, assignNameToComponentMessages, assignUidToComponentSchemas, assignUidToParameterSchemas, assignIdToAnonymousSchemas} = require('../anonymousNaming'); | ||
| const {traverseAsyncApiDocument, SchemaIteratorCallbackType} = require('../iterators'); | ||
| const xParserMessageName = 'x-parser-message-name'; | ||
| const xParserSchemaId = 'x-parser-schema-id'; | ||
| const xParserCircle = 'x-parser-circular'; | ||
| const xParserCircleProps = 'x-parser-circular-props'; | ||
| /** | ||
| * The different kind of stages when crawling a schema. | ||
| * | ||
| * @typedef SchemaIteratorCallbackType | ||
| * @property {string} NEW_SCHEMA The crawler just started crawling a schema. | ||
| * @property {string} END_SCHEMA The crawler just finished crawling a schema. | ||
| */ | ||
| /** | ||
| * @readonly | ||
| * @enum {SchemaIteratorCallbackType} | ||
| */ | ||
| const SchemaIteratorCallbackType = Object.freeze({ | ||
| NEW_SCHEMA: 'NEW_SCHEMA', | ||
| END_SCHEMA: 'END_SCHEMA' | ||
| }); | ||
| /** | ||
| * The different types of schemas you can iterate | ||
| * | ||
| * @typedef SchemaTypesToIterate | ||
| * @property {string} parameters Crawl all schemas in parameters | ||
| * @property {string} payloads Crawl all schemas in payloads | ||
| * @property {string} headers Crawl all schemas in headers | ||
| * @property {string} components Crawl all schemas in components | ||
| * @property {string} objects Crawl all schemas of type object | ||
| * @property {string} arrays Crawl all schemas of type array | ||
| * @property {string} oneOfs Crawl all schemas in oneOf's | ||
| * @property {string} allOfs Crawl all schemas in allOf's | ||
| * @property {string} anyOfs Crawl all schemas in anyOf's | ||
| */ | ||
| /** | ||
| * | ||
| * @readonly | ||
| * @enum {SchemaTypesToIterate} | ||
| */ | ||
| const SchemaTypesToIterate = Object.freeze({ | ||
| parameters: 'parameters', | ||
| payloads: 'payloads', | ||
| headers: 'headers', | ||
| components: 'components', | ||
| objects: 'objects', | ||
| arrays: 'arrays', | ||
| oneOfs: 'oneOfs', | ||
| allOfs: 'allOfs', | ||
| anyOfs: 'anyOfs' | ||
| }); | ||
| /** | ||
| * Implements functions to deal with the AsyncAPI document. | ||
@@ -325,266 +274,2 @@ * @class | ||
| /** | ||
| * Assign message keys as message name to all the component messages. | ||
| * | ||
| * @private | ||
| * @param {AsyncAPIDocument} doc | ||
| */ | ||
| function assignNameToComponentMessages(doc) { | ||
| if (doc.hasComponents()) { | ||
| for (const [key, m] of Object.entries(doc.components().messages())) { | ||
| if (m.name() === undefined) { | ||
| m.json()[String(xParserMessageName)] = key; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| /** | ||
| * Assign parameter keys as uid for the parameter schema. | ||
| * | ||
| * @private | ||
| * @param {AsyncAPIDocument} doc | ||
| */ | ||
| function assignUidToParameterSchemas(doc) { | ||
| doc.channelNames().forEach(channelName => { | ||
| const channel = doc.channel(channelName); | ||
| for (const [parameterKey, parameterSchema] of Object.entries(channel.parameters())) { | ||
| parameterSchema.json()[String(xParserSchemaId)] = parameterKey; | ||
| } | ||
| }); | ||
| } | ||
| /** | ||
| * Assign uid to component schemas. | ||
| * | ||
| * @private | ||
| * @param {AsyncAPIDocument} doc | ||
| */ | ||
| function assignUidToComponentSchemas(doc) { | ||
| if (doc.hasComponents()) { | ||
| for (const [key, s] of Object.entries(doc.components().schemas())) { | ||
| s.json()[String(xParserSchemaId)] = key; | ||
| } | ||
| } | ||
| } | ||
| /** | ||
| * Assign anonymous names to nameless messages. | ||
| * | ||
| * @private | ||
| * @param {AsyncAPIDocument} doc | ||
| */ | ||
| function assignNameToAnonymousMessages(doc) { | ||
| let anonymousMessageCounter = 0; | ||
| if (doc.hasChannels()) { | ||
| doc.channelNames().forEach(channelName => { | ||
| const channel = doc.channel(channelName); | ||
| if (channel.hasPublish()) addNameToKey(channel.publish().messages(), ++anonymousMessageCounter); | ||
| if (channel.hasSubscribe()) addNameToKey(channel.subscribe().messages(), ++anonymousMessageCounter); | ||
| }); | ||
| } | ||
| } | ||
| /** | ||
| * Add anonymous name to key if no name provided. | ||
| * | ||
| * @private | ||
| * @param {Message} map of messages | ||
| */ | ||
| function addNameToKey(messages, number) { | ||
| messages.forEach(m => { | ||
| if (m.name() === undefined) { | ||
| m.json()[String(xParserMessageName)] = `<anonymous-message-${number}>`; | ||
| } | ||
| }); | ||
| } | ||
| /** | ||
| * Traverse current schema and all nested schemas. | ||
| * | ||
| * @private | ||
| * @param {Schema} schemaContent schema. | ||
| * @param {TraverseSchemas} callback | ||
| * @param {SchemaTypesToIterate[]} schemaTypesToIterate | ||
| */ | ||
| function traverseSchema(schema, callback, prop, schemaTypesToIterate) { | ||
| if (schema === null) return; | ||
| if (!schemaTypesToIterate.includes(SchemaTypesToIterate.arrays) && schema.type() === 'array') return; | ||
| if (!schemaTypesToIterate.includes(SchemaTypesToIterate.objects) && schema.type() === 'object') return; | ||
| if (schema.isCircular()) return; | ||
| if (callback(schema, prop, SchemaIteratorCallbackType.NEW_SCHEMA) === false) return; | ||
| if (schema.type() !== undefined) { | ||
| switch (schema.type()) { | ||
| case 'object': | ||
| recursiveSchemaObject(schema, callback, schemaTypesToIterate); | ||
| break; | ||
| case 'array': | ||
| recursiveSchemaArray(schema, callback, schemaTypesToIterate); | ||
| break; | ||
| } | ||
| } else { | ||
| traverseCombinedSchemas(schema, callback, schemaTypesToIterate); | ||
| } | ||
| callback(schema, prop, SchemaIteratorCallbackType.END_SCHEMA); | ||
| } | ||
| /** | ||
| * Traverse combined notions | ||
| * | ||
| * @private | ||
| * @param {Schema} schemaContent schema. | ||
| * @param {TraverseSchemas} callback | ||
| * @param {SchemaTypesToIterate[]} schemaTypesToIterate | ||
| */ | ||
| function traverseCombinedSchemas(schema, callback, schemaTypesToIterate) { | ||
| //check for allOf, oneOf, anyOf | ||
| const checkCombiningSchemas = (combineArray) => { | ||
| (combineArray || []).forEach(combineSchema => { | ||
| traverseSchema(combineSchema, callback, null, schemaTypesToIterate); | ||
| }); | ||
| }; | ||
| if (schemaTypesToIterate.includes(SchemaTypesToIterate.allOfs)) { | ||
| checkCombiningSchemas(schema.allOf()); | ||
| } | ||
| if (schemaTypesToIterate.includes(SchemaTypesToIterate.anyOfs)) { | ||
| checkCombiningSchemas(schema.anyOf()); | ||
| } | ||
| if (schemaTypesToIterate.includes(SchemaTypesToIterate.oneOfs)) { | ||
| checkCombiningSchemas(schema.oneOf()); | ||
| } | ||
| } | ||
| /** | ||
| * Go through each channel and for each parameter, and message payload and headers recursively call the callback for each schema. | ||
| * | ||
| * @private | ||
| * @param {AsyncAPIDocument} doc | ||
| * @param {FoundSchemaCallback} callback | ||
| * @param {SchemaTypesToIterate[]} schemaTypesToIterate | ||
| */ | ||
| function traverseAsyncApiDocument(doc, callback, schemaTypesToIterate) { | ||
| if (!schemaTypesToIterate) { | ||
| schemaTypesToIterate = Object.values(SchemaTypesToIterate); | ||
| } | ||
| if (doc.hasChannels()) { | ||
| doc.channelNames().forEach(channelName => { | ||
| const channel = doc.channel(channelName); | ||
| traverseChannel(channel, callback, schemaTypesToIterate); | ||
| }); | ||
| } | ||
| if (doc.hasComponents() && schemaTypesToIterate.includes(SchemaTypesToIterate.components)) { | ||
| Object.values(doc.components().schemas()).forEach(s => { | ||
| traverseSchema(s, callback, null, schemaTypesToIterate); | ||
| }); | ||
| } | ||
| } | ||
| /** | ||
| * Go through each schema in channel | ||
| * | ||
| * @private | ||
| * @param {Channel} channel | ||
| * @param {FoundSchemaCallback} callback | ||
| * @param {SchemaTypesToIterate[]} schemaTypesToIterate | ||
| */ | ||
| function traverseChannel(channel, callback, schemaTypesToIterate) { | ||
| if (schemaTypesToIterate.includes(SchemaTypesToIterate.parameters)) { | ||
| Object.values(channel.parameters()).forEach(p => { | ||
| traverseSchema(p.schema(), callback, null, schemaTypesToIterate); | ||
| }); | ||
| } | ||
| if (channel.hasPublish()) { | ||
| channel.publish().messages().forEach(m => { | ||
| traverseMessage(m, callback, schemaTypesToIterate); | ||
| }); | ||
| } | ||
| if (channel.hasSubscribe()) { | ||
| channel.subscribe().messages().forEach(m => { | ||
| traverseMessage(m, callback, schemaTypesToIterate); | ||
| }); | ||
| } | ||
| } | ||
| /** | ||
| * Go through each schema in a message | ||
| * | ||
| * @private | ||
| * @param {Message} message | ||
| * @param {FoundSchemaCallback} callback | ||
| * @param {SchemaTypesToIterate[]} schemaTypesToIterate | ||
| */ | ||
| function traverseMessage(message, callback, schemaTypesToIterate) { | ||
| if (schemaTypesToIterate.includes(SchemaTypesToIterate.headers)) { | ||
| traverseSchema(message.headers(), callback, null, schemaTypesToIterate); | ||
| } | ||
| if (schemaTypesToIterate.includes(SchemaTypesToIterate.payloads)) { | ||
| traverseSchema(message.payload(), callback, null, schemaTypesToIterate); | ||
| } | ||
| } | ||
| /** | ||
| * Gives schemas id to all anonymous schemas. | ||
| * | ||
| * @private | ||
| * @param {AsyncAPIDocument} doc | ||
| */ | ||
| function assignIdToAnonymousSchemas(doc) { | ||
| let anonymousSchemaCounter = 0; | ||
| const callback = (schema) => { | ||
| if (!schema.uid()) { | ||
| schema.json()[String(xParserSchemaId)] = `<anonymous-schema-${++anonymousSchemaCounter}>`; | ||
| } | ||
| }; | ||
| traverseAsyncApiDocument(doc, callback); | ||
| } | ||
| /** | ||
| * Recursively go through schema of object type and execute callback. | ||
| * | ||
| * @private | ||
| * @param {Schema} schema Object type. | ||
| * @param {TraverseSchemas} callback | ||
| * @param {SchemaTypesToIterate[]} schemaTypesToIterate | ||
| */ | ||
| function recursiveSchemaObject(schema, callback, schemaTypesToIterate) { | ||
| if (schema.additionalProperties() !== undefined && typeof schema.additionalProperties() !== 'boolean') { | ||
| const additionalSchema = schema.additionalProperties(); | ||
| traverseSchema(additionalSchema, callback, null, schemaTypesToIterate); | ||
| } | ||
| if (schema.properties() !== null) { | ||
| const props = schema.properties(); | ||
| for (const [prop, propertySchema] of Object.entries(props)) { | ||
| const circularProps = schema.circularProps(); | ||
| if (circularProps !== undefined && circularProps.includes(prop)) continue; | ||
| traverseSchema(propertySchema, callback, prop, schemaTypesToIterate); | ||
| } | ||
| } | ||
| } | ||
| /** | ||
| * Recursively go through schema of array type and execute callback. | ||
| * | ||
| * @private | ||
| * @param {Schema} schema Array type. | ||
| * @param {TraverseSchemas} callback | ||
| * @param {SchemaTypesToIterate[]} schemaTypesToIterate | ||
| */ | ||
| function recursiveSchemaArray(schema, callback, schemaTypesToIterate) { | ||
| if (schema.additionalItems() !== undefined) { | ||
| const additionalArrayItems = schema.additionalItems(); | ||
| traverseSchema(additionalArrayItems, callback, null, schemaTypesToIterate); | ||
| } | ||
| if (schema.items() !== null) { | ||
| if (Array.isArray(schema.items())) { | ||
| schema.items().forEach(arraySchema => { | ||
| traverseSchema(arraySchema, callback, null, schemaTypesToIterate); | ||
| }); | ||
| } else { | ||
| traverseSchema(schema.items(), callback, null, schemaTypesToIterate); | ||
| } | ||
| } | ||
| } | ||
| module.exports = mix(AsyncAPIDocument, MixinTags, MixinExternalDocs, MixinSpecificationExtensions); |
| { | ||
| "name": "@asyncapi/parser", | ||
| "version": "1.3.1", | ||
| "version": "1.3.2", | ||
| "description": "JavaScript AsyncAPI parser.", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
@@ -1,42 +0,2 @@ | ||
| /** | ||
| * Implements functions to deal with the common Bindings object. | ||
| */ | ||
| declare interface MixinBindings { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the description field. | ||
| */ | ||
| declare interface MixinDescription { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the ExternalDocs object. | ||
| */ | ||
| declare interface MixinExternalDocs { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the SpecificationExtensions object. | ||
| */ | ||
| declare interface MixinSpecificationExtensions { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the Tags object. | ||
| */ | ||
| declare interface MixinTags { | ||
| } | ||
| /** | ||
| * The different kind of stages when crawling a schema. | ||
@@ -109,3 +69,43 @@ * @property NEW_SCHEMA - The crawler just started crawling a schema. | ||
| /** | ||
| * Implements functions to deal with the common Bindings object. | ||
| */ | ||
| declare interface MixinBindings { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the description field. | ||
| */ | ||
| declare interface MixinDescription { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the ExternalDocs object. | ||
| */ | ||
| declare interface MixinExternalDocs { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the SpecificationExtensions object. | ||
| */ | ||
| declare interface MixinSpecificationExtensions { | ||
| } | ||
| /** | ||
| * Implements functions to deal with the Tags object. | ||
| */ | ||
| declare interface MixinTags { | ||
| } | ||
| /** | ||
| * Callback used when crawling a schema. | ||
@@ -112,0 +112,0 @@ * @param schema - which is being crawled |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is too big to display
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.11%
1122529
- Number of package files
- increased by6.52%
49
- Lines of code
- increased by0.54%
6913
No dependency changes