feat: add x-origin property

example/bundle-cjs.cjs

@@ -10,7 +10,7 @@ const bundle = require('@asyncapi/bundler');
 
 async function main() {
  const document = await bundle([readFileSync('./main.yaml', 'utf-8')], {
- 'x-origin': true,
+ xOrigin: true,
  });
  if (document.yml()) {
  writeFileSync('asyncapi.yaml', document.yml());

package.json

@@ -48,6 +48,8 @@
  "devDependencies": {
  "@babel/cli": "^7.19.3",
  "@babel/core": "^7.19.3",
+ "@babel/plugin-proposal-class-properties": "^7.18.6",
+ "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
  "@babel/preset-env": "^7.19.3",
  "@babel/preset-typescript": "^7.18.6",
  "@types/jest": "^29.1.1",

src/index.ts

@@ -2,7 +2,6 @@ import { toJS, resolve, versionCheck } from './util';
 import { Document } from './document';
 
 import type { AsyncAPIObject } from './spec-types';
-import { resolveV3Document } from './v3/parser';
 
 /**
  *
@@ -81,18 +80,9 @@ export default async function bundle(files: string[], options: any = {}) {
  const parsedJsons = files.map(file => toJS(file)) as AsyncAPIObject[];
 
  const majorVersion = versionCheck(parsedJsons);
- let resolvedJsons;
-
- if (majorVersion === 3) {
- resolvedJsons = await resolveV3Document(parsedJsons, options);
- } else {
- /**
- * Bundle all external references for each file.
- * @private
- */
- resolvedJsons = await resolve(parsedJsons, options);
- }
 
+ const resolvedJsons: AsyncAPIObject[] = await resolve(parsedJsons, majorVersion, options);
+
  return new Document(resolvedJsons, options.base);
 }
 

src/parser.ts

@@ -1,33 +1,81 @@
 import $RefParser from '@apidevtools/json-schema-ref-parser';
 import { Parser } from '@asyncapi/parser';
 
-import { AsyncAPIObject } from 'spec-types';
+import type { ParserOptions as $RefParserOptions } from '@apidevtools/json-schema-ref-parser';
+import type { AsyncAPIObject } from 'spec-types';
 
 const parser = new Parser();
 
+let RefParserOptions: $RefParserOptions;
+
 /**
- * Fully dereferences the AsyncAPI Document.
+ * Function fully dereferences the provided AsyncAPI Document.
  * @param {Object[]} JSONSchema
+ * @param {number} specVersion
+ * @param {Object} options
  * @private
  */
-export async function parse(JSONSchema: AsyncAPIObject, options: any = {}) {
+export async function parse(
+ JSONSchema: AsyncAPIObject,
+ specVersion: number,
+ options: any = {}
+) {
  let validationResult: any[] = [];
+ /* eslint-disable indent */
+ // It is assumed that there will be major Spec versions 4, 5 and on.
+ switch (specVersion) {
+ case 2:
+ RefParserOptions = {
+ dereference: {
+ circular: false, // prettier-ignore
+ excludedPathMatcher: (path: string): any => { // eslint-disable-line
+ return;
+ },
+ onDereference: (path: string, value: AsyncAPIObject) => {
+ if (options.xOrigin) {
+ value['x-origin'] = path;
+ }
+ },
+ },
+ };
+ break;
+ case 3:
+ RefParserOptions = {
+ dereference: {
+ circular: false,
+ excludedPathMatcher: (path: string): any => {
+ return (
+ // prettier-ignore
+ (/#\/channels\/[a-zA-Z0-9]*\/servers/).test(path) ||
+ (/#\/operations\/[a-zA-Z0-9]*\/channel/).test(path) ||
+ (/#\/operations\/[a-zA-Z0-9]*\/messages/).test(path) ||
+ (/#\/operations\/[a-zA-Z0-9]*\/reply\/channel/).test(path) ||
+ (/#\/operations\/[a-zA-Z0-9]*\/reply\/messages/).test(path) ||
+ (/#\/components\/channels\/[a-zA-Z0-9]*\/servers/).test(path) ||
+ (/#\/components\/operations\/[a-zA-Z0-9]*\/channel/).test(path) ||
+ (/#\/components\/operations\/[a-zA-Z0-9]*\/messages/).test(path) ||
+ (/#\/components\/operations\/[a-zA-Z0-9]*\/reply\/channel/).test(path) ||
+ (/#\/components\/operations\/[a-zA-Z0-9]*\/reply\/messages/).test(path)
+ );
+ },
+ onDereference: (path: string, value: AsyncAPIObject) => {
+ if (options.xOrigin) {
+ value['x-origin'] = path;
+ }
+ },
+ },
+ };
+ break;
+ default:
+ console.error(
+ `There is no support for AsyncAPI Specification v${specVersion}.`
+ );
+ }
 
- const dereferencedJSONSchema = await $RefParser.dereference(JSONSchema, {
- dereference: {
- circular: false,
- // excludedPathMatcher: (path: string): any => {
- // return (
- // // prettier-ignore
- // );
- // },
- onDereference: (path: string, value: AsyncAPIObject) => {
- if (options['x-origin']) {
- value['x-origin'] = path;
- }
- },
- },
- });
+ const dereferencedJSONSchema = await $RefParser.dereference(
+ JSONSchema,
+ RefParserOptions
+ );
 
  // Option `noValidation: true` is used by the testing system, which
  // intentionally feeds Bundler wrong AsyncAPI Documents, thus it is not

src/util.ts

@@ -49,16 +49,17 @@ export const toJS = (asyncapiYAMLorJSON: string | object) => {
  */
 export const resolve = async (
  asyncapiDocuments: AsyncAPIObject[],
+ specVersion: number,
  options: any
 ) => {
  const docs = [];
 
  try {
  for (const asyncapiDocument of asyncapiDocuments) {
- await parse(asyncapiDocument, options);
+ await parse(asyncapiDocument, specVersion, options);
  docs.push(asyncapiDocument);
  }
- } catch (e) {}
+ } catch (e) {} // eslint-disable-line
 
  return docs;
 };