@speclynx/apidom-core 2.2.0 → 2.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@speclynx/apidom-core",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "Tools for manipulating ApiDOM structures.",
   "publishConfig": {
     "access": "public",
@@ -40,13 +40,14 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@babel/runtime-corejs3": "^7.28.4",
-    "@speclynx/apidom-datamodel": "^2.2.0",
-    "@speclynx/apidom-error": "^2.2.0",
-    "@speclynx/apidom-traverse": "^2.2.0",
+    "@speclynx/apidom-datamodel": "^2.2.2",
+    "@speclynx/apidom-error": "^2.2.2",
+    "@speclynx/apidom-traverse": "^2.2.2",
     "ramda": "~0.32.0",
     "ramda-adjunct": "^6.0.0",
     "short-unique-id": "^5.3.2",
-    "ts-mixer": "^6.0.4"
+    "ts-mixer": "^6.0.4",
+    "yaml": "^2.8.2"
   },
   "files": [
     "src/**/*.mjs",
@@ -58,5 +59,5 @@
     "README.md",
     "CHANGELOG.md"
   ],
-  "gitHead": "a3bfd57f83437ee123f2ef3175aedf30dd860b67"
+  "gitHead": "220dbc19c94e58d28ea05d05c4eaf2f5dc0c5fbc"
 }

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

@@ -3,92 +3,29 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _apidomTraverse = require("@speclynx/apidom-traverse");
+var _yaml = require("yaml");
 var _value = _interopRequireDefault(require("./value.cjs"));
-class YamlVisitor {
-  static indentChar = '  ';
-  result;
-  indent;
-  constructor({
-    directive = false,
-    indent = 0
-  } = {}) {
-    this.result = directive ? '%YAML 1.2\n---\n' : '';
-    this.indent = indent;
-  }
-  NumberElement(path) {
-    this.result += (0, _value.default)(path.node);
-  }
-  BooleanElement(path) {
-    const value = (0, _value.default)(path.node);
-    this.result += value ? 'true' : 'false';
-  }
-  StringElement(path) {
-    // for simplicity and avoiding ambiguity we always wrap strings in quotes
-    this.result += JSON.stringify((0, _value.default)(path.node));
-  }
-  NullElement() {
-    this.result += 'null';
-  }
-  ArrayElement(path) {
-    const element = path.node;
-    if (element.length === 0) {
-      this.result += '[]';
-      path.skip();
-      return;
-    }
-    element.forEach(item => {
-      const visitor = new YamlVisitor({
-        indent: this.indent + 1
-      });
-      const indent = YamlVisitor.indentChar.repeat(this.indent);
-      (0, _apidomTraverse.traverse)(item, visitor);
-      const {
-        result
-      } = visitor;
-      this.result += result.startsWith('\n') ? `\n${indent}-${result}` : `\n${indent}- ${result}`;
-    });
-    path.skip();
-  }
-  ObjectElement(path) {
-    const element = path.node;
-    if (element.length === 0) {
-      this.result += '{}';
-      path.skip();
-      return;
-    }
-    element.forEach((value, key) => {
-      const keyVisitor = new YamlVisitor({
-        indent: this.indent + 1
-      });
-      const valueVisitor = new YamlVisitor({
-        indent: this.indent + 1
-      });
-      const indent = YamlVisitor.indentChar.repeat(this.indent);
-      (0, _apidomTraverse.traverse)(key, keyVisitor);
-      (0, _apidomTraverse.traverse)(value, valueVisitor);
-      const {
-        result: keyResult
-      } = keyVisitor;
-      const {
-        result: valueResult
-      } = valueVisitor;
-      this.result += valueResult.startsWith('\n') ? `\n${indent}${keyResult}:${valueResult}` : `\n${indent}${keyResult}: ${valueResult}`;
-    });
-    path.skip();
-  }
-}
+/**
+ * @public
+ */
 
 /**
  * @public
  */
 const serializer = (element, {
-  directive = false
+  directive = false,
+  aliasDuplicateObjects = false,
+  ...options
 } = {}) => {
-  const visitor = new YamlVisitor({
-    directive
-  });
-  (0, _apidomTraverse.traverse)(element, visitor);
-  return visitor.result;
+  const allOptions = {
+    aliasDuplicateObjects,
+    ...options
+  };
+  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,89 +1,25 @@
-import { traverse } from '@speclynx/apidom-traverse';
-import serializeValue from "./value.mjs";
-class YamlVisitor {
-  static indentChar = '  ';
-  result;
-  indent;
-  constructor({
-    directive = false,
-    indent = 0
-  } = {}) {
-    this.result = directive ? '%YAML 1.2\n---\n' : '';
-    this.indent = indent;
-  }
-  NumberElement(path) {
-    this.result += serializeValue(path.node);
-  }
-  BooleanElement(path) {
-    const value = serializeValue(path.node);
-    this.result += value ? 'true' : 'false';
-  }
-  StringElement(path) {
-    // for simplicity and avoiding ambiguity we always wrap strings in quotes
-    this.result += JSON.stringify(serializeValue(path.node));
-  }
-  NullElement() {
-    this.result += 'null';
-  }
-  ArrayElement(path) {
-    const element = path.node;
-    if (element.length === 0) {
-      this.result += '[]';
-      path.skip();
-      return;
-    }
-    element.forEach(item => {
-      const visitor = new YamlVisitor({
-        indent: this.indent + 1
-      });
-      const indent = YamlVisitor.indentChar.repeat(this.indent);
-      traverse(item, visitor);
-      const {
-        result
-      } = visitor;
-      this.result += result.startsWith('\n') ? `\n${indent}-${result}` : `\n${indent}- ${result}`;
-    });
-    path.skip();
-  }
-  ObjectElement(path) {
-    const element = path.node;
-    if (element.length === 0) {
-      this.result += '{}';
-      path.skip();
-      return;
-    }
-    element.forEach((value, key) => {
-      const keyVisitor = new YamlVisitor({
-        indent: this.indent + 1
-      });
-      const valueVisitor = new YamlVisitor({
-        indent: this.indent + 1
-      });
-      const indent = YamlVisitor.indentChar.repeat(this.indent);
-      traverse(key, keyVisitor);
-      traverse(value, valueVisitor);
-      const {
-        result: keyResult
-      } = keyVisitor;
-      const {
-        result: valueResult
-      } = valueVisitor;
-      this.result += valueResult.startsWith('\n') ? `\n${indent}${keyResult}:${valueResult}` : `\n${indent}${keyResult}: ${valueResult}`;
-    });
-    path.skip();
-  }
-}
-
+import { Document, stringify } from 'yaml';
+import toValue from "./value.mjs";
+/**
+ * @public
+ */
 /**
  * @public
  */
 const serializer = (element, {
-  directive = false
+  directive = false,
+  aliasDuplicateObjects = false,
+  ...options
 } = {}) => {
-  const visitor = new YamlVisitor({
-    directive
-  });
-  traverse(element, visitor);
-  return visitor.result;
+  const allOptions = {
+    aliasDuplicateObjects,
+    ...options
+  };
+  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/types/apidom-core.d.ts

@@ -1,6 +1,8 @@
 import type { ApiDOMErrorOptions } from '@speclynx/apidom-error';
 import { ApiDOMStructuredError } from '@speclynx/apidom-error';
 import { ArrayElement } from '@speclynx/apidom-datamodel';
+import { CreateNodeOptions } from 'yaml';
+import { DocumentOptions } from 'yaml';
 import { Element as Element_2 } from '@speclynx/apidom-datamodel';
 import { hasElementSourceMap } from '@speclynx/apidom-datamodel';
 import { includesClasses } from '@speclynx/apidom-datamodel';
@@ -23,8 +25,10 @@ import { isStringElement } from '@speclynx/apidom-datamodel';
 import { Namespace } from '@speclynx/apidom-datamodel';
 import { ObjectElement } from '@speclynx/apidom-datamodel';
 import { Path } from '@speclynx/apidom-traverse';
+import { SchemaOptions } from 'yaml';
 import ShortUniqueId from 'short-unique-id';
 import { StringElement } from '@speclynx/apidom-datamodel';
+import { ToStringOptions } from 'yaml';
 
 /**
  * @public
@@ -326,9 +330,7 @@ export declare const toValue: <T extends Element_2 | unknown>(element: T) => unk
 /**
  * @public
  */
-export declare const toYAML: (element: Element_2, { directive }?: {
-    directive?: boolean | undefined;
-}) => string;
+export declare const toYAML: (element: Element_2, { directive, aliasDuplicateObjects, ...options }?: YamlSerializerOptions) => string;
 
 /**
  * This is a mutating function. If you don't want your Element to be mutated,
@@ -351,4 +353,12 @@ export declare class Transcluder {
     transclude(search: Element_2, replace: Element_2): Element_2 | undefined;
 }
 
+/**
+ * @public
+ */
+export declare interface YamlSerializerOptions extends DocumentOptions, Pick<CreateNodeOptions, 'aliasDuplicateObjects'>, Pick<SchemaOptions, 'sortMapEntries'>, ToStringOptions {
+    /** Include %YAML directive and document marker */
+    directive?: boolean;
+}
+
 export { }