@speclynx/apidom-datamodel 4.0.1 → 4.0.3

package/src/primitives/MemberElement.ts

@@ -0,0 +1,61 @@
+import KeyValuePair from '../KeyValuePair.ts';
+import Element, { type Meta, type Attributes } from './Element.ts';
+
+/**
+ * MemberElement represents a key-value pair member in an ObjectElement.
+ *
+ * The member's content is always a KeyValuePair containing:
+ * - `key`: The key element (typically a StringElement)
+ * - `value`: The value element (any Element type)
+ *
+ * @typeParam K - The key element type, defaults to Element
+ * @typeParam V - The value element type, defaults to Element
+ * @public
+ */
+class MemberElement<K extends Element = Element, V extends Element = Element> extends Element {
+  declare protected _content: KeyValuePair;
+
+  constructor(key?: unknown, value?: unknown, meta?: Meta, attributes?: Attributes) {
+    super(new KeyValuePair(), meta, attributes);
+    this.element = 'member';
+
+    if (key !== undefined) {
+      this.key = key;
+    }
+
+    // Note: We check arguments.length to distinguish between:
+    // - new MemberElement('key') - value not provided, don't set
+    // - new MemberElement('key', undefined) - value explicitly undefined, set it
+    if (arguments.length >= 2) {
+      this.value = value;
+    }
+  }
+
+  primitive(): string {
+    return 'member';
+  }
+
+  /**
+   * The key element of this member.
+   */
+  get key(): K | undefined {
+    return this._content.key as K | undefined;
+  }
+
+  set key(value: unknown) {
+    this._content.key = this.refract(value);
+  }
+
+  /**
+   * The value element of this member.
+   */
+  get value(): V | undefined {
+    return this._content.value as V | undefined;
+  }
+
+  set value(value: unknown) {
+    this._content.value = value === undefined ? undefined : this.refract(value);
+  }
+}
+
+export default MemberElement;

package/src/primitives/NullElement.cjs

@@ -0,0 +1,28 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _Element = _interopRequireDefault(require("./Element.cjs"));
+/**
+ * NullElement represents a null value in ApiDOM.
+ * @public
+ */
+class NullElement extends _Element.default {
+  constructor(content, meta, attributes) {
+    super(content ?? null, meta, attributes);
+    this.element = 'null';
+  }
+  primitive() {
+    return 'null';
+  }
+
+  /**
+   * NullElement cannot have its value changed.
+   * @throws Error - NullElement value cannot be modified
+   */
+  set(_content) {
+    throw new Error('Cannot set the value of null');
+  }
+}
+var _default = exports.default = NullElement;

package/src/primitives/NullElement.mjs

@@ -0,0 +1,23 @@
+import Element from "./Element.mjs";
+/**
+ * NullElement represents a null value in ApiDOM.
+ * @public
+ */
+class NullElement extends Element {
+  constructor(content, meta, attributes) {
+    super(content ?? null, meta, attributes);
+    this.element = 'null';
+  }
+  primitive() {
+    return 'null';
+  }
+
+  /**
+   * NullElement cannot have its value changed.
+   * @throws Error - NullElement value cannot be modified
+   */
+  set(_content) {
+    throw new Error('Cannot set the value of null');
+  }
+}
+export default NullElement;

package/src/primitives/NullElement.ts

@@ -0,0 +1,26 @@
+import Element, { type Meta, type Attributes } from './Element.ts';
+
+/**
+ * NullElement represents a null value in ApiDOM.
+ * @public
+ */
+class NullElement extends Element {
+  constructor(content?: null, meta?: Meta, attributes?: Attributes) {
+    super(content ?? null, meta, attributes);
+    this.element = 'null';
+  }
+
+  primitive(): string {
+    return 'null';
+  }
+
+  /**
+   * NullElement cannot have its value changed.
+   * @throws Error - NullElement value cannot be modified
+   */
+  override set(_content?: unknown): this {
+    throw new Error('Cannot set the value of null');
+  }
+}
+
+export default NullElement;

package/src/primitives/NumberElement.cjs

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

package/src/primitives/NumberElement.mjs

@@ -0,0 +1,15 @@
+import Element from "./Element.mjs";
+/**
+ * NumberElement represents a numeric value in ApiDOM.
+ * @public
+ */
+class NumberElement extends Element {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'number';
+  }
+  primitive() {
+    return 'number';
+  }
+}
+export default NumberElement;

package/src/primitives/NumberElement.ts

@@ -0,0 +1,18 @@
+import Element, { type Meta, type Attributes } from './Element.ts';
+
+/**
+ * NumberElement represents a numeric value in ApiDOM.
+ * @public
+ */
+class NumberElement extends Element {
+  constructor(content?: number, meta?: Meta, attributes?: Attributes) {
+    super(content, meta, attributes);
+    this.element = 'number';
+  }
+
+  primitive(): string {
+    return 'number';
+  }
+}
+
+export default NumberElement;

package/src/primitives/ObjectElement.cjs

@@ -0,0 +1,220 @@
+"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;
+  }
+
+  /**
+   * Returns an empty object element.
+   */
+  empty() {
+    return new this.constructor([]);
+  }
+}
+var _default = exports.default = ObjectElement;

package/src/primitives/ObjectElement.mjs

@@ -0,0 +1,214 @@
+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;
+  }
+
+  /**
+   * Returns an empty object element.
+   */
+  empty() {
+    return new this.constructor([]);
+  }
+}
+export default ObjectElement;