@speclynx/apidom-datamodel 1.12.2

package/src/ObjectSlice.cjs

@@ -0,0 +1,206 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+/**
+ * Callback type for ObjectSlice iteration methods.
+ * Receives (value, key, member) - the standard pattern for object-like iteration.
+ * @public
+ */
+
+/**
+ * Callback type for ObjectSlice forEach that also receives the index.
+ * @public
+ */
+
+/**
+ * ObjectSlice is a collection wrapper for MemberElement arrays.
+ * It provides functional methods with (value, key, member) callback signatures,
+ * which is the standard pattern for iterating over object-like structures.
+ *
+ * Unlike ArraySlice, ObjectSlice uses composition rather than inheritance
+ * because its callback signatures are fundamentally different.
+ *
+ * @public
+ */
+class ObjectSlice {
+  elements;
+  constructor(elements) {
+    this.elements = elements ?? [];
+  }
+
+  /**
+   * Converts all member elements to their JavaScript values.
+   * Returns an array of \{ key, value \} objects.
+   */
+  toValue() {
+    return this.elements.map(member => ({
+      key: member.key?.toValue(),
+      value: member.value?.toValue()
+    }));
+  }
+
+  /**
+   * Maps over the member elements, calling callback with (value, key, member).
+   * @param callback - Function to execute for each member
+   * @param thisArg - Value to use as this when executing callback
+   */
+  map(callback, thisArg) {
+    return this.elements.map(member => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        throw new Error('MemberElement must have both key and value');
+      }
+      return thisArg !== undefined ? callback.call(thisArg, value, key, member) : callback(value, key, member);
+    });
+  }
+
+  /**
+   * Filters member elements using the provided callback.
+   * @param callback - Function that receives (value, key, member) and returns boolean
+   * @param thisArg - Value to use as this when executing callback
+   */
+  filter(callback, thisArg) {
+    const filtered = this.elements.filter(member => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        return false; // Skip malformed members
+      }
+      return thisArg !== undefined ? callback.call(thisArg, value, key, member) : callback(value, key, member);
+    });
+    return new ObjectSlice(filtered);
+  }
+
+  /**
+   * Rejects member elements that match the provided callback.
+   * @param callback - Function that receives (value, key, member) and returns boolean
+   * @param thisArg - Value to use as this when executing callback
+   */
+  reject(callback, thisArg) {
+    const results = [];
+    for (const member of this.elements) {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        continue;
+      }
+      if (!callback.call(thisArg, value, key, member)) {
+        results.push(member);
+      }
+    }
+    return new ObjectSlice(results);
+  }
+
+  /**
+   * Executes a provided function once for each member element.
+   * @param callback - Function that receives (value, key, member, index)
+   * @param thisArg - Value to use as this when executing callback
+   */
+  forEach(callback, thisArg) {
+    this.elements.forEach((member, index) => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        return; // Skip malformed members
+      }
+      if (thisArg !== undefined) {
+        callback.call(thisArg, value, key, member, index);
+      } else {
+        callback(value, key, member, index);
+      }
+    });
+  }
+
+  /**
+   * Returns the first member element that satisfies the callback.
+   * @param callback - Function that receives (value, key, member) and returns boolean
+   * @param thisArg - Value to use as this when executing callback
+   */
+  find(callback, thisArg) {
+    return this.elements.find(member => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        return false;
+      }
+      return thisArg !== undefined ? callback.call(thisArg, value, key, member) : callback(value, key, member);
+    });
+  }
+
+  /**
+   * Returns an array of all keys' values.
+   */
+  keys() {
+    return this.elements.map(member => member.key?.toValue()).filter(key => key !== undefined);
+  }
+
+  /**
+   * Returns an array of all values' values.
+   */
+  values() {
+    return this.elements.map(member => member.value?.toValue()).filter(value => value !== undefined);
+  }
+
+  /**
+   * Returns the number of elements in the slice.
+   */
+  get length() {
+    return this.elements.length;
+  }
+
+  /**
+   * Returns whether the slice is empty.
+   */
+  get isEmpty() {
+    return this.length === 0;
+  }
+
+  /**
+   * Returns the first element in the slice or undefined if empty.
+   */
+  get first() {
+    return this.elements[0];
+  }
+
+  /**
+   * Gets the element at the specified index.
+   * @param index - The index of the element to get
+   */
+  get(index) {
+    return this.elements[index];
+  }
+
+  /**
+   * Adds the given member element to the end of the slice.
+   * @param member - The member element to add
+   */
+  push(member) {
+    this.elements.push(member);
+    return this;
+  }
+
+  /**
+   * Creates a deep clone of the ObjectSlice.
+   */
+  clone() {
+    return new ObjectSlice(this.elements.map(element => element.clone()));
+  }
+
+  /**
+   * Determines whether the slice includes a member with the given key value.
+   * @param keyValue - The key value to search for
+   */
+  includesKey(keyValue) {
+    return this.elements.some(member => member.key?.equals(keyValue));
+  }
+
+  /**
+   * Iterator support - allows for...of loops.
+   */
+  [Symbol.iterator]() {
+    return this.elements[Symbol.iterator]();
+  }
+}
+var _default = exports.default = ObjectSlice;

package/src/ObjectSlice.mjs

@@ -0,0 +1,202 @@
+/**
+ * Callback type for ObjectSlice iteration methods.
+ * Receives (value, key, member) - the standard pattern for object-like iteration.
+ * @public
+ */
+
+/**
+ * Callback type for ObjectSlice forEach that also receives the index.
+ * @public
+ */
+
+/**
+ * ObjectSlice is a collection wrapper for MemberElement arrays.
+ * It provides functional methods with (value, key, member) callback signatures,
+ * which is the standard pattern for iterating over object-like structures.
+ *
+ * Unlike ArraySlice, ObjectSlice uses composition rather than inheritance
+ * because its callback signatures are fundamentally different.
+ *
+ * @public
+ */
+class ObjectSlice {
+  elements;
+  constructor(elements) {
+    this.elements = elements ?? [];
+  }
+
+  /**
+   * Converts all member elements to their JavaScript values.
+   * Returns an array of \{ key, value \} objects.
+   */
+  toValue() {
+    return this.elements.map(member => ({
+      key: member.key?.toValue(),
+      value: member.value?.toValue()
+    }));
+  }
+
+  /**
+   * Maps over the member elements, calling callback with (value, key, member).
+   * @param callback - Function to execute for each member
+   * @param thisArg - Value to use as this when executing callback
+   */
+  map(callback, thisArg) {
+    return this.elements.map(member => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        throw new Error('MemberElement must have both key and value');
+      }
+      return thisArg !== undefined ? callback.call(thisArg, value, key, member) : callback(value, key, member);
+    });
+  }
+
+  /**
+   * Filters member elements using the provided callback.
+   * @param callback - Function that receives (value, key, member) and returns boolean
+   * @param thisArg - Value to use as this when executing callback
+   */
+  filter(callback, thisArg) {
+    const filtered = this.elements.filter(member => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        return false; // Skip malformed members
+      }
+      return thisArg !== undefined ? callback.call(thisArg, value, key, member) : callback(value, key, member);
+    });
+    return new ObjectSlice(filtered);
+  }
+
+  /**
+   * Rejects member elements that match the provided callback.
+   * @param callback - Function that receives (value, key, member) and returns boolean
+   * @param thisArg - Value to use as this when executing callback
+   */
+  reject(callback, thisArg) {
+    const results = [];
+    for (const member of this.elements) {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        continue;
+      }
+      if (!callback.call(thisArg, value, key, member)) {
+        results.push(member);
+      }
+    }
+    return new ObjectSlice(results);
+  }
+
+  /**
+   * Executes a provided function once for each member element.
+   * @param callback - Function that receives (value, key, member, index)
+   * @param thisArg - Value to use as this when executing callback
+   */
+  forEach(callback, thisArg) {
+    this.elements.forEach((member, index) => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        return; // Skip malformed members
+      }
+      if (thisArg !== undefined) {
+        callback.call(thisArg, value, key, member, index);
+      } else {
+        callback(value, key, member, index);
+      }
+    });
+  }
+
+  /**
+   * Returns the first member element that satisfies the callback.
+   * @param callback - Function that receives (value, key, member) and returns boolean
+   * @param thisArg - Value to use as this when executing callback
+   */
+  find(callback, thisArg) {
+    return this.elements.find(member => {
+      const value = member.value;
+      const key = member.key;
+      if (value === undefined || key === undefined) {
+        return false;
+      }
+      return thisArg !== undefined ? callback.call(thisArg, value, key, member) : callback(value, key, member);
+    });
+  }
+
+  /**
+   * Returns an array of all keys' values.
+   */
+  keys() {
+    return this.elements.map(member => member.key?.toValue()).filter(key => key !== undefined);
+  }
+
+  /**
+   * Returns an array of all values' values.
+   */
+  values() {
+    return this.elements.map(member => member.value?.toValue()).filter(value => value !== undefined);
+  }
+
+  /**
+   * Returns the number of elements in the slice.
+   */
+  get length() {
+    return this.elements.length;
+  }
+
+  /**
+   * Returns whether the slice is empty.
+   */
+  get isEmpty() {
+    return this.length === 0;
+  }
+
+  /**
+   * Returns the first element in the slice or undefined if empty.
+   */
+  get first() {
+    return this.elements[0];
+  }
+
+  /**
+   * Gets the element at the specified index.
+   * @param index - The index of the element to get
+   */
+  get(index) {
+    return this.elements[index];
+  }
+
+  /**
+   * Adds the given member element to the end of the slice.
+   * @param member - The member element to add
+   */
+  push(member) {
+    this.elements.push(member);
+    return this;
+  }
+
+  /**
+   * Creates a deep clone of the ObjectSlice.
+   */
+  clone() {
+    return new ObjectSlice(this.elements.map(element => element.clone()));
+  }
+
+  /**
+   * Determines whether the slice includes a member with the given key value.
+   * @param keyValue - The key value to search for
+   */
+  includesKey(keyValue) {
+    return this.elements.some(member => member.key?.equals(keyValue));
+  }
+
+  /**
+   * Iterator support - allows for...of loops.
+   */
+  [Symbol.iterator]() {
+    return this.elements[Symbol.iterator]();
+  }
+}
+export default ObjectSlice;

package/src/elements/LinkElement.cjs

@@ -0,0 +1,44 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _Element = _interopRequireDefault(require("../primitives/Element.cjs"));
+/**
+ * LinkElement represents a hyperlink in ApiDOM.
+ *
+ * Hyperlinking MAY be used to link to other resources, provide links to
+ * instructions on how to process a given element (by way of a profile or
+ * other means), and may be used to provide meta data about the element in
+ * which it's found. The meaning and purpose of the hyperlink is defined by
+ * the link relation according to RFC 5988.
+ *
+ * @public
+ */
+class LinkElement extends _Element.default {
+  constructor(content, meta, attributes) {
+    super(content || [], meta, attributes);
+    this.element = 'link';
+  }
+
+  /**
+   * The relation identifier for the link, as defined in RFC 5988.
+   */
+  get relation() {
+    return this.attributes.get('relation');
+  }
+  set relation(relation) {
+    this.attributes.set('relation', relation);
+  }
+
+  /**
+   * The URI for the given link.
+   */
+  get href() {
+    return this.attributes.get('href');
+  }
+  set href(href) {
+    this.attributes.set('href', href);
+  }
+}
+var _default = exports.default = LinkElement;

package/src/elements/LinkElement.mjs

@@ -0,0 +1,39 @@
+import Element from "../primitives/Element.mjs";
+/**
+ * LinkElement represents a hyperlink in ApiDOM.
+ *
+ * Hyperlinking MAY be used to link to other resources, provide links to
+ * instructions on how to process a given element (by way of a profile or
+ * other means), and may be used to provide meta data about the element in
+ * which it's found. The meaning and purpose of the hyperlink is defined by
+ * the link relation according to RFC 5988.
+ *
+ * @public
+ */
+class LinkElement extends Element {
+  constructor(content, meta, attributes) {
+    super(content || [], meta, attributes);
+    this.element = 'link';
+  }
+
+  /**
+   * The relation identifier for the link, as defined in RFC 5988.
+   */
+  get relation() {
+    return this.attributes.get('relation');
+  }
+  set relation(relation) {
+    this.attributes.set('relation', relation);
+  }
+
+  /**
+   * The URI for the given link.
+   */
+  get href() {
+    return this.attributes.get('href');
+  }
+  set href(href) {
+    this.attributes.set('href', href);
+  }
+}
+export default LinkElement;

package/src/elements/RefElement.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _Element = _interopRequireDefault(require("../primitives/Element.cjs"));
+/**
+ * RefElement represents a reference to another element in ApiDOM.
+ * @public
+ */
+class RefElement extends _Element.default {
+  constructor(content, meta, attributes) {
+    super(content || [], meta, attributes);
+    this.element = 'ref';
+    if (!this.path) {
+      this.path = 'element';
+    }
+  }
+
+  /**
+   * Path of referenced element to transclude instead of element itself.
+   * @defaultValue 'element'
+   */
+  get path() {
+    return this.attributes.get('path');
+  }
+  set path(newValue) {
+    this.attributes.set('path', newValue);
+  }
+}
+var _default = exports.default = RefElement;

package/src/elements/RefElement.mjs

@@ -0,0 +1,26 @@
+import Element from "../primitives/Element.mjs";
+/**
+ * RefElement represents a reference to another element in ApiDOM.
+ * @public
+ */
+class RefElement extends Element {
+  constructor(content, meta, attributes) {
+    super(content || [], meta, attributes);
+    this.element = 'ref';
+    if (!this.path) {
+      this.path = 'element';
+    }
+  }
+
+  /**
+   * Path of referenced element to transclude instead of element itself.
+   * @defaultValue 'element'
+   */
+  get path() {
+    return this.attributes.get('path');
+  }
+  set path(newValue) {
+    this.attributes.set('path', newValue);
+  }
+}
+export default RefElement;

package/src/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+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;
+var _Namespace = _interopRequireDefault(require("./Namespace.cjs"));
+exports.Namespace = _Namespace.default;
+var _KeyValuePair = _interopRequireDefault(require("./KeyValuePair.cjs"));
+exports.KeyValuePair = _KeyValuePair.default;
+var _registration = require("./registration.cjs");
+exports.ObjectSlice = _registration.ObjectSlice;
+exports.Element = _registration.Element;
+exports.CollectionElement = _registration.CollectionElement;
+exports.StringElement = _registration.StringElement;
+exports.NumberElement = _registration.NumberElement;
+exports.BooleanElement = _registration.BooleanElement;
+exports.NullElement = _registration.NullElement;
+exports.ArrayElement = _registration.ArrayElement;
+exports.ObjectElement = _registration.ObjectElement;
+exports.MemberElement = _registration.MemberElement;
+exports.RefElement = _registration.RefElement;
+exports.LinkElement = _registration.LinkElement;
+exports.refract = _registration.refract;
+var _JSONSerialiser = _interopRequireDefault(require("./serialisers/JSONSerialiser.cjs"));
+exports.JSONSerialiser = _JSONSerialiser.default;

package/src/index.mjs

@@ -0,0 +1,6 @@
+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 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