@speclynx/apidom-core 1.12.1

package/src/clone/index.mjs

@@ -0,0 +1,146 @@
+import { ArraySlice, ObjectSlice, KeyValuePair } from 'minim';
+import { isElement } from "../predicates/index.mjs";
+import DeepCloneError from "./errors/DeepCloneError.mjs";
+import ShallowCloneError from "./errors/ShallowCloneError.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+export const cloneDeep = (value, options = {}) => {
+  const {
+    visited = new WeakMap()
+  } = options;
+  const passThroughOptions = {
+    ...options,
+    visited
+  };
+
+  // detect cycle and return memoized value
+  if (visited.has(value)) {
+    return visited.get(value);
+  }
+  if (value instanceof KeyValuePair) {
+    const {
+      key,
+      value: val
+    } = value;
+    const keyCopy = isElement(key) ? cloneDeep(key, passThroughOptions) : key;
+    const valueCopy = isElement(val) ? cloneDeep(val, passThroughOptions) : val;
+    const copy = new KeyValuePair(keyCopy, valueCopy);
+    visited.set(value, copy);
+    return copy;
+  }
+  if (value instanceof ObjectSlice) {
+    const mapper = element => cloneDeep(element, passThroughOptions);
+    const items = [...value].map(mapper);
+    const copy = new ObjectSlice(items);
+    visited.set(value, copy);
+    return copy;
+  }
+  if (value instanceof ArraySlice) {
+    const mapper = element => cloneDeep(element, passThroughOptions);
+    const items = [...value].map(mapper);
+    const copy = new ArraySlice(items);
+    visited.set(value, copy);
+    return copy;
+  }
+  if (isElement(value)) {
+    const copy = cloneShallow(value);
+    visited.set(value, copy);
+    if (value.content) {
+      if (isElement(value.content)) {
+        copy.content = cloneDeep(value.content, passThroughOptions);
+      } else if (value.content instanceof KeyValuePair) {
+        copy.content = cloneDeep(value.content, passThroughOptions);
+      } else if (Array.isArray(value.content)) {
+        const mapper = element => cloneDeep(element, passThroughOptions);
+        copy.content = value.content.map(mapper);
+      } else {
+        copy.content = value.content;
+      }
+    } else {
+      copy.content = value.content;
+    }
+    return copy;
+  }
+  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 cloneShallowArraySlice = arraySlice => {
+  const items = [...arraySlice];
+  return new ArraySlice(items);
+};
+const cloneShallowObjectSlice = objectSlice => {
+  const items = [...objectSlice];
+  return new ObjectSlice(items);
+};
+const cloneShallowElement = element => {
+  // @ts-ignore
+  const copy = new element.constructor();
+  copy.element = element.element;
+  if (element.meta.length > 0) {
+    copy._meta = cloneDeep(element.meta);
+  }
+  if (element.attributes.length > 0) {
+    copy._attributes = cloneDeep(element.attributes);
+  }
+  if (isElement(element.content)) {
+    const content = element.content;
+    copy.content = cloneShallowElement(content);
+  } else if (Array.isArray(element.content)) {
+    copy.content = [...element.content];
+  } else if (element.content instanceof KeyValuePair) {
+    copy.content = cloneShallowKeyValuePair(element.content);
+  } else {
+    copy.content = element.content;
+  }
+  return copy;
+};
+
+/**
+ * @public
+ */
+export const cloneShallow = value => {
+  if (value instanceof KeyValuePair) {
+    return cloneShallowKeyValuePair(value);
+  }
+  if (value instanceof ObjectSlice) {
+    return cloneShallowObjectSlice(value);
+  }
+  if (value instanceof ArraySlice) {
+    return cloneShallowArraySlice(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;
+  }
+};

package/src/elements/Annotation.cjs

@@ -0,0 +1,23 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _minim = require("minim");
+/**
+ * @public
+ */
+class Annotation extends _minim.StringElement {
+  // classes: warning | error
+
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'annotation';
+  }
+  get code() {
+    return this.attributes.get('code');
+  }
+  set code(value) {
+    this.attributes.set('code', value);
+  }
+}
+var _default = exports.default = Annotation;

package/src/elements/Annotation.mjs

@@ -0,0 +1,20 @@
+import { StringElement } from 'minim';
+
+/**
+ * @public
+ */
+class Annotation extends StringElement {
+  // classes: warning | error
+
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'annotation';
+  }
+  get code() {
+    return this.attributes.get('code');
+  }
+  set code(value) {
+    this.attributes.set('code', value);
+  }
+}
+export default Annotation;

package/src/elements/Comment.cjs

@@ -0,0 +1,15 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _minim = require("minim");
+/**
+ * @public
+ */
+class Comment extends _minim.StringElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'comment';
+  }
+}
+var _default = exports.default = Comment;

package/src/elements/Comment.mjs

@@ -0,0 +1,12 @@
+import { StringElement } from 'minim';
+
+/**
+ * @public
+ */
+class Comment extends StringElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'comment';
+  }
+}
+export default Comment;

package/src/elements/ParseResult.cjs

@@ -0,0 +1,53 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _minim = require("minim");
+var _ramdaAdjunct = require("ramda-adjunct");
+/**
+ * @public
+ */
+class ParseResult extends _minim.ArrayElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'parseResult';
+  }
+  get api() {
+    return this.children.filter(item => item.classes.contains('api')).first;
+  }
+  get results() {
+    return this.children.filter(item => item.classes.contains('result'));
+  }
+  get result() {
+    return this.results.first;
+  }
+  get annotations() {
+    return this.children.filter(item => item.element === 'annotation');
+  }
+  get warnings() {
+    return this.children.filter(item => item.element === 'annotation' && item.classes.contains('warning'));
+  }
+  get errors() {
+    return this.children.filter(item => item.element === 'annotation' && item.classes.contains('error'));
+  }
+  get isEmpty() {
+    return this.children.reject(item => item.element === 'annotation').isEmpty;
+  }
+  replaceResult(replacement) {
+    const {
+      result
+    } = this;
+    if ((0, _ramdaAdjunct.isUndefined)(result)) {
+      return false;
+    }
+
+    // @ts-ignore
+    const searchIndex = this.content.findIndex(e => e === result);
+    if (searchIndex === -1) {
+      return false;
+    }
+    this.content[searchIndex] = replacement;
+    return true;
+  }
+}
+var _default = exports.default = ParseResult;

package/src/elements/ParseResult.mjs

@@ -0,0 +1,50 @@
+import { ArrayElement } from 'minim';
+import { isUndefined } from 'ramda-adjunct';
+
+/**
+ * @public
+ */
+class ParseResult extends ArrayElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'parseResult';
+  }
+  get api() {
+    return this.children.filter(item => item.classes.contains('api')).first;
+  }
+  get results() {
+    return this.children.filter(item => item.classes.contains('result'));
+  }
+  get result() {
+    return this.results.first;
+  }
+  get annotations() {
+    return this.children.filter(item => item.element === 'annotation');
+  }
+  get warnings() {
+    return this.children.filter(item => item.element === 'annotation' && item.classes.contains('warning'));
+  }
+  get errors() {
+    return this.children.filter(item => item.element === 'annotation' && item.classes.contains('error'));
+  }
+  get isEmpty() {
+    return this.children.reject(item => item.element === 'annotation').isEmpty;
+  }
+  replaceResult(replacement) {
+    const {
+      result
+    } = this;
+    if (isUndefined(result)) {
+      return false;
+    }
+
+    // @ts-ignore
+    const searchIndex = this.content.findIndex(e => e === result);
+    if (searchIndex === -1) {
+      return false;
+    }
+    this.content[searchIndex] = replacement;
+    return true;
+  }
+}
+export default ParseResult;

package/src/elements/SourceMap.cjs

@@ -0,0 +1,39 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _minim = require("minim");
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class SourceMap extends _minim.ArrayElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'sourceMap';
+  }
+  get positionStart() {
+    return this.children.filter(item => item.classes.contains('position')).get(0);
+  }
+  get positionEnd() {
+    return this.children.filter(item => item.classes.contains('position')).get(1);
+  }
+  set position(position) {
+    if (typeof position === 'undefined') {
+      return;
+    }
+    const start = new _minim.ArrayElement([position.start.row, position.start.column, position.start.char]);
+    const end = new _minim.ArrayElement([position.end.row, position.end.column, position.end.char]);
+    start.classes.push('position');
+    end.classes.push('position');
+    this.push(start).push(end);
+  }
+}
+var _default = exports.default = SourceMap;

package/src/elements/SourceMap.mjs

@@ -0,0 +1,36 @@
+import { ArrayElement } from 'minim';
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+class SourceMap extends ArrayElement {
+  constructor(content, meta, attributes) {
+    super(content, meta, attributes);
+    this.element = 'sourceMap';
+  }
+  get positionStart() {
+    return this.children.filter(item => item.classes.contains('position')).get(0);
+  }
+  get positionEnd() {
+    return this.children.filter(item => item.classes.contains('position')).get(1);
+  }
+  set position(position) {
+    if (typeof position === 'undefined') {
+      return;
+    }
+    const start = new ArrayElement([position.start.row, position.start.column, position.start.char]);
+    const end = new ArrayElement([position.end.row, position.end.column, position.end.char]);
+    start.classes.push('position');
+    end.classes.push('position');
+    this.push(start).push(end);
+  }
+}
+export default SourceMap;

package/src/identity/errors/ElementIdentityError.cjs

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

package/src/identity/errors/ElementIdentityError.mjs

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

package/src/identity/index.cjs

@@ -0,0 +1,62 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.defaultIdentityManager = exports.IdentityManager = void 0;
+var _minim = require("minim");
+var _shortUniqueId = _interopRequireDefault(require("short-unique-id"));
+var _ElementIdentityError = _interopRequireDefault(require("./errors/ElementIdentityError.cjs"));
+var _index = require("../predicates/index.cjs");
+/**
+ * @public
+ */
+class IdentityManager {
+  uuid;
+  identityMap;
+  constructor({
+    length = 6
+  } = {}) {
+    this.uuid = new _shortUniqueId.default({
+      length
+    });
+    this.identityMap = new WeakMap();
+  }
+  identify(element) {
+    if (!(0, _index.isElement)(element)) {
+      throw new _ElementIdentityError.default('Cannot not identify the element. `element` is neither structurally compatible nor a subclass of an Element class.', {
+        value: element
+      });
+    }
+
+    // use already assigned identity
+    if (element.meta.hasKey('id') && (0, _index.isStringElement)(element.meta.get('id')) && !element.meta.get('id').equals('')) {
+      return element.id;
+    }
+
+    // assign identity in immutable way
+    if (this.identityMap.has(element)) {
+      return this.identityMap.get(element);
+    }
+
+    // return element identity
+    const id = new _minim.StringElement(this.generateId());
+    this.identityMap.set(element, id);
+    return id;
+  }
+  forget(element) {
+    if (this.identityMap.has(element)) {
+      this.identityMap.delete(element);
+      return true;
+    }
+    return false;
+  }
+  generateId() {
+    return this.uuid.randomUUID();
+  }
+}
+
+/**
+ * @public
+ */
+exports.IdentityManager = IdentityManager;
+const defaultIdentityManager = exports.defaultIdentityManager = new IdentityManager();

package/src/identity/index.mjs

@@ -0,0 +1,56 @@
+import { StringElement } from 'minim';
+import ShortUniqueId from 'short-unique-id';
+import ElementIdentityError from "./errors/ElementIdentityError.mjs";
+import { isElement, isStringElement } from "../predicates/index.mjs";
+/**
+ * @public
+ */
+export class IdentityManager {
+  uuid;
+  identityMap;
+  constructor({
+    length = 6
+  } = {}) {
+    this.uuid = new ShortUniqueId({
+      length
+    });
+    this.identityMap = new WeakMap();
+  }
+  identify(element) {
+    if (!isElement(element)) {
+      throw new ElementIdentityError('Cannot not identify the element. `element` is neither structurally compatible nor a subclass of an Element class.', {
+        value: element
+      });
+    }
+
+    // use already assigned identity
+    if (element.meta.hasKey('id') && isStringElement(element.meta.get('id')) && !element.meta.get('id').equals('')) {
+      return element.id;
+    }
+
+    // assign identity in immutable way
+    if (this.identityMap.has(element)) {
+      return this.identityMap.get(element);
+    }
+
+    // return element identity
+    const id = new StringElement(this.generateId());
+    this.identityMap.set(element, id);
+    return id;
+  }
+  forget(element) {
+    if (this.identityMap.has(element)) {
+      this.identityMap.delete(element);
+      return true;
+    }
+    return false;
+  }
+  generateId() {
+    return this.uuid.randomUUID();
+  }
+}
+
+/**
+ * @public
+ */
+export const defaultIdentityManager = new IdentityManager();

package/src/index.cjs

@@ -0,0 +1,112 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.visit = exports.traverse = exports.transclude = exports.toYAML = exports.toValue = exports.toString = exports.toJSON = exports.some = exports.sexprs = exports.reject = exports.refractorPluginSemanticElementIdentity = exports.refractorPluginElementIdentity = exports.refract = exports.parents = exports.namespace = exports.mergeRight = exports.mergeLeft = exports.mergeAllVisitors = exports.keyMap = exports.isStringElement = exports.isSourceMapElement = exports.isRefElement = exports.isPrimitiveElement = exports.isParseResultElement = exports.isObjectElement = exports.isNumberElement = exports.isNullElement = exports.isMemberElement = exports.isLinkElement = exports.isElement = exports.isBooleanElement = exports.isArrayElement = exports.isAnnotationElement = exports.includesSymbols = exports.includesClasses = exports.hasElementSourceMap = exports.getNodeType = exports.from = exports.findAtOffset = exports.find = exports.filter = exports.dispatchRefractorPlugins = exports.dereference = exports.dehydrate = exports.defaultIdentityManager = exports.deepmerge = exports.createPredicate = exports.createNamespace = exports.cloneShallow = exports.cloneNode = exports.cloneDeep = exports.Transcluder = exports.StringElement = exports.SourceMapElement = exports.ShallowCloneError = exports.RefElement = exports.ParseResultElement = exports.ObjectSlice = exports.ObjectElement = exports.NumberElement = exports.NullElement = exports.Namespace = exports.MemberElement = exports.MediaTypes = exports.LinkElement = exports.KeyValuePair = exports.IdentityManager = exports.ElementIdentityError = exports.Element = exports.DeepCloneError = exports.CommentElement = exports.CloneError = exports.BooleanElement = exports.BREAK = exports.ArraySlice = exports.ArrayElement = exports.AnnotationElement = void 0;
+var _index = require("./refractor/plugins/dispatcher/index.cjs");
+exports.dispatchRefractorPlugins = _index.dispatchPluginsSync;
+var _elementIdentity = _interopRequireDefault(require("./refractor/plugins/element-identity.cjs"));
+exports.refractorPluginElementIdentity = _elementIdentity.default;
+var _semanticElementIdentity = _interopRequireDefault(require("./refractor/plugins/semantic-element-identity.cjs"));
+exports.refractorPluginSemanticElementIdentity = _semanticElementIdentity.default;
+var _mediaTypes = _interopRequireDefault(require("./media-types.cjs"));
+exports.MediaTypes = _mediaTypes.default;
+var _minim = require("minim");
+exports.Element = _minim.Element;
+exports.MemberElement = _minim.MemberElement;
+exports.KeyValuePair = _minim.KeyValuePair;
+exports.ObjectSlice = _minim.ObjectSlice;
+exports.ArraySlice = _minim.ArraySlice;
+exports.refract = _minim.refract;
+var _namespace = _interopRequireWildcard(require("./namespace.cjs"));
+exports.namespace = _namespace.default;
+exports.Namespace = _namespace.Namespace;
+exports.createNamespace = _namespace.createNamespace;
+var _registration = require("./refractor/registration.cjs");
+exports.ObjectElement = _registration.ObjectElement;
+exports.ArrayElement = _registration.ArrayElement;
+exports.BooleanElement = _registration.BooleanElement;
+exports.NullElement = _registration.NullElement;
+exports.NumberElement = _registration.NumberElement;
+exports.StringElement = _registration.StringElement;
+exports.LinkElement = _registration.LinkElement;
+exports.RefElement = _registration.RefElement;
+exports.AnnotationElement = _registration.AnnotationElement;
+exports.CommentElement = _registration.CommentElement;
+exports.ParseResultElement = _registration.ParseResultElement;
+exports.SourceMapElement = _registration.SourceMapElement;
+var _index2 = require("./predicates/index.cjs");
+exports.isElement = _index2.isElement;
+exports.isStringElement = _index2.isStringElement;
+exports.isNumberElement = _index2.isNumberElement;
+exports.isNullElement = _index2.isNullElement;
+exports.isBooleanElement = _index2.isBooleanElement;
+exports.isArrayElement = _index2.isArrayElement;
+exports.isObjectElement = _index2.isObjectElement;
+exports.isMemberElement = _index2.isMemberElement;
+exports.isLinkElement = _index2.isLinkElement;
+exports.isRefElement = _index2.isRefElement;
+exports.isAnnotationElement = _index2.isAnnotationElement;
+exports.isParseResultElement = _index2.isParseResultElement;
+exports.isSourceMapElement = _index2.isSourceMapElement;
+exports.isPrimitiveElement = _index2.isPrimitiveElement;
+exports.hasElementSourceMap = _index2.hasElementSourceMap;
+exports.includesSymbols = _index2.includesSymbols;
+exports.includesClasses = _index2.includesClasses;
+var _helpers = _interopRequireDefault(require("./predicates/helpers.cjs"));
+exports.createPredicate = _helpers.default;
+var _index3 = require("./traversal/index.cjs");
+exports.filter = _index3.filter;
+exports.reject = _index3.reject;
+exports.find = _index3.find;
+exports.findAtOffset = _index3.findAtOffset;
+exports.some = _index3.some;
+exports.traverse = _index3.traverse;
+exports.parents = _index3.parents;
+var _visitor = require("./traversal/visitor.cjs");
+exports.visit = _visitor.visit;
+exports.BREAK = _visitor.BREAK;
+exports.mergeAllVisitors = _visitor.mergeAllVisitors;
+exports.getNodeType = _visitor.getNodeType;
+exports.cloneNode = _visitor.cloneNode;
+exports.keyMap = _visitor.keyMapDefault;
+var _index4 = _interopRequireWildcard(require("./transcluder/index.cjs"));
+exports.transclude = _index4.transclude;
+exports.Transcluder = _index4.default;
+var _util = require("./util.cjs");
+exports.dereference = _util.dereference;
+var _index5 = require("./clone/index.cjs");
+exports.cloneShallow = _index5.cloneShallow;
+exports.cloneDeep = _index5.cloneDeep;
+var _CloneError = _interopRequireDefault(require("./clone/errors/CloneError.cjs"));
+exports.CloneError = _CloneError.default;
+var _DeepCloneError = _interopRequireDefault(require("./clone/errors/DeepCloneError.cjs"));
+exports.DeepCloneError = _DeepCloneError.default;
+var _ShallowCloneError = _interopRequireDefault(require("./clone/errors/ShallowCloneError.cjs"));
+exports.ShallowCloneError = _ShallowCloneError.default;
+var _index6 = require("./identity/index.cjs");
+exports.defaultIdentityManager = _index6.defaultIdentityManager;
+exports.IdentityManager = _index6.IdentityManager;
+var _ElementIdentityError = _interopRequireDefault(require("./identity/errors/ElementIdentityError.cjs"));
+exports.ElementIdentityError = _ElementIdentityError.default;
+var _from = _interopRequireDefault(require("./transformers/from.cjs"));
+exports.from = _from.default;
+var _index7 = _interopRequireDefault(require("./transformers/serializers/value/index.cjs"));
+exports.toValue = _index7.default;
+var _json = _interopRequireDefault(require("./transformers/serializers/json.cjs"));
+exports.toJSON = _json.default;
+var _yaml = _interopRequireDefault(require("./transformers/serializers/yaml-1-2.cjs"));
+exports.toYAML = _yaml.default;
+var _dehydrate = _interopRequireDefault(require("./transformers/dehydrate.cjs"));
+exports.dehydrate = _dehydrate.default;
+var _toString = _interopRequireDefault(require("./transformers/to-string.cjs"));
+exports.toString = _toString.default;
+var _sexprs = _interopRequireDefault(require("./transformers/sexprs.cjs"));
+exports.sexprs = _sexprs.default;
+var _deepmerge = _interopRequireDefault(require("./merge/deepmerge.cjs"));
+exports.deepmerge = _deepmerge.default;
+var _mergeRight = _interopRequireDefault(require("./merge/merge-right.cjs"));
+exports.mergeRight = _mergeRight.default;
+var _mergeLeft = _interopRequireDefault(require("./merge/merge-left.cjs"));
+exports.mergeLeft = _mergeLeft.default;