@speclynx/apidom-ns-openapi-3-0 1.12.2 → 2.1.0

package/src/refractor/inspect.mjs

@@ -0,0 +1,170 @@
+import { resolveSpecification } from '@speclynx/apidom-core';
+import { isPlainObject } from 'ramda-adjunct';
+
+/**
+ * OpenAPI 3.0 specification elements.
+ */
+import CallbackElement from "../elements/Callback.mjs";
+import ComponentsElement from "../elements/Components.mjs";
+import ContactElement from "../elements/Contact.mjs";
+import DiscriminatorElement from "../elements/Discriminator.mjs";
+import EncodingElement from "../elements/Encoding.mjs";
+import ExampleElement from "../elements/Example.mjs";
+import ExternalDocumentationElement from "../elements/ExternalDocumentation.mjs";
+import HeaderElement from "../elements/Header.mjs";
+import InfoElement from "../elements/Info.mjs";
+import LicenseElement from "../elements/License.mjs";
+import LinkElement from "../elements/Link.mjs";
+import MediaTypeElement from "../elements/MediaType.mjs";
+import OAuthFlowElement from "../elements/OAuthFlow.mjs";
+import OAuthFlowsElement from "../elements/OAuthFlows.mjs";
+import OpenapiElement from "../elements/Openapi.mjs";
+import OpenApi3_0Element from "../elements/OpenApi3-0.mjs";
+import OperationElement from "../elements/Operation.mjs";
+import ParameterElement from "../elements/Parameter.mjs";
+import PathItemElement from "../elements/PathItem.mjs";
+import PathsElement from "../elements/Paths.mjs";
+import ReferenceElement from "../elements/Reference.mjs";
+import RequestBodyElement from "../elements/RequestBody.mjs";
+import ResponseElement from "../elements/Response.mjs";
+import ResponsesElement from "../elements/Responses.mjs";
+import SchemaElement from "../elements/Schema.mjs";
+import SecurityRequirementElement from "../elements/SecurityRequirement.mjs";
+import SecuritySchemeElement from "../elements/SecurityScheme.mjs";
+import ServerElement from "../elements/Server.mjs";
+import ServerVariableElement from "../elements/ServerVariable.mjs";
+import TagElement from "../elements/Tag.mjs";
+import XmlElement from "../elements/Xml.mjs";
+import specification from "./specification.mjs";
+/**
+ * @public
+ */
+// Resolve specification to dereference $ref pointers
+const resolvedSpec = resolveSpecification(specification);
+
+// Extract fixed fields as list of { name, alias?, $visitor }
+const getFixedFields = fixedFieldsSpec => {
+  return Object.entries(fixedFieldsSpec).map(([name, fieldSpec]) => {
+    if (isPlainObject(fieldSpec)) {
+      return {
+        name,
+        ...fieldSpec
+      };
+    }
+    return {
+      name,
+      $visitor: fieldSpec
+    };
+  });
+};
+
+// OpenAPI 3.0 specification elements
+Object.defineProperty(OpenApi3_0Element, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OpenApi.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(InfoElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Info.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ContactElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Contact.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(LicenseElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.License.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ServerElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Server.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ServerVariableElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ServerVariable.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ComponentsElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Components.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(PathItemElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.PathItem.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(OperationElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Operation.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ExternalDocumentationElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.ExternalDocumentation.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ParameterElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Parameter.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(RequestBodyElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.RequestBody.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(MediaTypeElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.MediaType.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(EncodingElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Encoding.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ResponsesElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Responses.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ResponseElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Response.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ExampleElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Example.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(LinkElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Link.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(HeaderElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Header.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(TagElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Tag.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(ReferenceElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Reference.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(SchemaElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Schema.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(DiscriminatorElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.Discriminator.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(XmlElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.XML.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(SecuritySchemeElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.SecurityScheme.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(OAuthFlowsElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlows.fixedFields),
+  enumerable: true
+});
+Object.defineProperty(OAuthFlowElement, 'fixedFields', {
+  get: () => getFixedFields(resolvedSpec.visitors.document.objects.OAuthFlow.fixedFields),
+  enumerable: true
+});
+export { CallbackElement, ComponentsElement, ContactElement, DiscriminatorElement, EncodingElement, ExampleElement, ExternalDocumentationElement, HeaderElement, InfoElement, LicenseElement, LinkElement, MediaTypeElement, OAuthFlowElement, OAuthFlowsElement, OpenapiElement, OpenApi3_0Element, OperationElement, ParameterElement, PathItemElement, PathsElement, ReferenceElement, RequestBodyElement, ResponseElement, ResponsesElement, SchemaElement, SecurityRequirementElement, SecuritySchemeElement, ServerElement, ServerVariableElement, TagElement, XmlElement };

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

@@ -3,7 +3,9 @@
 var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault").default;
 exports.__esModule = true;
 exports.default = void 0;
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomCore = require("@speclynx/apidom-core");
+var _apidomTraverse = require("@speclynx/apidom-traverse");
 var _Info = _interopRequireDefault(require("../../elements/Info.cjs"));
 var _Contact = _interopRequireDefault(require("../../elements/Contact.cjs"));
 var _License = _interopRequireDefault(require("../../elements/License.cjs"));
@@ -66,7 +68,6 @@ var _OAuthFlowScopes = _interopRequireDefault(require("../../elements/nces/OAuth
 var _LinkParameters = _interopRequireDefault(require("../../elements/nces/LinkParameters.cjs"));
 var _HeaderExamples = _interopRequireDefault(require("../../elements/nces/HeaderExamples.cjs"));
 var _HeaderContent = _interopRequireDefault(require("../../elements/nces/HeaderContent.cjs"));
-var _visitor = require("../../traversal/visitor.cjs");
 /**
  * OpenAPI 3.0.x specification elements.
  */
@@ -107,7 +108,7 @@ var _visitor = require("../../traversal/visitor.cjs");
  *      (InfoElement))
  */
 
-const isEmptyElement = element => (0, _apidomCore.isStringElement)(element) && (0, _apidomCore.includesClasses)(['yaml-e-node', 'yaml-e-scalar'], element);
+const isEmptyElement = element => (0, _apidomDatamodel.isStringElement)(element) && (0, _apidomDatamodel.includesClasses)(element, ['yaml-e-node', 'yaml-e-scalar']);
 const schema = {
   // concrete types handling (CTs)
   OpenApi3_0Element: {
@@ -148,7 +149,7 @@ const schema = {
   },
   ServerVariableElement: {
     enum(...args) {
-      return new _apidomCore.ArrayElement(...args);
+      return new _apidomDatamodel.ArrayElement(...args);
     }
   },
   PathsElement: {
@@ -317,7 +318,7 @@ const schema = {
   },
   SecurityRequirementElement: {
     '[key: *]': function key(...args) {
-      return new _apidomCore.ArrayElement(...args);
+      return new _apidomDatamodel.ArrayElement(...args);
     }
   },
   TagElement: {
@@ -327,22 +328,22 @@ const schema = {
   },
   SchemaElement: {
     definitions(...args) {
-      const element = new _apidomCore.ObjectElement(...args);
+      const element = new _apidomDatamodel.ObjectElement(...args);
       element.classes.push('json-schema-definitions');
       return element;
     },
     allOf(...args) {
-      const element = new _apidomCore.ArrayElement(...args);
+      const element = new _apidomDatamodel.ArrayElement(...args);
       element.classes.push('json-schema-allOf');
       return element;
     },
     anyOf(...args) {
-      const element = new _apidomCore.ArrayElement(...args);
+      const element = new _apidomDatamodel.ArrayElement(...args);
       element.classes.push('json-schema-anyOf');
       return element;
     },
     oneOf(...args) {
-      const element = new _apidomCore.ArrayElement(...args);
+      const element = new _apidomDatamodel.ArrayElement(...args);
       element.classes.push('json-schema-oneOf');
       return element;
     },
@@ -353,12 +354,12 @@ const schema = {
       return new _Schema.default(...args);
     },
     properties(...args) {
-      const element = new _apidomCore.ObjectElement(...args);
+      const element = new _apidomDatamodel.ObjectElement(...args);
       element.classes.push('json-schema-properties');
       return element;
     },
     patternProperties(...args) {
-      const element = new _apidomCore.ObjectElement(...args);
+      const element = new _apidomDatamodel.ObjectElement(...args);
       element.classes.push('json-schema-patternProperties');
       return element;
     },
@@ -366,12 +367,12 @@ const schema = {
       return new _Schema.default(...args);
     },
     enum(...args) {
-      const element = new _apidomCore.ArrayElement(...args);
+      const element = new _apidomDatamodel.ArrayElement(...args);
       element.classes.push('json-schema-enum');
       return element;
     },
     required(...args) {
-      const element = new _apidomCore.ArrayElement(...args);
+      const element = new _apidomDatamodel.ArrayElement(...args);
       element.classes.push('json-schema-required');
       return element;
     },
@@ -592,7 +593,7 @@ const schema = {
   }
 };
 const findElementFactory = (ancestor, keyName) => {
-  const elementType = (0, _visitor.getNodeType)(ancestor); // @ts-ignore
+  const elementType = (0, _apidomTraverse.getNodeType)(ancestor);
   const keyMapping = schema[elementType] || schema[(0, _apidomCore.toValue)(ancestor.classes.first)];
   return typeof keyMapping === 'undefined' ? undefined : Object.hasOwn(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
 };
@@ -602,25 +603,28 @@ const findElementFactory = (ancestor, keyName) => {
  */
 const plugin = () => () => ({
   visitor: {
-    StringElement(element, key, parent, path, ancestors) {
-      if (!isEmptyElement(element)) return undefined;
-      const lineage = [...ancestors, parent].filter(_apidomCore.isElement);
+    StringElement(path) {
+      const element = path.node;
+      if (!isEmptyElement(element)) return;
+      const lineage = path.getAncestorNodes().reverse(); // root to parent
       const parentElement = lineage.at(-1);
       let elementFactory;
       let context;
-      if ((0, _apidomCore.isArrayElement)(parentElement)) {
+      if ((0, _apidomDatamodel.isArrayElement)(parentElement)) {
         context = element;
         elementFactory = findElementFactory(parentElement, '<*>');
-      } else if ((0, _apidomCore.isMemberElement)(parentElement)) {
+      } else if ((0, _apidomDatamodel.isMemberElement)(parentElement)) {
         context = lineage.at(-2);
         elementFactory = findElementFactory(context, (0, _apidomCore.toValue)(parentElement.key));
       }
 
       // no element factory found
-      if (typeof elementFactory !== 'function') return undefined;
-      return elementFactory.call({
+      if (typeof elementFactory !== 'function') return;
+      const newElement = elementFactory.call({
         context
-      }, undefined, (0, _apidomCore.cloneDeep)(element.meta), (0, _apidomCore.cloneDeep)(element.attributes));
+      }, undefined, (0, _apidomDatamodel.cloneDeep)(element.meta), (0, _apidomDatamodel.cloneDeep)(element.attributes));
+      _apidomDatamodel.SourceMapElement.transfer(element, newElement);
+      path.replaceWith(newElement);
     }
   }
 });

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

@@ -1,4 +1,6 @@
-import { ArrayElement, ObjectElement, isStringElement, isArrayElement, isElement, isMemberElement, includesClasses, cloneDeep, toValue } from '@speclynx/apidom-core';
+import { ArrayElement, ObjectElement, isStringElement, isArrayElement, isMemberElement, includesClasses, cloneDeep, SourceMapElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
+import { getNodeType } from '@speclynx/apidom-traverse';
 
 /**
  * OpenAPI 3.0.x specification elements.
@@ -65,7 +67,6 @@ import OAuthFlowScopesElement from "../../elements/nces/OAuthFlowScopes.mjs";
 import LinkParametersElement from "../../elements/nces/LinkParameters.mjs";
 import HeaderExamplesElement from "../../elements/nces/HeaderExamples.mjs";
 import HeaderContentElement from "../../elements/nces/HeaderContent.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,
@@ -99,7 +100,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)
   OpenApi3_0Element: {
@@ -584,7 +585,7 @@ const schema = {
   }
 };
 const findElementFactory = (ancestor, keyName) => {
-  const elementType = getNodeType(ancestor); // @ts-ignore
+  const elementType = getNodeType(ancestor);
   const keyMapping = schema[elementType] || schema[toValue(ancestor.classes.first)];
   return typeof keyMapping === 'undefined' ? undefined : Object.hasOwn(keyMapping, '[key: *]') ? keyMapping['[key: *]'] : keyMapping[keyName];
 };
@@ -594,9 +595,10 @@ 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;
+      const lineage = path.getAncestorNodes().reverse(); // root to parent
       const parentElement = lineage.at(-1);
       let elementFactory;
       let context;
@@ -609,10 +611,12 @@ const plugin = () => () => ({
       }
 
       // no element factory found
-      if (typeof elementFactory !== 'function') return undefined;
-      return elementFactory.call({
+      if (typeof elementFactory !== 'function') return;
+      const newElement = elementFactory.call({
         context
       }, undefined, cloneDeep(element.meta), cloneDeep(element.attributes));
+      SourceMapElement.transfer(element, newElement);
+      path.replaceWith(newElement);
     }
   }
 });

package/src/refractor/predicates.cjs

@@ -3,6 +3,7 @@
 exports.__esModule = true;
 exports.isTagLikeElement = exports.isServerLikeElement = exports.isReferenceLikeElement = exports.isOpenApiExtension = void 0;
 var _ramda = require("ramda");
+var _apidomDatamodel = require("@speclynx/apidom-datamodel");
 var _apidomCore = require("@speclynx/apidom-core");
 /**
  * @public
@@ -12,25 +13,24 @@ var _apidomCore = require("@speclynx/apidom-core");
  * @public
  */
 const isReferenceLikeElement = element => {
-  return (0, _apidomCore.isObjectElement)(element) && element.hasKey('$ref');
+  return (0, _apidomDatamodel.isObjectElement)(element) && element.hasKey('$ref');
 };
 
 /**
  * @public
  */
 exports.isReferenceLikeElement = isReferenceLikeElement;
-const isServerLikeElement = exports.isServerLikeElement = _apidomCore.isObjectElement;
+const isServerLikeElement = exports.isServerLikeElement = _apidomDatamodel.isObjectElement;
 
 /**
  * @public
  */
-const isTagLikeElement = exports.isTagLikeElement = _apidomCore.isObjectElement;
+const isTagLikeElement = exports.isTagLikeElement = _apidomDatamodel.isObjectElement;
 
 /**
  * @public
  */
 const isOpenApiExtension = element => {
-  // @ts-ignore
-  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));
 };
 exports.isOpenApiExtension = isOpenApiExtension;

package/src/refractor/predicates.mjs

@@ -1,5 +1,6 @@
 import { startsWith } from 'ramda';
-import { isStringElement, isObjectElement, toValue } from '@speclynx/apidom-core';
+import { isStringElement, isObjectElement } from '@speclynx/apidom-datamodel';
+import { toValue } from '@speclynx/apidom-core';
 
 /**
  * @public
@@ -26,6 +27,5 @@ export const isTagLikeElement = isObjectElement;
  * @public
  */
 export const isOpenApiExtension = element => {
-  // @ts-ignore
   return isStringElement(element.key) && startsWith('x-', toValue(element.key));
 };