@redocly/openapi-core 1.0.0-beta.78 → 1.0.0-beta.82

package/src/__tests__/js-yaml.test.ts

@@ -1,3 +1,4 @@
+import { outdent } from 'outdent';
 import { parseYaml, stringifyYaml } from '../js-yaml';
 
 const yaml = `
@@ -7,7 +8,8 @@ const yaml = `
   number: 1000
   decimal: 12.34
   boolean: true
-  date: 2020-01-01
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
   array:
     - 1
     - 2
@@ -16,6 +18,16 @@ const yaml = `
     key2: 2
 `;
 
+const yamlToDump = outdent`
+  date: '2022-01-21T11:29:56.694Z'
+  dateWithoutQuotes: 2020-01-01
+  dateWithQuotes: '2020-01-01'
+  dateImplicit: !!str 2020-01-01
+  string: test
+  stringWithQuotes: 'test'
+  stringWithDoubleQuotes: "test"
+`;
+
 const jsObject = {
   emptyValue: null,
   'spaces in keys': 'spaces in keys',
@@ -23,7 +35,8 @@ const jsObject = {
   number: 1000,
   decimal: 12.34,
   boolean: true,
-  date: '2020-01-01',
+  dateWithoutQuotes: '2020-01-01',
+  dateWithQuotes: '2020-01-01',
   array: [1, 2],
   object: { key1: 1, key2: 2 },
 };
@@ -33,14 +46,25 @@ describe('js-yaml', () => {
     expect(parseYaml(yaml)).toEqual(jsObject);
   });
 
+  test('should correctly dump date and string', () => {
+    expect(stringifyYaml(parseYaml(yamlToDump))).toMatchInlineSnapshot(
+    `
+    "date: '2022-01-21T11:29:56.694Z'
+    dateWithoutQuotes: '2020-01-01'
+    dateWithQuotes: '2020-01-01'
+    dateImplicit: '2020-01-01'
+    string: test
+    stringWithQuotes: test
+    stringWithDoubleQuotes: test
+    "
+    `);
+  });
+
   test('parse and stringify', () => {
     expect(parseYaml(stringifyYaml(jsObject))).toEqual(jsObject);
   });
 
   test('should throw an error for unsupported types', () => {
-    expect(() => stringifyYaml({ date: new Date() }))
-      .toThrow('unacceptable kind of an object to dump [object Date]');
-
     expect(() => stringifyYaml({ foo: () => {} }))
       .toThrow('unacceptable kind of an object to dump [object Function]');
   });

package/src/__tests__/lint.test.ts

@@ -3,9 +3,7 @@ import { outdent } from 'outdent';
 import { lintFromString, lintConfig, lintDocument } from '../lint';
 import { BaseResolver } from '../resolve';
 import { loadConfig } from '../config/load';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../__tests__/utils';
-// todo create general utils for tests and move this config.
-import { makeConfig } from '../rules/__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
 
 describe('lint', () => {
   it('lintFromString should work', async () => {

package/src/bundle.ts

@@ -1,5 +1,5 @@
 import isEqual = require('lodash.isequal');
-import { BaseResolver, resolveDocument, Document } from './resolve';
+import { BaseResolver, resolveDocument, Document, ResolvedRefMap, makeRefId } from './resolve';
 import { Oas3Rule, normalizeVisitors, Oas3Visitor, Oas2Visitor } from './visitors';
 import { Oas3Types } from './types/oas3';
 import { Oas2Types } from './types/oas2';
@@ -115,25 +115,25 @@ export async function bundleDocument(opts: {
     })
   }
 
+  const resolvedRefMap = await resolveDocument({
+    rootDocument: document,
+    rootType: types.DefinitionRoot,
+    externalRefResolver,
+  });
+
   const bundleVisitor = normalizeVisitors(
     [
       ...preprocessors,
       {
         severity: 'error',
         ruleId: 'bundler',
-        visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document),
+        visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap),
       },
       ...decorators,
     ],
     types,
   );
 
-  const resolvedRefMap = await resolveDocument({
-    rootDocument: document,
-    rootType: types.DefinitionRoot,
-    externalRefResolver,
-  });
-
   walkDocument({
     document,
     rootType: types.DefinitionRoot as NormalizedNodeType,
@@ -198,6 +198,7 @@ function makeBundleVisitor(
   dereference: boolean,
   skipRedoclyRegistryRefs: boolean,
   rootDocument: Document,
+  resolvedRefMap: ResolvedRefMap
 ) {
   let components: Record<string, Record<string, any>>;
 
@@ -230,6 +231,7 @@ function makeBundleVisitor(
             replaceRef(node, resolved, ctx);
           } else {
             node.$ref = saveComponent(componentType, resolved, ctx);
+            resolveBundledComponent(node, resolved, ctx);
           }
         }
       },
@@ -267,6 +269,17 @@ function makeBundleVisitor(
     };
   }
 
+  function resolveBundledComponent(node: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
+    const newRefId = makeRefId(ctx.location.source.absoluteRef, node.$ref)
+    resolvedRefMap.set(newRefId, {
+      document: rootDocument,
+      isRemote: false,
+      node: resolved.node,
+      nodePointer: node.$ref,
+      resolved: true,
+    });
+  }
+
   function replaceRef(ref: OasRef, resolved: ResolveResult<any>, ctx: UserContext) {
     if (!isPlainObject(resolved.node)) {
       ctx.parent[ctx.key] = resolved.node;

package/src/config/builtIn.ts

@@ -1,9 +1,13 @@
 import recommended from './recommended';
 import all from './all';
 import minimal from './minimal';
-import { LintRawConfig, Plugin } from './config';
-
-import * as builtinRules from '../rules/builtin';
+import { CustomRulesConfig, LintRawConfig, Plugin } from './config';
+import { rules as oas3Rules } from '../rules/oas3';
+import { rules as oas2Rules } from '../rules/oas2';
+import { preprocessors as oas3Preprocessors } from '../rules/oas3';
+import { preprocessors as oas2Preprocessors } from '../rules/oas2';
+import { decorators as oas3Decorators } from '../decorators/oas3';
+import { decorators as oas2Decorators } from '../decorators/oas2';
 
 export const builtInConfigs: Record<string, LintRawConfig> = {
   recommended,
@@ -16,8 +20,17 @@ export const builtInConfigs: Record<string, LintRawConfig> = {
 
 export const defaultPlugin: Plugin = {
   id: '', // default plugin doesn't have id
-  rules: builtinRules.rules,
-  preprocessors: builtinRules.preprocessors,
-  decorators: builtinRules.decorators,
+  rules: {
+    oas3: oas3Rules,
+    oas2: oas2Rules,
+  } as CustomRulesConfig,
+  preprocessors: {
+    oas3: oas3Preprocessors,
+    oas2: oas2Preprocessors,
+  },
+  decorators: {
+    oas3: oas3Decorators,
+    oas2: oas2Decorators,
+  },
   configs: builtInConfigs,
-}
+}

package/src/{rules/__tests__/hide-internals.test.ts → decorators/__tests__/remove-x-internal.test.ts}

@@ -1,8 +1,7 @@
 import { outdent } from 'outdent';
-import { bundleDocument } from '../../bundle'
+import { bundleDocument } from '../../bundle';
 import { BaseResolver } from '../../resolve';
-import { parseYamlToDocument, yamlSerializer } from '../../../__tests__/utils';
-import { makeConfig } from './config';
+import { parseYamlToDocument, yamlSerializer, makeConfig } from '../../../__tests__/utils';
 
 describe('oas3 remove-x-internal', () => {
   expect.addSnapshotSerializer(yamlSerializer);
@@ -19,23 +18,23 @@ describe('oas3 remove-x-internal', () => {
         parameters:
           x:
             name: x
-    `);
+    `,
+  );
 
   it('should use `internalFlagProperty` option to remove internal paths', async () => {
     const { bundle: res } = await bundleDocument({
       document: testDocument,
       externalRefResolver: new BaseResolver(),
-      config: makeConfig({}, { 'remove-x-internal': { 'internalFlagProperty': 'removeit' } })
+      config: makeConfig({}, { 'remove-x-internal': { internalFlagProperty: 'removeit' } }),
     });
-    expect(res.parsed).toMatchInlineSnapshot(
-    `
-    openapi: 3.0.0
-    components:
-      parameters:
-        x:
-          name: x
+    expect(res.parsed).toMatchInlineSnapshot(`
+          openapi: 3.0.0
+          components:
+            parameters:
+              x:
+                name: x
 
-    `);
+        `);
   });
 
   it('should clean types: Server, Operation, Parameter, PathItem, Example', async () => {
@@ -88,14 +87,14 @@ describe('oas3 remove-x-internal', () => {
               name: x
             y:
               name: y
-      `);
-      const { bundle: res } = await bundleDocument({
-        document: testDoc,
-        externalRefResolver: new BaseResolver(),
-        config: makeConfig({}, { 'remove-x-internal': 'on' })
-      });
-      expect(res.parsed).toMatchInlineSnapshot(
-      `
+      `,
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: makeConfig({}, { 'remove-x-internal': 'on' }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.1.0
       paths:
         /pet:
@@ -115,8 +114,7 @@ describe('oas3 remove-x-internal', () => {
           'y':
             name: 'y'
 
-      `
-      );
+      `);
   });
 
   it('should clean types: Schema, Response, RequestBody, MediaType, Callback', async () => {
@@ -162,14 +160,15 @@ describe('oas3 remove-x-internal', () => {
                     servers:
                       - url: //callback-url.path-level/v1
                         description: Path level server
-      `);
-      const { bundle: res } = await bundleDocument({
-        document: testDoc,
-        externalRefResolver: new BaseResolver(),
-        config: makeConfig({}, { 'remove-x-internal': 'on' })
-      });
-      expect(res.parsed).toMatchInlineSnapshot(
-      `
+      `,
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: makeConfig({}, { 'remove-x-internal': 'on' }),
+    });
+
+    expect(res.parsed).toMatchInlineSnapshot(`
       openapi: 3.1.0
       paths:
         /pet:
@@ -185,6 +184,90 @@ describe('oas3 remove-x-internal', () => {
 
       `);
   });
+
+  it('should remove refs', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.1
+        info:
+          version: 1.0.0
+          title: Test API
+        paths:
+          /test1:
+            get:
+              parameters:
+                - $ref: '#/components/parameters/Internal'
+                - in: query
+                  name: inline
+                  schema:
+                    type: string
+                - in: query
+                  name: inline-internal
+                  schema:
+                    type: string
+                  x-internal: true
+          /test2:
+            get:
+              parameters:
+                - $ref: '#/components/parameters/Public'
+                - $ref: '#/components/parameters/Internal'
+              requestBody:
+                $ref: '#/components/requestBodies/Public'
+        components:
+          requestBodies:
+            Public:
+              content:
+                application/json:
+                  schema:
+                    type: string
+              required: true
+              x-internal: true
+          parameters:
+            Public:
+              in: path
+              name: product_id
+              schema:
+                type: string
+            Internal:
+              in: header
+              name: X-Vendor
+              schema:
+                type: string
+              x-internal: true
+      `,
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: makeConfig({}, { 'remove-x-internal': 'on' }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.1
+      info:
+        version: 1.0.0
+        title: Test API
+      paths:
+        /test1:
+          get:
+            parameters:
+              - in: query
+                name: inline
+                schema:
+                  type: string
+        /test2:
+          get:
+            parameters:
+              - $ref: '#/components/parameters/Public'
+      components:
+        parameters:
+          Public:
+            in: path
+            name: product_id
+            schema:
+              type: string
+
+    `);
+  });
 });
 
 describe('oas2 remove-x-internal', () => {
@@ -214,21 +297,20 @@ describe('oas2 remove-x-internal', () => {
                 '200':
                   x-internal: true
                   description: List of recent media entries.
-      `);
+      `,
+    );
     const { bundle: res } = await bundleDocument({
       document: testDoc,
       externalRefResolver: new BaseResolver(),
-      config: makeConfig({}, { 'remove-x-internal': 'on' })
+      config: makeConfig({}, { 'remove-x-internal': 'on' }),
     });
-    expect(res.parsed).toMatchInlineSnapshot(
-    `
-    swagger: '2.0'
-    host: api.instagram.com
-    paths:
-      /geographies/{geo-id}/media/recent:
-        get: {}
+    expect(res.parsed).toMatchInlineSnapshot(`
+          swagger: '2.0'
+          host: api.instagram.com
+          paths:
+            /geographies/{geo-id}/media/recent:
+              get: {}
 
-    `
-    );
+        `);
   });
 });

package/src/{rules → decorators}/common/remove-x-internal.ts

@@ -1,6 +1,7 @@
 import { Oas3Decorator, Oas2Decorator } from '../../visitors';
 import { isEmptyArray, isEmptyObject, isPlainObject } from '../../utils';
 import { UserContext } from '../../walk';
+import { isRef } from '../../ref-utils';
 
 const DEFAULT_INTERNAL_PROPERTY_NAME = 'x-internal';
 
@@ -12,7 +13,15 @@ export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({ internalFlagPro
     let didDelete = false;
     if (Array.isArray(node)) {
       for (let i = 0; i < node.length; i++) {
-        if (node[i] && node[i][hiddenTag]) {
+        if (isRef(node[i])) {
+          const resolved = ctx.resolve(node[i]);
+          if (resolved.node?.[hiddenTag]) {
+            node.splice(i, 1);
+            didDelete = true;
+            i--;
+          }
+        }
+        if (node[i]?.[hiddenTag]) {
           node.splice(i, 1);
           didDelete = true;
           i--;
@@ -20,8 +29,16 @@ export const RemoveXInternal: Oas3Decorator | Oas2Decorator = ({ internalFlagPro
       }
     } else if (isPlainObject(node)) {
       for (const key of Object.keys(node)) {
-        if ((node as any)[key][hiddenTag]) {
-          delete (node as any)[key];
+        node = node as any;
+        if (isRef(node[key])) {
+          const resolved = ctx.resolve(node[key]);
+          if (resolved.node?.[hiddenTag]) {
+            delete node[key];
+            didDelete = true;
+          }
+        }
+        if (node[key]?.[hiddenTag]) {
+          delete node[key];
           didDelete = true;
         }
       }

package/src/decorators/oas2/index.ts

@@ -0,0 +1,14 @@
+import { Oas2Decorator } from '../../visitors';
+import { RegistryDependencies } from '../common/registry-dependencies';
+import { OperationDescriptionOverride } from '../common/operation-description-override';
+import { TagDescriptionOverride } from '../common/tag-description-override';
+import { InfoDescriptionOverride } from '../common/info-description-override';
+import { RemoveXInternal } from '../common/remove-x-internal';
+
+export const decorators = {
+  'registry-dependencies': RegistryDependencies as Oas2Decorator,
+  'operation-description-override': OperationDescriptionOverride as Oas2Decorator,
+  'tag-description-override': TagDescriptionOverride as Oas2Decorator,
+  'info-description-override': InfoDescriptionOverride as Oas2Decorator,
+  'remove-x-internal': RemoveXInternal as Oas2Decorator
+};

package/src/decorators/oas3/index.ts

@@ -0,0 +1,14 @@
+import { Oas3Decorator } from '../../visitors';
+import { RegistryDependencies } from '../common/registry-dependencies';
+import { OperationDescriptionOverride } from '../common/operation-description-override';
+import { TagDescriptionOverride } from '../common/tag-description-override';
+import { InfoDescriptionOverride } from '../common/info-description-override';
+import { RemoveXInternal } from '../common/remove-x-internal';
+
+export const decorators = {
+  'registry-dependencies': RegistryDependencies as Oas3Decorator,
+  'operation-description-override': OperationDescriptionOverride as Oas3Decorator,
+  'tag-description-override': TagDescriptionOverride as Oas3Decorator,
+  'info-description-override': InfoDescriptionOverride as Oas3Decorator,
+  'remove-x-internal': RemoveXInternal as Oas3Decorator
+};

package/src/js-yaml/index.ts

@@ -15,5 +15,4 @@ const DEFAULT_SCHEMA_WITHOUT_TIMESTAMP = JSON_SCHEMA.extend({
 export const parseYaml = (str: string, opts?: LoadOptions): unknown =>
   load(str, {schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts});
 
-export const stringifyYaml = (obj: any, opts?: DumpOptions): string =>
-  dump(obj, {schema: DEFAULT_SCHEMA_WITHOUT_TIMESTAMP, ...opts});
+export const stringifyYaml = (obj: any, opts?: DumpOptions): string => dump(obj, opts);

package/src/redocly/registry-api.ts

@@ -23,7 +23,10 @@ export class RegistryApi {
   private async request(path = '', options: RequestInit = {}, region?: Region) {
     const headers = Object.assign({}, options.headers || {}, { 'x-redocly-cli-version': version });
     if (!headers.hasOwnProperty('authorization')) { throw new Error('Unauthorized'); }
-    const response = await fetch(`${this.getBaseUrl(region)}${path}`, Object.assign({}, options, { headers }));
+    const response = await fetch(
+      `${this.getBaseUrl(region)}${path}`,
+      Object.assign({}, options, { headers }),
+    );
     if (response.status === 401) { throw new Error('Unauthorized'); }
     if (response.status === 404) {
       const body: RegistryApiTypes.NotFoundProblemResponse = await response.json();

package/src/resolve.ts

@@ -74,6 +74,10 @@ export type Document = {
   parsed: any;
 };
 
+export function makeRefId(absoluteRef: string, pointer: string) {
+  return absoluteRef + '::' + pointer;
+}
+
 export function makeDocumentFromString(sourceString: string, absoluteRef: string) {
   const source = new Source(absoluteRef, sourceString);
   try {
@@ -323,10 +327,8 @@ export async function resolveDocument(opts: {
           document: undefined,
           error: error,
         };
-
-        const refId = document.source.absoluteRef + '::' + ref.$ref;
+        const refId = makeRefId(document.source.absoluteRef, ref.$ref);
         resolvedRefMap.set(refId, resolvedRef);
-
         return resolvedRef;
       }
 
@@ -367,13 +369,11 @@ export async function resolveDocument(opts: {
 
       resolvedRef.node = target;
       resolvedRef.document = targetDoc;
-      const refId = document.source.absoluteRef + '::' + ref.$ref;
-
+      const refId = makeRefId(document.source.absoluteRef, ref.$ref);
       if (resolvedRef.document && isRef(target)) {
         resolvedRef = await followRef(resolvedRef.document, target, pushRef(refStack, target));
       }
       resolvedRefMap.set(refId, resolvedRef);
-
       return { ...resolvedRef };
     }
   }

package/src/rules/__tests__/no-unresolved-refs.test.ts

@@ -1,11 +1,8 @@
 import path = require('path');
 import { outdent } from 'outdent';
-
 import { lintDocument } from '../../lint';
 import { BaseResolver } from '../../resolve';
-
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../__tests__/utils';
-import { makeConfig } from './config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../__tests__/utils';
 
 describe('oas3 boolean-parameter-prefixes', () => {
   it('should report on unresolved $ref', async () => {

package/src/rules/common/__tests__/info-description.test.ts

@@ -1,10 +1,8 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
-import { makeConfig } from '../../__tests__/config';
-
 describe('Oas3 info-description', () => {
   it('should report on info with no description', async () => {
     const document = parseYamlToDocument(

package/src/rules/common/__tests__/info-license.test.ts

@@ -1,7 +1,6 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
-import { makeConfig } from '../../__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 info-license', () => {

package/src/rules/common/__tests__/license-url.test.ts

@@ -1,7 +1,6 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
-import { makeConfig } from '../../__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 license-url', () => {

package/src/rules/common/__tests__/no-ambiguous-paths.test.ts

@@ -1,7 +1,6 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
-import { makeConfig } from '../../__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
 describe('no-ambiguous-paths', () => {

package/src/rules/common/__tests__/no-enum-type-mismatch.test.ts

@@ -1,7 +1,6 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
-import { makeConfig } from '../../__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 typed enum', () => {

package/src/rules/common/__tests__/no-identical-paths.test.ts

@@ -1,7 +1,6 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
-import { makeConfig } from '../../__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
 describe('no-identical-paths', () => {

package/src/rules/common/__tests__/no-path-trailing-slash.test.ts

@@ -1,7 +1,6 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
-import { makeConfig } from '../../__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
 describe('no-path-trailing-slash', () => {

package/src/rules/common/__tests__/operation-2xx-response.test.ts

@@ -1,7 +1,6 @@
 import { outdent } from 'outdent';
 import { lintDocument } from '../../../lint';
-import { parseYamlToDocument, replaceSourceWithRef } from '../../../../__tests__/utils';
-import { makeConfig } from '../../__tests__/config';
+import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../../../__tests__/utils';
 import { BaseResolver } from '../../../resolve';
 
 describe('Oas3 operation-2xx-response', () => {