@redocly/openapi-core 1.3.0 → 1.4.1

package/lib/walk.js

@@ -33,9 +33,9 @@ function walkDocument(opts) {
     function walkNode(node, type, location, parent, key) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
         const resolve = (ref, from = currentLocation.source.absoluteRef) => {
-            if (!ref_utils_1.isRef(ref))
+            if (!(0, ref_utils_1.isRef)(ref))
                 return { location, node: ref };
-            const refId = resolve_1.makeRefId(from, ref.$ref);
+            const refId = (0, resolve_1.makeRefId)(from, ref.$ref);
             const resolvedRef = resolvedRefMap.get(refId);
             if (!resolvedRef) {
                 return {
@@ -55,7 +55,7 @@ function walkDocument(opts) {
         let currentLocation = location;
         const { node: resolvedNode, location: resolvedLocation, error } = resolve(node);
         const enteredContexts = new Set();
-        if (ref_utils_1.isRef(node)) {
+        if ((0, ref_utils_1.isRef)(node)) {
             const refEnterVisitors = normalizedVisitors.ref.enter;
             for (const { visit: visitor, ruleId, severity, context } of refEnterVisitors) {
                 enteredContexts.add(context);
@@ -120,10 +120,10 @@ function walkDocument(opts) {
                                     rawNode: node,
                                 })))) !== null && _k !== void 0 ? _k : false,
                         };
-                        context.activatedOn = utils_1.pushStack(context.activatedOn, activatedOn);
+                        context.activatedOn = (0, utils_1.pushStack)(context.activatedOn, activatedOn);
                         let ctx = context.parent;
                         while (ctx) {
-                            ctx.activatedOn.value.nextLevelTypeActivated = utils_1.pushStack(ctx.activatedOn.value.nextLevelTypeActivated, type);
+                            ctx.activatedOn.value.nextLevelTypeActivated = (0, utils_1.pushStack)(ctx.activatedOn.value.nextLevelTypeActivated, type);
                             ctx = ctx.parent;
                         }
                         if (!activatedOn.skipped) {
@@ -154,7 +154,7 @@ function walkDocument(opts) {
                     else if (type.extensionsPrefix) {
                         props.push(...Object.keys(resolvedNode).filter((k) => k.startsWith(type.extensionsPrefix)));
                     }
-                    if (ref_utils_1.isRef(node)) {
+                    if ((0, ref_utils_1.isRef)(node)) {
                         props.push(...Object.keys(node).filter((k) => k !== '$ref' && !props.includes(k))); // properties on the same level as $ref
                     }
                     for (const propName of props) {
@@ -174,14 +174,14 @@ function walkDocument(opts) {
                             propName.startsWith(type.extensionsPrefix)) {
                             propType = types_1.SpecExtension;
                         }
-                        if (!types_1.isNamedType(propType) && (propType === null || propType === void 0 ? void 0 : propType.directResolveAs)) {
+                        if (!(0, types_1.isNamedType)(propType) && (propType === null || propType === void 0 ? void 0 : propType.directResolveAs)) {
                             propType = propType.directResolveAs;
                             value = { $ref: value };
                         }
                         if (propType && propType.name === undefined && propType.resolvable !== false) {
                             propType = { name: 'scalar', properties: {} };
                         }
-                        if (!types_1.isNamedType(propType) || (propType.name === 'scalar' && !ref_utils_1.isRef(value))) {
+                        if (!(0, types_1.isNamedType)(propType) || (propType.name === 'scalar' && !(0, ref_utils_1.isRef)(value))) {
                             continue;
                         }
                         walkNode(value, propType, loc.child([propName]), resolvedNode, propName);
@@ -195,11 +195,11 @@ function walkDocument(opts) {
                     context.seen.delete(resolvedNode);
                 }
                 else {
-                    context.activatedOn = utils_1.popStack(context.activatedOn);
+                    context.activatedOn = (0, utils_1.popStack)(context.activatedOn);
                     if (context.parent) {
                         let ctx = context.parent;
                         while (ctx) {
-                            ctx.activatedOn.value.nextLevelTypeActivated = utils_1.popStack(ctx.activatedOn.value.nextLevelTypeActivated);
+                            ctx.activatedOn.value.nextLevelTypeActivated = (0, utils_1.popStack)(ctx.activatedOn.value.nextLevelTypeActivated);
                             ctx = ctx.parent;
                         }
                     }
@@ -212,7 +212,7 @@ function walkDocument(opts) {
             }
         }
         currentLocation = location;
-        if (ref_utils_1.isRef(node)) {
+        if ((0, ref_utils_1.isRef)(node)) {
             const refLeaveVisitors = normalizedVisitors.ref.leave;
             for (const { visit: visitor, ruleId, severity, context } of refLeaveVisitors) {
                 if (enteredContexts.has(context)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.3.0",
+  "version": "1.4.1",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -52,6 +52,6 @@
     "@types/minimatch": "^3.0.5",
     "@types/node-fetch": "^2.5.7",
     "@types/pluralize": "^0.0.29",
-    "typescript": "^4.0.5"
+    "typescript": "^5.2.2"
   }
 }

package/src/__tests__/lint.test.ts

@@ -27,11 +27,11 @@ describe('lint', () => {
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/info/license",
               "reportOnKey": false,
               "source": "/test/spec.yaml",
@@ -40,7 +40,7 @@ describe('lint', () => {
           "message": "Expected type \`License\` (object) but got \`string\`",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -56,11 +56,11 @@ describe('lint', () => {
 
     expect(replaceSourceWithRef(results, path.join(__dirname, 'fixtures/lint/')))
       .toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/info/license",
               "reportOnKey": false,
               "source": "openapi.yaml",
@@ -69,7 +69,7 @@ describe('lint', () => {
           "message": "Expected type \`License\` (object) but got \`string\`",
           "ruleId": "spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -125,11 +125,11 @@ describe('lint', () => {
     const results = await lintConfig({ document });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/eme",
               "reportOnKey": true,
               "source": "",
@@ -138,17 +138,17 @@ describe('lint', () => {
           "message": "Property \`eme\` is not expected here.",
           "ruleId": "configuration spec",
           "severity": "error",
-          "suggest": Array [
+          "suggest": [
             "theme",
             "env",
             "seo",
             "sso",
           ],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/openapi",
               "reportOnKey": true,
               "source": "",
@@ -157,12 +157,12 @@ describe('lint', () => {
           "message": "Property \`openapi\` is not expected here.",
           "ruleId": "configuration spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
-        Object {
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/apis",
               "reportOnKey": false,
               "source": "",
@@ -171,7 +171,7 @@ describe('lint', () => {
           "message": "Expected type \`ConfigApis\` (object) but got \`string\`",
           "ruleId": "configuration spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -191,11 +191,11 @@ describe('lint', () => {
     const results = await lintConfig({ document });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/api",
               "reportOnKey": true,
               "source": "",
@@ -204,7 +204,7 @@ describe('lint', () => {
           "message": "Property \`api\` is not expected here.",
           "ruleId": "configuration spec",
           "severity": "error",
-          "suggest": Array [
+          "suggest": [
             "apis",
             "seo",
             "sso",
@@ -231,11 +231,11 @@ describe('lint', () => {
     const results = await lintConfig({ document });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/referenceDocs",
               "reportOnKey": true,
               "source": "",
@@ -244,7 +244,7 @@ describe('lint', () => {
           "message": "Property \`referenceDocs\` is not expected here.",
           "ruleId": "configuration spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -266,11 +266,11 @@ describe('lint', () => {
     const results = await lintConfig({ document });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
+      [
+        {
           "from": undefined,
-          "location": Array [
-            Object {
+          "location": [
+            {
               "pointer": "#/apis/main/plugins",
               "reportOnKey": true,
               "source": "",
@@ -279,7 +279,7 @@ describe('lint', () => {
           "message": "Property \`plugins\` is not expected here.",
           "ruleId": "configuration spec",
           "severity": "error",
-          "suggest": Array [],
+          "suggest": [],
         },
       ]
     `);
@@ -323,7 +323,7 @@ describe('lint', () => {
       config: await makeConfig({ spec: 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('detect OpenAPI should throw an error when version is not string', () => {
@@ -402,7 +402,7 @@ describe('lint', () => {
       config: await makeConfig({ spec: 'error' }),
     });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`[]`);
   });
 
   it('should ignore error because ignore file passed', async () => {

package/src/__tests__/normalizeVisitors.test.ts

@@ -1,4 +1,10 @@
-import { normalizeVisitors, VisitorLevelContext } from '../visitors';
+import {
+  BaseVisitor,
+  NestedVisitObject,
+  normalizeVisitors,
+  RuleInstanceConfig,
+  VisitorLevelContext,
+} from '../visitors';
 import { Oas3RuleSet } from '../oas-types';
 import { Oas3Types } from '../types/oas3';
 import { normalizeTypes } from '../types';
@@ -25,7 +31,10 @@ describe('Normalize visitors', () => {
       }))
     );
 
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
+    const normalized = normalizeVisitors(
+      visitors as (RuleInstanceConfig & { visitor: NestedVisitObject<any, BaseVisitor> })[],
+      normalizeTypes(Oas3Types)
+    );
     expect(normalized).toBeDefined();
     expect(normalized.Schema.enter).toHaveLength(1);
     expect(normalized.Schema.enter[0].visit).toEqual(schemaEnter);
@@ -69,7 +78,10 @@ describe('Normalize visitors', () => {
       }))
     );
 
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
+    const normalized = normalizeVisitors(
+      visitors as (RuleInstanceConfig & { visitor: NestedVisitObject<any, BaseVisitor> })[],
+      normalizeTypes(Oas3Types)
+    );
     expect(normalized).toBeDefined();
     expect(normalized.Info.enter).toHaveLength(1);
 
@@ -107,7 +119,10 @@ describe('Normalize visitors', () => {
       }))
     );
 
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
+    const normalized = normalizeVisitors(
+      visitors as (RuleInstanceConfig & { visitor: NestedVisitObject<any, BaseVisitor> })[],
+      normalizeTypes(Oas3Types)
+    );
     expect(normalized).toBeDefined();
     expect(normalized.PathItem.enter).toHaveLength(1);
     expect(normalized.Operation.enter).toHaveLength(1);
@@ -142,7 +157,10 @@ describe('Normalize visitors', () => {
       }))
     );
 
-    const normalized = normalizeVisitors(visitors, normalizeTypes(Oas3Types));
+    const normalized = normalizeVisitors(
+      visitors as (RuleInstanceConfig & { visitor: NestedVisitObject<any, BaseVisitor> })[],
+      normalizeTypes(Oas3Types)
+    );
     expect(normalized).toBeDefined();
     expect(normalized.Parameter.enter).toHaveLength(2);
     expect(normalized.Parameter.enter[0].visit).toStrictEqual(operationParam);

package/src/__tests__/ref-utils.test.ts

@@ -9,8 +9,8 @@ describe('ref-utils', () => {
   it(`should unescape refs with '/'`, () => {
     const reference = 'somefile.yaml#/components/schemas/scope~1domain-schema';
     expect(parseRef(reference)).toMatchInlineSnapshot(`
-      Object {
-        "pointer": Array [
+      {
+        "pointer": [
           "components",
           "schemas",
           "scope/domain-schema",
@@ -23,8 +23,8 @@ describe('ref-utils', () => {
   it(`should unescape refs with '~'`, () => {
     const reference = 'somefile.yaml#/components/schemas/complex~0name';
     expect(parseRef(reference)).toMatchInlineSnapshot(`
-      Object {
-        "pointer": Array [
+      {
+        "pointer": [
           "components",
           "schemas",
           "complex~name",
@@ -37,8 +37,8 @@ describe('ref-utils', () => {
   it(`should unescape complex urlencoded paths`, () => {
     const referene = 'somefile.yaml#/components/schemas/scope%2Fcomplex~name';
     expect(parseRef(referene)).toMatchInlineSnapshot(`
-      Object {
-        "pointer": Array [
+      {
+        "pointer": [
           "components",
           "schemas",
           "scope/complex~name",
@@ -93,7 +93,7 @@ describe('ref-utils', () => {
       config: new StyleguideConfig({}),
     });
 
-    expect(result).toMatchInlineSnapshot(`Array []`);
+    expect(result).toMatchInlineSnapshot(`[]`);
   });
 
   describe('refBaseName', () => {

package/src/__tests__/resolve-http.test.ts

@@ -48,25 +48,25 @@ describe('Resolve http-headers', () => {
 
     expect(fetchMock).toBeCalledTimes(3);
     expect(fetchMock.mock.calls).toMatchInlineSnapshot(`
-      Array [
-        Array [
+      [
+        [
           "https://example.com/test.yaml",
-          Object {
-            "headers": Object {
+          {
+            "headers": {
               "X_TEST": "123",
             },
           },
         ],
-        Array [
+        [
           "https://sample.com/test.yaml",
-          Object {
-            "headers": Object {},
+          {
+            "headers": {},
           },
         ],
-        Array [
+        [
           "https://sample.com/test/a/test.yaml",
-          Object {
-            "headers": Object {
+          {
+            "headers": {
               "X_TEST": "321",
             },
           },

package/src/__tests__/resolve.test.ts

@@ -33,7 +33,7 @@ describe('collect refs', () => {
     expect(Array.from(resolvedRefs.keys())).toMatchInlineSnapshot(
       [`foobar.yaml::#/defs/info`],
       `
-      Array [
+      [
         "foobar.yaml::#/defs/info",
       ]
     `
@@ -198,7 +198,7 @@ describe('collect refs', () => {
         .map((ref) => ref.substring(cwd.length + 1))
         .sort()
     ).toMatchInlineSnapshot(`
-      Array [
+      [
         "openapi-with-back.yaml::./schemas/type-a.yaml#/",
         "openapi-with-back.yaml::./schemas/type-b.yaml#/",
         "schemas/type-a.yaml::../openapi-with-back.yaml#/components/schemas/TypeB",
@@ -214,19 +214,19 @@ describe('collect refs', () => {
           return getKey(firstEl).localeCompare(getKey(secondEl));
         })
     ).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "allOf": Array [
-            Object {
-              "properties": Object {
-                "integration_type": Object {
+      [
+        {
+          "allOf": [
+            {
+              "properties": {
+                "integration_type": {
                   "$ref": "../openapi-with-back.yaml#/components/schemas/TypeB",
                 },
-                "name": Object {
+                "name": {
                   "type": "string",
                 },
               },
-              "required": Array [
+              "required": [
                 "name",
                 "integration_type",
               ],
@@ -234,8 +234,8 @@ describe('collect refs', () => {
             },
           ],
         },
-        Object {
-          "enum": Array [
+        {
+          "enum": [
             "webhook",
             "api_key",
             "sftp",
@@ -243,8 +243,8 @@ describe('collect refs', () => {
           ],
           "type": "string",
         },
-        Object {
-          "enum": Array [
+        {
+          "enum": [
             "webhook",
             "api_key",
             "sftp",
@@ -270,7 +270,7 @@ describe('collect refs', () => {
     expect(resolvedRefs).toBeDefined();
     expect(Array.from(resolvedRefs.keys()).map((ref) => ref.substring(cwd.length + 1)))
       .toMatchInlineSnapshot(`
-      Array [
+      [
         "openapi.yaml::#/components/schemas/Local",
         "openapi.yaml::#/components/schemas/Local/properties/string",
         "openapi.yaml::./External.yaml#/properties/string",
@@ -281,62 +281,62 @@ describe('collect refs', () => {
     `);
 
     expect(Array.from(resolvedRefs.values()).map((val) => val.node)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "properties": Object {
-            "localCircular": Object {
+      [
+        {
+          "properties": {
+            "localCircular": {
               "$ref": "#/components/schemas/Local",
             },
-            "number": Object {
+            "number": {
               "type": "number",
             },
-            "string": Object {
+            "string": {
               "type": "string",
             },
           },
         },
-        Object {
+        {
           "type": "string",
         },
-        Object {
+        {
           "type": "string",
         },
-        Object {
-          "properties": Object {
-            "external": Object {
+        {
+          "properties": {
+            "external": {
               "$ref": "./External2.yaml",
             },
-            "number": Object {
+            "number": {
               "type": "number",
             },
-            "string": Object {
+            "string": {
               "type": "string",
             },
-            "unknown": Object {
+            "unknown": {
               "type": "string",
             },
           },
           "type": "object",
         },
-        Object {
-          "properties": Object {
-            "circularParent": Object {
+        {
+          "properties": {
+            "circularParent": {
               "$ref": "./External.yaml#/properties",
             },
           },
           "type": "object",
         },
-        Object {
-          "external": Object {
+        {
+          "external": {
             "$ref": "./External2.yaml",
           },
-          "number": Object {
+          "number": {
             "type": "number",
           },
-          "string": Object {
+          "string": {
             "type": "string",
           },
-          "unknown": Object {
+          "unknown": {
             "type": "string",
           },
         },
@@ -366,12 +366,12 @@ describe('collect refs', () => {
     // expect(resolvedRefs.size).toEqual(2);
     expect(Array.from(resolvedRefs.keys()).map((ref) => ref.substring(cwd.length + 1)))
       .toMatchInlineSnapshot(`
-      Array [
+      [
         "openapi-with-md-description.yaml::./description.md",
       ]
     `);
     expect(Array.from(resolvedRefs.values()).map((val) => val.node)).toMatchInlineSnapshot(`
-      Array [
+      [
         "# Hello World
 
       Lorem ipsum