@swagger-api/apidom-ns-openapi-3-0 0.77.0 → 0.78.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.78.0](https://github.com/swagger-api/apidom/compare/v0.77.0...v0.78.0) (2023-10-17)
+
+### Bug Fixes
+
+- **ns-openapi-3:** support only subset of JSON Schema Draft 4/5 ([#3265](https://github.com/swagger-api/apidom/issues/3265)) ([e8a19d1](https://github.com/swagger-api/apidom/commit/e8a19d18ad43959a688a004e5d277553b0a171ac))
+- **types:** fix regression in @types/ramda@0.29.6 ([#3281](https://github.com/swagger-api/apidom/issues/3281)) ([c6c279f](https://github.com/swagger-api/apidom/commit/c6c279f526e07b16221d8c00dd0041eeb93e1290)), closes [#3279](https://github.com/swagger-api/apidom/issues/3279)
+
+### Features
+
+- scaffold OpenAPI 2.0 namespace package ([#3218](https://github.com/swagger-api/apidom/issues/3218)) ([d949353](https://github.com/swagger-api/apidom/commit/d949353f7779690414fb74aafedff230ddf77cd3)), closes [#3097](https://github.com/swagger-api/apidom/issues/3097)
+
 # [0.77.0](https://github.com/swagger-api/apidom/compare/v0.76.2...v0.77.0) (2023-10-03)
 
 **Note:** Version bump only for package @swagger-api/apidom-ns-openapi-3-0

package/README.md

@@ -52,7 +52,7 @@ import { isOpenApi3_0Element, OpenApi3_0Element } from '@swagger-api/apidom-ns-o
 
 const openApiElement = new OpenApi3_0Element();
 
-OpenApi3_0Element(openApiElement); // => true
+isOpenApi3_0Element(openApiElement); // => true
 ```
 
 ## Traversal
@@ -160,7 +160,7 @@ openapi: 3.0.3
 info:
 `;
 const apiDOM = await parse(yamlDefinition);
-const apenApiElement = OpenApi3_0Element.refract(apiDOM.result, {
+const openApiElement = OpenApi3_0Element.refract(apiDOM.result, {
   plugins: [refractorPluginReplaceEmptyElement()],
 });
 

package/cjs/elements/Schema.cjs

@@ -2,7 +2,9 @@
 
 exports.__esModule = true;
 exports.default = void 0;
+var _apidomError = require("@swagger-api/apidom-error");
 var _apidomNsJsonSchemaDraft = require("@swagger-api/apidom-ns-json-schema-draft-4");
+/* eslint-disable class-methods-use-this */
 class Schema extends _apidomNsJsonSchemaDraft.JSONSchemaElement {
   constructor(content, meta, attributes) {
     super(content, meta, attributes);
@@ -10,6 +12,24 @@ class Schema extends _apidomNsJsonSchemaDraft.JSONSchemaElement {
     this.classes.push('json-schema-draft-4');
   }
 
+  /**
+   * Core vocabulary
+   *
+   * URI: https://tools.ietf.org/html/draft-wright-json-schema-00
+   */
+  get idProp() {
+    throw new _apidomError.UnsupportedOperationError('idProp getter in Schema class is not not supported.');
+  }
+  set idProp(idProps) {
+    throw new _apidomError.UnsupportedOperationError('idProp setter in Schema class is not not supported.');
+  }
+  get $schema() {
+    throw new _apidomError.UnsupportedOperationError('$schema getter in Schema class is not not supported.');
+  }
+  set $schema($schema) {
+    throw new _apidomError.UnsupportedOperationError('$schema setter in Schema class is not not supported.');
+  }
+
   /**
    * Validation keywords for arrays
    */
@@ -37,6 +57,18 @@ class Schema extends _apidomNsJsonSchemaDraft.JSONSchemaElement {
   set additionalProperties(additionalProperties) {
     this.set('additionalProperties', additionalProperties);
   }
+  get patternProperties() {
+    throw new _apidomError.UnsupportedOperationError('patternProperties getter in Schema class is not not supported.');
+  }
+  set patternProperties(patternProperties) {
+    throw new _apidomError.UnsupportedOperationError('patternProperties setter in Schema class is not not supported.');
+  }
+  get dependencies() {
+    throw new _apidomError.UnsupportedOperationError('dependencies getter in Schema class is not not supported.');
+  }
+  set dependencies(dependencies) {
+    throw new _apidomError.UnsupportedOperationError('dependencies setter in Schema class is not not supported.');
+  }
 
   /**
    *  Validation keywords for any instance type
@@ -54,6 +86,37 @@ class Schema extends _apidomNsJsonSchemaDraft.JSONSchemaElement {
   set not(not) {
     this.set('not', not);
   }
+  get definitions() {
+    throw new _apidomError.UnsupportedOperationError('definitions getter in Schema class is not not supported.');
+  }
+  set definitions(definitions) {
+    throw new _apidomError.UnsupportedOperationError('definitions setter in Schema class is not not supported.');
+  }
+
+  /**
+   * JSON Hyper-Schema
+   *
+   * URI: https://datatracker.ietf.org/doc/html/draft-wright-json-schema-hyperschema-00
+   */
+
+  get base() {
+    throw new _apidomError.UnsupportedOperationError('base getter in Schema class is not not supported.');
+  }
+  set base(base) {
+    throw new _apidomError.UnsupportedOperationError('base setter in Schema class is not not supported.');
+  }
+  get links() {
+    throw new _apidomError.UnsupportedOperationError('links getter in Schema class is not not supported.');
+  }
+  set links(links) {
+    throw new _apidomError.UnsupportedOperationError('links setter in Schema class is not not supported.');
+  }
+  get media() {
+    throw new _apidomError.UnsupportedOperationError('media getter in Schema class is not not supported.');
+  }
+  set media(media) {
+    throw new _apidomError.UnsupportedOperationError('media setter in Schema class is not not supported.');
+  }
 
   /**
    * OpenAPI vocabulary
@@ -102,4 +165,5 @@ class Schema extends _apidomNsJsonSchemaDraft.JSONSchemaElement {
     this.set('deprecated', deprecated);
   }
 }
+/* eslint-disable class-methods-use-this */
 var _default = exports.default = Schema;

package/cjs/refractor/specification.cjs

@@ -75,17 +75,14 @@ var _index15 = _interopRequireDefault(require("./visitors/open-api-3-0/schema/in
 var _AllOfVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/AllOfVisitor.cjs"));
 var _AnyOfVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/AnyOfVisitor.cjs"));
 var _OneOfVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/OneOfVisitor.cjs"));
-var _DefinitionsVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/DefinitionsVisitor.cjs"));
-var _DependenciesVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/DependenciesVisitor.cjs"));
 var _ItemsVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/ItemsVisitor.cjs"));
 var _PropertiesVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/PropertiesVisitor.cjs"));
-var _PatternPropertiesVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/PatternPropertiesVisitor.cjs"));
 var _TypeVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/TypeVisitor.cjs"));
 var _NullableVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/NullableVisitor.cjs"));
 var _WriteOnlyVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/WriteOnlyVisitor.cjs"));
 var _ExampleVisitor3 = _interopRequireDefault(require("./visitors/open-api-3-0/schema/ExampleVisitor.cjs"));
 var _DeprecatedVisitor3 = _interopRequireDefault(require("./visitors/open-api-3-0/schema/DeprecatedVisitor.cjs"));
-var _inheritedFixedFields = _interopRequireDefault(require("./visitors/open-api-3-0/schema/inherited-fixed-fields.cjs"));
+var _SchemaOrReferenceVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/schema/SchemaOrReferenceVisitor.cjs"));
 var _index16 = _interopRequireDefault(require("./visitors/open-api-3-0/distriminator/index.cjs"));
 var _PropertyNameVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/distriminator/PropertyNameVisitor.cjs"));
 var _MappingVisitor = _interopRequireDefault(require("./visitors/open-api-3-0/distriminator/MappingVisitor.cjs"));
@@ -175,46 +172,9 @@ var _TagsVisitor2 = _interopRequireDefault(require("./visitors/open-api-3-0/Tags
  * Note: Specification object allows to use absolute internal JSON pointers.
  */
 
-const ReferenceSpecification = {
-  $visitor: _index12.default,
-  fixedFields: {
-    $ref: _$RefVisitor.default
-  }
-};
-const SchemaSpecification = {
-  $visitor: _index15.default,
-  fixedFields: {
-    ..._inheritedFixedFields.default,
-    // validation vocabulary
-    // validation keywords for any instance type
-    allOf: _AllOfVisitor.default,
-    anyOf: _AnyOfVisitor.default,
-    oneOf: _OneOfVisitor.default,
-    definitions: _DefinitionsVisitor.default,
-    // validation keywords for arrays
-    items: _ItemsVisitor.default,
-    // Validation keywords for objects
-    dependencies: _DependenciesVisitor.default,
-    properties: _PropertiesVisitor.default,
-    patternProperties: _PatternPropertiesVisitor.default,
-    // validation keywords for any instance type
-    type: _TypeVisitor.default,
-    // OpenAPI vocabulary
-    nullable: _NullableVisitor.default,
-    discriminator: {
-      $ref: '#/visitors/document/objects/Discriminator'
-    },
-    writeOnly: _WriteOnlyVisitor.default,
-    xml: {
-      $ref: '#/visitors/document/objects/XML'
-    },
-    externalDocs: {
-      $ref: '#/visitors/document/objects/ExternalDocumentation'
-    },
-    example: _ExampleVisitor3.default,
-    deprecated: _DeprecatedVisitor3.default
-  }
-};
+const {
+  fixedFields: jsonSchemaFixedFields
+} = _apidomNsJsonSchemaDraft.specificationObj.visitors.document.objects.JSONSchema;
 const specification = {
   visitors: {
     value: _FallbackVisitor.default,
@@ -477,12 +437,66 @@ const specification = {
             }
           }
         },
-        JSONReference: ReferenceSpecification,
-        Reference: ReferenceSpecification,
-        JSONSchema: SchemaSpecification,
-        Schema: SchemaSpecification,
-        LinkDescription: _apidomNsJsonSchemaDraft.specificationObj.visitors.document.objects.LinkDescription,
-        Media: _apidomNsJsonSchemaDraft.specificationObj.visitors.document.objects.Media,
+        Reference: {
+          $visitor: _index12.default,
+          fixedFields: {
+            $ref: _$RefVisitor.default
+          }
+        },
+        JSONSchema: {
+          $ref: '#/visitors/document/objects/Schema'
+        },
+        JSONReference: {
+          $ref: '#/visitors/document/objects/Reference'
+        },
+        Schema: {
+          $visitor: _index15.default,
+          fixedFields: {
+            // the following properties are taken directly from the JSON Schema definition and follow the same specifications
+            title: jsonSchemaFixedFields.title,
+            multipleOf: jsonSchemaFixedFields.multipleOf,
+            maximum: jsonSchemaFixedFields.maximum,
+            exclusiveMaximum: jsonSchemaFixedFields.exclusiveMaximum,
+            minimum: jsonSchemaFixedFields.minimum,
+            exclusiveMinimum: jsonSchemaFixedFields.exclusiveMinimum,
+            maxLength: jsonSchemaFixedFields.maxLength,
+            minLength: jsonSchemaFixedFields.minLength,
+            pattern: jsonSchemaFixedFields.pattern,
+            maxItems: jsonSchemaFixedFields.maxItems,
+            minItems: jsonSchemaFixedFields.minItems,
+            uniqueItems: jsonSchemaFixedFields.uniqueItems,
+            maxProperties: jsonSchemaFixedFields.maxProperties,
+            minProperties: jsonSchemaFixedFields.minProperties,
+            required: jsonSchemaFixedFields.required,
+            enum: jsonSchemaFixedFields.enum,
+            // the following properties are taken from the JSON Schema definition but their definitions were adjusted to the OpenAPI Specification
+            type: _TypeVisitor.default,
+            allOf: _AllOfVisitor.default,
+            anyOf: _AnyOfVisitor.default,
+            oneOf: _OneOfVisitor.default,
+            not: _SchemaOrReferenceVisitor.default,
+            items: _ItemsVisitor.default,
+            properties: _PropertiesVisitor.default,
+            additionalProperties: _SchemaOrReferenceVisitor.default,
+            description: jsonSchemaFixedFields.description,
+            format: jsonSchemaFixedFields.format,
+            default: jsonSchemaFixedFields.default,
+            // OpenAPI vocabulary
+            nullable: _NullableVisitor.default,
+            discriminator: {
+              $ref: '#/visitors/document/objects/Discriminator'
+            },
+            writeOnly: _WriteOnlyVisitor.default,
+            xml: {
+              $ref: '#/visitors/document/objects/XML'
+            },
+            externalDocs: {
+              $ref: '#/visitors/document/objects/ExternalDocumentation'
+            },
+            example: _ExampleVisitor3.default,
+            deprecated: _DeprecatedVisitor3.default
+          }
+        },
         Discriminator: {
           $visitor: _index16.default,
           fixedFields: {

package/cjs/refractor/visitors/SpecificationVisitor.cjs

@@ -37,7 +37,11 @@ const SpecificationVisitor = (0, _stampit.default)(_Visitor.default, {
       return (0, _ramda.pick)(this.passingOptionsNames, this);
     },
     retrieveFixedFields(specPath) {
-      return (0, _ramda.pipe)((0, _ramda.path)(['visitors', ...specPath, 'fixedFields']), _ramda.keys)(this.specObj);
+      const fixedFields = (0, _ramda.path)(['visitors', ...specPath, 'fixedFields'], this.specObj);
+      if (typeof fixedFields === 'object' && fixedFields !== null) {
+        return Object.keys(fixedFields);
+      }
+      return [];
     },
     retrieveVisitor(specPath) {
       if ((0, _ramda.pathSatisfies)(_ramdaAdjunct.isFunction, ['visitors', ...specPath], this.specObj)) {