@speclynx/apidom-core 3.2.1 → 4.0.0

package/src/transformers/serializers/json.mjs

@@ -1,70 +0,0 @@
-import { isElement, isObjectElement, isArrayElement, isRefElement, isLinkElement, isStringElement, isNumberElement } from '@speclynx/apidom-datamodel';
-import toValue from "./value.mjs";
-const getStyle = element => {
-  return element.style?.json ?? {};
-};
-
-/**
- * @public
- */
-
-/**
- * Builds a POJO from an ApiDOM element tree. Numbers with rawContent
- * are replaced with sentinel strings; all other values go through toValue().
- */
-const toPojo = (element, sentinels) => {
-  const visited = new WeakSet();
-  const convert = node => {
-    if (!isElement(node)) return node;
-    if (visited.has(node)) return null;
-    visited.add(node);
-    if (isObjectElement(node)) {
-      const obj = {};
-      node.forEach((value, key) => {
-        const k = isElement(key) ? toValue(key) : key;
-        if (typeof k === 'string') obj[k] = convert(value);
-      });
-      return obj;
-    }
-    if (isArrayElement(node)) {
-      const arr = [];
-      node.forEach(item => arr.push(convert(item)));
-      return arr;
-    }
-    if (isRefElement(node)) return String(toValue(node));
-    if (isLinkElement(node)) return isStringElement(node.href) ? toValue(node.href) : '';
-
-    // number with rawContent — substitute with sentinel
-    if (isNumberElement(node)) {
-      const style = getStyle(node);
-      if (typeof style.rawContent === 'string') {
-        const sentinel = `\0RAW${sentinels.size}\0`;
-        sentinels.set(sentinel, style.rawContent);
-        return sentinel;
-      }
-    }
-    return toValue(node);
-  };
-  return convert(element);
-};
-
-/**
- * @public
- */
-const serializer = (element, replacer, space, options) => {
-  if (options?.preserveStyle) {
-    const style = getStyle(element);
-    const indent = typeof space === 'number' ? space : typeof style.indent === 'number' ? style.indent : 0;
-    const sentinels = new Map();
-    const pojo = toPojo(element, sentinels);
-    let serialized = JSON.stringify(pojo, null, indent);
-
-    // replace quoted sentinels with raw number representations
-    for (const [sentinel, raw] of sentinels) {
-      serialized = serialized.replace(JSON.stringify(sentinel), raw);
-    }
-    return serialized;
-  }
-  return JSON.stringify(toValue(element), replacer, space);
-};
-export default serializer;

package/src/transformers/serializers/value.cjs

@@ -1,50 +0,0 @@
-"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

@@ -1,47 +0,0 @@
-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

@@ -1,142 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _yaml = require("yaml");
-var _apidomDatamodel = require("@speclynx/apidom-datamodel");
-var _value = _interopRequireDefault(require("./value.cjs"));
-const getStyle = element => {
-  return element.style?.yaml ?? {};
-};
-
-// map our scalarStyle strings to YAML library Scalar.Type constants
-const scalarStyleMap = {
-  Plain: _yaml.Scalar.PLAIN,
-  SingleQuoted: _yaml.Scalar.QUOTE_SINGLE,
-  DoubleQuoted: _yaml.Scalar.QUOTE_DOUBLE,
-  Literal: _yaml.Scalar.BLOCK_LITERAL,
-  Folded: _yaml.Scalar.BLOCK_FOLDED
-};
-
-// the YAML library prefixes comments with '#' only (no space), so we add ' ' to get '# comment'
-const applyComments = (node, style) => {
-  if (style.comment) node.comment = ` ${style.comment}`;
-  if (style.commentBefore) node.commentBefore = ` ${style.commentBefore}`;
-};
-
-/**
- * @public
- */
-
-/**
- * Converts an ApiDOM element tree to YAML library AST nodes,
- * preserving style information from `element.style.yaml`.
- */
-const toYAMLNode = (element, visited) => {
-  if (!(0, _apidomDatamodel.isElement)(element)) return element;
-
-  // cycle detection
-  if (visited.has(element)) return undefined;
-  visited.add(element);
-  const style = getStyle(element);
-  if ((0, _apidomDatamodel.isObjectElement)(element)) {
-    const map = new _yaml.YAMLMap();
-    map.flow = style.styleGroup === 'Flow';
-    applyComments(map, style);
-    element.forEach((value, key, member) => {
-      const memberStyle = (0, _apidomDatamodel.isMemberElement)(member) ? getStyle(member) : {};
-      const keyNode = toYAMLNode(key, visited);
-      const valueNode = toYAMLNode(value, visited);
-      const pair = new _yaml.Pair(keyNode, valueNode);
-      if (memberStyle.commentBefore && (0, _yaml.isNode)(keyNode)) {
-        keyNode.commentBefore = ` ${memberStyle.commentBefore}`;
-      }
-      if (memberStyle.comment && (0, _yaml.isNode)(valueNode)) {
-        valueNode.comment = ` ${memberStyle.comment}`;
-      }
-      map.items.push(pair);
-    });
-    return map;
-  }
-  if ((0, _apidomDatamodel.isArrayElement)(element)) {
-    const seq = new _yaml.YAMLSeq();
-    seq.flow = style.styleGroup === 'Flow';
-    applyComments(seq, style);
-    element.forEach(item => {
-      seq.items.push(toYAMLNode(item, visited));
-    });
-    return seq;
-  }
-  if ((0, _apidomDatamodel.isRefElement)(element)) {
-    return new _yaml.Scalar(String((0, _value.default)(element)));
-  }
-  if ((0, _apidomDatamodel.isLinkElement)(element)) {
-    return new _yaml.Scalar((0, _apidomDatamodel.isStringElement)(element.href) ? (0, _value.default)(element.href) : '');
-  }
-
-  // scalar element (string, number, boolean, null)
-  const scalarType = style.scalarStyle ? scalarStyleMap[style.scalarStyle] : undefined;
-  const scalar = new _yaml.Scalar((0, _value.default)(element));
-  if (scalarType) {
-    scalar.type = scalarType;
-  }
-
-  // use rawContent to infer YAML library format hints for plain scalars that resolved to numbers;
-  // only applies to Plain style — quoted scalars are always strings in YAML.
-  // note: the YAML library may normalize the representation (e.g. 1.0e10 -> 1e+10, 0x1A -> 0x1a)
-  // while preserving the format category (exponential, hex, octal, fractional digits)
-  if (style.rawContent && style.scalarStyle === 'Plain' && typeof scalar.value === 'number') {
-    if (/[eE]/.test(style.rawContent)) {
-      scalar.format = 'EXP';
-    } else if (/^0x/i.test(style.rawContent)) {
-      scalar.format = 'HEX';
-    } else if (/^0o/i.test(style.rawContent)) {
-      scalar.format = 'OCT';
-    }
-    const dotMatch = style.rawContent.match(/\.(\d+)/);
-    if (dotMatch) {
-      scalar.minFractionDigits = dotMatch[1].length;
-    }
-  }
-  applyComments(scalar, style);
-  return scalar;
-};
-
-/**
- * @public
- */
-const serializer = (element, {
-  directive = false,
-  preserveStyle = false,
-  aliasDuplicateObjects = false,
-  ...options
-} = {}) => {
-  const allOptions = {
-    aliasDuplicateObjects,
-    ...options
-  };
-  if (preserveStyle) {
-    const style = getStyle(element);
-    if (options.indent === undefined && typeof style.indent === 'number') {
-      allOptions.indent = style.indent;
-    }
-    if (typeof style.flowCollectionPadding === 'boolean') {
-      allOptions.flowCollectionPadding = style.flowCollectionPadding;
-    }
-    const rootNode = toYAMLNode(element, new WeakSet());
-    const doc = new _yaml.Document(undefined, allOptions);
-    doc.contents = rootNode;
-    if (directive) {
-      doc.directives.yaml.explicit = true;
-    }
-    return doc.toString(allOptions);
-  }
-  if (directive) {
-    const doc = new _yaml.Document((0, _value.default)(element), allOptions);
-    doc.directives.yaml.explicit = true;
-    return doc.toString(allOptions);
-  }
-  return (0, _yaml.stringify)((0, _value.default)(element), allOptions);
-};
-var _default = exports.default = serializer;

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

@@ -1,137 +0,0 @@
-import { Document, stringify, isNode, Scalar, YAMLMap, YAMLSeq, Pair } from 'yaml';
-import { isElement, isObjectElement, isArrayElement, isRefElement, isLinkElement, isStringElement, isMemberElement } from '@speclynx/apidom-datamodel';
-import toValue from "./value.mjs";
-const getStyle = element => {
-  return element.style?.yaml ?? {};
-};
-
-// map our scalarStyle strings to YAML library Scalar.Type constants
-const scalarStyleMap = {
-  Plain: Scalar.PLAIN,
-  SingleQuoted: Scalar.QUOTE_SINGLE,
-  DoubleQuoted: Scalar.QUOTE_DOUBLE,
-  Literal: Scalar.BLOCK_LITERAL,
-  Folded: Scalar.BLOCK_FOLDED
-};
-
-// the YAML library prefixes comments with '#' only (no space), so we add ' ' to get '# comment'
-const applyComments = (node, style) => {
-  if (style.comment) node.comment = ` ${style.comment}`;
-  if (style.commentBefore) node.commentBefore = ` ${style.commentBefore}`;
-};
-
-/**
- * @public
- */
-
-/**
- * Converts an ApiDOM element tree to YAML library AST nodes,
- * preserving style information from `element.style.yaml`.
- */
-const toYAMLNode = (element, visited) => {
-  if (!isElement(element)) return element;
-
-  // cycle detection
-  if (visited.has(element)) return undefined;
-  visited.add(element);
-  const style = getStyle(element);
-  if (isObjectElement(element)) {
-    const map = new YAMLMap();
-    map.flow = style.styleGroup === 'Flow';
-    applyComments(map, style);
-    element.forEach((value, key, member) => {
-      const memberStyle = isMemberElement(member) ? getStyle(member) : {};
-      const keyNode = toYAMLNode(key, visited);
-      const valueNode = toYAMLNode(value, visited);
-      const pair = new Pair(keyNode, valueNode);
-      if (memberStyle.commentBefore && isNode(keyNode)) {
-        keyNode.commentBefore = ` ${memberStyle.commentBefore}`;
-      }
-      if (memberStyle.comment && isNode(valueNode)) {
-        valueNode.comment = ` ${memberStyle.comment}`;
-      }
-      map.items.push(pair);
-    });
-    return map;
-  }
-  if (isArrayElement(element)) {
-    const seq = new YAMLSeq();
-    seq.flow = style.styleGroup === 'Flow';
-    applyComments(seq, style);
-    element.forEach(item => {
-      seq.items.push(toYAMLNode(item, visited));
-    });
-    return seq;
-  }
-  if (isRefElement(element)) {
-    return new Scalar(String(toValue(element)));
-  }
-  if (isLinkElement(element)) {
-    return new Scalar(isStringElement(element.href) ? toValue(element.href) : '');
-  }
-
-  // scalar element (string, number, boolean, null)
-  const scalarType = style.scalarStyle ? scalarStyleMap[style.scalarStyle] : undefined;
-  const scalar = new Scalar(toValue(element));
-  if (scalarType) {
-    scalar.type = scalarType;
-  }
-
-  // use rawContent to infer YAML library format hints for plain scalars that resolved to numbers;
-  // only applies to Plain style — quoted scalars are always strings in YAML.
-  // note: the YAML library may normalize the representation (e.g. 1.0e10 -> 1e+10, 0x1A -> 0x1a)
-  // while preserving the format category (exponential, hex, octal, fractional digits)
-  if (style.rawContent && style.scalarStyle === 'Plain' && typeof scalar.value === 'number') {
-    if (/[eE]/.test(style.rawContent)) {
-      scalar.format = 'EXP';
-    } else if (/^0x/i.test(style.rawContent)) {
-      scalar.format = 'HEX';
-    } else if (/^0o/i.test(style.rawContent)) {
-      scalar.format = 'OCT';
-    }
-    const dotMatch = style.rawContent.match(/\.(\d+)/);
-    if (dotMatch) {
-      scalar.minFractionDigits = dotMatch[1].length;
-    }
-  }
-  applyComments(scalar, style);
-  return scalar;
-};
-
-/**
- * @public
- */
-const serializer = (element, {
-  directive = false,
-  preserveStyle = false,
-  aliasDuplicateObjects = false,
-  ...options
-} = {}) => {
-  const allOptions = {
-    aliasDuplicateObjects,
-    ...options
-  };
-  if (preserveStyle) {
-    const style = getStyle(element);
-    if (options.indent === undefined && typeof style.indent === 'number') {
-      allOptions.indent = style.indent;
-    }
-    if (typeof style.flowCollectionPadding === 'boolean') {
-      allOptions.flowCollectionPadding = style.flowCollectionPadding;
-    }
-    const rootNode = toYAMLNode(element, new WeakSet());
-    const doc = new Document(undefined, allOptions);
-    doc.contents = rootNode;
-    if (directive) {
-      doc.directives.yaml.explicit = true;
-    }
-    return doc.toString(allOptions);
-  }
-  if (directive) {
-    const doc = new Document(toValue(element), allOptions);
-    doc.directives.yaml.explicit = true;
-    return doc.toString(allOptions);
-  }
-  return stringify(toValue(element), allOptions);
-};
-export default serializer;

package/src/transformers/sexprs.cjs

@@ -1,31 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports.default = void 0;
-var _apidomTraverse = require("@speclynx/apidom-traverse");
-/**
- * Transforms ApiDOM into S-expressions (Symbolic Expressions).
- * @public
- */
-const sexprs = element => {
-  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,28 +0,0 @@
-import { traverse } from '@speclynx/apidom-traverse';
-
-/**
- * Transforms ApiDOM into S-expressions (Symbolic Expressions).
- * @public
- */
-const sexprs = element => {
-  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.cjs

@@ -1,16 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
-exports.__esModule = true;
-exports.default = void 0;
-var _namespace = _interopRequireDefault(require("../namespace.cjs"));
-var _dehydrate = _interopRequireDefault(require("./dehydrate.cjs"));
-/**
- * Create a refracted string representation of an Element.
- * @public
- */
-const toString = (element, namespace = _namespace.default) => {
-  const refractStructure = (0, _dehydrate.default)(element, namespace);
-  return JSON.stringify(refractStructure);
-};
-var _default = exports.default = toString;

package/src/transformers/to-string.mjs

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