swagger-client 3.26.7 → 3.27.0

package/es/resolver/strategies/openapi-3-1-apidom/resolve.js

@@ -1,8 +1,8 @@
 /* eslint-disable camelcase */
-import { toValue, transclude, ParseResultElement } from '@swagger-api/apidom-core';
+import { ParseResultElement, ObjectElement, toValue, transclude, cloneDeep } from '@swagger-api/apidom-core';
 import { compile as jsonPointerCompile, evaluate as jsonPointerEvaluate, EvaluationJsonPointerError, InvalidJsonPointerError } from '@swagger-api/apidom-json-pointer';
-import { OpenApi3_1Element, mediaTypes } from '@swagger-api/apidom-ns-openapi-3-1';
-import { dereferenceApiDOM, url, ReferenceSet, Reference } from '@swagger-api/apidom-reference/configuration/empty';
+import { mediaTypes, OpenApi3_1Element } from '@swagger-api/apidom-ns-openapi-3-1';
+import { dereferenceApiDOM, url, ReferenceSet, Reference, options as referenceOptions } from '@swagger-api/apidom-reference/configuration/empty';
 import BinaryParser from '@swagger-api/apidom-reference/parse/parsers/binary';
 import OpenApi3_1ResolveStrategy from '@swagger-api/apidom-reference/resolve/strategies/openapi-3-1';
 import { DEFAULT_BASE_URL } from '../../../constants.js';
@@ -14,6 +14,18 @@ import YamlParser from '../../apidom/reference/parse/parsers/yaml-1-2/index.js';
 import OpenApiJson3_1Parser from '../../apidom/reference/parse/parsers/openapi-json-3-1/index.js';
 import OpenApiYaml3_1Parser from '../../apidom/reference/parse/parsers/openapi-yaml-3-1/index.js';
 import OpenApi3_1SwaggerClientDereferenceStrategy from '../../apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js';
+export const circularReplacer = refElement => {
+  const $refBaseURI = toValue(refElement.meta.get('baseURI'));
+  const referencingElement = refElement.meta.get('referencingElement');
+
+  /**
+   * Removing semantics from the absolutified referencing element by
+   * using generic ObjectElement to represent the reference.
+   */
+  return new ObjectElement({
+    $ref: $refBaseURI
+  }, cloneDeep(referencingElement.meta), cloneDeep(referencingElement.attributes));
+};
 const resolveOpenAPI31Strategy = async options => {
   const {
     spec,
@@ -122,7 +134,9 @@ const resolveOpenAPI31Strategy = async options => {
         dereferenceOpts: {
           errors
         },
-        immutable: false
+        immutable: false,
+        circular: useCircularStructures ? 'ignore' : 'replace',
+        circularReplacer: useCircularStructures ? referenceOptions.dereference.circularReplacer : circularReplacer
       }
     });
     const transcluded = transclude(fragmentElement, dereferenced, openApiElement);

package/lib/execute/oas3/content-serializer.js

@@ -13,7 +13,16 @@ function serialize(value, mediaType) {
       // Assume the user has a JSON string
       return value;
     }
+    if (Array.isArray(value)) {
+      value = value.map(v => {
+        try {
+          return JSON.parse(v);
+        } catch (e) {
+          return v;
+        }
+      });
+    }
     return JSON.stringify(value);
   }
-  return value.toString();
+  return String(value);
 }

package/lib/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/index.js

@@ -18,7 +18,6 @@ const visitAsync = _apidomCore.visit[Symbol.for('nodejs.util.promisify.custom')]
 const mergeAllVisitorsAsync = _apidomCore.mergeAllVisitors[Symbol.for('nodejs.util.promisify.custom')];
 const OpenApi3_1SwaggerClientDereferenceStrategy = _openapi.default.compose({
   props: {
-    useCircularStructures: true,
     allowMetaPatches: false,
     parameterMacro: null,
     modelPropertyMacro: null,
@@ -26,7 +25,6 @@ const OpenApi3_1SwaggerClientDereferenceStrategy = _openapi.default.compose({
     ancestors: null
   },
   init({
-    useCircularStructures = this.useCircularStructures,
     allowMetaPatches = this.allowMetaPatches,
     parameterMacro = this.parameterMacro,
     modelPropertyMacro = this.modelPropertyMacro,
@@ -34,7 +32,6 @@ const OpenApi3_1SwaggerClientDereferenceStrategy = _openapi.default.compose({
     ancestors = []
   } = {}) {
     this.name = 'openapi-3-1-swagger-client';
-    this.useCircularStructures = useCircularStructures;
     this.allowMetaPatches = allowMetaPatches;
     this.parameterMacro = parameterMacro;
     this.modelPropertyMacro = modelPropertyMacro;
@@ -46,17 +43,32 @@ const OpenApi3_1SwaggerClientDereferenceStrategy = _openapi.default.compose({
       var _options$dereference$;
       const visitors = [];
       const namespace = (0, _apidomCore.createNamespace)(_apidomNsOpenapi.default);
-      const refSet = (_options$dereference$ = options.dereference.refSet) != null ? _options$dereference$ : (0, _empty.ReferenceSet)();
+      const immutableRefSet = (_options$dereference$ = options.dereference.refSet) != null ? _options$dereference$ : (0, _empty.ReferenceSet)();
+      const mutableRefsSet = (0, _empty.ReferenceSet)();
+      let refSet = immutableRefSet;
       let reference;
-      if (!refSet.has(file.uri)) {
+      if (!immutableRefSet.has(file.uri)) {
         reference = (0, _empty.Reference)({
           uri: file.uri,
           value: file.parseResult
         });
-        refSet.add(reference);
+        immutableRefSet.add(reference);
       } else {
         // pre-computed refSet was provided as configuration option
-        reference = refSet.find(ref => ref.uri === file.uri);
+        reference = immutableRefSet.find(ref => ref.uri === file.uri);
+      }
+
+      /**
+       * Clone refSet due the dereferencing process being mutable.
+       * We don't want to mutate the original refSet and the references.
+       */
+      if (options.dereference.immutable) {
+        immutableRefSet.refs.map(ref => (0, _empty.Reference)({
+          ...ref,
+          value: (0, _apidomCore.cloneDeep)(ref.value)
+        })).forEach(ref => mutableRefsSet.add(ref));
+        reference = mutableRefsSet.find(ref => ref.uri === file.uri);
+        refSet = mutableRefsSet;
       }
 
       // create main dereference visitor
@@ -64,7 +76,6 @@ const OpenApi3_1SwaggerClientDereferenceStrategy = _openapi.default.compose({
         reference,
         namespace,
         options,
-        useCircularStructures: this.useCircularStructures,
         allowMetaPatches: this.allowMetaPatches,
         ancestors: this.ancestors
       });
@@ -106,12 +117,25 @@ const OpenApi3_1SwaggerClientDereferenceStrategy = _openapi.default.compose({
       });
 
       /**
-       * Release all memory if this refSet was not provided as a configuration option.
+       * If immutable option is set, replay refs from the refSet.
+       */
+      if (options.dereference.immutable) {
+        mutableRefsSet.refs.filter(ref => ref.uri.startsWith('immutable://')).map(ref => (0, _empty.Reference)({
+          ...ref,
+          uri: ref.uri.replace(/^immutable:\/\//, '')
+        })).forEach(ref => immutableRefSet.add(ref));
+        reference = immutableRefSet.find(ref => ref.uri === file.uri);
+        refSet = immutableRefSet;
+      }
+
+      /**
+       * Release all memory if this refSet was not provided as an configuration option.
        * If provided as configuration option, then provider is responsible for cleanup.
        */
       if (options.dereference.refSet === null) {
-        refSet.clean();
+        immutableRefSet.clean();
       }
+      mutableRefsSet.clean();
       return dereferencedElement;
     }
   }

package/lib/resolver/apidom/reference/dereference/strategies/openapi-3-1-swagger-client/visitors/all-of.js

@@ -31,7 +31,8 @@ const AllOfVisitor = (0, _compose.default)({
 
         // remove allOf keyword if empty
         if (schemaElement.allOf.isEmpty) {
-          return new _apidomNsOpenapi.SchemaElement(schemaElement.content.filter(memberElement => (0, _apidomCore.toValue)(memberElement.key) !== 'allOf'), (0, _apidomCore.cloneDeep)(schemaElement.meta), (0, _apidomCore.cloneDeep)(schemaElement.attributes));
+          schemaElement.remove('allOf');
+          return undefined;
         }
 
         // collect errors if allOf keyword contains anything else than Schema Object
@@ -43,37 +44,45 @@ const AllOfVisitor = (0, _compose.default)({
           (_this$options$derefer2 = this.options.dereference.dereferenceOpts) == null || (_this$options$derefer2 = _this$options$derefer2.errors) == null || _this$options$derefer2.push == null || _this$options$derefer2.push(error);
           return undefined;
         }
-        const mergedSchemaElement = _apidomCore.deepmerge.all([...schemaElement.allOf.content, schemaElement]);
+        while (schemaElement.hasKey('allOf')) {
+          const {
+            allOf
+          } = schemaElement;
+          schemaElement.remove('allOf');
+          const allOfMerged = _apidomCore.deepmerge.all([...allOf.content, schemaElement]);
 
-        /**
-         * If there was not an original $$ref value, make sure to remove
-         * any $$ref value that may exist from the result of `allOf` merges.
-         */
-        if (!schemaElement.hasKey('$$ref')) {
-          mergedSchemaElement.remove('$$ref');
-        }
+          /**
+           * If there was not an original $$ref value, make sure to remove
+           * any $$ref value that may exist from the result of `allOf` merges.
+           */
+          if (!schemaElement.hasKey('$$ref')) {
+            allOfMerged.remove('$$ref');
+          }
 
-        /**
-         * If there was an example keyword in the original definition,
-         * keep it instead of merging with example from other schema.
-         */
-        if (schemaElement.hasKey('example')) {
-          const member = mergedSchemaElement.getMember('example');
-          member.value = schemaElement.get('example');
-        }
+          /**
+           * If there was an example keyword in the original schema,
+           * keep it instead of merging with example from other schema.
+           */
+          if (schemaElement.hasKey('example')) {
+            const member = allOfMerged.getMember('example');
+            if (member) {
+              member.value = schemaElement.get('example');
+            }
+          }
 
-        /**
-         * If there was an examples keyword in the original definition,
-         * keep it instead of merging with examples from other schema.
-         */
-        if (schemaElement.hasKey('examples')) {
-          const member = mergedSchemaElement.getMember('examples');
-          member.value = schemaElement.get('examples');
+          /**
+           * If there was an examples keyword in the original schema,
+           * keep it instead of merging with examples from other schema.
+           */
+          if (schemaElement.hasKey('examples')) {
+            const member = allOfMerged.getMember('examples');
+            if (member) {
+              member.value = schemaElement.get('examples');
+            }
+          }
+          schemaElement.content = allOfMerged.content;
         }
-
-        // remove allOf keyword after the merge
-        mergedSchemaElement.remove('allOf');
-        return mergedSchemaElement;
+        return undefined;
       }
     }
   }