@speclynx/apidom-datamodel 1.12.2 → 2.0.0

package/src/index.mjs

@@ -1,6 +1,10 @@
 export { default as Namespace } from "./Namespace.mjs";
-export { default as KeyValuePair } from "./KeyValuePair.mjs"; // Re-export elements directly to preserve JSDoc
-export { ObjectSlice, Element, CollectionElement, StringElement, NumberElement, BooleanElement, NullElement, ArrayElement, ObjectElement, MemberElement, RefElement, LinkElement, refract } from "./registration.mjs";
+export { default as KeyValuePair } from "./KeyValuePair.mjs"; // Clone utilities
+export { cloneShallow, cloneDeep, CloneError, DeepCloneError, ShallowCloneError } from "./clone/index.mjs";
+// Re-export elements directly to preserve JSDoc
+export { ObjectSlice, Element, CollectionElement, StringElement, NumberElement, BooleanElement, NullElement, ArrayElement, ObjectElement, MemberElement, RefElement, LinkElement, AnnotationElement, CommentElement, ParseResultElement, SourceMapElement, refract } from "./registration.mjs";
 export { default as JSONSerialiser } from "./serialisers/JSONSerialiser.mjs"; // Re-export types - essential public API
 // Re-export types - for advanced users extending the library
-// Re-export types - used in public method signatures
+// Re-export types - used in public method signatures
+// Re-export predicates
+export { isElement, isStringElement, isNumberElement, isNullElement, isBooleanElement, isObjectElement, isArrayElement, isMemberElement, isLinkElement, isRefElement, isAnnotationElement, isCommentElement, isParseResultElement, isSourceMapElement, isPrimitiveElement, hasElementSourceMap, includesSymbols, includesClasses } from "./predicates/index.mjs";

package/src/predicates/elements.cjs

@@ -0,0 +1,46 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.isSourceMapElement = exports.isRefElement = exports.isParseResultElement = exports.isLinkElement = exports.isCommentElement = exports.isAnnotationElement = void 0;
+var _LinkElement = _interopRequireDefault(require("../elements/LinkElement.cjs"));
+var _RefElement = _interopRequireDefault(require("../elements/RefElement.cjs"));
+var _Annotation = _interopRequireDefault(require("../elements/Annotation.cjs"));
+var _Comment = _interopRequireDefault(require("../elements/Comment.cjs"));
+var _ParseResult = _interopRequireDefault(require("../elements/ParseResult.cjs"));
+var _SourceMap = _interopRequireDefault(require("../elements/SourceMap.cjs"));
+/**
+ * @public
+ */
+const isLinkElement = element => element instanceof _LinkElement.default;
+
+/**
+ * @public
+ */
+exports.isLinkElement = isLinkElement;
+const isRefElement = element => element instanceof _RefElement.default;
+
+/**
+ * @public
+ */
+exports.isRefElement = isRefElement;
+const isAnnotationElement = element => element instanceof _Annotation.default;
+
+/**
+ * @public
+ */
+exports.isAnnotationElement = isAnnotationElement;
+const isCommentElement = element => element instanceof _Comment.default;
+
+/**
+ * @public
+ */
+exports.isCommentElement = isCommentElement;
+const isParseResultElement = element => element instanceof _ParseResult.default;
+
+/**
+ * @public
+ */
+exports.isParseResultElement = isParseResultElement;
+const isSourceMapElement = element => element instanceof _SourceMap.default;
+exports.isSourceMapElement = isSourceMapElement;

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/index.cjs

@@ -0,0 +1,68 @@
+"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.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 complete source position information.
+ * Returns true only if all 6 position properties are numbers.
+ * @public
+ */
+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,48 @@
+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 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/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/primitives/ArrayElement.cjs

@@ -13,13 +13,6 @@ var _CollectionElement = _interopRequireDefault(require("./CollectionElement.cjs
  * @public
  */
 class ArrayElement extends _CollectionElement.default {
-  // Static Fantasy Land methods
-  static empty() {
-    return new this();
-  }
-  static 'fantasy-land/empty'() {
-    return ArrayElement.empty();
-  }
   constructor(content, meta, attributes) {
     super(content || [], meta, attributes);
     this.element = 'array';
@@ -152,25 +145,11 @@ class ArrayElement extends _CollectionElement.default {
     });
   }
 
-  // Fantasy Land
-
   /**
    * Returns an empty array element.
    */
   empty() {
     return new this.constructor([]);
   }
-  'fantasy-land/map'(transform) {
-    return new this.constructor(this.map(transform));
-  }
-  'fantasy-land/chain'(transform) {
-    return this.map(element => transform(element)).reduce((a, b) => a.concat(b), this.empty());
-  }
-  'fantasy-land/filter'(callback) {
-    return new this.constructor(this._content.filter(callback));
-  }
-  'fantasy-land/reduce'(transform, initialValue) {
-    return this._content.reduce(transform, initialValue);
-  }
 }
 var _default = exports.default = ArrayElement;

package/src/primitives/ArrayElement.mjs

@@ -6,13 +6,6 @@ import CollectionElement from "./CollectionElement.mjs"; // Re-export types from
  * @public
  */
 class ArrayElement extends CollectionElement {
-  // Static Fantasy Land methods
-  static empty() {
-    return new this();
-  }
-  static 'fantasy-land/empty'() {
-    return ArrayElement.empty();
-  }
   constructor(content, meta, attributes) {
     super(content || [], meta, attributes);
     this.element = 'array';
@@ -145,25 +138,11 @@ class ArrayElement extends CollectionElement {
     });
   }
 
-  // Fantasy Land
-
   /**
    * Returns an empty array element.
    */
   empty() {
     return new this.constructor([]);
   }
-  'fantasy-land/map'(transform) {
-    return new this.constructor(this.map(transform));
-  }
-  'fantasy-land/chain'(transform) {
-    return this.map(element => transform(element)).reduce((a, b) => a.concat(b), this.empty());
-  }
-  'fantasy-land/filter'(callback) {
-    return new this.constructor(this._content.filter(callback));
-  }
-  'fantasy-land/reduce'(transform, initialValue) {
-    return this._content.reduce(transform, initialValue);
-  }
 }
 export default ArrayElement;

package/src/primitives/CollectionElement.cjs

@@ -69,20 +69,15 @@ class CollectionElement extends _Element.default {
   }
 
   /**
-   * Adds the given element to the end of the collection.
+   * Adds the given elements to the end of the collection.
    */
-  push(value) {
-    this._content.push(this.refract(value));
+  push(...values) {
+    for (const value of values) {
+      this._content.push(this.refract(value));
+    }
     return this;
   }
 
-  /**
-   * Alias for push.
-   */
-  add(value) {
-    this.push(value);
-  }
-
   /**
    * Removes the first element from the collection.
    */
@@ -165,16 +160,10 @@ class CollectionElement extends _Element.default {
     return this.find(item => item.id.toValue() === id).first;
   }
 
-  // Fantasy Land - Monoid
-
   /**
    * Returns an empty collection element.
    */
 
-  'fantasy-land/empty'() {
-    return this.empty();
-  }
-
   /**
    * Concatenates two collection elements.
    */
@@ -182,9 +171,6 @@ class CollectionElement extends _Element.default {
     const Ctor = this.constructor;
     return new Ctor(this._content.concat(other._content));
   }
-  'fantasy-land/concat'(other) {
-    return this.concat(other);
-  }
 
   // Iterator support
   [Symbol.iterator]() {

package/src/primitives/CollectionElement.mjs

@@ -62,20 +62,15 @@ class CollectionElement extends Element {
   }
 
   /**
-   * Adds the given element to the end of the collection.
+   * Adds the given elements to the end of the collection.
    */
-  push(value) {
-    this._content.push(this.refract(value));
+  push(...values) {
+    for (const value of values) {
+      this._content.push(this.refract(value));
+    }
     return this;
   }
 
-  /**
-   * Alias for push.
-   */
-  add(value) {
-    this.push(value);
-  }
-
   /**
    * Removes the first element from the collection.
    */
@@ -158,16 +153,10 @@ class CollectionElement extends Element {
     return this.find(item => item.id.toValue() === id).first;
   }
 
-  // Fantasy Land - Monoid
-
   /**
    * Returns an empty collection element.
    */
 
-  'fantasy-land/empty'() {
-    return this.empty();
-  }
-
   /**
    * Concatenates two collection elements.
    */
@@ -175,9 +164,6 @@ class CollectionElement extends Element {
     const Ctor = this.constructor;
     return new Ctor(this._content.concat(other._content));
   }
-  'fantasy-land/concat'(other) {
-    return this.concat(other);
-  }
 
   // Iterator support
   [Symbol.iterator]() {