@speclynx/apidom-core 1.12.1

package/src/refractor/plugins/element-identity.cjs

@@ -0,0 +1,31 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _index = require("../../identity/index.cjs");
+/**
+ * Plugin for decorating every element in ApiDOM tree with UUID.
+ * @public
+ */
+
+const plugin = ({
+  length = 6
+} = {}) => () => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new _index.IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(element) {
+        element.id = identityManager.identify(element);
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+var _default = exports.default = plugin;

package/src/refractor/plugins/element-identity.mjs

@@ -0,0 +1,26 @@
+import { IdentityManager } from "../../identity/index.mjs";
+/**
+ * Plugin for decorating every element in ApiDOM tree with UUID.
+ * @public
+ */
+const plugin = ({
+  length = 6
+} = {}) => () => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(element) {
+        element.id = identityManager.identify(element);
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+export default plugin;

package/src/refractor/plugins/semantic-element-identity.cjs

@@ -0,0 +1,38 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _index = require("../../identity/index.cjs");
+/**
+ * @public
+ */
+
+/**
+ * Plugin for decorating every semantic element in ApiDOM tree with UUID.
+ * @public
+ */
+const plugin = ({
+  length = 6
+} = {}) => ({
+  predicates
+}) => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new _index.IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(element) {
+        if (!predicates.isPrimitiveElement(element)) {
+          element.id = identityManager.identify(element);
+        }
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+var _default = exports.default = plugin;

package/src/refractor/plugins/semantic-element-identity.mjs

@@ -0,0 +1,33 @@
+import { IdentityManager } from "../../identity/index.mjs";
+/**
+ * @public
+ */
+/**
+ * Plugin for decorating every semantic element in ApiDOM tree with UUID.
+ * @public
+ */
+const plugin = ({
+  length = 6
+} = {}) => ({
+  predicates
+}) => {
+  let identityManager;
+  return {
+    pre() {
+      identityManager = new IdentityManager({
+        length
+      });
+    },
+    visitor: {
+      enter(element) {
+        if (!predicates.isPrimitiveElement(element)) {
+          element.id = identityManager.identify(element);
+        }
+      }
+    },
+    post() {
+      identityManager = null;
+    }
+  };
+};
+export default plugin;

package/src/refractor/registration.cjs

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+var _minim = require("minim");
+exports.ObjectElement = _minim.ObjectElement;
+exports.ArrayElement = _minim.ArrayElement;
+exports.StringElement = _minim.StringElement;
+exports.BooleanElement = _minim.BooleanElement;
+exports.NullElement = _minim.NullElement;
+exports.NumberElement = _minim.NumberElement;
+exports.LinkElement = _minim.LinkElement;
+exports.RefElement = _minim.RefElement;
+var _Annotation = _interopRequireDefault(require("../elements/Annotation.cjs"));
+exports.AnnotationElement = _Annotation.default;
+var _Comment = _interopRequireDefault(require("../elements/Comment.cjs"));
+exports.CommentElement = _Comment.default;
+var _ParseResult = _interopRequireDefault(require("../elements/ParseResult.cjs"));
+exports.ParseResultElement = _ParseResult.default;
+var _SourceMap = _interopRequireDefault(require("../elements/SourceMap.cjs"));
+exports.SourceMapElement = _SourceMap.default;
+var _index = require("./index.cjs");
+_minim.ObjectElement.refract = (0, _index.createRefractor)(_minim.ObjectElement);
+_minim.ArrayElement.refract = (0, _index.createRefractor)(_minim.ArrayElement);
+_minim.StringElement.refract = (0, _index.createRefractor)(_minim.StringElement);
+_minim.BooleanElement.refract = (0, _index.createRefractor)(_minim.BooleanElement);
+_minim.NullElement.refract = (0, _index.createRefractor)(_minim.NullElement);
+_minim.NumberElement.refract = (0, _index.createRefractor)(_minim.NumberElement);
+_minim.LinkElement.refract = (0, _index.createRefractor)(_minim.LinkElement);
+_minim.RefElement.refract = (0, _index.createRefractor)(_minim.RefElement);
+_Annotation.default.refract = (0, _index.createRefractor)(_Annotation.default);
+_Comment.default.refract = (0, _index.createRefractor)(_Comment.default);
+_ParseResult.default.refract = (0, _index.createRefractor)(_ParseResult.default);
+_SourceMap.default.refract = (0, _index.createRefractor)(_SourceMap.default);

package/src/refractor/registration.mjs

@@ -0,0 +1,19 @@
+import { ObjectElement, ArrayElement, StringElement, BooleanElement, NullElement, NumberElement, LinkElement, RefElement } from 'minim';
+import AnnotationElement from "../elements/Annotation.mjs";
+import CommentElement from "../elements/Comment.mjs";
+import ParseResultElement from "../elements/ParseResult.mjs";
+import SourceMapElement from "../elements/SourceMap.mjs";
+import { createRefractor } from "./index.mjs";
+ObjectElement.refract = createRefractor(ObjectElement);
+ArrayElement.refract = createRefractor(ArrayElement);
+StringElement.refract = createRefractor(StringElement);
+BooleanElement.refract = createRefractor(BooleanElement);
+NullElement.refract = createRefractor(NullElement);
+NumberElement.refract = createRefractor(NumberElement);
+LinkElement.refract = createRefractor(LinkElement);
+RefElement.refract = createRefractor(RefElement);
+AnnotationElement.refract = createRefractor(AnnotationElement);
+CommentElement.refract = createRefractor(CommentElement);
+ParseResultElement.refract = createRefractor(ParseResultElement);
+SourceMapElement.refract = createRefractor(SourceMapElement);
+export { ObjectElement, ArrayElement, StringElement, BooleanElement, NullElement, NumberElement, LinkElement, RefElement, AnnotationElement, CommentElement, ParseResultElement, SourceMapElement };

package/src/refractor/toolbox.cjs

@@ -0,0 +1,29 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
+exports.__esModule = true;
+exports.default = void 0;
+var basePredicates = _interopRequireWildcard(require("../predicates/index.cjs"));
+var _namespace = _interopRequireDefault(require("../namespace.cjs"));
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+
+/**
+ * @public
+ */
+const createToolbox = () => {
+  const predicates = {
+    ...basePredicates
+  };
+  return {
+    predicates,
+    namespace: _namespace.default
+  };
+};
+var _default = exports.default = createToolbox;

package/src/refractor/toolbox.mjs

@@ -0,0 +1,21 @@
+import * as basePredicates from "../predicates/index.mjs";
+import defaultNamespaceInstance from "../namespace.mjs";
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+/**
+ * @public
+ */
+const createToolbox = () => {
+  const predicates = {
+    ...basePredicates
+  };
+  return {
+    predicates,
+    namespace: defaultNamespaceInstance
+  };
+};
+export default createToolbox;

package/src/transcluder/Transcluder.cjs

@@ -0,0 +1,111 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _ramdaAdjunct = require("ramda-adjunct");
+var _index = require("../predicates/index.cjs");
+const computeEdges = (element, edges = new WeakMap()) => {
+  if ((0, _index.isMemberElement)(element)) {
+    // @ts-ignore
+    edges.set(element.key, element);
+    // @ts-ignore
+    computeEdges(element.key, edges);
+    // @ts-ignore
+    edges.set(element.value, element);
+    // @ts-ignore
+    computeEdges(element.value, edges);
+  } else {
+    element.children.forEach(childElement => {
+      edges.set(childElement, element);
+      computeEdges(childElement, edges);
+    });
+  }
+  return edges;
+};
+const transcludeChildOfMemberElement = (search, replace, edges) => {
+  const memberElement = edges.get(search);
+  if (!(0, _index.isMemberElement)(memberElement)) {
+    return;
+  }
+  if (memberElement.key === search) {
+    memberElement.key = replace;
+    edges.delete(search);
+    edges.set(replace, memberElement);
+  }
+  if (memberElement.value === search) {
+    memberElement.value = replace;
+    edges.delete(search);
+    edges.set(replace, memberElement);
+  }
+};
+const transcludeChildOfObjectElement = (search, replace, edges) => {
+  const objectElement = edges.get(search);
+  if (!(0, _index.isObjectElement)(objectElement)) {
+    return;
+  }
+  objectElement.content = objectElement.map((value, key, member) => {
+    if (member === search) {
+      edges.delete(search);
+      edges.set(replace, objectElement);
+      return replace;
+    }
+    return member;
+  });
+};
+const transcludeChildOfArrayElement = (search, replace, edges) => {
+  const arrayElement = edges.get(search);
+  if (!(0, _index.isArrayElement)(arrayElement)) {
+    return;
+  }
+  arrayElement.content = arrayElement.map(element => {
+    if (element === search) {
+      edges.delete(search);
+      edges.set(replace, arrayElement);
+      return replace;
+    }
+    return element;
+  });
+};
+
+/**
+ * This is a mutating stamp. If you don't want your Element to be mutated,
+ * clone in before passing it to initializer of this stamp.
+ * @public
+ */
+
+class Transcluder {
+  element;
+  edges;
+  constructor({
+    element
+  }) {
+    this.element = element;
+  }
+  transclude(search, replace) {
+    // shortcut 1. - replacing entire ApiDOM tree
+    if (search === this.element) return replace;
+    // shortcut 2. - replacing nothing
+    if (search === replace) return this.element;
+    this.edges = this.edges ?? computeEdges(this.element);
+    const parent = this.edges.get(search);
+    if ((0, _ramdaAdjunct.isUndefined)(parent)) {
+      return undefined;
+    }
+
+    /**
+     * This predicate must be first because ObjectElement extends ArrayElement.
+     * isArrayElement returns true for ObjectElements.
+     * (classical problems with polymorphism)
+     */
+    if ((0, _index.isObjectElement)(parent)) {
+      // @ts-ignore
+      transcludeChildOfObjectElement(search, replace, this.edges);
+    } else if ((0, _index.isArrayElement)(parent)) {
+      transcludeChildOfArrayElement(search, replace, this.edges);
+    } else if ((0, _index.isMemberElement)(parent)) {
+      transcludeChildOfMemberElement(search, replace, this.edges);
+    }
+    return this.element;
+  }
+}
+var _default = exports.default = Transcluder;

package/src/transcluder/Transcluder.mjs

@@ -0,0 +1,107 @@
+import { isUndefined } from 'ramda-adjunct';
+import { isObjectElement, isArrayElement, isMemberElement } from "../predicates/index.mjs";
+const computeEdges = (element, edges = new WeakMap()) => {
+  if (isMemberElement(element)) {
+    // @ts-ignore
+    edges.set(element.key, element);
+    // @ts-ignore
+    computeEdges(element.key, edges);
+    // @ts-ignore
+    edges.set(element.value, element);
+    // @ts-ignore
+    computeEdges(element.value, edges);
+  } else {
+    element.children.forEach(childElement => {
+      edges.set(childElement, element);
+      computeEdges(childElement, edges);
+    });
+  }
+  return edges;
+};
+const transcludeChildOfMemberElement = (search, replace, edges) => {
+  const memberElement = edges.get(search);
+  if (!isMemberElement(memberElement)) {
+    return;
+  }
+  if (memberElement.key === search) {
+    memberElement.key = replace;
+    edges.delete(search);
+    edges.set(replace, memberElement);
+  }
+  if (memberElement.value === search) {
+    memberElement.value = replace;
+    edges.delete(search);
+    edges.set(replace, memberElement);
+  }
+};
+const transcludeChildOfObjectElement = (search, replace, edges) => {
+  const objectElement = edges.get(search);
+  if (!isObjectElement(objectElement)) {
+    return;
+  }
+  objectElement.content = objectElement.map((value, key, member) => {
+    if (member === search) {
+      edges.delete(search);
+      edges.set(replace, objectElement);
+      return replace;
+    }
+    return member;
+  });
+};
+const transcludeChildOfArrayElement = (search, replace, edges) => {
+  const arrayElement = edges.get(search);
+  if (!isArrayElement(arrayElement)) {
+    return;
+  }
+  arrayElement.content = arrayElement.map(element => {
+    if (element === search) {
+      edges.delete(search);
+      edges.set(replace, arrayElement);
+      return replace;
+    }
+    return element;
+  });
+};
+
+/**
+ * This is a mutating stamp. If you don't want your Element to be mutated,
+ * clone in before passing it to initializer of this stamp.
+ * @public
+ */
+
+class Transcluder {
+  element;
+  edges;
+  constructor({
+    element
+  }) {
+    this.element = element;
+  }
+  transclude(search, replace) {
+    // shortcut 1. - replacing entire ApiDOM tree
+    if (search === this.element) return replace;
+    // shortcut 2. - replacing nothing
+    if (search === replace) return this.element;
+    this.edges = this.edges ?? computeEdges(this.element);
+    const parent = this.edges.get(search);
+    if (isUndefined(parent)) {
+      return undefined;
+    }
+
+    /**
+     * This predicate must be first because ObjectElement extends ArrayElement.
+     * isArrayElement returns true for ObjectElements.
+     * (classical problems with polymorphism)
+     */
+    if (isObjectElement(parent)) {
+      // @ts-ignore
+      transcludeChildOfObjectElement(search, replace, this.edges);
+    } else if (isArrayElement(parent)) {
+      transcludeChildOfArrayElement(search, replace, this.edges);
+    } else if (isMemberElement(parent)) {
+      transcludeChildOfMemberElement(search, replace, this.edges);
+    }
+    return this.element;
+  }
+}
+export default Transcluder;

package/src/transcluder/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.transclude = exports.default = void 0;
+var _Transcluder = _interopRequireDefault(require("./Transcluder.cjs"));
+/**
+ * This is a mutating function. If you don't want your Element to be mutated,
+ * clone in before passing it to this function.
+ * @public
+ */
+const transclude = (search, replace, element) => {
+  const transcluder = new _Transcluder.default({
+    element
+  });
+  return transcluder.transclude(search, replace);
+};
+exports.transclude = transclude;
+var _default = exports.default = _Transcluder.default;

package/src/transcluder/index.mjs

@@ -0,0 +1,13 @@
+import Transcluder from "./Transcluder.mjs";
+/**
+ * This is a mutating function. If you don't want your Element to be mutated,
+ * clone in before passing it to this function.
+ * @public
+ */
+export const transclude = (search, replace, element) => {
+  const transcluder = new Transcluder({
+    element
+  });
+  return transcluder.transclude(search, replace);
+};
+export default Transcluder;

package/src/transformers/dehydrate.cjs

@@ -0,0 +1,15 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _namespace = _interopRequireDefault(require("../namespace.cjs"));
+/**
+ * Creates a refract representation of an Element.
+ * https://github.com/refractproject/refract-spec
+ * @public
+ */
+const dehydrate = (element, namespace = _namespace.default) => {
+  return namespace.toRefract(element);
+};
+var _default = exports.default = dehydrate;

package/src/transformers/dehydrate.mjs

@@ -0,0 +1,10 @@
+import defaultNamespaceInstance from "../namespace.mjs";
+/**
+ * Creates a refract representation of an Element.
+ * https://github.com/refractproject/refract-spec
+ * @public
+ */
+const dehydrate = (element, namespace = defaultNamespaceInstance) => {
+  return namespace.toRefract(element);
+};
+export default dehydrate;

package/src/transformers/from.cjs

@@ -0,0 +1,34 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _ramda = require("ramda");
+var _ramdaAdjunct = require("ramda-adjunct");
+var _namespace = _interopRequireDefault(require("../namespace.cjs"));
+/**
+ * Transforms data to an Element from a particular namespace.
+ *
+ * The name of the function was originally `from`,
+ * but it was renamed to `fromFn` to avoid issues with Parcel.js:
+ *
+ * - https://github.com/parcel-bundler/parcel/issues/9473
+ * - https://github.com/swagger-api/swagger-ui/issues/9466#issuecomment-1881053410
+ * @public
+ */
+const fromFn = (data, namespace = _namespace.default) => {
+  if ((0, _ramdaAdjunct.isString)(data)) {
+    // JSON serialized refract
+    try {
+      return namespace.fromRefract(JSON.parse(data));
+    } catch {
+      // noop
+    }
+  }
+  if ((0, _ramdaAdjunct.isPlainObject)(data) && (0, _ramda.has)('element', data)) {
+    // refract javascript structure
+    return namespace.fromRefract(data);
+  }
+  return namespace.toElement(data);
+};
+var _default = exports.default = fromFn;

package/src/transformers/from.mjs

@@ -0,0 +1,29 @@
+import { has } from 'ramda';
+import { isPlainObject, isString } from 'ramda-adjunct';
+import defaultNamespaceInstance from "../namespace.mjs";
+/**
+ * Transforms data to an Element from a particular namespace.
+ *
+ * The name of the function was originally `from`,
+ * but it was renamed to `fromFn` to avoid issues with Parcel.js:
+ *
+ * - https://github.com/parcel-bundler/parcel/issues/9473
+ * - https://github.com/swagger-api/swagger-ui/issues/9466#issuecomment-1881053410
+ * @public
+ */
+const fromFn = (data, namespace = defaultNamespaceInstance) => {
+  if (isString(data)) {
+    // JSON serialized refract
+    try {
+      return namespace.fromRefract(JSON.parse(data));
+    } catch {
+      // noop
+    }
+  }
+  if (isPlainObject(data) && has('element', data)) {
+    // refract javascript structure
+    return namespace.fromRefract(data);
+  }
+  return namespace.toElement(data);
+};
+export default fromFn;

package/src/transformers/serializers/json.cjs

@@ -0,0 +1,11 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
+exports.__esModule = true;
+exports.default = void 0;
+var _index = _interopRequireDefault(require("./value/index.cjs"));
+/**
+ * @public
+ */
+const serializer = (element, replacer, space) => JSON.stringify((0, _index.default)(element), replacer, space);
+var _default = exports.default = serializer;

package/src/transformers/serializers/json.mjs

@@ -0,0 +1,6 @@
+import serializeValue from "./value/index.mjs";
+/**
+ * @public
+ */
+const serializer = (element, replacer, space) => JSON.stringify(serializeValue(element), replacer, space);
+export default serializer;

package/src/transformers/serializers/value/ast/ephemeral-array.cjs

@@ -0,0 +1,21 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+class EphemeralArray {
+  type = 'EphemeralArray';
+  content = [];
+  reference = undefined;
+  constructor(content) {
+    this.content = content;
+    this.reference = [];
+  }
+  toReference() {
+    return this.reference;
+  }
+  toArray() {
+    this.reference.push(...this.content);
+    return this.reference;
+  }
+}
+var _default = exports.default = EphemeralArray;

package/src/transformers/serializers/value/ast/ephemeral-array.mjs

@@ -0,0 +1,17 @@
+class EphemeralArray {
+  type = 'EphemeralArray';
+  content = [];
+  reference = undefined;
+  constructor(content) {
+    this.content = content;
+    this.reference = [];
+  }
+  toReference() {
+    return this.reference;
+  }
+  toArray() {
+    this.reference.push(...this.content);
+    return this.reference;
+  }
+}
+export default EphemeralArray;

package/src/transformers/serializers/value/ast/ephemeral-object.cjs

@@ -0,0 +1,20 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+class EphemeralObject {
+  type = 'EphemeralObject';
+  content = [];
+  reference = undefined;
+  constructor(content) {
+    this.content = content;
+    this.reference = {};
+  }
+  toReference() {
+    return this.reference;
+  }
+  toObject() {
+    return Object.assign(this.reference, Object.fromEntries(this.content));
+  }
+}
+var _default = exports.default = EphemeralObject;

package/src/transformers/serializers/value/ast/ephemeral-object.mjs

@@ -0,0 +1,16 @@
+class EphemeralObject {
+  type = 'EphemeralObject';
+  content = [];
+  reference = undefined;
+  constructor(content) {
+    this.content = content;
+    this.reference = {};
+  }
+  toReference() {
+    return this.reference;
+  }
+  toObject() {
+    return Object.assign(this.reference, Object.fromEntries(this.content));
+  }
+}
+export default EphemeralObject;