@speclynx/apidom-datamodel 3.2.0 → 4.0.0

package/src/clone/index.mjs

@@ -1,178 +0,0 @@
-import { clone } from 'ramda';
-import ObjectSlice from "../ObjectSlice.mjs";
-import KeyValuePair from "../KeyValuePair.mjs";
-import { isElement, hasElementSourceMap, hasElementStyle } from "../predicates/index.mjs";
-import SourceMapElement from "../elements/SourceMap.mjs";
-import DeepCloneError from "./errors/DeepCloneError.mjs";
-import ShallowCloneError from "./errors/ShallowCloneError.mjs";
-/**
- * @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 (isElement(content)) {
-    copy.content = cloneDeepElement(content, passThroughOptions);
-  } else if (content instanceof KeyValuePair) {
-    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(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(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
- */
-export const cloneDeep = (value, options = {}) => {
-  if (value instanceof KeyValuePair) {
-    return cloneDeepKeyValuePair(value, options);
-  }
-  if (value instanceof ObjectSlice) {
-    return cloneDeepObjectSlice(value, options);
-  }
-  if (isElement(value)) {
-    return cloneDeepElement(value, options);
-  }
-  throw new DeepCloneError("Value provided to cloneDeep function couldn't be cloned", {
-    value
-  });
-};
-cloneDeep.safe = value => {
-  try {
-    return cloneDeep(value);
-  } catch {
-    return value;
-  }
-};
-const cloneShallowKeyValuePair = keyValuePair => {
-  const {
-    key,
-    value
-  } = keyValuePair;
-  return new KeyValuePair(key, value);
-};
-const cloneShallowObjectSlice = objectSlice => {
-  const items = [...objectSlice];
-  return new ObjectSlice(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 (hasElementSourceMap(element)) {
-    SourceMapElement.transfer(element, copy);
-  }
-  if (hasElementStyle(element)) {
-    copy.style = clone(element.style);
-  }
-  const {
-    content
-  } = element;
-  if (isElement(content)) {
-    copy.content = cloneShallowElement(content);
-  } else if (Array.isArray(content)) {
-    copy.content = [...content];
-  } else if (content instanceof KeyValuePair) {
-    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
- */
-export const cloneShallow = value => {
-  if (value instanceof KeyValuePair) {
-    return cloneShallowKeyValuePair(value);
-  }
-  if (value instanceof ObjectSlice) {
-    return cloneShallowObjectSlice(value);
-  }
-  if (isElement(value)) {
-    return cloneShallowElement(value);
-  }
-  throw new ShallowCloneError("Value provided to cloneShallow function couldn't be cloned", {
-    value
-  });
-};
-cloneShallow.safe = value => {
-  try {
-    return cloneShallow(value);
-  } catch {
-    return value;
-  }
-};
-export { default as CloneError } from "./errors/CloneError.mjs";
-export { default as DeepCloneError } from "./errors/DeepCloneError.mjs";
-export { default as ShallowCloneError } from "./errors/ShallowCloneError.mjs";

package/src/elements/Annotation.cjs

@@ -1,35 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _StringElement = _interopRequireDefault(require("../primitives/StringElement.cjs"));
-/**
- * AnnotationElement represents a parsing annotation (warning or error).
- *
- * The annotation's class indicates its severity:
- * - 'warning' - A non-fatal issue
- * - 'error' - A fatal issue
- *
- * @public
- */
-class AnnotationElement extends _StringElement.default {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'annotation';
-  }
-
-  /**
-   * The annotation code identifying the type of annotation.
-   */
-  get code() {
-    if (this.hasAttributesProperty('code')) {
-      return this.attributes.get('code');
-    }
-    return undefined;
-  }
-  set code(value) {
-    this.attributes.set('code', value);
-  }
-}
-var _default = exports.default = AnnotationElement;

package/src/elements/Annotation.mjs

@@ -1,30 +0,0 @@
-import StringElement from "../primitives/StringElement.mjs";
-/**
- * AnnotationElement represents a parsing annotation (warning or error).
- *
- * The annotation's class indicates its severity:
- * - 'warning' - A non-fatal issue
- * - 'error' - A fatal issue
- *
- * @public
- */
-class AnnotationElement extends StringElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'annotation';
-  }
-
-  /**
-   * The annotation code identifying the type of annotation.
-   */
-  get code() {
-    if (this.hasAttributesProperty('code')) {
-      return this.attributes.get('code');
-    }
-    return undefined;
-  }
-  set code(value) {
-    this.attributes.set('code', value);
-  }
-}
-export default AnnotationElement;

package/src/elements/Comment.cjs

@@ -1,18 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _StringElement = _interopRequireDefault(require("../primitives/StringElement.cjs"));
-/**
- * CommentElement represents a comment in the source document.
- *
- * @public
- */
-class CommentElement extends _StringElement.default {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'comment';
-  }
-}
-var _default = exports.default = CommentElement;

package/src/elements/Comment.mjs

@@ -1,13 +0,0 @@
-import StringElement from "../primitives/StringElement.mjs";
-/**
- * CommentElement represents a comment in the source document.
- *
- * @public
- */
-class CommentElement extends StringElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'comment';
-  }
-}
-export default CommentElement;

package/src/elements/LinkElement.cjs

@@ -1,50 +0,0 @@
-"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() {
-    if (this.hasAttributesProperty('relation')) {
-      return this.attributes.get('relation');
-    }
-    return undefined;
-  }
-  set relation(relation) {
-    this.attributes.set('relation', relation);
-  }
-
-  /**
-   * The URI for the given link.
-   */
-  get href() {
-    if (this.hasAttributesProperty('href')) {
-      return this.attributes.get('href');
-    }
-    return undefined;
-  }
-  set href(href) {
-    this.attributes.set('href', href);
-  }
-}
-var _default = exports.default = LinkElement;

package/src/elements/LinkElement.mjs

@@ -1,45 +0,0 @@
-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() {
-    if (this.hasAttributesProperty('relation')) {
-      return this.attributes.get('relation');
-    }
-    return undefined;
-  }
-  set relation(relation) {
-    this.attributes.set('relation', relation);
-  }
-
-  /**
-   * The URI for the given link.
-   */
-  get href() {
-    if (this.hasAttributesProperty('href')) {
-      return this.attributes.get('href');
-    }
-    return undefined;
-  }
-  set href(href) {
-    this.attributes.set('href', href);
-  }
-}
-export default LinkElement;

package/src/elements/ParseResult.cjs

@@ -1,91 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _ArrayElement = _interopRequireDefault(require("../primitives/ArrayElement.cjs"));
-var _index = require("../predicates/index.cjs");
-/**
- * ParseResultElement represents the result of parsing a document.
- *
- * Contains the parsed API element, any result elements, and annotations
- * (warnings and errors) from the parsing process.
- *
- * @public
- */
-class ParseResultElement extends _ArrayElement.default {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'parseResult';
-  }
-
-  /**
-   * The main API element from the parse result.
-   */
-  get api() {
-    return this.filter(item => (0, _index.includesClasses)(item, ['api'])).first;
-  }
-
-  /**
-   * All result elements from the parse result.
-   */
-  get results() {
-    return this.filter(item => (0, _index.includesClasses)(item, ['result']));
-  }
-
-  /**
-   * The first result element.
-   */
-  get result() {
-    return this.results.first;
-  }
-
-  /**
-   * All annotation elements (warnings and errors).
-   */
-  get annotations() {
-    return this.filter(item => item.element === 'annotation');
-  }
-
-  /**
-   * All warning annotations.
-   */
-  get warnings() {
-    return this.filter(item => item.element === 'annotation' && (0, _index.includesClasses)(item, ['warning']));
-  }
-
-  /**
-   * All error annotations.
-   */
-  get errors() {
-    return this.filter(item => item.element === 'annotation' && (0, _index.includesClasses)(item, ['error']));
-  }
-
-  /**
-   * Whether the parse result is empty (contains only annotations).
-   */
-  get isEmpty() {
-    return this.reject(item => item.element === 'annotation').length === 0;
-  }
-
-  /**
-   * Replaces the first result element with the given replacement.
-   * @returns true if replacement was successful, false otherwise
-   */
-  replaceResult(replacement) {
-    const {
-      result
-    } = this;
-    if (result === undefined) {
-      return false;
-    }
-    const content = this._content;
-    const searchIndex = content.findIndex(e => e === result);
-    if (searchIndex === -1) {
-      return false;
-    }
-    content[searchIndex] = replacement;
-    return true;
-  }
-}
-var _default = exports.default = ParseResultElement;

package/src/elements/ParseResult.mjs

@@ -1,86 +0,0 @@
-import ArrayElement from "../primitives/ArrayElement.mjs";
-import { includesClasses } from "../predicates/index.mjs";
-/**
- * ParseResultElement represents the result of parsing a document.
- *
- * Contains the parsed API element, any result elements, and annotations
- * (warnings and errors) from the parsing process.
- *
- * @public
- */
-class ParseResultElement extends ArrayElement {
-  constructor(content, meta, attributes) {
-    super(content, meta, attributes);
-    this.element = 'parseResult';
-  }
-
-  /**
-   * The main API element from the parse result.
-   */
-  get api() {
-    return this.filter(item => includesClasses(item, ['api'])).first;
-  }
-
-  /**
-   * All result elements from the parse result.
-   */
-  get results() {
-    return this.filter(item => includesClasses(item, ['result']));
-  }
-
-  /**
-   * The first result element.
-   */
-  get result() {
-    return this.results.first;
-  }
-
-  /**
-   * All annotation elements (warnings and errors).
-   */
-  get annotations() {
-    return this.filter(item => item.element === 'annotation');
-  }
-
-  /**
-   * All warning annotations.
-   */
-  get warnings() {
-    return this.filter(item => item.element === 'annotation' && includesClasses(item, ['warning']));
-  }
-
-  /**
-   * All error annotations.
-   */
-  get errors() {
-    return this.filter(item => item.element === 'annotation' && includesClasses(item, ['error']));
-  }
-
-  /**
-   * Whether the parse result is empty (contains only annotations).
-   */
-  get isEmpty() {
-    return this.reject(item => item.element === 'annotation').length === 0;
-  }
-
-  /**
-   * Replaces the first result element with the given replacement.
-   * @returns true if replacement was successful, false otherwise
-   */
-  replaceResult(replacement) {
-    const {
-      result
-    } = this;
-    if (result === undefined) {
-      return false;
-    }
-    const content = this._content;
-    const searchIndex = content.findIndex(e => e === result);
-    if (searchIndex === -1) {
-      return false;
-    }
-    content[searchIndex] = replacement;
-    return true;
-  }
-}
-export default ParseResultElement;

package/src/elements/RefElement.cjs

@@ -1,34 +0,0 @@
-"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() {
-    if (this.hasAttributesProperty('path')) {
-      return this.attributes.get('path');
-    }
-    return undefined;
-  }
-  set path(newValue) {
-    this.attributes.set('path', newValue);
-  }
-}
-var _default = exports.default = RefElement;

package/src/elements/RefElement.mjs

@@ -1,29 +0,0 @@
-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() {
-    if (this.hasAttributesProperty('path')) {
-      return this.attributes.get('path');
-    }
-    return undefined;
-  }
-  set path(newValue) {
-    this.attributes.set('path', newValue);
-  }
-}
-export default RefElement;