@speclynx/apidom-datamodel 1.12.2 → 2.0.0

package/src/elements/Annotation.cjs

@@ -0,0 +1,35 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _StringElement = _interopRequireDefault(require("../primitives/StringElement.cjs"));
+/**
+ * AnnotationElement represents a parsing annotation (warning or error).
+ *
+ * The annotation's class indicates its severity:
+ * - 'warning' - A non-fatal issue
+ * - 'error' - A fatal issue
+ *
+ * @public
+ */
+class AnnotationElement extends _StringElement.default {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'annotation';
+  }
+
+  /**
+   * The annotation code identifying the type of annotation.
+   */
+  get code() {
+    if (this.hasAttributesProperty('code')) {
+      return this.attributes.get('code');
+    }
+    return undefined;
+  }
+  set code(value) {
+    this.attributes.set('code', value);
+  }
+}
+var _default = exports.default = AnnotationElement;

package/src/elements/Annotation.mjs

@@ -0,0 +1,30 @@
+import StringElement from "../primitives/StringElement.mjs";
+/**
+ * AnnotationElement represents a parsing annotation (warning or error).
+ *
+ * The annotation's class indicates its severity:
+ * - 'warning' - A non-fatal issue
+ * - 'error' - A fatal issue
+ *
+ * @public
+ */
+class AnnotationElement extends StringElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'annotation';
+  }
+
+  /**
+   * The annotation code identifying the type of annotation.
+   */
+  get code() {
+    if (this.hasAttributesProperty('code')) {
+      return this.attributes.get('code');
+    }
+    return undefined;
+  }
+  set code(value) {
+    this.attributes.set('code', value);
+  }
+}
+export default AnnotationElement;

package/src/elements/Comment.cjs

@@ -0,0 +1,18 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _StringElement = _interopRequireDefault(require("../primitives/StringElement.cjs"));
+/**
+ * CommentElement represents a comment in the source document.
+ *
+ * @public
+ */
+class CommentElement extends _StringElement.default {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'comment';
+  }
+}
+var _default = exports.default = CommentElement;

package/src/elements/Comment.mjs

@@ -0,0 +1,13 @@
+import StringElement from "../primitives/StringElement.mjs";
+/**
+ * CommentElement represents a comment in the source document.
+ *
+ * @public
+ */
+class CommentElement extends StringElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'comment';
+  }
+}
+export default CommentElement;

package/src/elements/LinkElement.cjs

@@ -25,7 +25,10 @@ class LinkElement extends _Element.default {
    * The relation identifier for the link, as defined in RFC 5988.
    */
   get relation() {
-    return this.attributes.get('relation');
+    if (this.hasAttributesProperty('relation')) {
+      return this.attributes.get('relation');
+    }
+    return undefined;
   }
   set relation(relation) {
     this.attributes.set('relation', relation);
@@ -35,7 +38,10 @@ class LinkElement extends _Element.default {
    * The URI for the given link.
    */
   get href() {
-    return this.attributes.get('href');
+    if (this.hasAttributesProperty('href')) {
+      return this.attributes.get('href');
+    }
+    return undefined;
   }
   set href(href) {
     this.attributes.set('href', href);

package/src/elements/LinkElement.mjs

@@ -20,7 +20,10 @@ class LinkElement extends Element {
    * The relation identifier for the link, as defined in RFC 5988.
    */
   get relation() {
-    return this.attributes.get('relation');
+    if (this.hasAttributesProperty('relation')) {
+      return this.attributes.get('relation');
+    }
+    return undefined;
   }
   set relation(relation) {
     this.attributes.set('relation', relation);
@@ -30,7 +33,10 @@ class LinkElement extends Element {
    * The URI for the given link.
    */
   get href() {
-    return this.attributes.get('href');
+    if (this.hasAttributesProperty('href')) {
+      return this.attributes.get('href');
+    }
+    return undefined;
   }
   set href(href) {
     this.attributes.set('href', href);

package/src/elements/ParseResult.cjs

@@ -0,0 +1,91 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ArrayElement = _interopRequireDefault(require("../primitives/ArrayElement.cjs"));
+var _index = require("../predicates/index.cjs");
+/**
+ * ParseResultElement represents the result of parsing a document.
+ *
+ * Contains the parsed API element, any result elements, and annotations
+ * (warnings and errors) from the parsing process.
+ *
+ * @public
+ */
+class ParseResultElement extends _ArrayElement.default {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'parseResult';
+  }
+
+  /**
+   * The main API element from the parse result.
+   */
+  get api() {
+    return this.filter(item => (0, _index.includesClasses)(item, ['api'])).first;
+  }
+
+  /**
+   * All result elements from the parse result.
+   */
+  get results() {
+    return this.filter(item => (0, _index.includesClasses)(item, ['result']));
+  }
+
+  /**
+   * The first result element.
+   */
+  get result() {
+    return this.results.first;
+  }
+
+  /**
+   * All annotation elements (warnings and errors).
+   */
+  get annotations() {
+    return this.filter(item => item.element === 'annotation');
+  }
+
+  /**
+   * All warning annotations.
+   */
+  get warnings() {
+    return this.filter(item => item.element === 'annotation' && (0, _index.includesClasses)(item, ['warning']));
+  }
+
+  /**
+   * All error annotations.
+   */
+  get errors() {
+    return this.filter(item => item.element === 'annotation' && (0, _index.includesClasses)(item, ['error']));
+  }
+
+  /**
+   * Whether the parse result is empty (contains only annotations).
+   */
+  get isEmpty() {
+    return this.reject(item => item.element === 'annotation').length === 0;
+  }
+
+  /**
+   * Replaces the first result element with the given replacement.
+   * @returns true if replacement was successful, false otherwise
+   */
+  replaceResult(replacement) {
+    const {
+      result
+    } = this;
+    if (result === undefined) {
+      return false;
+    }
+    const content = this._content;
+    const searchIndex = content.findIndex(e => e === result);
+    if (searchIndex === -1) {
+      return false;
+    }
+    content[searchIndex] = replacement;
+    return true;
+  }
+}
+var _default = exports.default = ParseResultElement;

package/src/elements/ParseResult.mjs

@@ -0,0 +1,86 @@
+import ArrayElement from "../primitives/ArrayElement.mjs";
+import { includesClasses } from "../predicates/index.mjs";
+/**
+ * ParseResultElement represents the result of parsing a document.
+ *
+ * Contains the parsed API element, any result elements, and annotations
+ * (warnings and errors) from the parsing process.
+ *
+ * @public
+ */
+class ParseResultElement extends ArrayElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'parseResult';
+  }
+
+  /**
+   * The main API element from the parse result.
+   */
+  get api() {
+    return this.filter(item => includesClasses(item, ['api'])).first;
+  }
+
+  /**
+   * All result elements from the parse result.
+   */
+  get results() {
+    return this.filter(item => includesClasses(item, ['result']));
+  }
+
+  /**
+   * The first result element.
+   */
+  get result() {
+    return this.results.first;
+  }
+
+  /**
+   * All annotation elements (warnings and errors).
+   */
+  get annotations() {
+    return this.filter(item => item.element === 'annotation');
+  }
+
+  /**
+   * All warning annotations.
+   */
+  get warnings() {
+    return this.filter(item => item.element === 'annotation' && includesClasses(item, ['warning']));
+  }
+
+  /**
+   * All error annotations.
+   */
+  get errors() {
+    return this.filter(item => item.element === 'annotation' && includesClasses(item, ['error']));
+  }
+
+  /**
+   * Whether the parse result is empty (contains only annotations).
+   */
+  get isEmpty() {
+    return this.reject(item => item.element === 'annotation').length === 0;
+  }
+
+  /**
+   * Replaces the first result element with the given replacement.
+   * @returns true if replacement was successful, false otherwise
+   */
+  replaceResult(replacement) {
+    const {
+      result
+    } = this;
+    if (result === undefined) {
+      return false;
+    }
+    const content = this._content;
+    const searchIndex = content.findIndex(e => e === result);
+    if (searchIndex === -1) {
+      return false;
+    }
+    content[searchIndex] = replacement;
+    return true;
+  }
+}
+export default ParseResultElement;

package/src/elements/RefElement.cjs

@@ -22,7 +22,10 @@ class RefElement extends _Element.default {
    * @defaultValue 'element'
    */
   get path() {
-    return this.attributes.get('path');
+    if (this.hasAttributesProperty('path')) {
+      return this.attributes.get('path');
+    }
+    return undefined;
   }
   set path(newValue) {
     this.attributes.set('path', newValue);

package/src/elements/RefElement.mjs

@@ -17,7 +17,10 @@ class RefElement extends Element {
    * @defaultValue 'element'
    */
   get path() {
-    return this.attributes.get('path');
+    if (this.hasAttributesProperty('path')) {
+      return this.attributes.get('path');
+    }
+    return undefined;
   }
   set path(newValue) {
     this.attributes.set('path', newValue);

package/src/elements/SourceMap.cjs

@@ -0,0 +1,140 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _StringElement = _interopRequireDefault(require("../primitives/StringElement.cjs"));
+/**
+ * Shape with optional source position properties.
+ * @public
+ */
+
+/**
+ * SourceMapElement stores source position as a compact VLQ-encoded string.
+ *
+ * The encoded string contains 6 values: startLine, startCharacter, startOffset,
+ * endLine, endCharacter, endOffset. All values use UTF-16 code units,
+ * compatible with LSP, TextDocument, and JavaScript string indexing.
+ *
+ * web-tree-sitter automatically provides position data in UTF-16 code units.
+ *
+ * @public
+ */
+class SourceMapElement extends _StringElement.default {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'sourceMap';
+  }
+
+  /**
+   * Transfers source position properties from one object to another.
+   */
+  static transfer(from, to) {
+    to.startLine = from.startLine;
+    to.startCharacter = from.startCharacter;
+    to.startOffset = from.startOffset;
+    to.endLine = from.endLine;
+    to.endCharacter = from.endCharacter;
+    to.endOffset = from.endOffset;
+  }
+
+  /**
+   * Creates a SourceMapElement from source position properties.
+   * Returns undefined if any position property is not a number.
+   * Also assigns position properties to the instance for inspection.
+   */
+  static from(source) {
+    const {
+      startLine,
+      startCharacter,
+      startOffset,
+      endLine,
+      endCharacter,
+      endOffset
+    } = source;
+    if (typeof startLine !== 'number' || typeof startCharacter !== 'number' || typeof startOffset !== 'number' || typeof endLine !== 'number' || typeof endCharacter !== 'number' || typeof endOffset !== 'number') {
+      return undefined;
+    }
+    const packed = packSourceMap([startLine, startCharacter, startOffset, endLine, endCharacter, endOffset]);
+    const sourceMap = new SourceMapElement(packed);
+    sourceMap.startLine = startLine;
+    sourceMap.startCharacter = startCharacter;
+    sourceMap.startOffset = startOffset;
+    sourceMap.endLine = endLine;
+    sourceMap.endCharacter = endCharacter;
+    sourceMap.endOffset = endOffset;
+    return sourceMap;
+  }
+
+  /**
+   * Decodes the VLQ string and applies source position properties to the target.
+   */
+  applyTo(target) {
+    if (!this.content) return;
+    [target.startLine, target.startCharacter, target.startOffset, target.endLine, target.endCharacter, target.endOffset] = unpackSourceMap(this.content);
+  }
+}
+const BASE64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
+
+// Encode one unsigned integer to Base64-VLQ
+function vlqEncodeInt(value) {
+  let vlq = value >>> 0; // ensure unsigned 32-bit
+  let out = '';
+  do {
+    let digit = vlq & 31; // 5 bits
+    vlq >>>= 5;
+    if (vlq !== 0) digit |= 32; // continuation bit
+    out += BASE64[digit];
+  } while (vlq !== 0);
+  return out;
+}
+
+// Decode one unsigned integer from Base64-VLQ, starting at `index`
+function vlqDecodeInt(str, index = 0) {
+  let result = 0;
+  let shift = 0;
+  let i = index;
+  while (true) {
+    const ch = str[i++];
+    const digit = BASE64.indexOf(ch);
+    if (digit === -1) throw new Error(`Invalid Base64 VLQ char: ${ch}`);
+    const cont = (digit & 32) !== 0;
+    result |= (digit & 31) << shift;
+    shift += 5;
+    if (!cont) break;
+  }
+  return {
+    value: result >>> 0,
+    next: i
+  };
+}
+
+/**
+ * Span of 6 position values: [startLine, startCharacter, startOffset, endLine, endCharacter, endOffset]
+ * @public
+ */
+
+/**
+ * Encodes 6 position values into a compact VLQ string.
+ * @public
+ */
+function packSourceMap(v) {
+  return 'sm1:' + v.map(vlqEncodeInt).join('');
+}
+
+/**
+ * Decodes a VLQ string into 6 position values.
+ * @public
+ */
+function unpackSourceMap(packed) {
+  const s = packed.startsWith('sm1:') ? packed.slice(4) : packed;
+  const out = [];
+  let i = 0;
+  for (let k = 0; k < 6; k++) {
+    const r = vlqDecodeInt(s, i);
+    out.push(r.value);
+    i = r.next;
+  }
+  return out;
+}
+var _default = exports.default = SourceMapElement;

package/src/elements/SourceMap.mjs

@@ -0,0 +1,134 @@
+import StringElement from "../primitives/StringElement.mjs";
+/**
+ * Shape with optional source position properties.
+ * @public
+ */
+/**
+ * SourceMapElement stores source position as a compact VLQ-encoded string.
+ *
+ * The encoded string contains 6 values: startLine, startCharacter, startOffset,
+ * endLine, endCharacter, endOffset. All values use UTF-16 code units,
+ * compatible with LSP, TextDocument, and JavaScript string indexing.
+ *
+ * web-tree-sitter automatically provides position data in UTF-16 code units.
+ *
+ * @public
+ */
+class SourceMapElement extends StringElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'sourceMap';
+  }
+
+  /**
+   * Transfers source position properties from one object to another.
+   */
+  static transfer(from, to) {
+    to.startLine = from.startLine;
+    to.startCharacter = from.startCharacter;
+    to.startOffset = from.startOffset;
+    to.endLine = from.endLine;
+    to.endCharacter = from.endCharacter;
+    to.endOffset = from.endOffset;
+  }
+
+  /**
+   * Creates a SourceMapElement from source position properties.
+   * Returns undefined if any position property is not a number.
+   * Also assigns position properties to the instance for inspection.
+   */
+  static from(source) {
+    const {
+      startLine,
+      startCharacter,
+      startOffset,
+      endLine,
+      endCharacter,
+      endOffset
+    } = source;
+    if (typeof startLine !== 'number' || typeof startCharacter !== 'number' || typeof startOffset !== 'number' || typeof endLine !== 'number' || typeof endCharacter !== 'number' || typeof endOffset !== 'number') {
+      return undefined;
+    }
+    const packed = packSourceMap([startLine, startCharacter, startOffset, endLine, endCharacter, endOffset]);
+    const sourceMap = new SourceMapElement(packed);
+    sourceMap.startLine = startLine;
+    sourceMap.startCharacter = startCharacter;
+    sourceMap.startOffset = startOffset;
+    sourceMap.endLine = endLine;
+    sourceMap.endCharacter = endCharacter;
+    sourceMap.endOffset = endOffset;
+    return sourceMap;
+  }
+
+  /**
+   * Decodes the VLQ string and applies source position properties to the target.
+   */
+  applyTo(target) {
+    if (!this.content) return;
+    [target.startLine, target.startCharacter, target.startOffset, target.endLine, target.endCharacter, target.endOffset] = unpackSourceMap(this.content);
+  }
+}
+const BASE64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';
+
+// Encode one unsigned integer to Base64-VLQ
+function vlqEncodeInt(value) {
+  let vlq = value >>> 0; // ensure unsigned 32-bit
+  let out = '';
+  do {
+    let digit = vlq & 31; // 5 bits
+    vlq >>>= 5;
+    if (vlq !== 0) digit |= 32; // continuation bit
+    out += BASE64[digit];
+  } while (vlq !== 0);
+  return out;
+}
+
+// Decode one unsigned integer from Base64-VLQ, starting at `index`
+function vlqDecodeInt(str, index = 0) {
+  let result = 0;
+  let shift = 0;
+  let i = index;
+  while (true) {
+    const ch = str[i++];
+    const digit = BASE64.indexOf(ch);
+    if (digit === -1) throw new Error(`Invalid Base64 VLQ char: ${ch}`);
+    const cont = (digit & 32) !== 0;
+    result |= (digit & 31) << shift;
+    shift += 5;
+    if (!cont) break;
+  }
+  return {
+    value: result >>> 0,
+    next: i
+  };
+}
+
+/**
+ * Span of 6 position values: [startLine, startCharacter, startOffset, endLine, endCharacter, endOffset]
+ * @public
+ */
+
+/**
+ * Encodes 6 position values into a compact VLQ string.
+ * @public
+ */
+function packSourceMap(v) {
+  return 'sm1:' + v.map(vlqEncodeInt).join('');
+}
+
+/**
+ * Decodes a VLQ string into 6 position values.
+ * @public
+ */
+function unpackSourceMap(packed) {
+  const s = packed.startsWith('sm1:') ? packed.slice(4) : packed;
+  const out = [];
+  let i = 0;
+  for (let k = 0; k < 6; k++) {
+    const r = vlqDecodeInt(s, i);
+    out.push(r.value);
+    i = r.next;
+  }
+  return out;
+}
+export default SourceMapElement;

package/src/index.cjs

@@ -2,11 +2,17 @@
 
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
-exports.refract = exports.StringElement = exports.RefElement = exports.ObjectSlice = exports.ObjectElement = exports.NumberElement = exports.NullElement = exports.Namespace = exports.MemberElement = exports.LinkElement = exports.KeyValuePair = exports.JSONSerialiser = exports.Element = exports.CollectionElement = exports.BooleanElement = exports.ArrayElement = void 0;
+exports.refract = exports.isStringElement = exports.isSourceMapElement = exports.isRefElement = exports.isPrimitiveElement = exports.isParseResultElement = exports.isObjectElement = exports.isNumberElement = exports.isNullElement = exports.isMemberElement = exports.isLinkElement = exports.isElement = exports.isCommentElement = exports.isBooleanElement = exports.isArrayElement = exports.isAnnotationElement = exports.includesSymbols = exports.includesClasses = exports.hasElementSourceMap = exports.cloneShallow = exports.cloneDeep = exports.StringElement = exports.SourceMapElement = exports.ShallowCloneError = exports.RefElement = exports.ParseResultElement = exports.ObjectSlice = exports.ObjectElement = exports.NumberElement = exports.NullElement = exports.Namespace = exports.MemberElement = exports.LinkElement = exports.KeyValuePair = exports.JSONSerialiser = exports.Element = exports.DeepCloneError = exports.CommentElement = exports.CollectionElement = exports.CloneError = exports.BooleanElement = exports.ArrayElement = exports.AnnotationElement = void 0;
 var _Namespace = _interopRequireDefault(require("./Namespace.cjs"));
 exports.Namespace = _Namespace.default;
 var _KeyValuePair = _interopRequireDefault(require("./KeyValuePair.cjs"));
 exports.KeyValuePair = _KeyValuePair.default;
+var _index = require("./clone/index.cjs");
+exports.cloneShallow = _index.cloneShallow;
+exports.cloneDeep = _index.cloneDeep;
+exports.CloneError = _index.CloneError;
+exports.DeepCloneError = _index.DeepCloneError;
+exports.ShallowCloneError = _index.ShallowCloneError;
 var _registration = require("./registration.cjs");
 exports.ObjectSlice = _registration.ObjectSlice;
 exports.Element = _registration.Element;
@@ -20,6 +26,29 @@ exports.ObjectElement = _registration.ObjectElement;
 exports.MemberElement = _registration.MemberElement;
 exports.RefElement = _registration.RefElement;
 exports.LinkElement = _registration.LinkElement;
+exports.AnnotationElement = _registration.AnnotationElement;
+exports.CommentElement = _registration.CommentElement;
+exports.ParseResultElement = _registration.ParseResultElement;
+exports.SourceMapElement = _registration.SourceMapElement;
 exports.refract = _registration.refract;
 var _JSONSerialiser = _interopRequireDefault(require("./serialisers/JSONSerialiser.cjs"));
-exports.JSONSerialiser = _JSONSerialiser.default;
+exports.JSONSerialiser = _JSONSerialiser.default;
+var _index2 = require("./predicates/index.cjs");
+exports.isElement = _index2.isElement;
+exports.isStringElement = _index2.isStringElement;
+exports.isNumberElement = _index2.isNumberElement;
+exports.isNullElement = _index2.isNullElement;
+exports.isBooleanElement = _index2.isBooleanElement;
+exports.isObjectElement = _index2.isObjectElement;
+exports.isArrayElement = _index2.isArrayElement;
+exports.isMemberElement = _index2.isMemberElement;
+exports.isLinkElement = _index2.isLinkElement;
+exports.isRefElement = _index2.isRefElement;
+exports.isAnnotationElement = _index2.isAnnotationElement;
+exports.isCommentElement = _index2.isCommentElement;
+exports.isParseResultElement = _index2.isParseResultElement;
+exports.isSourceMapElement = _index2.isSourceMapElement;
+exports.isPrimitiveElement = _index2.isPrimitiveElement;
+exports.hasElementSourceMap = _index2.hasElementSourceMap;
+exports.includesSymbols = _index2.includesSymbols;
+exports.includesClasses = _index2.includesClasses;