Befor generating

2026-06-01 13:17:37 +02:00
parent 3383f4bf4a
commit 1aa1b5f625
6756 changed files with 649946 additions and 1 deletions
@@ -0,0 +1,64 @@
+const ERROR_URL_PREFIX = 'https://github.com/asyncapi/parser-js/';
+
+const buildError = (from, to) => {
+  to.type = from.type.startsWith(ERROR_URL_PREFIX) ? from.type : `${ERROR_URL_PREFIX}${from.type}`;
+  to.title = from.title;
+  if (from.detail) to.detail = from.detail;
+  if (from.validationErrors) to.validationErrors = from.validationErrors;
+  if (from.parsedJSON) to.parsedJSON = from.parsedJSON;
+  if (from.location) to.location = from.location;
+  if (from.refs) to.refs = from.refs;
+  return to;
+};
+
+/**
+ * Represents an error while trying to parse an AsyncAPI document.
+ * @alias module:@asyncapi/parser#ParserError
+ * @extends Error
+ */
+class ParserError extends Error {
+  /**
+   * Instantiates an error
+   * @param {Object} definition
+   * @param {String} definition.type The type of the error.
+   * @param {String} definition.title The message of the error.
+   * @param {String} [definition.detail] A string containing more detailed information about the error.
+   * @param {Object} [definition.parsedJSON] The resulting JSON after YAML transformation. Or the JSON object if the this was the initial format.
+   * @param {Object[]} [definition.validationErrors] The errors resulting from the validation. For more information, see https://www.npmjs.com/package/better-ajv-errors.
+   * @param {String} definition.validationErrors.title A validation error message.
+   * @param {String} definition.validationErrors.jsonPointer The path to the field that contains the error. Uses JSON Pointer format.
+   * @param {Number} definition.validationErrors.startLine The line where the error starts in the AsyncAPI document.
+   * @param {Number} definition.validationErrors.startColumn The column where the error starts in the AsyncAPI document.
+   * @param {Number} definition.validationErrors.startOffset The offset (starting from the beginning of the document) where the error starts in the AsyncAPI document.
+   * @param {Number} definition.validationErrors.endLine The line where the error ends in the AsyncAPI document.
+   * @param {Number} definition.validationErrors.endColumn The column where the error ends in the AsyncAPI document.
+   * @param {Number} definition.validationErrors.endOffset The offset (starting from the beginning of the document) where the error ends in the AsyncAPI document.
+   * @param {Object} [definition.location] Error location details after trying to parse an invalid JSON or YAML document.
+   * @param {Number} definition.location.startLine The line of the YAML/JSON document where the error starts.
+   * @param {Number} definition.location.startColumn The column of the YAML/JSON document where the error starts.
+   * @param {Number} definition.location.startOffset The offset (starting from the beginning of the document) where the error starts in the YAML/JSON AsyncAPI document.
+   * @param {Object[]} [definition.refs] Error details after trying to resolve $ref's.
+   * @param {String} definition.refs.title A validation error message.
+   * @param {String} definition.refs.jsonPointer The path to the field that contains the error. Uses JSON Pointer format.
+   * @param {Number} definition.refs.startLine The line where the error starts in the AsyncAPI document.
+   * @param {Number} definition.refs.startColumn The column where the error starts in the AsyncAPI document.
+   * @param {Number} definition.refs.startOffset The offset (starting from the beginning of the document) where the error starts in the AsyncAPI document.
+   * @param {Number} definition.refs.endLine The line where the error ends in the AsyncAPI document.
+   * @param {Number} definition.refs.endColumn The column where the error ends in the AsyncAPI document.
+   * @param {Number} definition.refs.endOffset The offset (starting from the beginning of the document) where the error ends in the AsyncAPI document.
+   */
+  constructor(def) {
+    super();
+    buildError(def, this);
+    this.message = def.title;
+  }
+
+  /**
+   * Returns a JS object representation of the error.
+   */
+  toJS() {
+    return buildError(this, {});
+  }
+}
+
+module.exports = ParserError;