@redocly/openapi-core 1.0.0-beta.100 → 1.0.0-beta.103

package/src/__tests__/lint.test.ts

@@ -85,7 +85,7 @@ describe('lint', () => {
             },
           ],
           "message": "Expected type \`ConfigApis\` (object) but got \`string\`",
-          "ruleId": "spec",
+          "ruleId": "configuration spec",
           "severity": "error",
           "suggest": Array [],
         },
@@ -97,8 +97,8 @@ describe('lint', () => {
               "source": "",
             },
           ],
-          "message": "Expected type \`string\` but got \`object\`.",
-          "ruleId": "spec",
+          "message": "\`layout\` can be one of the following only: \\"stacked\\", \\"three-panel\\".",
+          "ruleId": "configuration spec",
           "severity": "error",
           "suggest": Array [],
         },
@@ -123,6 +123,19 @@ describe('lint', () => {
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
       Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/apis/lint",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "The field \`root\` must be present on this level.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
         Object {
           "location": Array [
             Object {
@@ -132,7 +145,7 @@ describe('lint', () => {
             },
           ],
           "message": "Property \`plugins\` is not expected here.",
-          "ruleId": "spec",
+          "ruleId": "configuration spec",
           "severity": "error",
           "suggest": Array [],
         },

package/src/config/__tests__/load.test.ts

@@ -44,6 +44,12 @@ describe('loadConfig', () => {
       },
     ]);
   });
+
+  it('should call callback if such passed', async () => {
+    const mockFn = jest.fn();
+    await loadConfig(undefined, undefined, mockFn);
+    expect(mockFn).toHaveBeenCalled();
+  });
 });
 
 describe('findConfig', () => {

package/src/config/load.ts

@@ -8,11 +8,16 @@ import { resolveConfig } from './config-resolvers';
 
 import type { RawConfig, Region } from './types';
 
-export async function loadConfig(
-  configPath: string | undefined = findConfig(),
-  customExtends?: string[],
-): Promise<Config> {
-  const rawConfig = await getConfig(configPath);
+async function addConfigMetadata({
+  rawConfig,
+  customExtends,
+  configPath
+}: {
+  rawConfig: RawConfig;
+  customExtends?: string[];
+  configPath?: string;
+  
+}): Promise<Config> {
   if (customExtends !== undefined) {
     rawConfig.lint = rawConfig.lint || {};
     rawConfig.lint.extends = customExtends;
@@ -56,6 +61,24 @@ export async function loadConfig(
   return resolveConfig(rawConfig, configPath);
 }
 
+export async function loadConfig(
+  configPath: string | undefined = findConfig(),
+  customExtends?: string[],
+  processRawConfig?: (rawConfig: RawConfig) => void | Promise<void>,
+): Promise<Config> {
+  const rawConfig = await getConfig(configPath);
+
+  if (typeof processRawConfig === 'function') {
+    await processRawConfig(rawConfig);
+  }
+
+  return await addConfigMetadata({
+    rawConfig,
+    customExtends,
+    configPath,
+  });
+};
+
 export const CONFIG_FILE_NAMES = ['redocly.yaml', 'redocly.yml', '.redocly.yaml', '.redocly.yml'];
 
 export function findConfig(dir?: string): string | undefined {

package/src/config/types.ts

@@ -11,17 +11,18 @@ import type {
 } from '../oas-types';
 import type { NodeType } from '../types';
 
+export type RuleSeverity = ProblemSeverity | 'off';
+
+export type PreprocessorSeverity = RuleSeverity | 'on';
+
 export type RuleConfig =
-  | ProblemSeverity
-  | 'off'
+  | RuleSeverity
   | ({
       severity?: ProblemSeverity;
     } & Record<string, any>);
 
 export type PreprocessorConfig =
-  | ProblemSeverity
-  | 'off'
-  | 'on'
+  | PreprocessorSeverity
   | ({
       severity?: ProblemSeverity;
     } & Record<string, any>);

package/src/decorators/__tests__/filter-in.test.ts

@@ -0,0 +1,310 @@
+import { outdent } from 'outdent';
+import { bundleDocument } from '../../bundle';
+import { BaseResolver } from '../../resolve';
+import { makeConfig, parseYamlToDocument, yamlSerializer } from '../../../__tests__/utils';
+
+describe('oas3 filter-in', () => {
+  expect.addSnapshotSerializer(yamlSerializer);
+
+  const inputDoc = parseYamlToDocument(
+    outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            x-audience: Global
+            post:
+              summary: test
+          /user:
+            x-audience: [Public, Global]
+            post:
+              summary: test
+          /post:
+            get:
+              summary: test                        
+          /order:
+            x-audience: [Public, Protected]
+            post:
+              operationId: storeOrder
+              callbacks:
+                x-access: protected`
+  );
+
+  it('should include /user path and remove y parameter', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-access: private
+          get:
+            parameters:
+              - $ref: '#/components/parameters/x'
+        /user:
+          x-access: public
+          get:
+            parameters:
+              - $ref: '#/components/parameters/y'      
+      components:
+        parameters:
+          x:
+            name: x
+          y:
+            x-access: private
+            name: y            
+    `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDocument,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig({}, { 'filter-in': { value: 'public', property: 'x-access' } }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /user:
+          x-access: public
+          get: {}
+      components:
+        parameters:
+          x:
+            name: x
+
+    `);
+  });
+
+  it('should include /order and /post paths', async () => {
+    const { bundle: res } = await bundleDocument({
+      document: inputDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-in': {
+            property: 'x-audience',
+            value: ['Public', 'Protected'],
+            matchStrategy: 'all',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /post:
+          get:
+            summary: test
+        /order:
+          x-audience:
+            - Public
+            - Protected
+          post:
+            operationId: storeOrder
+            callbacks:
+              x-access: protected
+      components: {}
+
+    `);
+  });
+
+  it('should include all paths', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            x-audience: Global
+            post:
+              summary: test
+          /user:
+            x-audience: [Public, Global]
+            post:
+              summary: test            
+          /order:
+            x-audience: [Public, Protected]
+            post:
+              operationId: storeOrder
+              parameters:
+                - name: api_key
+                 `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-in': {
+            property: 'x-audience',
+            value: ['Public', 'Global'],
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-audience: Global
+          post:
+            summary: test
+        /user:
+          x-audience:
+            - Public
+            - Global
+          post:
+            summary: test
+        /order:
+          x-audience:
+            - Public
+            - Protected
+          post:
+            operationId: storeOrder
+            parameters:
+              - name: api_key
+      components: {}
+
+    `);
+  });
+
+  it('should include path without x-audience property ', async () => {
+    const { bundle: res } = await bundleDocument({
+      document: inputDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-in': {
+            property: 'x-audience',
+            value: 'non-existing-audience',
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /post:
+          get:
+            summary: test
+      components: {}
+
+    `);
+  });
+
+  it('should include /pet and /account without post method', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            x-audience: Global
+            post:
+              summary: test
+          /user:
+            x-audience: Private
+            post:
+              summary: test
+            get:
+               summary: get
+               x-audience: [Public, Global]
+          /account:
+            get:
+               summary: get
+            post: 
+               summary: test
+               x-audience: Private     
+                 `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-in': {
+            property: 'x-audience',
+            value: ['Public', 'Global'],
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-audience: Global
+          post:
+            summary: test
+        /account:
+          get:
+            summary: get
+      components: {}
+
+    `);
+  });
+});
+
+describe('oas2 filter-in', () => {
+  it('should include only one parameter and not include response', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+        swagger: '2.0'
+        host: api.instagram.com
+        paths:
+          '/geographies/{geo-id}/media/recent':
+            get:
+              parameters:
+                - description: The geography ID.
+                  x-access: private
+                  in: path
+                  name: geo-id
+                  required: true
+                  type: string
+                - description: Max number of media to return.
+                  x-access: public
+                  format: int32
+                  in: query
+                  name: count
+                  required: false
+                  type: integer
+              responses:
+                '200':
+                  description: List of recent media entries.
+                  x-access: [private, protected]
+      `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-in': {
+            property: 'x-access',
+            value: ['public', 'global'],
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      swagger: '2.0'
+      host: api.instagram.com
+      paths:
+        /geographies/{geo-id}/media/recent:
+          get:
+            parameters:
+              - description: Max number of media to return.
+                x-access: public
+                format: int32
+                in: query
+                name: count
+                required: false
+                type: integer
+
+    `);
+  });
+});

package/src/decorators/__tests__/filter-out.test.ts

@@ -0,0 +1,227 @@
+import { outdent } from 'outdent';
+import { bundleDocument } from '../../bundle';
+import { BaseResolver } from '../../resolve';
+import { makeConfig, parseYamlToDocument, yamlSerializer } from '../../../__tests__/utils';
+
+describe('oas3 filter-out', () => {
+  expect.addSnapshotSerializer(yamlSerializer);
+
+  const inputDoc = parseYamlToDocument(
+    outdent`
+        openapi: 3.0.0
+        paths:
+          /pet:
+            x-audience: Private
+            post:
+              summary: test
+          /user:
+            x-audience: Protected
+            post:
+              summary: test          
+          /order:
+            x-audience: [Private, Protected]
+            post:
+              operationId: storeOrder
+              parameters:
+                - name: api_key
+              callbacks:
+                x-access: protected
+                orderInProgress:
+                  x-internal: true
+             `
+  );
+
+  it('should remove /pet path and y parameter', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-access: private
+          get:
+            parameters:
+              - $ref: '#/components/parameters/y'
+      components:
+        parameters:
+          x:
+            name: x
+          y:
+            x-access: private
+            name: y  
+    `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDocument,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig({}, { 'filter-out': { property: 'x-access', value: 'private' } }),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+          openapi: 3.0.0
+          components:
+            parameters:
+              x:
+                name: x
+
+        `);
+  });
+
+  it('should remove only /order path', async () => {
+    const { bundle: res } = await bundleDocument({
+      document: inputDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-audience',
+            value: ['Private', 'Protected'],
+            matchStrategy: 'all',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          x-audience: Private
+          post:
+            summary: test
+        /user:
+          x-audience: Protected
+          post:
+            summary: test
+      components: {}
+
+    `);
+  });
+
+  it('should remove all paths', async () => {
+    const { bundle: res } = await bundleDocument({
+      document: inputDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-audience',
+            value: ['Private', 'Protected'],
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+        openapi: 3.0.0
+        components: {}
+        
+        `);
+  });
+
+  it('should remove requestBody', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          post:
+            summary: test
+            requestBody:
+              content:
+                x-access: private
+                application/x-www-form-urlencoded:
+                  schema:
+                    type: object
+      components: {}
+            
+        `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-access',
+            value: 'private',
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      openapi: 3.0.0
+      paths:
+        /pet:
+          post:
+            summary: test
+      components: {}
+
+    `);
+  });
+});
+
+describe('oas2 filter-out', () => {
+  it('should clean all parameters and responses ', async () => {
+    const testDoc = parseYamlToDocument(
+      outdent`
+        swagger: '2.0'
+        host: api.instagram.com
+        paths:
+          '/geographies/{geo-id}/media/recent':
+            get:
+              parameters:
+                - description: The geography ID.
+                  x-access: private
+                  in: path
+                  name: geo-id
+                  required: true
+                  type: string
+                - description: Max number of media to return.
+                  x-access: protected
+                  format: int32
+                  in: query
+                  name: count
+                  required: false
+                  type: integer
+              responses:
+                $ref: '#/components/response/200'
+        components:
+          response:
+            '200':
+                  description: List of recent media entries.
+                  x-access: [protected, public]            
+      `
+    );
+    const { bundle: res } = await bundleDocument({
+      document: testDoc,
+      externalRefResolver: new BaseResolver(),
+      config: await makeConfig(
+        {},
+        {
+          'filter-out': {
+            property: 'x-access',
+            value: ['private', 'protected'],
+            matchStrategy: 'any',
+          },
+        }
+      ),
+    });
+    expect(res.parsed).toMatchInlineSnapshot(`
+      swagger: '2.0'
+      host: api.instagram.com
+      paths:
+        /geographies/{geo-id}/media/recent:
+          get: {}
+      components:
+        response:
+          '200':
+            description: List of recent media entries.
+            x-access:
+              - protected
+              - public
+
+    `);
+  });
+});