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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.99",
+  "version": "1.0.0-rc.1",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -16,7 +16,8 @@
     "fs": false,
     "path": "path-browserify",
     "os": false,
-    "node-fetch": false
+    "node-fetch": false,
+    "colorette": false
   },
   "homepage": "https://github.com/Redocly/redocly-cli",
   "keywords": [
@@ -28,12 +29,10 @@
     "oas"
   ],
   "contributors": [
-    "Sergey Dubovyk <serhii@redoc.ly> (https://redoc.ly/)",
-    "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)",
-    "Andriy Leliv <andriy@redoc.ly> (https://redoc.ly/)"
+    "Roman Hotsiy <roman@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/ajv": "^8.6.4",
+    "@redocly/ajv": "^8.11.0",
     "@types/node": "^14.11.8",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",

package/__tests__/utils.ts

@@ -1,86 +0,0 @@
-import * as path from 'path';
-
-import { Document, Source, NormalizedProblem, parseYaml, stringifyYaml } from '../src';
-import { LintConfig, resolveLint, resolvePlugins } from '../src/config';
-import { Oas3RuleSet } from '../src/oas-types';
-
-import type { RuleConfig, Plugin, DecoratorConfig } from '../src/config';
-
-export function parseYamlToDocument(body: string, absoluteRef: string = ''): Document {
-  return {
-    source: new Source(absoluteRef, body),
-    parsed: parseYaml(body, { filename: absoluteRef }),
-  };
-}
-
-export function replaceSourceWithRef(results: NormalizedProblem[], cwd?: string) {
-  const cwdRegexp = cwd ? new RegExp(cwd + path.sep, 'g') : /$^/;
-  return results.map((r) => {
-    const mapped = {
-      ...r,
-      message: r.message.replace(cwdRegexp, ''),
-      location: r.location.map((l) => ({
-        ...l,
-        source: cwd ? path.relative(cwd, l.source.absoluteRef) : l.source.absoluteRef,
-      })),
-    };
-    if (mapped.from) {
-      mapped.from = {
-        ...mapped.from,
-        source: cwd
-          ? path.relative(cwd, mapped.from.source.absoluteRef)
-          : (mapped.from.source.absoluteRef as any),
-      };
-    }
-    return mapped;
-  });
-}
-
-export const yamlSerializer = {
-  test: () => {
-    return true;
-  },
-  print: (val: any) => {
-    return stringifyYaml(val);
-  },
-};
-
-export function makeConfigForRuleset(
-  rules: Oas3RuleSet,
-  plugin?: Partial<Plugin>,
-  version: string = 'oas3',
-) {
-  const rulesConf: Record<string, RuleConfig> = {};
-  const ruleId = 'test';
-  Object.keys(rules).forEach((name) => {
-    rulesConf[`${ruleId}/${name}`] = 'error';
-  });
-  const plugins = resolvePlugins([
-    {
-      ...plugin,
-      id: ruleId,
-      rules: { [version]: rules },
-    },
-  ]);
-
-  return new LintConfig({
-    plugins,
-    rules: rulesConf,
-  });
-}
-
-export async function makeConfig(
-  rules: Record<string, RuleConfig>,
-  decorators?: Record<string, DecoratorConfig>,
-) {
-  return new LintConfig(
-    await resolveLint({
-      lintConfig: {
-        plugins: [],
-        extends: [],
-        rules,
-        decorators,
-      },
-    }),
-  );
-}

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__/__snapshots__/bundle.test.ts.snap

@@ -1,255 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`bundle should bundle external refs 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-b'
-        - name: test
-    get:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-c'
-    post:
-      parameters:
-        - $ref: '#/paths/~1pet/put/parameters/2'
-components:
-  parameters:
-    param-a:
-      name: param_a
-      schema:
-        $ref: '#/components/schemas/schema-a'
-      examples:
-        first:
-          $ref: '#/components/examples/param-a-first'
-        second:
-          $ref: '#/components/examples/second'
-    path-param:
-      name: path_param
-      examples:
-        first:
-          $ref: '#/components/examples/first'
-    param-c:
-      name: param_c
-    param-b:
-      name: param_b
-  examples:
-    first:
-      value: b1
-    param-a-first:
-      value: a1
-    second:
-      value: a2
-  schemas:
-    schema-a:
-      type: string
-
-`;
-
-exports[`bundle should bundle external refs and warn for conflicting names 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: '#/components/parameters/param-b'
-        - $ref: '#/components/parameters/param-b-2'
-    get:
-      parameters:
-        - $ref: '#/components/parameters/param-a'
-        - $ref: '#/components/parameters/param-c'
-components:
-  parameters:
-    param-a:
-      name: test
-    param-b:
-      name: param_b_alt
-    path-param:
-      name: path_param
-    param-c:
-      name: param_c
-    param-b-2:
-      name: param_b
-
-`;
-
-exports[`bundle should dereferenced correctly when used with dereference 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    get:
-      operationId: get
-      parameters:
-        - name: shared-a
-        - name: get_b
-    post:
-      operationId: post
-      parameters:
-        - name: shared-a
-components:
-  parameters:
-    shared_a:
-      name: shared-a
-
-`;
-
-exports[`bundle should not bundle url refs if used with keepUrlRefs 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    parameters:
-      - $ref: '#/components/parameters/path-param'
-    put:
-      parameters:
-        - $ref: https://someexternal.schema
-        - $ref: '#/components/parameters/param-b'
-        - name: test
-    get:
-      parameters:
-        - $ref: http://someexternal.schema
-        - $ref: '#/components/parameters/param-c'
-components:
-  parameters:
-    path-param:
-      name: path_param
-    param-c:
-      name: param_c
-    param-b:
-      name: param_b
-
-`;
-
-exports[`bundle should not place referened schema inline when component in question is not of type "schemas" 1`] = `
-openapi: 3.0.0
-paths:
-  /pet:
-    post:
-      requestBody:
-        content:
-          application/json:
-            schema:
-              $ref: '#/components/schemas/requestBody'
-components:
-  schemas:
-    requestBody:
-      content:
-        application/json:
-          schema:
-            type: object
-            properties:
-              a:
-                type: string
-              b:
-                type: number
-
-`;
-
-exports[`bundle should place referenced schema inline when referenced schema name resolves to original schema name 1`] = `
-openapi: 3.1.0
-info:
-  title: My API
-  description: It ain't so wonderful, but at least it's mine.
-  version: '1.0'
-  contact:
-    email: me@theintenet.com
-    name: me
-paths:
-  /test:
-    get:
-      summary: test
-      responses:
-        '200':
-          description: test
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/vendor.schema'
-components:
-  schemas:
-    vendor:
-      $ref: '#/components/schemas/vendor.schema'
-    myvendor:
-      $ref: '#/components/schemas/vendor.schema'
-    simple:
-      type: string
-    A:
-      type: string
-    test:
-      $ref: '#/components/schemas/rename-2'
-    rename:
-      type: string
-    rename-2:
-      type: number
-    vendor.schema:
-      title: vendor
-      type: object
-      description: Vendors
-      properties:
-        key:
-          type: string
-          description: System-assigned key for the vendor.
-          readOnly: true
-        id:
-          type: string
-          description: >
-            Unique identifier of the vendor.
-
-            You must specify a unique vendor ID when creating a vendor unless
-            document sequencing is configured, in which case the ID is
-            auto-generated.
-        name:
-          type: string
-          description: Name of the vendor.
-        isOneTimeUse:
-          type: boolean
-          description: One-time use
-          default: false
-
-`;
-
-exports[`bundle should pull hosted schema 1`] = `
-openapi: 3.0.3
-info:
-  title: bugtest
-  version: '1.0'
-  description: Demo
-  license:
-    name: DEMO
-    url: https://demo.com
-servers:
-  - url: http://demo.com/api
-paths:
-  /customer:
-    summary: Customer scope
-    get:
-      summary: Get demo no refs
-      operationId: GetCustomer
-      description: Returns Demo No Refs
-      responses:
-        '200':
-          description: Demo No Refs
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/Customer'
-components:
-  schemas:
-    Customer:
-      type: object
-      properties:
-        customerName:
-          type: string
-        accounts:
-          type: array
-          items:
-            $ref: '#/components/schemas/someexternal'
-    someexternal: External schema content
-
-`;

package/src/__tests__/bundle.test.ts

@@ -1,156 +0,0 @@
-import outdent from 'outdent';
-import * as path from 'path';
-
-import { bundleDocument, bundle } from '../bundle';
-import { parseYamlToDocument, yamlSerializer } from '../../__tests__/utils';
-import { LintConfig, Config, ResolvedConfig } from '../config';
-import { BaseResolver } from '../resolve';
-
-describe('bundle', () => {
-  expect.addSnapshotSerializer(yamlSerializer);
-
-  const testDocument = parseYamlToDocument(
-    outdent`
-      openapi: 3.0.0
-      paths:
-        /pet:
-          get:
-            operationId: get
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-              - name: get_b
-          post:
-            operationId: post
-            parameters:
-              - $ref: '#/components/parameters/shared_a'
-      components:
-        parameters:
-          shared_a:
-            name: shared-a
-    `,
-    '',
-  );
-
-  it('change nothing with only internal refs', async () => {
-    const { bundle, problems } = await bundleDocument({
-      document: testDocument,
-      externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
-    });
-
-    const origCopy = JSON.parse(JSON.stringify(testDocument.parsed));
-
-    expect(problems).toHaveLength(0);
-    expect(bundle.parsed).toEqual(origCopy);
-  });
-
-  it('should bundle external refs', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/openapi-with-external-refs.yaml'),
-    });
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should bundle external refs and warn for conflicting names', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/openapi-with-external-refs-conflicting-names.yaml'),
-    });
-    expect(problems).toHaveLength(1);
-    expect(problems[0].message).toEqual(
-      `Two schemas are referenced with the same name but different content. Renamed param-b to param-b-2.`,
-    );
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should dereferenced correctly when used with dereference', async () => {
-    const { bundle: res, problems } = await bundleDocument({
-      externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
-      document: testDocument,
-      dereference: true,
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should place referenced schema inline when referenced schema name resolves to original schema name', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/externalref.yaml'),
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should not place referened schema inline when component in question is not of type "schemas"', async () => {
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      ref: path.join(__dirname, 'fixtures/refs/external-request-body.yaml'),
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should pull hosted schema', async () => {
-    const fetchMock = jest.fn(
-      () => Promise.resolve({
-        ok: true,
-        text: () => 'External schema content',
-        headers: {
-          get: () => ''
-        }
-      })
-    );
-
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      externalRefResolver: new BaseResolver({
-        http: {
-          customFetch: fetchMock,
-          headers: []
-        }
-      }),
-      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml')
-    });
-
-    expect(problems).toHaveLength(0);
-    expect(fetchMock).toHaveBeenCalledWith(
-      "https://someexternal.schema",
-      {
-        headers: {}
-      }
-    );
-    expect(res.parsed).toMatchSnapshot();
-  });
-
-  it('should not bundle url refs if used with keepUrlRefs', async () => {
-    const fetchMock = jest.fn(() =>
-        Promise.resolve({
-          ok: true,
-          text: () => 'External schema content',
-          headers: {
-            get: () => '',
-          },
-        }),
-    );
-    const { bundle: res, problems } = await bundle({
-      config: new Config({} as ResolvedConfig),
-      externalRefResolver: new BaseResolver({
-        http: {
-          customFetch: fetchMock,
-          headers: [],
-        },
-      }),
-      ref: path.join(__dirname, 'fixtures/refs/openapi-with-url-refs.yaml'),
-      keepUrlRefs: true,
-    });
-    expect(problems).toHaveLength(0);
-    expect(res.parsed).toMatchSnapshot();
-  });
-});