@speclynx/apidom-ns-openapi-2 1.12.2 → 2.0.1

package/src/refractor/plugins/replace-empty-element.mjs

@@ -1,4 +1,6 @@
-import { ArrayElement, ObjectElement, isStringElement, isElement, isMemberElement, isArrayElement, includesClasses, cloneDeep, toValue } from '@speclynx/apidom-core';
+import { ArrayElement, ObjectElement, isStringElement, isElement, isMemberElement, isArrayElement, includesClasses, cloneDeep, SourceMapElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { getNodeType } from '@speclynx/apidom-traverse';
 
 /**
  * OpenAPI 2.0 specification elements.
@@ -39,7 +41,6 @@ import SwaggerConsumesElement from "../../elements/nces/SwaggerConsumes.mjs";
 import SwaggerProducesElement from "../../elements/nces/SwaggerProduces.mjs";
 import SwaggerSecurityElement from "../../elements/nces/SwaggerSecurity.mjs";
 import SwaggerTagsElement from "../../elements/nces/SwaggerTags.mjs";
-import { getNodeType } from "../../traversal/visitor.mjs";
 /**
  * This plugin is specific to YAML 1.2 format, which allows defining key-value pairs
  * with empty key, empty value, or both. If the value is not provided in YAML format,
@@ -73,7 +74,7 @@ import { getNodeType } from "../../traversal/visitor.mjs";
  *      (StringElement)
  *      (InfoElement))
  */
-const isEmptyElement = element => isStringElement(element) && includesClasses(['yaml-e-node', 'yaml-e-scalar'], element);
+const isEmptyElement = element => isStringElement(element) && includesClasses(element, ['yaml-e-node', 'yaml-e-scalar']);
 const schema = {
   // concrete types handling (CTs)
   SwaggerElement: {
@@ -325,9 +326,12 @@ const findElementFactory = (ancestor, keyName) => {
  */
 const plugin = () => () => ({
   visitor: {
-    StringElement(element, key, parent, path, ancestors) {
-      if (!isEmptyElement(element)) return undefined;
-      const lineage = [...ancestors, parent].filter(isElement);
+    StringElement(path) {
+      const element = path.node;
+      if (!isEmptyElement(element)) return;
+
+      // getAncestorNodes() returns [parent, grandparent, ..., root], so reverse to get [root, ..., parent]
+      const lineage = path.getAncestorNodes().reverse().filter(isElement);
       const parentElement = lineage.at(-1);
       let elementFactory;
       let context;
@@ -340,10 +344,12 @@ const plugin = () => () => ({
       }
 
       // no element factory found
-      if (typeof elementFactory !== 'function') return undefined;
-      return elementFactory.call({
+      if (typeof elementFactory !== 'function') return;
+      const replacement = elementFactory.call({
         context
       }, undefined, cloneDeep(element.meta), cloneDeep(element.attributes));
+      SourceMapElement.transfer(element, replacement);
+      path.replaceWith(replacement);
     }
   }
 });

package/src/refractor/predicates.cjs

@@ -3,6 +3,7 @@
 exports.__esModule = true;
 exports.isSwaggerExtension = exports.isReferenceLikeElement = void 0;
 var _ramda = require("ramda");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomCore = require("@speclynx/apidom-core");
 /**
  * @public
@@ -12,7 +13,7 @@ var _apidomCore = require("@speclynx/apidom-core");
  * @public
  */
 const isSwaggerExtension = element => {
-  return (0, _apidomCore.isStringElement)(element.key) && (0, _ramda.startsWith)('x-', (0, _apidomCore.toValue)(element.key));
+  return (0, _apidomDatamodel.isStringElement)(element.key) && (0, _ramda.startsWith)('x-', (0, _apidomCore.toValue)(element.key));
 };
 
 /**
@@ -20,6 +21,6 @@ const isSwaggerExtension = element => {
  */
 exports.isSwaggerExtension = isSwaggerExtension;
 const isReferenceLikeElement = element => {
-  return (0, _apidomCore.isObjectElement)(element) && element.hasKey('$ref');
+  return (0, _apidomDatamodel.isObjectElement)(element) && element.hasKey('$ref');
 };
 exports.isReferenceLikeElement = isReferenceLikeElement;

package/src/refractor/predicates.mjs

@@ -1,5 +1,6 @@
 import { startsWith } from 'ramda';
-import { isStringElement, toValue, isObjectElement } from '@speclynx/apidom-core';
+import { isStringElement, isObjectElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
 
 /**
  * @public

package/src/refractor/specification.cjs

@@ -84,6 +84,7 @@ const specification = {
         // OpenAPI 2 specific visitors
         Swagger: {
           $visitor: _index.default,
+          element: 'swagger',
           fixedFields: {
             swagger: _SwaggerVisitor.default,
             info: {
@@ -118,6 +119,7 @@ const specification = {
         },
         Info: {
           $visitor: _index2.default,
+          element: 'info',
           fixedFields: {
             title: {
               $ref: '#/visitors/value'
@@ -139,6 +141,7 @@ const specification = {
         },
         Contact: {
           $visitor: _index3.default,
+          element: 'contact',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -153,6 +156,7 @@ const specification = {
         },
         License: {
           $visitor: _index4.default,
+          element: 'license',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -163,10 +167,12 @@ const specification = {
           }
         },
         Paths: {
-          $visitor: _index5.default
+          $visitor: _index5.default,
+          element: 'paths'
         },
         PathItem: {
           $visitor: _index6.default,
+          element: 'pathItem',
           fixedFields: {
             $ref: _$RefVisitor.default,
             get: {
@@ -195,6 +201,7 @@ const specification = {
         },
         Operation: {
           $visitor: _index7.default,
+          element: 'operation',
           fixedFields: {
             tags: _TagsVisitor2.default,
             summary: {
@@ -224,6 +231,7 @@ const specification = {
         },
         ExternalDocumentation: {
           $visitor: _index8.default,
+          element: 'externalDocumentation',
           fixedFields: {
             description: {
               $ref: '#/visitors/value'
@@ -235,6 +243,7 @@ const specification = {
         },
         Parameter: {
           $visitor: _index9.default,
+          element: 'parameter',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -248,7 +257,8 @@ const specification = {
             type: jsonSchemaFixedFields.type,
             format: jsonSchemaFixedFields.format,
             items: {
-              $ref: '#/visitors/document/objects/Items'
+              $visitor: _index0.default,
+              alias: 'itemsField'
             },
             collectionFormat: {
               $ref: '#/visitors/value'
@@ -270,11 +280,13 @@ const specification = {
         },
         Items: {
           $visitor: _index0.default,
+          element: 'items',
           fixedFields: {
             type: jsonSchemaFixedFields.type,
             format: jsonSchemaFixedFields.format,
             items: {
-              $ref: '#/visitors/document/objects/Items'
+              $visitor: _index0.default,
+              alias: 'itemsField'
             },
             collectionFormat: {
               $ref: '#/visitors/value'
@@ -296,12 +308,14 @@ const specification = {
         },
         Responses: {
           $visitor: _index1.default,
+          element: 'responses',
           fixedFields: {
             default: _DefaultVisitor.default
           }
         },
         Response: {
           $visitor: _index10.default,
+          element: 'response',
           fixedFields: {
             description: {
               $ref: '#/visitors/value'
@@ -316,19 +330,23 @@ const specification = {
           }
         },
         Headers: {
-          $visitor: _index11.default
+          $visitor: _index11.default,
+          element: 'headers'
         },
         Example: {
-          $visitor: _index12.default
+          $visitor: _index12.default,
+          element: 'example'
         },
         Header: {
           $visitor: _index13.default,
+          element: 'header',
           fixedFields: {
             description: jsonSchemaFixedFields.description,
             type: jsonSchemaFixedFields.type,
             format: jsonSchemaFixedFields.format,
             items: {
-              $ref: '#/visitors/document/objects/Items'
+              $visitor: _index0.default,
+              alias: 'itemsField'
             },
             collectionFormat: {
               $ref: '#/visitors/value'
@@ -350,6 +368,7 @@ const specification = {
         },
         Tag: {
           $visitor: _index14.default,
+          element: 'tag',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -364,12 +383,14 @@ const specification = {
         },
         Reference: {
           $visitor: _index15.default,
+          element: 'reference',
           fixedFields: {
             $ref: _$RefVisitor2.default
           }
         },
         Schema: {
           $visitor: _index16.default,
+          element: 'schema',
           fixedFields: {
             // the following properties are taken directly from the JSON Schema definition and follow the same specifications
             format: jsonSchemaFixedFields.format,
@@ -415,6 +436,7 @@ const specification = {
         },
         XML: {
           $visitor: _index17.default,
+          element: 'xml',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -434,19 +456,24 @@ const specification = {
           }
         },
         Definitions: {
-          $visitor: _index18.default
+          $visitor: _index18.default,
+          element: 'definitions'
         },
         ParametersDefinitions: {
-          $visitor: _index20.default
+          $visitor: _index20.default,
+          element: 'parametersDefinitions'
         },
         ResponsesDefinitions: {
-          $visitor: _index19.default
+          $visitor: _index19.default,
+          element: 'responsesDefinitions'
         },
         SecurityDefinitions: {
-          $visitor: _index21.default
+          $visitor: _index21.default,
+          element: 'securityDefinitions'
         },
         SecurityScheme: {
           $visitor: _index22.default,
+          element: 'securityScheme',
           fixedFields: {
             type: {
               $ref: '#/visitors/value'
@@ -475,10 +502,12 @@ const specification = {
           }
         },
         Scopes: {
-          $visitor: _index23.default
+          $visitor: _index23.default,
+          element: 'scopes'
         },
         SecurityRequirement: {
-          $visitor: _index24.default
+          $visitor: _index24.default,
+          element: 'securityRequirement'
         }
       },
       extension: {

package/src/refractor/specification.mjs

@@ -78,6 +78,7 @@ const specification = {
         // OpenAPI 2 specific visitors
         Swagger: {
           $visitor: SwaggerVisitor,
+          element: 'swagger',
           fixedFields: {
             swagger: SwaggerSwaggerVisitor,
             info: {
@@ -112,6 +113,7 @@ const specification = {
         },
         Info: {
           $visitor: InfoVisitor,
+          element: 'info',
           fixedFields: {
             title: {
               $ref: '#/visitors/value'
@@ -133,6 +135,7 @@ const specification = {
         },
         Contact: {
           $visitor: ContactVisitor,
+          element: 'contact',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -147,6 +150,7 @@ const specification = {
         },
         License: {
           $visitor: LicenseVisitor,
+          element: 'license',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -157,10 +161,12 @@ const specification = {
           }
         },
         Paths: {
-          $visitor: PathsVisitor
+          $visitor: PathsVisitor,
+          element: 'paths'
         },
         PathItem: {
           $visitor: PathItemVisitor,
+          element: 'pathItem',
           fixedFields: {
             $ref: PathItem$RefVisitor,
             get: {
@@ -189,6 +195,7 @@ const specification = {
         },
         Operation: {
           $visitor: OperationVisitor,
+          element: 'operation',
           fixedFields: {
             tags: OperationTagsVisitor,
             summary: {
@@ -218,6 +225,7 @@ const specification = {
         },
         ExternalDocumentation: {
           $visitor: ExternalDocumentationElement,
+          element: 'externalDocumentation',
           fixedFields: {
             description: {
               $ref: '#/visitors/value'
@@ -229,6 +237,7 @@ const specification = {
         },
         Parameter: {
           $visitor: ParameterVisitor,
+          element: 'parameter',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -242,7 +251,8 @@ const specification = {
             type: jsonSchemaFixedFields.type,
             format: jsonSchemaFixedFields.format,
             items: {
-              $ref: '#/visitors/document/objects/Items'
+              $visitor: ItemsVisitor,
+              alias: 'itemsField'
             },
             collectionFormat: {
               $ref: '#/visitors/value'
@@ -264,11 +274,13 @@ const specification = {
         },
         Items: {
           $visitor: ItemsVisitor,
+          element: 'items',
           fixedFields: {
             type: jsonSchemaFixedFields.type,
             format: jsonSchemaFixedFields.format,
             items: {
-              $ref: '#/visitors/document/objects/Items'
+              $visitor: ItemsVisitor,
+              alias: 'itemsField'
             },
             collectionFormat: {
               $ref: '#/visitors/value'
@@ -290,12 +302,14 @@ const specification = {
         },
         Responses: {
           $visitor: ResponsesVisitor,
+          element: 'responses',
           fixedFields: {
             default: ResponsesDefaultVisitor
           }
         },
         Response: {
           $visitor: ResponseVisitor,
+          element: 'response',
           fixedFields: {
             description: {
               $ref: '#/visitors/value'
@@ -310,19 +324,23 @@ const specification = {
           }
         },
         Headers: {
-          $visitor: HeadersVisitor
+          $visitor: HeadersVisitor,
+          element: 'headers'
         },
         Example: {
-          $visitor: ExampleVisitor
+          $visitor: ExampleVisitor,
+          element: 'example'
         },
         Header: {
           $visitor: HeaderVisitor,
+          element: 'header',
           fixedFields: {
             description: jsonSchemaFixedFields.description,
             type: jsonSchemaFixedFields.type,
             format: jsonSchemaFixedFields.format,
             items: {
-              $ref: '#/visitors/document/objects/Items'
+              $visitor: ItemsVisitor,
+              alias: 'itemsField'
             },
             collectionFormat: {
               $ref: '#/visitors/value'
@@ -344,6 +362,7 @@ const specification = {
         },
         Tag: {
           $visitor: TagVisitor,
+          element: 'tag',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -358,12 +377,14 @@ const specification = {
         },
         Reference: {
           $visitor: ReferenceVisitor,
+          element: 'reference',
           fixedFields: {
             $ref: Reference$RefVisitor
           }
         },
         Schema: {
           $visitor: SchemaVisitor,
+          element: 'schema',
           fixedFields: {
             // the following properties are taken directly from the JSON Schema definition and follow the same specifications
             format: jsonSchemaFixedFields.format,
@@ -409,6 +430,7 @@ const specification = {
         },
         XML: {
           $visitor: XmlVisitor,
+          element: 'xml',
           fixedFields: {
             name: {
               $ref: '#/visitors/value'
@@ -428,19 +450,24 @@ const specification = {
           }
         },
         Definitions: {
-          $visitor: DefinitionsVisitor
+          $visitor: DefinitionsVisitor,
+          element: 'definitions'
         },
         ParametersDefinitions: {
-          $visitor: ParametersDefinitionsVisitor
+          $visitor: ParametersDefinitionsVisitor,
+          element: 'parametersDefinitions'
         },
         ResponsesDefinitions: {
-          $visitor: ResponsesDefinitionsVisitor
+          $visitor: ResponsesDefinitionsVisitor,
+          element: 'responsesDefinitions'
         },
         SecurityDefinitions: {
-          $visitor: SecurityDefinitionsVisitor
+          $visitor: SecurityDefinitionsVisitor,
+          element: 'securityDefinitions'
         },
         SecurityScheme: {
           $visitor: SecuritySchemeVisitor,
+          element: 'securityScheme',
           fixedFields: {
             type: {
               $ref: '#/visitors/value'
@@ -469,10 +496,12 @@ const specification = {
           }
         },
         Scopes: {
-          $visitor: ScopesVisitor
+          $visitor: ScopesVisitor,
+          element: 'scopes'
         },
         SecurityRequirement: {
-          $visitor: SecurityRequirementVisitor
+          $visitor: SecurityRequirementVisitor,
+          element: 'securityRequirement'
         }
       },
       extension: {

package/src/refractor/toolbox.cjs

@@ -4,17 +4,22 @@ var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequ
 var _interopRequireWildcard = require("@babel/runtime-corejs3/helpers/interopRequireWildcard").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var openApi2Predicates = _interopRequireWildcard(require("../predicates.cjs"));
 var refractorPredicates = _interopRequireWildcard(require("./predicates.cjs"));
 var _namespace = _interopRequireDefault(require("../namespace.cjs"));
+/**
+ * @public
+ */
+
 const createToolbox = () => {
-  const namespace = (0, _apidomCore.createNamespace)(_namespace.default);
+  const namespace = new _apidomDatamodel.Namespace();
   const predicates = {
     ...refractorPredicates,
     ...openApi2Predicates,
-    isStringElement: _apidomCore.isStringElement
+    isStringElement: _apidomDatamodel.isStringElement
   };
+  namespace.use(_namespace.default);
   return {
     predicates,
     namespace

package/src/refractor/toolbox.mjs

@@ -1,14 +1,18 @@
-import { createNamespace, isStringElement } from '@speclynx/apidom-core';
+import { isStringElement, Namespace } from '@speclynx/apidom-datamodel';
 import * as openApi2Predicates from "../predicates.mjs";
 import * as refractorPredicates from "./predicates.mjs";
 import openApi2Namespace from "../namespace.mjs";
+/**
+ * @public
+ */
 const createToolbox = () => {
-  const namespace = createNamespace(openApi2Namespace);
+  const namespace = new Namespace();
   const predicates = {
     ...refractorPredicates,
     ...openApi2Predicates,
     isStringElement
   };
+  namespace.use(openApi2Namespace);
   return {
     predicates,
     namespace

package/src/refractor/visitors/FallbackVisitor.cjs

@@ -3,7 +3,7 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _Visitor = _interopRequireDefault(require("./Visitor.cjs"));
 /**
  * This visitor is responsible for falling back to current traversed element
@@ -16,9 +16,9 @@ var _Visitor = _interopRequireDefault(require("./Visitor.cjs"));
  * @public
  */
 class FallbackVisitor extends _Visitor.default {
-  enter(element) {
-    this.element = (0, _apidomCore.cloneDeep)(element);
-    return _apidomCore.BREAK;
+  enter(path) {
+    this.element = (0, _apidomDatamodel.cloneDeep)(path.node);
+    path.stop();
   }
 }
 var _default = exports.default = FallbackVisitor;

package/src/refractor/visitors/FallbackVisitor.mjs

@@ -1,4 +1,4 @@
-import { BREAK, cloneDeep } from '@speclynx/apidom-core';
+import { cloneDeep } from '@speclynx/apidom-datamodel';
 import Visitor from "./Visitor.mjs";
 /**
  * This visitor is responsible for falling back to current traversed element
@@ -10,9 +10,9 @@ import Visitor from "./Visitor.mjs";
  * @public
  */
 class FallbackVisitor extends Visitor {
-  enter(element) {
-    this.element = cloneDeep(element);
-    return BREAK;
+  enter(path) {
+    this.element = cloneDeep(path.node);
+    path.stop();
   }
 }
 export default FallbackVisitor;

package/src/refractor/visitors/SpecificationExtensionVisitor.cjs

@@ -3,16 +3,16 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = void 0;
-var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _SpecificationVisitor = _interopRequireDefault(require("./SpecificationVisitor.cjs"));
 /**
  * @public
  */
 class SpecificationExtensionVisitor extends _SpecificationVisitor.default {
-  MemberElement(memberElement) {
-    this.element = (0, _apidomCore.cloneDeep)(memberElement);
+  MemberElement(path) {
+    this.element = (0, _apidomDatamodel.cloneDeep)(path.node);
     this.element.classes.push('specification-extension');
-    return _apidomCore.BREAK;
+    path.stop();
   }
 }
 var _default = exports.default = SpecificationExtensionVisitor;

package/src/refractor/visitors/SpecificationExtensionVisitor.mjs

@@ -1,13 +1,13 @@
-import { BREAK, cloneDeep } from '@speclynx/apidom-core';
+import { cloneDeep } from '@speclynx/apidom-datamodel';
 import SpecificationVisitor from "./SpecificationVisitor.mjs";
 /**
  * @public
  */
 class SpecificationExtensionVisitor extends SpecificationVisitor {
-  MemberElement(memberElement) {
-    this.element = cloneDeep(memberElement);
+  MemberElement(path) {
+    this.element = cloneDeep(path.node);
     this.element.classes.push('specification-extension');
-    return BREAK;
+    path.stop();
   }
 }
 export default SpecificationExtensionVisitor;

package/src/refractor/visitors/SpecificationVisitor.cjs

@@ -5,7 +5,8 @@ exports.__esModule = true;
 exports.default = void 0;
 var _ramda = require("ramda");
 var _ramdaAdjunct = require("ramda-adjunct");
-var _apidomCore = require("@speclynx/apidom-core");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _Visitor = _interopRequireDefault(require("./Visitor.cjs"));
 var _FallbackVisitor = _interopRequireDefault(require("./FallbackVisitor.cjs"));
 /**
@@ -65,9 +66,9 @@ class SpecificationVisitor extends _Visitor.default {
      */
     const visitor = this.retrieveVisitorInstance(specPath, options);
     if (visitor instanceof _FallbackVisitor.default && visitor?.constructor === _FallbackVisitor.default) {
-      return (0, _apidomCore.cloneDeep)(element);
+      return (0, _apidomDatamodel.cloneDeep)(element);
     }
-    (0, _apidomCore.visit)(element, visitor, options);
+    (0, _apidomTraverse.traverse)(element, visitor);
     return visitor.element;
   }
 }

package/src/refractor/visitors/SpecificationVisitor.mjs

@@ -1,6 +1,7 @@
 import { pathSatisfies, path, pick } from 'ramda';
 import { isFunction } from 'ramda-adjunct';
-import { visit, cloneDeep } from '@speclynx/apidom-core';
+import { cloneDeep } from '@speclynx/apidom-datamodel';
+import { traverse } from '@speclynx/apidom-traverse';
 import Visitor from "./Visitor.mjs";
 import FallbackVisitor from "./FallbackVisitor.mjs";
 /**
@@ -61,7 +62,7 @@ class SpecificationVisitor extends Visitor {
     if (visitor instanceof FallbackVisitor && visitor?.constructor === FallbackVisitor) {
       return cloneDeep(element);
     }
-    visit(element, visitor, options);
+    traverse(element, visitor);
     return visitor.element;
   }
 }