@speclynx/apidom-datamodel 1.12.2

package/src/primitives/ObjectElement.cjs

@@ -0,0 +1,222 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _CollectionElement = _interopRequireDefault(require("./CollectionElement.cjs"));
+var _MemberElement = _interopRequireDefault(require("./MemberElement.cjs"));
+var _ObjectSlice = _interopRequireDefault(require("../ObjectSlice.cjs"));
+/**
+ * Callback type for ObjectElement iteration methods.
+ * @public
+ */
+
+/**
+ * ObjectElement represents an object/dictionary of key-value pairs in ApiDOM.
+ *
+ * @typeParam K - The key element type, defaults to Element
+ * @typeParam V - The value element type, defaults to Element
+ * @public
+ */
+class ObjectElement extends _CollectionElement.default {
+  constructor(content, meta, attributes) {
+    super(content || [], meta, attributes);
+    this.element = 'object';
+  }
+  primitive() {
+    return 'object';
+  }
+  toValue() {
+    return this._content.reduce((results, el) => {
+      results[el.key.toValue()] = el.value ? el.value.toValue() : undefined;
+      return results;
+    }, {});
+  }
+
+  /**
+   * Gets the value element for the given key.
+   */
+  get(name) {
+    const member = this.getMember(name);
+    if (member) {
+      return member.value;
+    }
+    return undefined;
+  }
+
+  /**
+   * Helper for returning the value of an item by key.
+   */
+  getValue(name) {
+    const item = this.get(name);
+    if (item) {
+      return item.toValue();
+    }
+    return undefined;
+  }
+
+  /**
+   * Gets the member element for the given key.
+   */
+  getMember(name) {
+    if (name === undefined) {
+      return undefined;
+    }
+    return this._content.find(element => element.key.toValue() === name);
+  }
+
+  /**
+   * Removes the member with the given key.
+   */
+  remove(name) {
+    let removed = null;
+    this.content = this._content.filter(item => {
+      if (item.key.toValue() === name) {
+        removed = item;
+        return false;
+      }
+      return true;
+    });
+    return removed;
+  }
+
+  /**
+   * Gets the key element for the given key name.
+   */
+  getKey(name) {
+    const member = this.getMember(name);
+    if (member) {
+      return member.key;
+    }
+    return undefined;
+  }
+
+  /**
+   * Set allows either a key/value pair to be given or an object.
+   * If an object is given, each key is set to its respective value.
+   */
+  set(keyOrObject, value) {
+    if (typeof keyOrObject === 'string') {
+      const member = this.getMember(keyOrObject);
+      if (member) {
+        member.value = value;
+      } else {
+        this._content.push(new _MemberElement.default(keyOrObject, value));
+      }
+    } else if (typeof keyOrObject === 'object' && !Array.isArray(keyOrObject)) {
+      for (const objectKey of Object.keys(keyOrObject)) {
+        this.set(objectKey, keyOrObject[objectKey]);
+      }
+    }
+    return this;
+  }
+
+  /**
+   * Returns an array of all keys' values.
+   */
+  keys() {
+    return this._content.map(item => item.key.toValue());
+  }
+
+  /**
+   * Returns an array of all values' values.
+   */
+  values() {
+    return this._content.map(item => item.value.toValue());
+  }
+
+  /**
+   * Returns whether the object has the given key.
+   */
+  hasKey(value) {
+    return this._content.some(member => member.key.equals(value));
+  }
+
+  /**
+   * Returns an array of [key, value] pairs.
+   */
+  items() {
+    return this._content.map(item => [item.key.toValue(), item.value.toValue()]);
+  }
+
+  /**
+   * Maps over the member elements, calling callback with (value, key, member).
+   */
+  map(callback, thisArg) {
+    return this._content.map(item => callback.call(thisArg, item.value, item.key, item));
+  }
+
+  /**
+   * Returns an array containing the truthy results of calling the given transformation.
+   */
+  compactMap(callback, thisArg) {
+    const results = [];
+    this.forEach((value, key, member) => {
+      const result = callback.call(thisArg, value, key, member);
+      if (result) {
+        results.push(result);
+      }
+    });
+    return results;
+  }
+
+  /**
+   * Filters member elements using the provided callback.
+   */
+  filter(callback, thisArg) {
+    return new _ObjectSlice.default(this._content).filter(callback, thisArg);
+  }
+
+  /**
+   * Rejects member elements that match the provided callback.
+   */
+  reject(callback, thisArg) {
+    const results = [];
+    for (const member of this._content) {
+      if (!callback.call(thisArg, member.value, member.key, member)) {
+        results.push(member);
+      }
+    }
+    return new _ObjectSlice.default(results);
+  }
+
+  /**
+   * Executes a provided function once for each member element.
+   */
+  forEach(callback, thisArg) {
+    this._content.forEach(item => callback.call(thisArg, item.value, item.key, item));
+  }
+
+  /**
+   * Reduces the object to a single value.
+   * Callback receives (memo, value, key, member, obj).
+   */
+  reduce(callback, initialValue) {
+    let startIndex;
+    let memo;
+    if (initialValue !== undefined) {
+      startIndex = 0;
+      memo = this.refract(initialValue);
+    } else {
+      startIndex = 1;
+      // For objects, memo starts as the first member's value
+      memo = this._content[0]?.value;
+    }
+    for (let i = startIndex; i < this._content.length; i += 1) {
+      const member = this._content[i];
+      const result = callback(memo, member.value, member.key, member, this);
+      memo = result === undefined ? result : this.refract(result);
+    }
+    return memo;
+  }
+
+  // Fantasy Land
+
+  /**
+   * Returns an empty object element.
+   */
+  empty() {
+    return new this.constructor([]);
+  }
+}
+var _default = exports.default = ObjectElement;

package/src/primitives/ObjectElement.mjs

@@ -0,0 +1,216 @@
+import CollectionElement from "./CollectionElement.mjs";
+import MemberElement from "./MemberElement.mjs";
+import ObjectSlice from "../ObjectSlice.mjs";
+/**
+ * Callback type for ObjectElement iteration methods.
+ * @public
+ */
+/**
+ * ObjectElement represents an object/dictionary of key-value pairs in ApiDOM.
+ *
+ * @typeParam K - The key element type, defaults to Element
+ * @typeParam V - The value element type, defaults to Element
+ * @public
+ */
+class ObjectElement extends CollectionElement {
+  constructor(content, meta, attributes) {
+    super(content || [], meta, attributes);
+    this.element = 'object';
+  }
+  primitive() {
+    return 'object';
+  }
+  toValue() {
+    return this._content.reduce((results, el) => {
+      results[el.key.toValue()] = el.value ? el.value.toValue() : undefined;
+      return results;
+    }, {});
+  }
+
+  /**
+   * Gets the value element for the given key.
+   */
+  get(name) {
+    const member = this.getMember(name);
+    if (member) {
+      return member.value;
+    }
+    return undefined;
+  }
+
+  /**
+   * Helper for returning the value of an item by key.
+   */
+  getValue(name) {
+    const item = this.get(name);
+    if (item) {
+      return item.toValue();
+    }
+    return undefined;
+  }
+
+  /**
+   * Gets the member element for the given key.
+   */
+  getMember(name) {
+    if (name === undefined) {
+      return undefined;
+    }
+    return this._content.find(element => element.key.toValue() === name);
+  }
+
+  /**
+   * Removes the member with the given key.
+   */
+  remove(name) {
+    let removed = null;
+    this.content = this._content.filter(item => {
+      if (item.key.toValue() === name) {
+        removed = item;
+        return false;
+      }
+      return true;
+    });
+    return removed;
+  }
+
+  /**
+   * Gets the key element for the given key name.
+   */
+  getKey(name) {
+    const member = this.getMember(name);
+    if (member) {
+      return member.key;
+    }
+    return undefined;
+  }
+
+  /**
+   * Set allows either a key/value pair to be given or an object.
+   * If an object is given, each key is set to its respective value.
+   */
+  set(keyOrObject, value) {
+    if (typeof keyOrObject === 'string') {
+      const member = this.getMember(keyOrObject);
+      if (member) {
+        member.value = value;
+      } else {
+        this._content.push(new MemberElement(keyOrObject, value));
+      }
+    } else if (typeof keyOrObject === 'object' && !Array.isArray(keyOrObject)) {
+      for (const objectKey of Object.keys(keyOrObject)) {
+        this.set(objectKey, keyOrObject[objectKey]);
+      }
+    }
+    return this;
+  }
+
+  /**
+   * Returns an array of all keys' values.
+   */
+  keys() {
+    return this._content.map(item => item.key.toValue());
+  }
+
+  /**
+   * Returns an array of all values' values.
+   */
+  values() {
+    return this._content.map(item => item.value.toValue());
+  }
+
+  /**
+   * Returns whether the object has the given key.
+   */
+  hasKey(value) {
+    return this._content.some(member => member.key.equals(value));
+  }
+
+  /**
+   * Returns an array of [key, value] pairs.
+   */
+  items() {
+    return this._content.map(item => [item.key.toValue(), item.value.toValue()]);
+  }
+
+  /**
+   * Maps over the member elements, calling callback with (value, key, member).
+   */
+  map(callback, thisArg) {
+    return this._content.map(item => callback.call(thisArg, item.value, item.key, item));
+  }
+
+  /**
+   * Returns an array containing the truthy results of calling the given transformation.
+   */
+  compactMap(callback, thisArg) {
+    const results = [];
+    this.forEach((value, key, member) => {
+      const result = callback.call(thisArg, value, key, member);
+      if (result) {
+        results.push(result);
+      }
+    });
+    return results;
+  }
+
+  /**
+   * Filters member elements using the provided callback.
+   */
+  filter(callback, thisArg) {
+    return new ObjectSlice(this._content).filter(callback, thisArg);
+  }
+
+  /**
+   * Rejects member elements that match the provided callback.
+   */
+  reject(callback, thisArg) {
+    const results = [];
+    for (const member of this._content) {
+      if (!callback.call(thisArg, member.value, member.key, member)) {
+        results.push(member);
+      }
+    }
+    return new ObjectSlice(results);
+  }
+
+  /**
+   * Executes a provided function once for each member element.
+   */
+  forEach(callback, thisArg) {
+    this._content.forEach(item => callback.call(thisArg, item.value, item.key, item));
+  }
+
+  /**
+   * Reduces the object to a single value.
+   * Callback receives (memo, value, key, member, obj).
+   */
+  reduce(callback, initialValue) {
+    let startIndex;
+    let memo;
+    if (initialValue !== undefined) {
+      startIndex = 0;
+      memo = this.refract(initialValue);
+    } else {
+      startIndex = 1;
+      // For objects, memo starts as the first member's value
+      memo = this._content[0]?.value;
+    }
+    for (let i = startIndex; i < this._content.length; i += 1) {
+      const member = this._content[i];
+      const result = callback(memo, member.value, member.key, member, this);
+      memo = result === undefined ? result : this.refract(result);
+    }
+    return memo;
+  }
+
+  // Fantasy Land
+
+  /**
+   * Returns an empty object element.
+   */
+  empty() {
+    return new this.constructor([]);
+  }
+}
+export default ObjectElement;

package/src/primitives/StringElement.cjs

@@ -0,0 +1,27 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _Element = _interopRequireDefault(require("./Element.cjs"));
+/**
+ * StringElement represents a string value in ApiDOM.
+ * @public
+ */
+class StringElement extends _Element.default {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'string';
+  }
+  primitive() {
+    return 'string';
+  }
+
+  /**
+   * The length of the string.
+   */
+  get length() {
+    return this.content?.length ?? 0;
+  }
+}
+var _default = exports.default = StringElement;

package/src/primitives/StringElement.mjs

@@ -0,0 +1,22 @@
+import Element from "./Element.mjs";
+/**
+ * StringElement represents a string value in ApiDOM.
+ * @public
+ */
+class StringElement extends Element {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'string';
+  }
+  primitive() {
+    return 'string';
+  }
+
+  /**
+   * The length of the string.
+   */
+  get length() {
+    return this.content?.length ?? 0;
+  }
+}
+export default StringElement;

package/src/registration.cjs

@@ -0,0 +1,87 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.refract = refract;
+var _Element = _interopRequireDefault(require("./primitives/Element.cjs"));
+exports.Element = _Element.default;
+var _CollectionElement = _interopRequireDefault(require("./primitives/CollectionElement.cjs"));
+exports.CollectionElement = _CollectionElement.default;
+var _NullElement = _interopRequireDefault(require("./primitives/NullElement.cjs"));
+exports.NullElement = _NullElement.default;
+var _StringElement = _interopRequireDefault(require("./primitives/StringElement.cjs"));
+exports.StringElement = _StringElement.default;
+var _NumberElement = _interopRequireDefault(require("./primitives/NumberElement.cjs"));
+exports.NumberElement = _NumberElement.default;
+var _BooleanElement = _interopRequireDefault(require("./primitives/BooleanElement.cjs"));
+exports.BooleanElement = _BooleanElement.default;
+var _ArrayElement = _interopRequireDefault(require("./primitives/ArrayElement.cjs"));
+exports.ArrayElement = _ArrayElement.default;
+var _MemberElement = _interopRequireDefault(require("./primitives/MemberElement.cjs"));
+exports.MemberElement = _MemberElement.default;
+var _ObjectElement = _interopRequireDefault(require("./primitives/ObjectElement.cjs"));
+exports.ObjectElement = _ObjectElement.default;
+var _LinkElement = _interopRequireDefault(require("./elements/LinkElement.cjs"));
+exports.LinkElement = _LinkElement.default;
+var _RefElement = _interopRequireDefault(require("./elements/RefElement.cjs"));
+exports.RefElement = _RefElement.default;
+var _ObjectSlice = _interopRequireDefault(require("./ObjectSlice.cjs"));
+exports.ObjectSlice = _ObjectSlice.default;
+var _KeyValuePair = _interopRequireDefault(require("./KeyValuePair.cjs"));
+exports.KeyValuePair = _KeyValuePair.default;
+/**
+ * Refracts an array item to ApiDOM element.
+ * Converts undefined to NullElement (aligned with JSON.stringify behavior).
+ */
+function refractArrayItem(value) {
+  if (value === undefined) {
+    return new _NullElement.default();
+  }
+  return refract(value);
+}
+
+/**
+ * Refracts a JSON type to ApiDOM elements.
+ * @public
+ */
+function refract(value) {
+  if (value instanceof _Element.default) {
+    return value;
+  }
+  if (typeof value === 'string') {
+    return new _StringElement.default(value);
+  }
+  if (typeof value === 'number') {
+    return new _NumberElement.default(value);
+  }
+  if (typeof value === 'boolean') {
+    return new _BooleanElement.default(value);
+  }
+  if (value === null) {
+    return new _NullElement.default();
+  }
+  if (Array.isArray(value)) {
+    return new _ArrayElement.default(value.map(refractArrayItem));
+  }
+  if (typeof value === 'object') {
+    return new _ObjectElement.default(value);
+  }
+  throw new Error(`Cannot refract value of type ${typeof value}`);
+}
+
+// Set up prototype assignments for circular dependency resolution.
+// These allow Element instances to create ObjectElement, MemberElement, RefElement
+// without importing them directly (which would cause circular imports).
+// Using 'declare' in the class definitions enables type-safe access to these properties.
+_Element.default.prototype.ObjectElement = _ObjectElement.default;
+_Element.default.prototype.ArrayElement = _ArrayElement.default;
+_Element.default.prototype.RefElement = _RefElement.default;
+_Element.default.prototype.MemberElement = _MemberElement.default;
+_Element.default.prototype.refract = refract;
+
+/**
+ * Contains all of the element classes, and related structures and methods
+ * for handling with element instances.
+ */
+
+// Re-export types from element classes

package/src/registration.mjs

@@ -0,0 +1,70 @@
+import Element from "./primitives/Element.mjs";
+import CollectionElement from "./primitives/CollectionElement.mjs";
+import NullElement from "./primitives/NullElement.mjs";
+import StringElement from "./primitives/StringElement.mjs";
+import NumberElement from "./primitives/NumberElement.mjs";
+import BooleanElement from "./primitives/BooleanElement.mjs";
+import ArrayElement from "./primitives/ArrayElement.mjs";
+import MemberElement from "./primitives/MemberElement.mjs";
+import ObjectElement from "./primitives/ObjectElement.mjs";
+import LinkElement from "./elements/LinkElement.mjs";
+import RefElement from "./elements/RefElement.mjs";
+import ObjectSlice from "./ObjectSlice.mjs";
+import KeyValuePair from "./KeyValuePair.mjs";
+/**
+ * Refracts an array item to ApiDOM element.
+ * Converts undefined to NullElement (aligned with JSON.stringify behavior).
+ */
+function refractArrayItem(value) {
+  if (value === undefined) {
+    return new NullElement();
+  }
+  return refract(value);
+}
+
+/**
+ * Refracts a JSON type to ApiDOM elements.
+ * @public
+ */
+function refract(value) {
+  if (value instanceof Element) {
+    return value;
+  }
+  if (typeof value === 'string') {
+    return new StringElement(value);
+  }
+  if (typeof value === 'number') {
+    return new NumberElement(value);
+  }
+  if (typeof value === 'boolean') {
+    return new BooleanElement(value);
+  }
+  if (value === null) {
+    return new NullElement();
+  }
+  if (Array.isArray(value)) {
+    return new ArrayElement(value.map(refractArrayItem));
+  }
+  if (typeof value === 'object') {
+    return new ObjectElement(value);
+  }
+  throw new Error(`Cannot refract value of type ${typeof value}`);
+}
+
+// Set up prototype assignments for circular dependency resolution.
+// These allow Element instances to create ObjectElement, MemberElement, RefElement
+// without importing them directly (which would cause circular imports).
+// Using 'declare' in the class definitions enables type-safe access to these properties.
+Element.prototype.ObjectElement = ObjectElement;
+Element.prototype.ArrayElement = ArrayElement;
+Element.prototype.RefElement = RefElement;
+Element.prototype.MemberElement = MemberElement;
+Element.prototype.refract = refract;
+
+/**
+ * Contains all of the element classes, and related structures and methods
+ * for handling with element instances.
+ */
+export { Element, CollectionElement, NullElement, StringElement, NumberElement, BooleanElement, ArrayElement, MemberElement, ObjectElement, LinkElement, RefElement, refract, ObjectSlice, KeyValuePair };
+
+// Re-export types from element classes