@speclynx/apidom-datamodel 4.0.2 → 4.0.3

package/src/predicates/elements.mjs

@@ -0,0 +1,35 @@
+import LinkElement from "../elements/LinkElement.mjs";
+import RefElement from "../elements/RefElement.mjs";
+import AnnotationElement from "../elements/Annotation.mjs";
+import CommentElement from "../elements/Comment.mjs";
+import ParseResultElement from "../elements/ParseResult.mjs";
+import SourceMapElement from "../elements/SourceMap.mjs";
+/**
+ * @public
+ */
+export const isLinkElement = element => element instanceof LinkElement;
+
+/**
+ * @public
+ */
+export const isRefElement = element => element instanceof RefElement;
+
+/**
+ * @public
+ */
+export const isAnnotationElement = element => element instanceof AnnotationElement;
+
+/**
+ * @public
+ */
+export const isCommentElement = element => element instanceof CommentElement;
+
+/**
+ * @public
+ */
+export const isParseResultElement = element => element instanceof ParseResultElement;
+
+/**
+ * @public
+ */
+export const isSourceMapElement = element => element instanceof SourceMapElement;

package/src/predicates/elements.ts

@@ -0,0 +1,42 @@
+import LinkElement from '../elements/LinkElement.ts';
+import RefElement from '../elements/RefElement.ts';
+import AnnotationElement from '../elements/Annotation.ts';
+import CommentElement from '../elements/Comment.ts';
+import ParseResultElement from '../elements/ParseResult.ts';
+import SourceMapElement from '../elements/SourceMap.ts';
+
+/**
+ * @public
+ */
+export const isLinkElement = (element: unknown): element is LinkElement =>
+  element instanceof LinkElement;
+
+/**
+ * @public
+ */
+export const isRefElement = (element: unknown): element is RefElement =>
+  element instanceof RefElement;
+
+/**
+ * @public
+ */
+export const isAnnotationElement = (element: unknown): element is AnnotationElement =>
+  element instanceof AnnotationElement;
+
+/**
+ * @public
+ */
+export const isCommentElement = (element: unknown): element is CommentElement =>
+  element instanceof CommentElement;
+
+/**
+ * @public
+ */
+export const isParseResultElement = (element: unknown): element is ParseResultElement =>
+  element instanceof ParseResultElement;
+
+/**
+ * @public
+ */
+export const isSourceMapElement = (element: unknown): element is SourceMapElement =>
+  element instanceof SourceMapElement;

package/src/predicates/index.cjs

@@ -0,0 +1,77 @@
+"use strict";
+
+exports.__esModule = true;
+exports.isStringElement = exports.isSourceMapElement = exports.isRefElement = exports.isPrimitiveElement = exports.isParseResultElement = exports.isObjectElement = exports.isNumberElement = exports.isNullElement = exports.isMemberElement = exports.isLinkElement = exports.isCommentElement = exports.isBooleanElement = exports.isAnnotationElement = exports.includesSymbols = exports.includesClasses = exports.hasElementStyle = exports.hasElementSourceMap = void 0;
+var _primitives = require("./primitives.cjs");
+exports.isArrayElement = _primitives.isArrayElement;
+exports.isElement = _primitives.isElement;
+exports.isStringElement = _primitives.isStringElement;
+exports.isNumberElement = _primitives.isNumberElement;
+exports.isNullElement = _primitives.isNullElement;
+exports.isBooleanElement = _primitives.isBooleanElement;
+exports.isObjectElement = _primitives.isObjectElement;
+exports.isMemberElement = _primitives.isMemberElement;
+exports.isPrimitiveElement = _primitives.isPrimitiveElement;
+var _elements = require("./elements.cjs");
+exports.isLinkElement = _elements.isLinkElement;
+exports.isRefElement = _elements.isRefElement;
+exports.isAnnotationElement = _elements.isAnnotationElement;
+exports.isCommentElement = _elements.isCommentElement;
+exports.isParseResultElement = _elements.isParseResultElement;
+exports.isSourceMapElement = _elements.isSourceMapElement;
+/**
+ * Checks if an element has format-specific style information.
+ * @public
+ */
+const hasElementStyle = element => {
+  return element.style !== undefined;
+};
+
+/**
+ * Checks if an element has complete source position information.
+ * Returns true only if all 6 position properties are numbers.
+ * @public
+ */
+exports.hasElementStyle = hasElementStyle;
+const hasElementSourceMap = element => {
+  return typeof element.startLine === 'number' && typeof element.startCharacter === 'number' && typeof element.startOffset === 'number' && typeof element.endLine === 'number' && typeof element.endCharacter === 'number' && typeof element.endOffset === 'number';
+};
+
+/**
+ * @public
+ */
+exports.hasElementSourceMap = hasElementSourceMap;
+const includesSymbols = (element, symbols) => {
+  if (symbols.length === 0) {
+    return true;
+  }
+  if (!element.hasAttributesProperty('symbols')) {
+    return false;
+  }
+  const elementSymbols = element.attributes.get('symbols');
+  if (!(0, _primitives.isArrayElement)(elementSymbols)) {
+    return false;
+  }
+  return symbols.every(symbol => elementSymbols.includes(symbol));
+};
+
+/**
+ * @public
+ */
+exports.includesSymbols = includesSymbols;
+const includesClasses = (element, classes) => {
+  if (classes.length === 0) {
+    return true;
+  }
+  if (!(0, _primitives.isElement)(element)) {
+    return false;
+  }
+  if (element.isMetaEmpty) {
+    return false;
+  }
+  if (!element.hasMetaProperty('classes')) {
+    return false;
+  }
+  return classes.every(cls => element.classes.includes(cls));
+};
+exports.includesClasses = includesClasses;

package/src/predicates/index.mjs

@@ -0,0 +1,56 @@
+import { isArrayElement, isElement } from "./primitives.mjs";
+export { isStringElement, isNumberElement, isNullElement, isBooleanElement, isArrayElement, isObjectElement, isMemberElement, isPrimitiveElement } from "./primitives.mjs";
+export { isElement };
+export { isLinkElement, isRefElement, isAnnotationElement, isCommentElement, isParseResultElement, isSourceMapElement } from "./elements.mjs";
+/**
+ * Checks if an element has format-specific style information.
+ * @public
+ */
+export const hasElementStyle = element => {
+  return element.style !== undefined;
+};
+
+/**
+ * Checks if an element has complete source position information.
+ * Returns true only if all 6 position properties are numbers.
+ * @public
+ */
+export const hasElementSourceMap = element => {
+  return typeof element.startLine === 'number' && typeof element.startCharacter === 'number' && typeof element.startOffset === 'number' && typeof element.endLine === 'number' && typeof element.endCharacter === 'number' && typeof element.endOffset === 'number';
+};
+
+/**
+ * @public
+ */
+export const includesSymbols = (element, symbols) => {
+  if (symbols.length === 0) {
+    return true;
+  }
+  if (!element.hasAttributesProperty('symbols')) {
+    return false;
+  }
+  const elementSymbols = element.attributes.get('symbols');
+  if (!isArrayElement(elementSymbols)) {
+    return false;
+  }
+  return symbols.every(symbol => elementSymbols.includes(symbol));
+};
+
+/**
+ * @public
+ */
+export const includesClasses = (element, classes) => {
+  if (classes.length === 0) {
+    return true;
+  }
+  if (!isElement(element)) {
+    return false;
+  }
+  if (element.isMetaEmpty) {
+    return false;
+  }
+  if (!element.hasMetaProperty('classes')) {
+    return false;
+  }
+  return classes.every(cls => element.classes.includes(cls));
+};

package/src/predicates/index.ts

@@ -0,0 +1,89 @@
+import Element from '../primitives/Element.ts';
+import { isArrayElement, isElement } from './primitives.ts';
+
+export {
+  isStringElement,
+  isNumberElement,
+  isNullElement,
+  isBooleanElement,
+  isArrayElement,
+  isObjectElement,
+  isMemberElement,
+  isPrimitiveElement,
+} from './primitives.ts';
+export { isElement };
+export type { PrimitiveElement } from './primitives.ts';
+
+export {
+  isLinkElement,
+  isRefElement,
+  isAnnotationElement,
+  isCommentElement,
+  isParseResultElement,
+  isSourceMapElement,
+} from './elements.ts';
+
+/**
+ * Checks if an element has format-specific style information.
+ * @public
+ */
+export const hasElementStyle = <T extends Element>(element: T): boolean => {
+  return element.style !== undefined;
+};
+
+/**
+ * Checks if an element has complete source position information.
+ * Returns true only if all 6 position properties are numbers.
+ * @public
+ */
+export const hasElementSourceMap = <T extends Element>(element: T): boolean => {
+  return (
+    typeof element.startLine === 'number' &&
+    typeof element.startCharacter === 'number' &&
+    typeof element.startOffset === 'number' &&
+    typeof element.endLine === 'number' &&
+    typeof element.endCharacter === 'number' &&
+    typeof element.endOffset === 'number'
+  );
+};
+
+/**
+ * @public
+ */
+export const includesSymbols = <T extends Element>(element: T, symbols: string[]): boolean => {
+  if (symbols.length === 0) {
+    return true;
+  }
+
+  if (!element.hasAttributesProperty('symbols')) {
+    return false;
+  }
+
+  const elementSymbols = element.attributes.get('symbols');
+
+  if (!isArrayElement(elementSymbols)) {
+    return false;
+  }
+
+  return symbols.every((symbol) => elementSymbols.includes(symbol));
+};
+
+/**
+ * @public
+ */
+export const includesClasses = <T extends Element>(element: T, classes: string[]): boolean => {
+  if (classes.length === 0) {
+    return true;
+  }
+  if (!isElement(element)) {
+    return false;
+  }
+  if (element.isMetaEmpty) {
+    return false;
+  }
+  if (!element.hasMetaProperty('classes')) {
+    return false;
+  }
+
+  return classes.every((cls) => element.classes.includes(cls));
+};

package/src/predicates/primitives.cjs

@@ -0,0 +1,69 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.isStringElement = exports.isPrimitiveElement = exports.isObjectElement = exports.isNumberElement = exports.isNullElement = exports.isMemberElement = exports.isElement = exports.isBooleanElement = exports.isArrayElement = void 0;
+var _Element = _interopRequireDefault(require("../primitives/Element.cjs"));
+var _StringElement = _interopRequireDefault(require("../primitives/StringElement.cjs"));
+var _NumberElement = _interopRequireDefault(require("../primitives/NumberElement.cjs"));
+var _NullElement = _interopRequireDefault(require("../primitives/NullElement.cjs"));
+var _BooleanElement = _interopRequireDefault(require("../primitives/BooleanElement.cjs"));
+var _ArrayElement = _interopRequireDefault(require("../primitives/ArrayElement.cjs"));
+var _ObjectElement = _interopRequireDefault(require("../primitives/ObjectElement.cjs"));
+var _MemberElement = _interopRequireDefault(require("../primitives/MemberElement.cjs"));
+/**
+ * @public
+ */
+const isElement = element => element instanceof _Element.default;
+
+/**
+ * @public
+ */
+exports.isElement = isElement;
+const isStringElement = element => element instanceof _StringElement.default;
+
+/**
+ * @public
+ */
+exports.isStringElement = isStringElement;
+const isNumberElement = element => element instanceof _NumberElement.default;
+
+/**
+ * @public
+ */
+exports.isNumberElement = isNumberElement;
+const isNullElement = element => element instanceof _NullElement.default;
+
+/**
+ * @public
+ */
+exports.isNullElement = isNullElement;
+const isBooleanElement = element => element instanceof _BooleanElement.default;
+
+/**
+ * @public
+ */
+exports.isBooleanElement = isBooleanElement;
+const isArrayElement = element => element instanceof _ArrayElement.default;
+
+/**
+ * @public
+ */
+exports.isArrayElement = isArrayElement;
+const isObjectElement = element => element instanceof _ObjectElement.default;
+
+/**
+ * @public
+ */
+exports.isObjectElement = isObjectElement;
+const isMemberElement = element => element instanceof _MemberElement.default;
+
+/**
+ * @public
+ */
+exports.isMemberElement = isMemberElement;
+/**
+ * @public
+ */
+const isPrimitiveElement = element => isObjectElement(element) && element.element === 'object' || isArrayElement(element) && element.element === 'array' || isBooleanElement(element) && element.element === 'boolean' || isNumberElement(element) && element.element === 'number' || isStringElement(element) && element.element === 'string' || isNullElement(element) && element.element === 'null' || isMemberElement(element) && element.element === 'member';
+exports.isPrimitiveElement = isPrimitiveElement;

package/src/predicates/primitives.mjs

@@ -0,0 +1,56 @@
+import Element from "../primitives/Element.mjs";
+import StringElement from "../primitives/StringElement.mjs";
+import NumberElement from "../primitives/NumberElement.mjs";
+import NullElement from "../primitives/NullElement.mjs";
+import BooleanElement from "../primitives/BooleanElement.mjs";
+import ArrayElement from "../primitives/ArrayElement.mjs";
+import ObjectElement from "../primitives/ObjectElement.mjs";
+import MemberElement from "../primitives/MemberElement.mjs";
+/**
+ * @public
+ */
+export const isElement = element => element instanceof Element;
+
+/**
+ * @public
+ */
+export const isStringElement = element => element instanceof StringElement;
+
+/**
+ * @public
+ */
+export const isNumberElement = element => element instanceof NumberElement;
+
+/**
+ * @public
+ */
+export const isNullElement = element => element instanceof NullElement;
+
+/**
+ * @public
+ */
+export const isBooleanElement = element => element instanceof BooleanElement;
+
+/**
+ * @public
+ */
+export const isArrayElement = element => element instanceof ArrayElement;
+
+/**
+ * @public
+ */
+export const isObjectElement = element => element instanceof ObjectElement;
+
+/**
+ * @public
+ */
+export const isMemberElement = element => element instanceof MemberElement;
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+export const isPrimitiveElement = element => isObjectElement(element) && element.element === 'object' || isArrayElement(element) && element.element === 'array' || isBooleanElement(element) && element.element === 'boolean' || isNumberElement(element) && element.element === 'number' || isStringElement(element) && element.element === 'string' || isNullElement(element) && element.element === 'null' || isMemberElement(element) && element.element === 'member';

package/src/predicates/primitives.ts

@@ -0,0 +1,79 @@
+import Element from '../primitives/Element.ts';
+import StringElement from '../primitives/StringElement.ts';
+import NumberElement from '../primitives/NumberElement.ts';
+import NullElement from '../primitives/NullElement.ts';
+import BooleanElement from '../primitives/BooleanElement.ts';
+import ArrayElement from '../primitives/ArrayElement.ts';
+import ObjectElement from '../primitives/ObjectElement.ts';
+import MemberElement from '../primitives/MemberElement.ts';
+
+/**
+ * @public
+ */
+export const isElement = (element: unknown): element is Element => element instanceof Element;
+
+/**
+ * @public
+ */
+export const isStringElement = (element: unknown): element is StringElement =>
+  element instanceof StringElement;
+
+/**
+ * @public
+ */
+export const isNumberElement = (element: unknown): element is NumberElement =>
+  element instanceof NumberElement;
+
+/**
+ * @public
+ */
+export const isNullElement = (element: unknown): element is NullElement =>
+  element instanceof NullElement;
+
+/**
+ * @public
+ */
+export const isBooleanElement = (element: unknown): element is BooleanElement =>
+  element instanceof BooleanElement;
+
+/**
+ * @public
+ */
+export const isArrayElement = (element: unknown): element is ArrayElement =>
+  element instanceof ArrayElement;
+
+/**
+ * @public
+ */
+export const isObjectElement = (element: unknown): element is ObjectElement =>
+  element instanceof ObjectElement;
+
+/**
+ * @public
+ */
+export const isMemberElement = (element: unknown): element is MemberElement =>
+  element instanceof MemberElement;
+
+/**
+ * @public
+ */
+export type PrimitiveElement =
+  | ObjectElement
+  | ArrayElement
+  | BooleanElement
+  | NumberElement
+  | StringElement
+  | NullElement
+  | MemberElement;
+
+/**
+ * @public
+ */
+export const isPrimitiveElement = (element: unknown): element is PrimitiveElement =>
+  (isObjectElement(element) && element.element === 'object') ||
+  (isArrayElement(element) && element.element === 'array') ||
+  (isBooleanElement(element) && element.element === 'boolean') ||
+  (isNumberElement(element) && element.element === 'number') ||
+  (isStringElement(element) && element.element === 'string') ||
+  (isNullElement(element) && element.element === 'null') ||
+  (isMemberElement(element) && element.element === 'member');

package/src/primitives/ArrayElement.cjs

@@ -0,0 +1,155 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _CollectionElement = _interopRequireDefault(require("./CollectionElement.cjs"));
+// Re-export types from CollectionElement
+
+/**
+ * ArrayElement represents an array/collection of elements in ApiDOM.
+ *
+ * @typeParam T - The element type contained in the array, defaults to Element
+ * @public
+ */
+class ArrayElement extends _CollectionElement.default {
+  constructor(content, meta, attributes) {
+    super(content || [], meta, attributes);
+    this.element = 'array';
+  }
+  primitive() {
+    return 'array';
+  }
+
+  /**
+   * Gets the element at the specified index.
+   */
+  get(index) {
+    return this._content[index];
+  }
+
+  /**
+   * Helper for returning the value of an item.
+   */
+  getValue(index) {
+    const item = this.get(index);
+    if (item) {
+      return item.toValue();
+    }
+    return undefined;
+  }
+
+  /**
+   * Sets the element at the specified index, or sets the content if called with one argument.
+   */
+  set(indexOrContent, value) {
+    if (typeof indexOrContent === 'number' && value !== undefined) {
+      this._content[indexOrContent] = this.refract(value);
+    } else {
+      // Delegate to parent set behavior
+      this.content = indexOrContent;
+    }
+    return this;
+  }
+
+  /**
+   * Removes the element at the specified index.
+   */
+  remove(index) {
+    return this._content.splice(index, 1)[0] ?? null;
+  }
+
+  /**
+   * Maps each element using the provided callback function.
+   */
+  map(callback, thisArg) {
+    return this._content.map(callback, thisArg);
+  }
+
+  /**
+   * Maps and then flattens the results.
+   */
+  flatMap(callback, thisArg) {
+    return this._content.flatMap(callback, thisArg);
+  }
+
+  /**
+   * Returns an array containing the truthy results of calling the given transformation.
+   */
+  compactMap(transform, thisArg) {
+    const results = [];
+    for (const element of this._content) {
+      const result = transform.call(thisArg, element);
+      if (result) {
+        results.push(result);
+      }
+    }
+    return results;
+  }
+
+  /**
+   * Filters elements using the provided callback.
+   */
+  filter(callback, thisArg) {
+    const filtered = this._content.filter(callback, thisArg);
+    return new this.constructor(filtered);
+  }
+
+  /**
+   * Rejects elements that match the provided callback.
+   */
+  reject(callback, thisArg) {
+    const results = [];
+    for (const element of this._content) {
+      if (!callback.call(thisArg, element)) {
+        results.push(element);
+      }
+    }
+    return new this.constructor(results);
+  }
+
+  /**
+   * Reduces the array to a single value.
+   * This is a reduce function specifically for datamodel arrays and objects.
+   * It allows for returning normal values or datamodel instances.
+   */
+  reduce(callback, initialValue) {
+    let startIndex;
+    let memo;
+
+    // Allows for defining a starting value of the reduce
+    if (initialValue !== undefined) {
+      startIndex = 0;
+      memo = this.refract(initialValue);
+    } else {
+      startIndex = 1;
+      memo = this.first;
+    }
+
+    // Sending each function call to the registry allows for passing datamodel
+    // instances through the function return.
+    for (let i = startIndex; i < this.length; i += 1) {
+      const item = this._content[i];
+      const result = callback(memo, item, i, this);
+      memo = result === undefined ? result : this.refract(result);
+    }
+    return memo;
+  }
+
+  /**
+   * Executes a provided function once for each element.
+   */
+  forEach(callback, thisArg) {
+    this._content.forEach((item, index) => {
+      callback.call(thisArg, item, index);
+    });
+  }
+
+  /**
+   * Returns an empty array element.
+   */
+  empty() {
+    return new this.constructor([]);
+  }
+}
+var _default = exports.default = ArrayElement;