@swagger-api/apidom-core 0.82.2 → 0.84.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.84.0](https://github.com/swagger-api/apidom/compare/v0.83.0...v0.84.0) (2023-11-24)
+
+### Features
+
+- **ast:** see edits by the following merged visitors ([#3412](https://github.com/swagger-api/apidom/issues/3412)) ([6499557](https://github.com/swagger-api/apidom/commit/64995573f5df1f7f291c20833cf274173f6a7bac))
+
+# [0.83.0](https://github.com/swagger-api/apidom/compare/v0.82.2...v0.83.0) (2023-11-07)
+
+### Features
+
+- **core:** add support for formalized element identity management ([#3366](https://github.com/swagger-api/apidom/issues/3366)) ([65dcd0e](https://github.com/swagger-api/apidom/commit/65dcd0e8a96544773001560fe142a9768a2c3668))
+
 ## [0.82.2](https://github.com/swagger-api/apidom/compare/v0.82.1...v0.82.2) (2023-11-03)
 
 **Note:** Version bump only for package @swagger-api/apidom-core

package/README.md

@@ -687,6 +687,25 @@ const numberElement = new NumberElement(1);
 dehyrate(numberElement); // => { element: 'number', content: 1 }
 ```
 
+### S-Expression
+
+Transforms ApiDOM into [symbolic expression](https://en.wikipedia.org/wiki/S-expression).
+
+```js
+import { sexprs, ObjectElement } from '@swagger-api/apidom-core';
+
+const objectElement = new ObjectElement({ a: 1 });
+
+sexprs(objectElement);
+// =>
+// (ObjectElement
+//   (MemberElement
+//     (StringElement)
+//     (NumberElement)))
+
+
+```
+
 ### toString
 
 Create a [refracted string](https://github.com/refractproject/refract-spec) representation of an Element.

package/cjs/clone/errors/CloneError.cjs

@@ -7,7 +7,7 @@ class CloneError extends _apidomError.ApiDOMStructuredError {
   constructor(message, structuredOptions) {
     super(message, structuredOptions);
     if (typeof structuredOptions !== 'undefined') {
-      this.value = structuredOptions.source;
+      this.value = structuredOptions.value;
     }
   }
 }

package/cjs/identity/errors/ElementIdentityError.cjs

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

package/cjs/identity/index.cjs

@@ -0,0 +1,63 @@
+"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 _stampit = _interopRequireDefault(require("stampit"));
+var _shortUniqueId = _interopRequireDefault(require("short-unique-id"));
+var _ElementIdentityError = _interopRequireDefault(require("./errors/ElementIdentityError.cjs"));
+var _index = require("../predicates/index.cjs");
+const IdentityManager = exports.IdentityManager = (0, _stampit.default)({
+  props: {
+    uuid: null,
+    length: null,
+    identityMap: null
+  },
+  init({
+    length = 6
+  } = {}) {
+    this.length = 6;
+    this.uuid = new _shortUniqueId.default({
+      length
+    });
+    this.identityMap = new WeakMap();
+  },
+  methods: {
+    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.id) && !element.meta.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();
+    }
+  }
+});
+const defaultIdentityManager = exports.defaultIdentityManager = IdentityManager({
+  length: 6
+});

package/cjs/index.cjs

@@ -3,7 +3,7 @@
 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.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.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.Element = exports.DeepCloneError = exports.CommentElement = exports.CloneError = exports.BooleanElement = exports.BREAK = exports.ArraySlice = exports.ArrayElement = exports.AnnotationElement = void 0;
+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.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/utils/index.cjs");
 exports.dispatchRefractorPlugins = _index.dispatchPlugins;
 var _elementIdentity = _interopRequireDefault(require("./refractor/plugins/element-identity.cjs"));
@@ -85,10 +85,15 @@ var _DeepCloneError = _interopRequireDefault(require("./clone/errors/DeepCloneEr
 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 _index6 = _interopRequireDefault(require("./transformers/serializers/value/index.cjs"));
-exports.toValue = _index6.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"));

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

@@ -1,10 +1,9 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _shortUniqueId = _interopRequireDefault(require("short-unique-id"));
 var _minim = require("minim");
+var _index = require("../../identity/index.cjs");
 /**
  * Plugin for decorating every element in ApiDOM tree with UUID.
  */
@@ -12,21 +11,21 @@ var _minim = require("minim");
 const plugin = ({
   length = 6
 } = {}) => () => {
-  let uuid;
+  let identityManager;
   return {
     pre() {
-      uuid = new _shortUniqueId.default({
+      identityManager = (0, _index.IdentityManager)({
         length
       });
     },
     visitor: {
       enter(element) {
-        // eslint-disable-next-line no-param-reassign
-        element.id = new _minim.StringElement(uuid.randomUUID());
+        element.id = new _minim.StringElement(identityManager.generateId()); // eslint-disable-line no-param-reassign
       }
     },
+
     post() {
-      uuid = null;
+      identityManager = null;
     }
   };
 };

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

@@ -1,10 +1,9 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _shortUniqueId = _interopRequireDefault(require("short-unique-id"));
 var _minim = require("minim");
+var _index = require("../../identity/index.cjs");
 /**
  * Plugin for decorating every semantic element in ApiDOM tree with UUID.
  */
@@ -14,23 +13,23 @@ const plugin = ({
 } = {}) => ({
   predicates
 }) => {
-  let uuid;
+  let identityManager;
   return {
     pre() {
-      uuid = new _shortUniqueId.default({
+      identityManager = (0, _index.IdentityManager)({
         length
       });
     },
     visitor: {
       enter(element) {
         if (!predicates.isPrimitiveElement(element)) {
-          // eslint-disable-next-line no-param-reassign
-          element.id = new _minim.StringElement(uuid.randomUUID());
+          element.id = new _minim.StringElement(identityManager.generateId()); // eslint-disable-line no-param-reassign
         }
       }
     },
+
     post() {
-      uuid = null;
+      identityManager = null;
     }
   };
 };

package/cjs/refractor/plugins/utils/index.cjs

@@ -7,19 +7,29 @@ var _ramda = require("ramda");
 var _ramdaAdjunct = require("ramda-adjunct");
 var _toolbox = _interopRequireDefault(require("../../toolbox.cjs"));
 var _visitor = require("../../../traversal/visitor.cjs");
+const defaultDispatchPluginsOptions = {
+  toolboxCreator: _toolbox.default,
+  visitorOptions: {
+    nodeTypeGetter: _visitor.getNodeType,
+    exposeEdits: true
+  }
+};
+
 // eslint-disable-next-line import/prefer-default-export
 const dispatchPlugins = (element, plugins, options = {}) => {
   if (plugins.length === 0) return element;
-  const toolboxCreator = (0, _ramda.propOr)(_toolbox.default, 'toolboxCreator', options);
-  const visitorOptions = (0, _ramda.propOr)({}, 'visitorOptions', options);
-  const nodeTypeGetter = (0, _ramda.propOr)(_visitor.getNodeType, 'nodeTypeGetter', visitorOptions);
+  const mergedOptions = (0, _ramda.mergeDeepRight)(defaultDispatchPluginsOptions, options);
+  const {
+    toolboxCreator,
+    visitorOptions
+  } = mergedOptions;
   const toolbox = toolboxCreator();
   const pluginsSpecs = plugins.map(plugin => plugin(toolbox));
-  const pluginsVisitor = (0, _visitor.mergeAllVisitors)(pluginsSpecs.map((0, _ramda.propOr)({}, 'visitor')), {
-    nodeTypeGetter
+  const mergedPluginsVisitor = (0, _visitor.mergeAllVisitors)(pluginsSpecs.map((0, _ramda.propOr)({}, 'visitor')), {
+    ...visitorOptions
   });
   pluginsSpecs.forEach((0, _ramdaAdjunct.invokeArgs)(['pre'], []));
-  const newElement = (0, _visitor.visit)(element, pluginsVisitor, visitorOptions);
+  const newElement = (0, _visitor.visit)(element, mergedPluginsVisitor, visitorOptions);
   pluginsSpecs.forEach((0, _ramdaAdjunct.invokeArgs)(['post'], []));
   return newElement;
 };

package/cjs/traversal/visitor.cjs

@@ -20,9 +20,7 @@ const getNodeType = element => {
    *
    * There is a problem with naming visitor methods described here: https://github.com/babel/babel/discussions/12874
    */
-  /* eslint-disable no-nested-ternary */
   return (0, _index.isObjectElement)(element) ? 'ObjectElement' : (0, _index.isArrayElement)(element) ? 'ArrayElement' : (0, _index.isMemberElement)(element) ? 'MemberElement' : (0, _index.isStringElement)(element) ? 'StringElement' : (0, _index.isBooleanElement)(element) ? 'BooleanElement' : (0, _index.isNumberElement)(element) ? 'NumberElement' : (0, _index.isNullElement)(element) ? 'NullElement' : (0, _index.isLinkElement)(element) ? 'LinkElement' : (0, _index.isRefElement)(element) ? 'RefElement' : undefined;
-  /* eslint-enable */
 };
 
 // cloneNode :: a -> a