@speclynx/apidom-core 1.12.2 → 2.0.1

package/src/refractor/toolbox.mjs

@@ -1,21 +1,40 @@
-import * as basePredicates from "../predicates/index.mjs";
-import defaultNamespaceInstance from "../namespace.mjs";
+import { isElement, isStringElement, isNumberElement, isNullElement, isBooleanElement, isArrayElement, isObjectElement, isMemberElement, isPrimitiveElement, isLinkElement, isRefElement, isAnnotationElement, isCommentElement, isParseResultElement, isSourceMapElement, hasElementSourceMap, includesSymbols, includesClasses } from '@speclynx/apidom-datamodel';
+import defaultNamespace from "../namespace.mjs";
 /**
  * @public
  */
+const predicates = {
+  isElement,
+  isStringElement,
+  isNumberElement,
+  isNullElement,
+  isBooleanElement,
+  isArrayElement,
+  isObjectElement,
+  isMemberElement,
+  isPrimitiveElement,
+  isLinkElement,
+  isRefElement,
+  isAnnotationElement,
+  isCommentElement,
+  isParseResultElement,
+  isSourceMapElement,
+  hasElementSourceMap,
+  includesSymbols,
+  includesClasses
+};
+
 /**
  * @public
  */
+
 /**
  * @public
  */
 const createToolbox = () => {
-  const predicates = {
-    ...basePredicates
-  };
   return {
     predicates,
-    namespace: defaultNamespaceInstance
+    namespace: defaultNamespace
   };
 };
 export default createToolbox;

package/src/specification.cjs

@@ -0,0 +1,51 @@
+"use strict";
+
+exports.__esModule = true;
+exports.resolveSpecification = void 0;
+var _ramda = require("ramda");
+var _ramdaAdjunct = require("ramda-adjunct");
+/**
+ * Base type for resolved specification objects.
+ * Extend this in namespace packages to add specific type information.
+ * @public
+ */
+
+const specCache = new WeakMap();
+
+/**
+ * Resolves a specification object by:
+ * 1. Dereferencing all $ref pointers
+ * 2. Building elementMap from objects with `element` property
+ * 3. Caching results for efficiency
+ *
+ * @public
+ */
+const resolveSpecification = specification => {
+  if (specCache.has(specification)) {
+    return specCache.get(specification);
+  }
+  const elementMap = {};
+  const traverse = (obj, root, currentPath) => {
+    // Collect element mapping
+    if (typeof obj.element === 'string') {
+      elementMap[obj.element] = obj.$visitor ? [...currentPath, '$visitor'] : currentPath;
+    }
+    return (0, _ramda.mapObjIndexed)((val, key) => {
+      const newPath = [...currentPath, key];
+      if ((0, _ramdaAdjunct.isPlainObject)(val) && (0, _ramda.has)('$ref', val) && (0, _ramda.propSatisfies)(_ramdaAdjunct.isString, '$ref', val)) {
+        const $ref = (0, _ramda.path)(['$ref'], val);
+        const pointer = (0, _ramdaAdjunct.trimCharsStart)('#/', $ref);
+        return (0, _ramda.path)(pointer.split('/'), root);
+      }
+      if ((0, _ramdaAdjunct.isPlainObject)(val)) {
+        return traverse(val, root, newPath);
+      }
+      return val;
+    }, obj);
+  };
+  const resolved = traverse(specification, specification, []);
+  resolved.elementMap = elementMap;
+  specCache.set(specification, resolved);
+  return resolved;
+};
+exports.resolveSpecification = resolveSpecification;

package/src/specification.mjs

@@ -0,0 +1,47 @@
+import { mapObjIndexed, path, has, propSatisfies } from 'ramda';
+import { isPlainObject, trimCharsStart, isString } from 'ramda-adjunct';
+
+/**
+ * Base type for resolved specification objects.
+ * Extend this in namespace packages to add specific type information.
+ * @public
+ */
+
+const specCache = new WeakMap();
+
+/**
+ * Resolves a specification object by:
+ * 1. Dereferencing all $ref pointers
+ * 2. Building elementMap from objects with `element` property
+ * 3. Caching results for efficiency
+ *
+ * @public
+ */
+export const resolveSpecification = specification => {
+  if (specCache.has(specification)) {
+    return specCache.get(specification);
+  }
+  const elementMap = {};
+  const traverse = (obj, root, currentPath) => {
+    // Collect element mapping
+    if (typeof obj.element === 'string') {
+      elementMap[obj.element] = obj.$visitor ? [...currentPath, '$visitor'] : currentPath;
+    }
+    return mapObjIndexed((val, key) => {
+      const newPath = [...currentPath, key];
+      if (isPlainObject(val) && has('$ref', val) && propSatisfies(isString, '$ref', val)) {
+        const $ref = path(['$ref'], val);
+        const pointer = trimCharsStart('#/', $ref);
+        return path(pointer.split('/'), root);
+      }
+      if (isPlainObject(val)) {
+        return traverse(val, root, newPath);
+      }
+      return val;
+    }, obj);
+  };
+  const resolved = traverse(specification, specification, []);
+  resolved.elementMap = elementMap;
+  specCache.set(specification, resolved);
+  return resolved;
+};

package/src/transcluder/Transcluder.cjs

@@ -2,10 +2,10 @@
 
 exports.__esModule = true;
 exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _ramdaAdjunct = require("ramda-adjunct");
-var _index = require("../predicates/index.cjs");
 const computeEdges = (element, edges = new WeakMap()) => {
-  if ((0, _index.isMemberElement)(element)) {
+  if ((0, _apidomDatamodel.isMemberElement)(element)) {
     // @ts-ignore
     edges.set(element.key, element);
     // @ts-ignore
@@ -24,7 +24,7 @@ const computeEdges = (element, edges = new WeakMap()) => {
 };
 const transcludeChildOfMemberElement = (search, replace, edges) => {
   const memberElement = edges.get(search);
-  if (!(0, _index.isMemberElement)(memberElement)) {
+  if (!(0, _apidomDatamodel.isMemberElement)(memberElement)) {
     return;
   }
   if (memberElement.key === search) {
@@ -40,7 +40,7 @@ const transcludeChildOfMemberElement = (search, replace, edges) => {
 };
 const transcludeChildOfObjectElement = (search, replace, edges) => {
   const objectElement = edges.get(search);
-  if (!(0, _index.isObjectElement)(objectElement)) {
+  if (!(0, _apidomDatamodel.isObjectElement)(objectElement)) {
     return;
   }
   objectElement.content = objectElement.map((value, key, member) => {
@@ -54,7 +54,7 @@ const transcludeChildOfObjectElement = (search, replace, edges) => {
 };
 const transcludeChildOfArrayElement = (search, replace, edges) => {
   const arrayElement = edges.get(search);
-  if (!(0, _index.isArrayElement)(arrayElement)) {
+  if (!(0, _apidomDatamodel.isArrayElement)(arrayElement)) {
     return;
   }
   arrayElement.content = arrayElement.map(element => {
@@ -97,12 +97,12 @@ class Transcluder {
      * isArrayElement returns true for ObjectElements.
      * (classical problems with polymorphism)
      */
-    if ((0, _index.isObjectElement)(parent)) {
+    if ((0, _apidomDatamodel.isObjectElement)(parent)) {
       // @ts-ignore
       transcludeChildOfObjectElement(search, replace, this.edges);
-    } else if ((0, _index.isArrayElement)(parent)) {
+    } else if ((0, _apidomDatamodel.isArrayElement)(parent)) {
       transcludeChildOfArrayElement(search, replace, this.edges);
-    } else if ((0, _index.isMemberElement)(parent)) {
+    } else if ((0, _apidomDatamodel.isMemberElement)(parent)) {
       transcludeChildOfMemberElement(search, replace, this.edges);
     }
     return this.element;

package/src/transcluder/Transcluder.mjs

@@ -1,5 +1,5 @@
+import { isObjectElement, isArrayElement, isMemberElement } from '@speclynx/apidom-datamodel';
 import { isUndefined } from 'ramda-adjunct';
-import { isObjectElement, isArrayElement, isMemberElement } from "../predicates/index.mjs";
 const computeEdges = (element, edges = new WeakMap()) => {
   if (isMemberElement(element)) {
     // @ts-ignore

package/src/transformers/from.mjs

@@ -1,6 +1,6 @@
 import { has } from 'ramda';
 import { isPlainObject, isString } from 'ramda-adjunct';
-import defaultNamespaceInstance from "../namespace.mjs";
+import defaultNamespace from "../namespace.mjs";
 /**
  * Transforms data to an Element from a particular namespace.
  *
@@ -11,7 +11,7 @@ import defaultNamespaceInstance from "../namespace.mjs";
  * - https://github.com/swagger-api/swagger-ui/issues/9466#issuecomment-1881053410
  * @public
  */
-const fromFn = (data, namespace = defaultNamespaceInstance) => {
+const fromFn = (data, namespace = defaultNamespace) => {
   if (isString(data)) {
     // JSON serialized refract
     try {

package/src/transformers/serializers/json.cjs

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

package/src/transformers/serializers/json.mjs

@@ -1,4 +1,4 @@
-import serializeValue from "./value/index.mjs";
+import serializeValue from "./value.mjs";
 /**
  * @public
  */

package/src/transformers/serializers/value.cjs

@@ -0,0 +1,50 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+/**
+ * Transforms the ApiDOM into JavaScript POJO.
+ * This POJO would be the result of interpreting the ApiDOM
+ * into JavaScript structure.
+ * @public
+ */
+const serializer = element => {
+  if (!(0, _apidomDatamodel.isElement)(element)) return element;
+
+  // Shortcut optimization for primitive element types
+  if ((0, _apidomDatamodel.isStringElement)(element) || (0, _apidomDatamodel.isNumberElement)(element) || (0, _apidomDatamodel.isBooleanElement)(element) || (0, _apidomDatamodel.isNullElement)(element)) {
+    return element.toValue();
+  }
+
+  // WeakMap for cycle handling - stores references to already-visited elements
+  const references = new WeakMap();
+  const serialize = node => {
+    if (!(0, _apidomDatamodel.isElement)(node)) return node;
+    if ((0, _apidomDatamodel.isObjectElement)(node)) {
+      if (references.has(node)) return references.get(node);
+      const obj = {};
+      references.set(node, obj);
+      node.forEach((value, key) => {
+        const k = serialize(key);
+        const v = serialize(value);
+        if (typeof k === 'string') obj[k] = v;
+      });
+      return obj;
+    }
+    if ((0, _apidomDatamodel.isArrayElement)(node)) {
+      if (references.has(node)) return references.get(node);
+      const arr = [];
+      references.set(node, arr);
+      node.forEach(item => arr.push(serialize(item)));
+      return arr;
+    }
+    if ((0, _apidomDatamodel.isRefElement)(node)) return String(node.toValue());
+    if ((0, _apidomDatamodel.isLinkElement)(node)) {
+      return (0, _apidomDatamodel.isStringElement)(node.href) ? node.href.toValue() : '';
+    }
+    return node.toValue();
+  };
+  return serialize(element);
+};
+var _default = exports.default = serializer;

package/src/transformers/serializers/value.mjs

@@ -0,0 +1,47 @@
+import { isElement, isObjectElement, isArrayElement, isRefElement, isLinkElement, isStringElement, isBooleanElement, isNumberElement, isNullElement } from '@speclynx/apidom-datamodel';
+
+/**
+ * Transforms the ApiDOM into JavaScript POJO.
+ * This POJO would be the result of interpreting the ApiDOM
+ * into JavaScript structure.
+ * @public
+ */
+const serializer = element => {
+  if (!isElement(element)) return element;
+
+  // Shortcut optimization for primitive element types
+  if (isStringElement(element) || isNumberElement(element) || isBooleanElement(element) || isNullElement(element)) {
+    return element.toValue();
+  }
+
+  // WeakMap for cycle handling - stores references to already-visited elements
+  const references = new WeakMap();
+  const serialize = node => {
+    if (!isElement(node)) return node;
+    if (isObjectElement(node)) {
+      if (references.has(node)) return references.get(node);
+      const obj = {};
+      references.set(node, obj);
+      node.forEach((value, key) => {
+        const k = serialize(key);
+        const v = serialize(value);
+        if (typeof k === 'string') obj[k] = v;
+      });
+      return obj;
+    }
+    if (isArrayElement(node)) {
+      if (references.has(node)) return references.get(node);
+      const arr = [];
+      references.set(node, arr);
+      node.forEach(item => arr.push(serialize(item)));
+      return arr;
+    }
+    if (isRefElement(node)) return String(node.toValue());
+    if (isLinkElement(node)) {
+      return isStringElement(node.href) ? node.href.toValue() : '';
+    }
+    return node.toValue();
+  };
+  return serialize(element);
+};
+export default serializer;

package/src/transformers/serializers/yaml-1-2.cjs

@@ -3,8 +3,8 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _visitor = require("../../traversal/visitor.cjs");
-var _index = _interopRequireDefault(require("./value/index.cjs"));
+var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _value = _interopRequireDefault(require("./value.cjs"));
 class YamlVisitor {
   static indentChar = '  ';
   result;
@@ -16,42 +16,46 @@ class YamlVisitor {
     this.result = directive ? '%YAML 1.2\n---\n' : '';
     this.indent = indent;
   }
-  NumberElement(element) {
-    this.result += (0, _index.default)(element);
+  NumberElement(path) {
+    this.result += (0, _value.default)(path.node);
   }
-  BooleanElement(element) {
-    const value = (0, _index.default)(element);
+  BooleanElement(path) {
+    const value = (0, _value.default)(path.node);
     this.result += value ? 'true' : 'false';
   }
-  StringElement(element) {
+  StringElement(path) {
     // for simplicity and avoiding ambiguity we always wrap strings in quotes
-    this.result += JSON.stringify((0, _index.default)(element));
+    this.result += JSON.stringify((0, _value.default)(path.node));
   }
   NullElement() {
     this.result += 'null';
   }
-  ArrayElement(element) {
+  ArrayElement(path) {
+    const element = path.node;
     if (element.length === 0) {
       this.result += '[]';
-      return false;
+      path.skip();
+      return;
     }
     element.forEach(item => {
       const visitor = new YamlVisitor({
         indent: this.indent + 1
       });
       const indent = YamlVisitor.indentChar.repeat(this.indent);
-      (0, _visitor.visit)(item, visitor);
+      (0, _apidomTraverse.traverse)(item, visitor);
       const {
         result
       } = visitor;
       this.result += result.startsWith('\n') ? `\n${indent}-${result}` : `\n${indent}- ${result}`;
     });
-    return false;
+    path.skip();
   }
-  ObjectElement(element) {
+  ObjectElement(path) {
+    const element = path.node;
     if (element.length === 0) {
       this.result += '{}';
-      return false;
+      path.skip();
+      return;
     }
     element.forEach((value, key) => {
       const keyVisitor = new YamlVisitor({
@@ -61,8 +65,8 @@ class YamlVisitor {
         indent: this.indent + 1
       });
       const indent = YamlVisitor.indentChar.repeat(this.indent);
-      (0, _visitor.visit)(key, keyVisitor);
-      (0, _visitor.visit)(value, valueVisitor);
+      (0, _apidomTraverse.traverse)(key, keyVisitor);
+      (0, _apidomTraverse.traverse)(value, valueVisitor);
       const {
         result: keyResult
       } = keyVisitor;
@@ -71,7 +75,7 @@ class YamlVisitor {
       } = valueVisitor;
       this.result += valueResult.startsWith('\n') ? `\n${indent}${keyResult}:${valueResult}` : `\n${indent}${keyResult}: ${valueResult}`;
     });
-    return false;
+    path.skip();
   }
 }
 
@@ -84,7 +88,7 @@ const serializer = (element, {
   const visitor = new YamlVisitor({
     directive
   });
-  (0, _visitor.visit)(element, visitor);
+  (0, _apidomTraverse.traverse)(element, visitor);
   return visitor.result;
 };
 var _default = exports.default = serializer;

package/src/transformers/serializers/yaml-1-2.mjs

@@ -1,5 +1,5 @@
-import { visit } from "../../traversal/visitor.mjs";
-import serializeValue from "./value/index.mjs";
+import { traverse } from '@speclynx/apidom-traverse';
+import serializeValue from "./value.mjs";
 class YamlVisitor {
   static indentChar = '  ';
   result;
@@ -11,42 +11,46 @@ class YamlVisitor {
     this.result = directive ? '%YAML 1.2\n---\n' : '';
     this.indent = indent;
   }
-  NumberElement(element) {
-    this.result += serializeValue(element);
+  NumberElement(path) {
+    this.result += serializeValue(path.node);
   }
-  BooleanElement(element) {
-    const value = serializeValue(element);
+  BooleanElement(path) {
+    const value = serializeValue(path.node);
     this.result += value ? 'true' : 'false';
   }
-  StringElement(element) {
+  StringElement(path) {
     // for simplicity and avoiding ambiguity we always wrap strings in quotes
-    this.result += JSON.stringify(serializeValue(element));
+    this.result += JSON.stringify(serializeValue(path.node));
   }
   NullElement() {
     this.result += 'null';
   }
-  ArrayElement(element) {
+  ArrayElement(path) {
+    const element = path.node;
     if (element.length === 0) {
       this.result += '[]';
-      return false;
+      path.skip();
+      return;
     }
     element.forEach(item => {
       const visitor = new YamlVisitor({
         indent: this.indent + 1
       });
       const indent = YamlVisitor.indentChar.repeat(this.indent);
-      visit(item, visitor);
+      traverse(item, visitor);
       const {
         result
       } = visitor;
       this.result += result.startsWith('\n') ? `\n${indent}-${result}` : `\n${indent}- ${result}`;
     });
-    return false;
+    path.skip();
   }
-  ObjectElement(element) {
+  ObjectElement(path) {
+    const element = path.node;
     if (element.length === 0) {
       this.result += '{}';
-      return false;
+      path.skip();
+      return;
     }
     element.forEach((value, key) => {
       const keyVisitor = new YamlVisitor({
@@ -56,8 +60,8 @@ class YamlVisitor {
         indent: this.indent + 1
       });
       const indent = YamlVisitor.indentChar.repeat(this.indent);
-      visit(key, keyVisitor);
-      visit(value, valueVisitor);
+      traverse(key, keyVisitor);
+      traverse(value, valueVisitor);
       const {
         result: keyResult
       } = keyVisitor;
@@ -66,7 +70,7 @@ class YamlVisitor {
       } = valueVisitor;
       this.result += valueResult.startsWith('\n') ? `\n${indent}${keyResult}:${valueResult}` : `\n${indent}${keyResult}: ${valueResult}`;
     });
-    return false;
+    path.skip();
   }
 }
 
@@ -79,7 +83,7 @@ const serializer = (element, {
   const visitor = new YamlVisitor({
     directive
   });
-  visit(element, visitor);
+  traverse(element, visitor);
   return visitor.result;
 };
 export default serializer;

package/src/transformers/sexprs.cjs

@@ -2,33 +2,30 @@
 
 exports.__esModule = true;
 exports.default = void 0;
-var _visitor = require("../traversal/visitor.cjs");
-class SymbolicExpressionsVisitor {
-  result = '';
-  nestingLevel = 0;
-  enter(element) {
-    const {
-      element: elementName
-    } = element;
-    const capitalizedElementName = elementName.charAt(0).toUpperCase() + elementName.slice(1);
-    const indent = '  '.repeat(this.nestingLevel);
-    this.result += this.nestingLevel > 0 ? '\n' : '';
-    this.result += `${indent}(${capitalizedElementName}Element`;
-    this.nestingLevel += 1;
-  }
-  leave() {
-    this.nestingLevel -= 1;
-    this.result += ')';
-  }
-}
-
+var _apidomTraverse = require("@speclynx/apidom-traverse");
 /**
  * Transforms ApiDOM into S-expressions (Symbolic Expressions).
  * @public
  */
 const sexprs = element => {
-  const visitor = new SymbolicExpressionsVisitor();
-  (0, _visitor.visit)(element, visitor);
-  return visitor.result;
+  let result = '';
+  let nestingLevel = 0;
+  (0, _apidomTraverse.traverse)(element, {
+    enter(path) {
+      const {
+        element: elementName
+      } = path.node;
+      const capitalizedElementName = elementName.charAt(0).toUpperCase() + elementName.slice(1);
+      const indent = '  '.repeat(nestingLevel);
+      result += nestingLevel > 0 ? '\n' : '';
+      result += `${indent}(${capitalizedElementName}Element`;
+      nestingLevel += 1;
+    },
+    leave() {
+      nestingLevel -= 1;
+      result += ')';
+    }
+  });
+  return result;
 };
 var _default = exports.default = sexprs;

package/src/transformers/sexprs.mjs

@@ -1,30 +1,28 @@
-import { visit } from "../traversal/visitor.mjs";
-class SymbolicExpressionsVisitor {
-  result = '';
-  nestingLevel = 0;
-  enter(element) {
-    const {
-      element: elementName
-    } = element;
-    const capitalizedElementName = elementName.charAt(0).toUpperCase() + elementName.slice(1);
-    const indent = '  '.repeat(this.nestingLevel);
-    this.result += this.nestingLevel > 0 ? '\n' : '';
-    this.result += `${indent}(${capitalizedElementName}Element`;
-    this.nestingLevel += 1;
-  }
-  leave() {
-    this.nestingLevel -= 1;
-    this.result += ')';
-  }
-}
+import { traverse } from '@speclynx/apidom-traverse';
 
 /**
  * Transforms ApiDOM into S-expressions (Symbolic Expressions).
  * @public
  */
 const sexprs = element => {
-  const visitor = new SymbolicExpressionsVisitor();
-  visit(element, visitor);
-  return visitor.result;
+  let result = '';
+  let nestingLevel = 0;
+  traverse(element, {
+    enter(path) {
+      const {
+        element: elementName
+      } = path.node;
+      const capitalizedElementName = elementName.charAt(0).toUpperCase() + elementName.slice(1);
+      const indent = '  '.repeat(nestingLevel);
+      result += nestingLevel > 0 ? '\n' : '';
+      result += `${indent}(${capitalizedElementName}Element`;
+      nestingLevel += 1;
+    },
+    leave() {
+      nestingLevel -= 1;
+      result += ')';
+    }
+  });
+  return result;
 };
 export default sexprs;

package/src/transformers/to-string.mjs

@@ -1,10 +1,10 @@
-import defaultNamespaceInstance from "../namespace.mjs";
+import defaultNamespace from "../namespace.mjs";
 import dehydrate from "./dehydrate.mjs";
 /**
  * Create a refracted string representation of an Element.
  * @public
  */
-const toString = (element, namespace = defaultNamespaceInstance) => {
+const toString = (element, namespace = defaultNamespace) => {
   const refractStructure = dehydrate(element, namespace);
   return JSON.stringify(refractStructure);
 };