@speclynx/apidom-datamodel 3.2.1 → 4.0.0

package/src/ObjectSlice.cjs

@@ -1,199 +0,0 @@
-"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;
-  }
-
-  /**
-   * 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

@@ -1,195 +0,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;
-  }
-
-  /**
-   * 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/clone/errors/CloneError.cjs

@@ -1,22 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomError = require("@speclynx/apidom-error");
-/**
- * @public
- */
-
-/**
- * @public
- */
-class CloneError extends _apidomError.ApiDOMStructuredError {
-  value;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.value = structuredOptions.value;
-    }
-  }
-}
-var _default = exports.default = CloneError;

package/src/clone/errors/CloneError.mjs

@@ -1,19 +0,0 @@
-import { ApiDOMStructuredError } from '@speclynx/apidom-error';
-
-/**
- * @public
- */
-
-/**
- * @public
- */
-class CloneError extends ApiDOMStructuredError {
-  value;
-  constructor(message, structuredOptions) {
-    super(message, structuredOptions);
-    if (typeof structuredOptions !== 'undefined') {
-      this.value = structuredOptions.value;
-    }
-  }
-}
-export default CloneError;

package/src/clone/errors/DeepCloneError.cjs

@@ -1,11 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _CloneError = _interopRequireDefault(require("./CloneError.cjs"));
-/**
- * @public
- */
-class DeepCloneError extends _CloneError.default {}
-var _default = exports.default = DeepCloneError;

package/src/clone/errors/DeepCloneError.mjs

@@ -1,6 +0,0 @@
-import CloneError from "./CloneError.mjs";
-/**
- * @public
- */
-class DeepCloneError extends CloneError {}
-export default DeepCloneError;

package/src/clone/errors/ShallowCloneError.cjs

@@ -1,11 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _CloneError = _interopRequireDefault(require("./CloneError.cjs"));
-/**
- * @public
- */
-class ShallowCloneError extends _CloneError.default {}
-var _default = exports.default = ShallowCloneError;

package/src/clone/errors/ShallowCloneError.mjs

@@ -1,6 +0,0 @@
-import CloneError from "./CloneError.mjs";
-/**
- * @public
- */
-class ShallowCloneError extends CloneError {}
-export default ShallowCloneError;

package/src/clone/index.cjs

@@ -1,188 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.cloneShallow = exports.cloneDeep = exports.ShallowCloneError = exports.DeepCloneError = exports.CloneError = void 0;
-var _ramda = require("ramda");
-var _ObjectSlice = _interopRequireDefault(require("../ObjectSlice.cjs"));
-var _KeyValuePair = _interopRequireDefault(require("../KeyValuePair.cjs"));
-var _index = require("../predicates/index.cjs");
-var _SourceMap = _interopRequireDefault(require("../elements/SourceMap.cjs"));
-var _DeepCloneError = _interopRequireDefault(require("./errors/DeepCloneError.cjs"));
-exports.DeepCloneError = _DeepCloneError.default;
-var _ShallowCloneError = _interopRequireDefault(require("./errors/ShallowCloneError.cjs"));
-exports.ShallowCloneError = _ShallowCloneError.default;
-var _CloneError = _interopRequireDefault(require("./errors/CloneError.cjs"));
-exports.CloneError = _CloneError.default;
-/**
- * @public
- */
-
-/**
- * @public
- */
-
-const cloneDeepElement = (element, options) => {
-  const {
-    visited = new WeakMap()
-  } = options;
-  const passThroughOptions = {
-    ...options,
-    visited
-  };
-
-  // detect cycle and return memoized value
-  if (visited.has(element)) {
-    return visited.get(element);
-  }
-  const copy = cloneShallowElement(element);
-  visited.set(element, copy);
-  const {
-    content
-  } = element;
-  if (Array.isArray(content)) {
-    copy.content = content.map(el => cloneDeepElement(el, passThroughOptions));
-  } else if ((0, _index.isElement)(content)) {
-    copy.content = cloneDeepElement(content, passThroughOptions);
-  } else if (content instanceof _KeyValuePair.default) {
-    copy.content = cloneDeepKeyValuePair(content, passThroughOptions);
-  } else {
-    copy.content = content;
-  }
-  return copy;
-};
-const cloneDeepKeyValuePair = (kvp, options) => {
-  const {
-    visited = new WeakMap()
-  } = options;
-  const passThroughOptions = {
-    ...options,
-    visited
-  };
-  if (visited.has(kvp)) {
-    return visited.get(kvp);
-  }
-  const {
-    key,
-    value
-  } = kvp;
-  const keyCopy = key !== undefined ? cloneDeepElement(key, passThroughOptions) : undefined;
-  const valueCopy = value !== undefined ? cloneDeepElement(value, passThroughOptions) : undefined;
-  const copy = new _KeyValuePair.default(keyCopy, valueCopy);
-  visited.set(kvp, copy);
-  return copy;
-};
-const cloneDeepObjectSlice = (slice, options) => {
-  const {
-    visited = new WeakMap()
-  } = options;
-  const passThroughOptions = {
-    ...options,
-    visited
-  };
-  if (visited.has(slice)) {
-    return visited.get(slice);
-  }
-  const items = [...slice].map(element => cloneDeepElement(element, passThroughOptions));
-  const copy = new _ObjectSlice.default(items);
-  visited.set(slice, copy);
-  return copy;
-};
-
-/**
- * Creates a deep clone of an ApiDOM Element, KeyValuePair, or ObjectSlice.
- * Handles cycles by memoizing visited objects.
- * @public
- */
-const cloneDeep = (value, options = {}) => {
-  if (value instanceof _KeyValuePair.default) {
-    return cloneDeepKeyValuePair(value, options);
-  }
-  if (value instanceof _ObjectSlice.default) {
-    return cloneDeepObjectSlice(value, options);
-  }
-  if ((0, _index.isElement)(value)) {
-    return cloneDeepElement(value, options);
-  }
-  throw new _DeepCloneError.default("Value provided to cloneDeep function couldn't be cloned", {
-    value
-  });
-};
-exports.cloneDeep = cloneDeep;
-cloneDeep.safe = value => {
-  try {
-    return cloneDeep(value);
-  } catch {
-    return value;
-  }
-};
-const cloneShallowKeyValuePair = keyValuePair => {
-  const {
-    key,
-    value
-  } = keyValuePair;
-  return new _KeyValuePair.default(key, value);
-};
-const cloneShallowObjectSlice = objectSlice => {
-  const items = [...objectSlice];
-  return new _ObjectSlice.default(items);
-};
-const cloneShallowElement = element => {
-  const Ctor = element.constructor;
-  const copy = new Ctor();
-  copy.element = element.element;
-  if (!element.isMetaEmpty) {
-    copy.meta = element.meta.cloneDeep();
-  }
-  if (!element.isAttributesEmpty) {
-    copy.attributes = cloneDeep(element.attributes);
-  }
-  if ((0, _index.hasElementSourceMap)(element)) {
-    _SourceMap.default.transfer(element, copy);
-  }
-  if ((0, _index.hasElementStyle)(element)) {
-    copy.style = (0, _ramda.clone)(element.style);
-  }
-  const {
-    content
-  } = element;
-  if ((0, _index.isElement)(content)) {
-    copy.content = cloneShallowElement(content);
-  } else if (Array.isArray(content)) {
-    copy.content = [...content];
-  } else if (content instanceof _KeyValuePair.default) {
-    copy.content = cloneShallowKeyValuePair(content);
-  } else {
-    copy.content = content;
-  }
-  return copy;
-};
-
-/**
- * Creates a shallow clone of an ApiDOM Element, KeyValuePair, or ObjectSlice.
- * The element itself is cloned, but content references are shared.
- * Meta and attributes are deep cloned to preserve semantic information.
- * @public
- */
-const cloneShallow = value => {
-  if (value instanceof _KeyValuePair.default) {
-    return cloneShallowKeyValuePair(value);
-  }
-  if (value instanceof _ObjectSlice.default) {
-    return cloneShallowObjectSlice(value);
-  }
-  if ((0, _index.isElement)(value)) {
-    return cloneShallowElement(value);
-  }
-  throw new _ShallowCloneError.default("Value provided to cloneShallow function couldn't be cloned", {
-    value
-  });
-};
-exports.cloneShallow = cloneShallow;
-cloneShallow.safe = value => {
-  try {
-    return cloneShallow(value);
-  } catch {
-    return value;
-  }
-};