@redocly/openapi-core 1.0.0-beta.98 → 1.0.0-rc.1

package/lib/rules/common/info-description.d.ts

@@ -1,2 +0,0 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-export declare const InfoDescription: Oas3Rule | Oas2Rule;

package/lib/rules/common/info-description.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InfoDescription = void 0;
-const utils_1 = require("../utils");
-const InfoDescription = () => {
-    return {
-        Info(info, ctx) {
-            utils_1.validateDefinedAndNonEmpty('description', info, ctx);
-        },
-    };
-};
-exports.InfoDescription = InfoDescription;

package/lib/rules/common/license-url.d.ts

@@ -1,2 +0,0 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-export declare const InfoLicenseUrl: Oas3Rule | Oas2Rule;

package/lib/rules/common/license-url.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.InfoLicenseUrl = void 0;
-const utils_1 = require("../utils");
-const InfoLicenseUrl = () => {
-    return {
-        License(license, ctx) {
-            utils_1.validateDefinedAndNonEmpty('url', license, ctx);
-        },
-    };
-};
-exports.InfoLicenseUrl = InfoLicenseUrl;

package/lib/rules/common/operation-security-defined.d.ts

@@ -1,2 +0,0 @@
-import { Oas3Rule, Oas2Rule } from '../../visitors';
-export declare const OperationSecurityDefined: Oas3Rule | Oas2Rule;

package/lib/rules/oas3/no-servers-empty-enum.d.ts

@@ -1,2 +0,0 @@
-import { Oas3Rule } from '../../visitors';
-export declare const NoEmptyEnumServers: Oas3Rule;

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

@@ -1,71 +0,0 @@
-import { outdent } from 'outdent';
-import { parseYaml, stringifyYaml } from '../js-yaml';
-
-const yaml = `
-  emptyValue:
-  spaces in keys: spaces in keys
-  numberString: '0123456789'
-  number: 1000
-  decimal: 12.34
-  boolean: true
-  dateWithoutQuotes: 2020-01-01
-  dateWithQuotes: '2020-01-01'
-  array:
-    - 1
-    - 2
-  object:
-    key1: 1
-    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',
-  numberString: '0123456789',
-  number: 1000,
-  decimal: 12.34,
-  boolean: true,
-  dateWithoutQuotes: '2020-01-01',
-  dateWithQuotes: '2020-01-01',
-  array: [1, 2],
-  object: { key1: 1, key2: 2 },
-};
-
-describe('js-yaml', () => {
-  test('parseYaml', () => {
-    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({ foo: () => {} }))
-      .toThrow('unacceptable kind of an object to dump [object Function]');
-  });
-});

package/src/__tests__/lint.test.ts

@@ -1,182 +0,0 @@
-import { outdent } from 'outdent';
-
-import { lintFromString, lintConfig, lintDocument } from '../lint';
-import { BaseResolver } from '../resolve';
-import { loadConfig } from '../config/load';
-import { parseYamlToDocument, replaceSourceWithRef, makeConfig } from '../../__tests__/utils';
-
-describe('lint', () => {
-  it('lintFromString should work', async () => {
-    const results = await lintFromString({
-      absoluteRef: '/test/spec.yaml',
-      source: outdent`
-      openapi: 3.0.0
-      info:
-        title: Test API
-        version: "1.0"
-        description: Test
-        license: Fail
-
-      servers:
-        - url: http://example.com
-      paths: {}
-    `,
-      config: await loadConfig(),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/info/license",
-              "reportOnKey": false,
-              "source": "/test/spec.yaml",
-            },
-          ],
-          "message": "Expected type \`License\` (object) but got \`string\`",
-          "ruleId": "spec",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it('lintConfig should work', async () => {
-    const document = parseYamlToDocument(
-      outdent`
-      apis: error string
-      lint:
-        plugins:
-          - './local-plugin.js'
-        extends:
-          - recommended
-          - local/all
-        rules:
-          operation-2xx-response: warn
-          no-invalid-media-type-examples: error
-          path-http-verbs-order: error
-          boolean-parameter-prefixes: off
-      features.openapi:
-        showConsole: true
-        layout:
-          scope: section
-        routingStrategy: browser
-        theme:
-          rightPanel:
-            backgroundColor: '#263238'
-          links:
-            color: '#6CC496'
-      `,
-      '',
-    );
-    const results = await lintConfig({ document });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/apis",
-              "reportOnKey": false,
-              "source": "",
-            },
-          ],
-          "message": "Expected type \`ConfigApis\` (object) but got \`string\`",
-          "ruleId": "spec",
-          "severity": "error",
-          "suggest": Array [],
-        },
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/features.openapi/layout",
-              "reportOnKey": false,
-              "source": "",
-            },
-          ],
-          "message": "Expected type \`string\` but got \`object\`.",
-          "ruleId": "spec",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it("'plugins' shouldn't be allowed in 'apis' -> 'lint' field", async () => {
-    const document = parseYamlToDocument(
-      outdent`
-      apis: 
-        lint: 
-          plugins: 
-            - './local-plugin.js'
-      lint:
-        plugins:
-          - './local-plugin.js'
-      `,
-      '',
-    );
-    const results = await lintConfig({ document });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
-      Array [
-        Object {
-          "location": Array [
-            Object {
-              "pointer": "#/apis/lint/plugins",
-              "reportOnKey": true,
-              "source": "",
-            },
-          ],
-          "message": "Property \`plugins\` is not expected here.",
-          "ruleId": "spec",
-          "severity": "error",
-          "suggest": Array [],
-        },
-      ]
-    `);
-  });
-
-  it("'const' can have any type", async () => {
-    const document = parseYamlToDocument(
-      outdent`
-      openapi: "3.1.0"
-      info:
-        version: 1.0.0
-        title: Swagger Petstore
-        description: Information about Petstore
-        license:
-          name: MIT
-          url: https://opensource.org/licenses/MIT
-      servers:
-        - url: http://petstore.swagger.io/v1
-      paths:
-        /pets:
-          get:
-            summary: List all pets
-            operationId: listPets
-            tags:
-              - pets
-            responses:
-              200:
-                description: An paged array of pets
-                content:
-                  application/json:
-                    schema:
-                      type: string
-                      const: ABC
-        `,
-      'foobar.yaml',
-    );
-
-    const results = await lintDocument({
-      externalRefResolver: new BaseResolver(),
-      document,
-      config: await makeConfig({ spec: 'error' }),
-    });
-
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
-  });
-});

package/src/__tests__/utils.test.ts

@@ -1,74 +0,0 @@
-import { pickObjectProps, omitObjectProps, slash } from '../utils';
-
-describe('utils', () => {
-  const testObject = {
-    a: 'value a',
-    b: 'value b',
-    c: 'value c',
-    d: 'value d',
-    e: 'value e',
-  };
-
-  describe('pickObjectProps', () => {
-    it('returns correct object result', () => {
-      expect(pickObjectProps(testObject, ['a', 'b'])).toStrictEqual({ a: 'value a', b: 'value b' });
-    });
-
-    it('returns correct object if passed non existing key', () => {
-      expect(pickObjectProps(testObject, ['a', 'b', 'nonExisting'])).toStrictEqual({
-        a: 'value a',
-        b: 'value b',
-      });
-    });
-
-    it('returns an empty object if no keys are passed', () => {
-      expect(pickObjectProps(testObject, [])).toStrictEqual({});
-    });
-
-    it('returns an empty object if empty target obj passed', () => {
-      expect(pickObjectProps({}, ['d', 'e'])).toStrictEqual({});
-    });
-  });
-
-  describe('omitObjectProps', () => {
-    it('returns correct object result', () => {
-      expect(omitObjectProps(testObject, ['a', 'b', 'c'])).toStrictEqual({
-        d: 'value d',
-        e: 'value e',
-      });
-    });
-
-    it('returns correct object if passed non existing key', () => {
-      expect(omitObjectProps(testObject, ['a', 'b', 'c', 'nonExisting'])).toStrictEqual({
-        d: 'value d',
-        e: 'value e',
-      });
-    });
-
-    it('returns full object if no keys are passed', () => {
-      expect(omitObjectProps(testObject, [])).toStrictEqual(testObject);
-    });
-
-    it('returns an empty object if empty target obj passed', () => {
-      expect(omitObjectProps({}, ['d', 'e'])).toStrictEqual({});
-    });
-  });
-
-  describe('slash path', () => {
-    it('can correctly slash path', () => {
-      [
-        ['foo\\bar', 'foo/bar'],
-        ['foo/bar', 'foo/bar'],
-        ['foo\\中文', 'foo/中文'],
-        ['foo/中文', 'foo/中文'],
-      ].forEach(([path, expectRes]) => {
-        expect(slash(path)).toBe(expectRes);
-      });
-    });
-
-    it('does not modify extended length paths', () => {
-      const extended = '\\\\?\\some\\path';
-      expect(slash(extended)).toBe(extended);
-    });
-  });
-});

package/src/benchmark/benches/lint-with-many-rules.bench.ts

@@ -1,35 +0,0 @@
-import { readFileSync } from 'fs';
-import { join as pathJoin, resolve as pathResolve } from 'path';
-import { lintDocument } from '../../lint';
-import { BaseResolver } from '../../resolve';
-import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
-
-export const name = 'Validate with 50 top-level rules';
-export const count = 10;
-const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
-const rebillyDocument = parseYamlToDocument(
-  readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
-);
-
-const ruleset: any = {};
-for (let i = 0; i < 50; i++) {
-  ruleset['rule-' + i] = () => {
-    let count = 0;
-    return {
-      Schema() {
-        count++;
-        if (count === -1) throw new Error('Disable optimization');
-      },
-    };
-  };
-}
-
-const config = makeConfigForRuleset(ruleset);
-export function measureAsync() {
-  return lintDocument({
-    externalRefResolver: new BaseResolver(),
-    document: rebillyDocument,
-    config,
-  });
-}

package/src/benchmark/benches/lint-with-nested-rule.bench.ts

@@ -1,39 +0,0 @@
-import { readFileSync } from 'fs';
-import { join as pathJoin, resolve as pathResolve } from 'path';
-import { lintDocument } from '../../lint';
-import { BaseResolver } from '../../resolve';
-import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
-
-export const name = 'Validate with single nested rule';
-export const count = 10;
-const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
-const rebillyDocument = parseYamlToDocument(
-  readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
-);
-const visitor = {
-  test: () => {
-    let count = 0;
-    return {
-      PathItem: {
-        Parameter() {
-          count++;
-        },
-        Operation: {
-          Parameter() {
-            count++;
-            if (count === -1) throw new Error('Disable optimization');
-          },
-        },
-      },
-    };
-  },
-};
-const config = makeConfigForRuleset(visitor);
-export function measureAsync() {
-  return lintDocument({
-    externalRefResolver: new BaseResolver(),
-    document: rebillyDocument,
-    config,
-  });
-}

package/src/benchmark/benches/lint-with-no-rules.bench.ts

@@ -1,20 +0,0 @@
-import { readFileSync } from 'fs';
-import { join as pathJoin, resolve as pathResolve } from 'path';
-import { lintDocument } from '../../lint';
-import { BaseResolver } from '../../resolve';
-import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
-export const name = 'Validate with no rules';
-export const count = 10;
-const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
-const rebillyDocument = parseYamlToDocument(
-  readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
-);
-const config = makeConfigForRuleset({});
-export function measureAsync() {
-  return lintDocument({
-    externalRefResolver: new BaseResolver(),
-    document: rebillyDocument,
-    config,
-  });
-}

package/src/benchmark/benches/lint-with-top-level-rule-report.bench.ts

@@ -1,36 +0,0 @@
-import { readFileSync } from 'fs';
-import { join as pathJoin, resolve as pathResolve } from 'path';
-import { lintDocument } from '../../lint';
-import { BaseResolver } from '../../resolve';
-import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
-
-export const name = 'Validate with single top-level rule and report';
-export const count = 10;
-const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
-const rebillyDocument = parseYamlToDocument(
-  readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
-);
-
-const config = makeConfigForRuleset({
-  test: () => {
-    return {
-      // @ts-ignore
-      Schema(schema, ctx) {
-        if (schema.type === 'number') {
-          ctx.report({
-            message: 'type number is not allowed',
-          });
-        }
-      },
-    };
-  },
-});
-
-export function measureAsync() {
-  return lintDocument({
-    externalRefResolver: new BaseResolver(),
-    document: rebillyDocument,
-    config,
-  });
-}

package/src/benchmark/benches/lint-with-top-level-rule.bench.ts

@@ -1,32 +0,0 @@
-import { readFileSync } from 'fs';
-import { join as pathJoin, resolve as pathResolve } from 'path';
-import { lintDocument } from '../../lint';
-import { BaseResolver } from '../../resolve';
-import { parseYamlToDocument, makeConfigForRuleset } from '../utils';
-export const name = 'Validate with single top-level rule';
-export const count = 10;
-const rebillyDefinitionRef = pathResolve(pathJoin(__dirname, 'rebilly.yaml'));
-const rebillyDocument = parseYamlToDocument(
-  readFileSync(rebillyDefinitionRef, 'utf-8'),
-  rebillyDefinitionRef,
-);
-
-const config = makeConfigForRuleset({
-  test: () => {
-    let count = 0;
-    return {
-      Schema() {
-        count++;
-        if (count === -1) throw new Error('Disable optimization');
-      },
-    };
-  },
-});
-
-export function measureAsync() {
-  return lintDocument({
-    externalRefResolver: new BaseResolver(),
-    document: rebillyDocument,
-    config,
-  });
-}