openapi-enforcer - npm Package Compare versions

Comparing version 1.17.0 to 1.17.1

CHANGELOG.md

@@ -7,2 +7,11 @@ # Change Log
 
+
+## 1.17.1
+
+### Fixed
+
+- **Lookup $ref Value Only When $ref is a string**
+
+  Previously any objects with a `$ref` property would treat the value of the `$ref` as a reference to resolve regardless of the value assigned to the `$ref` property. Now there is a check that makes sure that the value assigned to the `$ref` property is a string prior to attempting to look up the reference.
+
 ## 1.17.0
@@ -9,0 +18,0 @@

examples/check-definition-for-errors.js

@@ -0,0 +0,0 @@ /**

examples/request-response.js

@@ -0,0 +0,0 @@ /**

index.js

@@ -0,0 +0,0 @@ /**

package.json

 {
   "name": "openapi-enforcer",
-  "version": "1.17.0",
+  "version": "1.17.1",
   "description": "Library for validating, parsing, and formatting data against open api schemas.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -0,0 +0,0 @@ # OpenAPI-Enforcer

src/assert.js

@@ -0,0 +0,0 @@ /**

src/data-type-formats.js

@@ -0,0 +0,0 @@ /**

src/definition-builder.js

@@ -0,0 +0,0 @@ /**

src/definition-validator.js

@@ -0,0 +0,0 @@ /**

src/enforcer-ref.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Callback.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Components.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Contact.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Encoding.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Example.js

@@ -0,0 +0,0 @@ /**

src/enforcers/ExternalDocumentation.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Header.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Info.js

@@ -0,0 +0,0 @@ /**

src/enforcers/License.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Link.js

@@ -0,0 +0,0 @@ /**

src/enforcers/MediaType.js

@@ -0,0 +0,0 @@ /**

src/enforcers/OAuthFlow.js

@@ -0,0 +0,0 @@ /**

src/enforcers/OAuthFlows.js

@@ -0,0 +0,0 @@ /**

src/enforcers/OpenApi.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Parameter.js

@@ -0,0 +0,0 @@ /**

src/enforcers/PathItem.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Paths.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Reference.js

@@ -0,0 +0,0 @@ /**

src/enforcers/RequestBody.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Response.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Responses.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Schema.js

@@ -0,0 +0,0 @@ /**

src/enforcers/SecurityRequirement.js

@@ -0,0 +0,0 @@ /**

src/enforcers/SecurityScheme.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Server.js

@@ -0,0 +0,0 @@ /**

src/enforcers/ServerVariable.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Swagger.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Tag.js

@@ -0,0 +0,0 @@ /**

src/enforcers/Xml.js

@@ -0,0 +0,0 @@ /**

src/exception.js

@@ -0,0 +0,0 @@ /**

src/ref-parser.js

@@ -284,3 +284,3 @@ /**
     } else if (value && typeof value === 'object') {
-        if (value.hasOwnProperty('$ref')) {
+        if (value.hasOwnProperty('$ref') && typeof value.$ref === 'string') {
             const infiniteLoop = chain.includes(value);
@@ -287,0 +287,0 @@ if (infiniteLoop) {

src/result.js

@@ -0,0 +0,0 @@ /**

src/rx.js

@@ -0,0 +0,0 @@ /**

src/schema/deserialize.js

@@ -0,0 +0,0 @@ /**

src/schema/hooks.js

@@ -0,0 +0,0 @@

src/schema/populate.js

@@ -0,0 +0,0 @@ /**

src/schema/random.js

@@ -0,0 +0,0 @@ /**

src/schema/serialize.js

@@ -0,0 +0,0 @@ /**

src/schema/util.js

@@ -0,0 +0,0 @@ const Exception = require('../exception');

src/schema/validate.js

@@ -0,0 +0,0 @@ /**

src/schema/value.js

@@ -0,0 +0,0 @@ /**

src/super.js

@@ -0,0 +0,0 @@ /**

src/util.js

@@ -0,0 +0,0 @@ /**

src/validator-parameter-base.js

@@ -0,0 +0,0 @@ /**

test-resources/ref-parser/Household.json

@@ -0,0 +0,0 @@ {

test-resources/ref-parser/server.js

@@ -0,0 +0,0 @@ const fs = require('fs');

test/definition-validator.test.js

@@ -0,0 +0,0 @@ /**

test/definition.callback.test.js

@@ -0,0 +0,0 @@ /**

test/definition.example.test.js

@@ -0,0 +0,0 @@ /**

test/definition.open-api.test.js

@@ -0,0 +0,0 @@ /**

test/definition.response.test.js

@@ -0,0 +0,0 @@ /**

test/definition.security.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.contact.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.external-documentation.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.info.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.license.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.links.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.openapi.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.parameter.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.paths.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.request-body.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.response.test.js

@@ -0,0 +0,0 @@ /**

test/enforcer.tag.test.js

@@ -0,0 +0,0 @@ /**

test/exception.test.js

@@ -0,0 +0,0 @@ /**

test/issues.test.js

@@ -0,0 +0,0 @@ const expect = require('chai').expect;

test/ref-parser.test.js

@@ -93,2 +93,23 @@ const expect = require('chai').expect;
 
+    it('will only lookup reference if $ref value is of type string', async () => {
+        const obj = {
+            A: {
+                title: 'A',
+                pair: {
+                    $ref: '#/B/title'
+                },
+            },
+            B: {
+                title: 'B'
+            },
+            $ref: {
+                title: '$ref'
+            }
+        };
+        const parser = new RefParser(obj);
+        const [ result ] = await parser.dereference();
+        expect(result.A.pair).to.equal('B')
+        expect(result.$ref.title).to.equal('$ref')
+    })
+
     it('can handle circular references in same object', async () => {
@@ -95,0 +116,0 @@ const obj = {

test/util.test.js

@@ -0,0 +0,0 @@ /**

New alerts

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Fixed alerts

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

1025055

decreased by-35.71%

Number of package files

112

decreased by-39.46%

Lines of code

20308

decreased by-3.29%

No dependency changes