@redocly/openapi-core 1.0.0-beta.105 → 1.0.0-beta.108

package/lib/rules/utils.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateExample = exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
+exports.getAdditionalPropertiesOption = exports.validateExample = exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
 const levenshtein = require("js-levenshtein");
 const ref_utils_1 = require("../ref-utils");
 const ajv_1 = require("./ajv");
+const utils_1 = require("../utils");
 function oasTypeOf(value) {
     if (Array.isArray(value)) {
         return 'array';
@@ -11,6 +12,9 @@ function oasTypeOf(value) {
     else if (value === null) {
         return 'null';
     }
+    else if (Number.isInteger(value)) {
+        return 'integer';
+    }
     else {
         return typeof value;
     }
@@ -25,7 +29,7 @@ exports.oasTypeOf = oasTypeOf;
  */
 function matchesJsonSchemaType(value, type, nullable) {
     if (nullable && value === null) {
-        return value === null;
+        return true;
     }
     switch (type) {
         case 'array':
@@ -82,11 +86,11 @@ function getSuggest(given, variants) {
     return distances.map((d) => d.variant);
 }
 exports.getSuggest = getSuggest;
-function validateExample(example, schema, dataLoc, { resolve, location, report }, disallowAdditionalProperties) {
+function validateExample(example, schema, dataLoc, { resolve, location, report }, allowAdditionalProperties) {
     try {
-        const { valid, errors } = ajv_1.validateJsonSchema(example, schema, location.child('schema'), dataLoc.pointer, resolve, disallowAdditionalProperties);
+        const { valid, errors } = ajv_1.validateJsonSchema(example, schema, location.child('schema'), dataLoc.pointer, resolve, allowAdditionalProperties);
         if (!valid) {
-            for (let error of errors) {
+            for (const error of errors) {
                 report({
                     message: `Example value must conform to the schema: ${error.message}.`,
                     location: Object.assign(Object.assign({}, new ref_utils_1.Location(dataLoc.source, error.instancePath)), { reportOnKey: error.keyword === 'additionalProperties' }),
@@ -105,3 +109,14 @@ function validateExample(example, schema, dataLoc, { resolve, location, report }
     }
 }
 exports.validateExample = validateExample;
+function getAdditionalPropertiesOption(opts) {
+    if (opts.disallowAdditionalProperties === undefined) {
+        return opts.allowAdditionalProperties;
+    }
+    if (opts.allowAdditionalProperties !== undefined) {
+        utils_1.showErrorForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties');
+    }
+    utils_1.showWarningForDeprecatedField('disallowAdditionalProperties', 'allowAdditionalProperties');
+    return !opts.disallowAdditionalProperties;
+}
+exports.getAdditionalPropertiesOption = getAdditionalPropertiesOption;

package/lib/types/index.d.ts

@@ -22,7 +22,7 @@ export declare type NodeType = {
     items?: string;
     required?: string[] | ((value: any, key: string | number | undefined) => string[]);
     requiredOneOf?: string[];
-    allowed?: ((value: any) => string[] | undefined);
+    allowed?: (value: any) => string[] | undefined;
     extensionsPrefix?: string;
 };
 declare type PropType = string | NodeType | ScalarSchema | undefined | null;
@@ -34,7 +34,7 @@ export declare type NormalizedNodeType = {
     items?: NormalizedNodeType;
     required?: string[] | ((value: any, key: string | number | undefined) => string[]);
     requiredOneOf?: string[];
-    allowed?: ((value: any) => string[] | undefined);
+    allowed?: (value: any) => string[] | undefined;
     extensionsPrefix?: string;
 };
 declare type NormalizedPropType = NormalizedNodeType | NormalizedScalarSchema | undefined | null;

package/lib/types/redocly-yaml.js

@@ -43,7 +43,7 @@ const builtInRulesList = [
     'no-identical-paths',
     'no-ambiguous-paths',
     'no-undefined-server-variable',
-    'no-servers-empty-enum',
+    'no-server-variables-empty-enum',
     'no-http-verbs-in-paths',
     'path-excludes-patterns',
     'request-mime-type',
@@ -112,7 +112,8 @@ const ConfigRoot = {
             properties: {},
             additionalProperties: { properties: { type: 'string' } },
         },
-        lint: 'RootConfigLint',
+        styleguide: 'RootConfigStyleguide',
+        lint: 'RootConfigStyleguide',
         'features.openapi': 'ConfigReferenceDocs',
         referenceDocs: 'ConfigReferenceDocs',
         'features.mockServer': 'ConfigMockServer',
@@ -137,7 +138,7 @@ const ConfigApisProperties = {
                 type: 'string',
             },
         },
-        lint: 'ConfigLint',
+        styleguide: 'ConfigStyleguide',
         'features.openapi': 'ConfigReferenceDocs',
         'features.mockServer': 'ConfigMockServer',
     },
@@ -153,7 +154,7 @@ const ConfigHTTP = {
         },
     },
 };
-const ConfigLint = {
+const ConfigStyleguide = {
     properties: {
         extends: {
             type: 'array',
@@ -176,11 +177,11 @@ const ConfigLint = {
         oas3_1Decorators: { type: 'object' },
     },
 };
-const RootConfigLint = {
+const RootConfigStyleguide = {
     properties: Object.assign({ plugins: {
             type: 'array',
             items: { type: 'string' },
-        } }, ConfigLint.properties),
+        } }, ConfigStyleguide.properties),
 };
 const Rules = {
     properties: {},
@@ -765,8 +766,8 @@ exports.ConfigTypes = {
     ConfigRoot,
     ConfigApis,
     ConfigApisProperties,
-    RootConfigLint,
-    ConfigLint,
+    RootConfigStyleguide,
+    ConfigStyleguide,
     ConfigReferenceDocs,
     ConfigMockServer,
     ConfigHTTP,

package/lib/utils.d.ts

@@ -41,3 +41,8 @@ export declare function assignExisting<T>(target: Record<string, T>, obj: Record
 export declare function getMatchingStatusCodeRange(code: number | string): string;
 export declare function isCustomRuleId(id: string): boolean;
 export declare function doesYamlFileExist(filePath: string): boolean;
+export declare function showWarningForDeprecatedField(deprecatedField: string, updatedField: string): void;
+export declare function showErrorForDeprecatedField(deprecatedField: string, updatedField: string): void;
+export declare type Falsy = undefined | null | false | '' | 0;
+export declare function isTruthy<Truthy>(value: Truthy | Falsy): value is Truthy;
+export declare function identity<T>(value: T): T;

package/lib/utils.js

@@ -9,14 +9,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.identity = exports.isTruthy = exports.showErrorForDeprecatedField = exports.showWarningForDeprecatedField = exports.doesYamlFileExist = exports.isCustomRuleId = exports.getMatchingStatusCodeRange = exports.assignExisting = exports.isNotString = exports.isString = exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const path_1 = require("path");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
 const pluralize = require("pluralize");
 const js_yaml_1 = require("./js-yaml");
-const config_1 = require("./config");
+const env_1 = require("./env");
+const logger_1 = require("./logger");
 var js_yaml_2 = require("./js-yaml");
 Object.defineProperty(exports, "parseYaml", { enumerable: true, get: function () { return js_yaml_2.parseYaml; } });
 Object.defineProperty(exports, "stringifyYaml", { enumerable: true, get: function () { return js_yaml_2.stringifyYaml; } });
@@ -58,7 +59,7 @@ function readFileFromUrl(url, config) {
         for (const header of config.headers) {
             if (match(url, header.matches)) {
                 headers[header.name] =
-                    header.envVariable !== undefined ? config_1.env[header.envVariable] || '' : header.value;
+                    header.envVariable !== undefined ? env_1.env[header.envVariable] || '' : header.value;
             }
         }
         const req = yield (config.customFetch || node_fetch_1.default)(url, {
@@ -89,7 +90,7 @@ exports.omitObjectProps = omitObjectProps;
 function splitCamelCaseIntoWords(str) {
     const camel = str
         .split(/(?:[-._])|([A-Z][a-z]+)/)
-        .filter(Boolean)
+        .filter(isTruthy)
         .map((item) => item.toLocaleLowerCase());
     const caps = str
         .split(/([A-Z]{2,})/)
@@ -167,7 +168,7 @@ function isNotString(value) {
 }
 exports.isNotString = isNotString;
 function assignExisting(target, obj) {
-    for (let k of Object.keys(obj)) {
+    for (const k of Object.keys(obj)) {
         if (target.hasOwnProperty(k)) {
             target[k] = obj[k];
         }
@@ -188,3 +189,19 @@ function doesYamlFileExist(filePath) {
         fs.existsSync(filePath));
 }
 exports.doesYamlFileExist = doesYamlFileExist;
+function showWarningForDeprecatedField(deprecatedField, updatedField) {
+    logger_1.logger.warn(`The ${logger_1.colorize.red(deprecatedField)} field is deprecated. Use ${logger_1.colorize.green(updatedField)} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`);
+}
+exports.showWarningForDeprecatedField = showWarningForDeprecatedField;
+function showErrorForDeprecatedField(deprecatedField, updatedField) {
+    throw new Error(`Do not use '${deprecatedField}' field. Use '${updatedField}' instead.\n`);
+}
+exports.showErrorForDeprecatedField = showErrorForDeprecatedField;
+function isTruthy(value) {
+    return !!value;
+}
+exports.isTruthy = isTruthy;
+function identity(value) {
+    return value;
+}
+exports.identity = identity;

package/lib/visitors.d.ts

@@ -16,7 +16,7 @@ declare type VisitObject<T> = {
 };
 declare type NestedVisitObject<T, P> = VisitObject<T> & NestedVisitor<P>;
 declare type VisitFunctionOrObject<T> = VisitFunction<T> | VisitObject<T>;
-declare type VisitorNode<T extends any> = {
+declare type VisitorNode<T> = {
     ruleId: string;
     severity: ProblemSeverity;
     context: VisitorLevelContext | VisitorSkippedLevelContext;

package/lib/visitors.js

@@ -30,7 +30,7 @@ function normalizeVisitors(visitorsConfig, types) {
             return;
         stack = [...stack, from];
         const possibleChildren = new Set();
-        for (let type of Object.values(from.properties)) {
+        for (const type of Object.values(from.properties)) {
             if (type === to) {
                 addWeakFromStack(ruleConf, stack);
                 continue;
@@ -55,7 +55,7 @@ function normalizeVisitors(visitorsConfig, types) {
                 possibleChildren.add(from.items);
             }
         }
-        for (let fromType of Array.from(possibleChildren.values())) {
+        for (const fromType of Array.from(possibleChildren.values())) {
             addWeakNodes(ruleConf, fromType, to, parentContext, stack);
         }
         function addWeakFromStack(ruleConf, stack) {

package/lib/walk.d.ts

@@ -4,6 +4,7 @@ import { NormalizedOasVisitors } from './visitors';
 import { ResolvedRefMap, Document, ResolveError, YamlParseError, Source } from './resolve';
 import { OasVersion } from './oas-types';
 import { NormalizedNodeType } from './types';
+import type { RuleSeverity } from './config';
 declare type NonUndefined = string | number | boolean | symbol | bigint | object | Record<string, any>;
 export declare type ResolveResult<T extends NonUndefined> = {
     node: T;
@@ -49,7 +50,7 @@ export declare type Problem = {
     suggest?: string[];
     location?: Partial<LocationObject> | Array<Partial<LocationObject>>;
     from?: LocationObject;
-    forceSeverity?: ProblemSeverity;
+    forceSeverity?: RuleSeverity;
     ruleId?: string;
 };
 export declare type NormalizedProblem = {

package/lib/walk.js

@@ -249,9 +249,12 @@ function walkDocument(opts) {
                     ? opts.location
                     : [opts.location]
                 : [Object.assign(Object.assign({}, currentLocation), { reportOnKey: false })];
-            ctx.problems.push(Object.assign(Object.assign({ ruleId: opts.ruleId || ruleId, severity: opts.forceSeverity || severity }, opts), { suggest: opts.suggest || [], location: loc.map((loc) => {
-                    return Object.assign(Object.assign(Object.assign({}, currentLocation), { reportOnKey: false }), loc);
-                }) }));
+            const ruleSeverity = opts.forceSeverity || severity;
+            if (ruleSeverity !== 'off') {
+                ctx.problems.push(Object.assign(Object.assign({ ruleId: opts.ruleId || ruleId, severity: ruleSeverity }, opts), { suggest: opts.suggest || [], location: loc.map((loc) => {
+                        return Object.assign(Object.assign(Object.assign({}, currentLocation), { reportOnKey: false }), loc);
+                    }) }));
+            }
         }
         function getVisitorDataFn(ruleId) {
             ctx.visitorsData[ruleId] = ctx.visitorsData[ruleId] || {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.105",
+  "version": "1.0.0-beta.108",
   "description": "",
   "main": "lib/index.js",
   "engines": {
@@ -34,7 +34,7 @@
     "Andriy Leliv <andriy@redoc.ly> (https://redoc.ly/)"
   ],
   "dependencies": {
-    "@redocly/ajv": "^8.6.4",
+    "@redocly/ajv": "^8.6.5",
     "@types/node": "^14.11.8",
     "colorette": "^1.2.0",
     "js-levenshtein": "^1.1.6",

package/src/__tests__/__snapshots__/bundle.test.ts.snap

@@ -1,5 +1,146 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`bundle should add to meta ref from redocly registry 1`] = `
+fileDependencies: {}
+rootType:
+  properties:
+    openapi: null
+    info:
+      properties:
+        title:
+          type: string
+        version:
+          type: string
+        description:
+          type: string
+        termsOfService:
+          type: string
+        contact:
+          properties:
+            name:
+              type: string
+            url:
+              type: string
+            email:
+              type: string
+          name: Contact
+        license:
+          properties:
+            name:
+              type: string
+            url:
+              type: string
+          required:
+            - name
+          name: License
+      required:
+        - title
+        - version
+      name: Info
+    servers:
+      name: ServerList
+      properties: {}
+      items:
+        properties:
+          url:
+            type: string
+          description:
+            type: string
+          variables:
+            name: ServerVariableMap
+            properties: {}
+        required:
+          - url
+        name: Server
+    security:
+      name: SecurityRequirementList
+      properties: {}
+      items:
+        properties: {}
+        additionalProperties:
+          type: array
+          items:
+            type: string
+        name: SecurityRequirement
+    tags:
+      name: TagList
+      properties: {}
+      items:
+        properties:
+          name:
+            type: string
+          description:
+            type: string
+          externalDocs:
+            properties:
+              description:
+                type: string
+              url:
+                type: string
+            required:
+              - url
+            name: ExternalDocs
+        required:
+          - name
+        name: Tag
+    externalDocs:
+      properties:
+        description:
+          type: string
+        url:
+          type: string
+      required:
+        - url
+      name: ExternalDocs
+    paths:
+      properties: {}
+      name: PathMap
+    components:
+      properties:
+        parameters:
+          name: NamedParameters
+          properties: {}
+        schemas:
+          name: NamedSchemas
+          properties: {}
+        responses:
+          name: NamedResponses
+          properties: {}
+        examples:
+          name: NamedExamples
+          properties: {}
+        requestBodies:
+          name: NamedRequestBodies
+          properties: {}
+        headers:
+          name: NamedHeaders
+          properties: {}
+        securitySchemes:
+          name: NamedSecuritySchemes
+          properties: {}
+        links:
+          name: NamedLinks
+          properties: {}
+        callbacks:
+          name: NamedCallbacks
+          properties: {}
+      name: Components
+    x-webhooks:
+      properties: {}
+      name: WebhooksMap
+  required:
+    - openapi
+    - paths
+    - info
+  name: DefinitionRoot
+refTypes: {}
+visitorsData:
+  registry-dependencies:
+    links:
+      - https://api.redocly.com/registry/params
+
+`;
+
 exports[`bundle should bundle external refs 1`] = `
 openapi: 3.0.0
 paths:

package/src/__tests__/bundle.test.ts

@@ -2,11 +2,21 @@ 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 { parseYamlToDocument, yamlSerializer, makeConfig } from '../../__tests__/utils';
+import { StyleguideConfig, Config, ResolvedConfig } from '../config';
 import { BaseResolver } from '../resolve';
 
 describe('bundle', () => {
+  const fetchMock = jest.fn(() =>
+    Promise.resolve({
+      ok: true,
+      text: () => 'External schema content',
+      headers: {
+        get: () => '',
+      },
+    })
+  );
+
   expect.addSnapshotSerializer(yamlSerializer);
 
   const testDocument = parseYamlToDocument(
@@ -28,14 +38,14 @@ describe('bundle', () => {
           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({}),
+      config: new StyleguideConfig({}),
     });
 
     const origCopy = JSON.parse(JSON.stringify(testDocument.parsed));
@@ -60,7 +70,7 @@ describe('bundle', () => {
     });
     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.`,
+      `Two schemas are referenced with the same name but different content. Renamed param-b to param-b-2.`
     );
     expect(res.parsed).toMatchSnapshot();
   });
@@ -68,7 +78,7 @@ describe('bundle', () => {
   it('should dereferenced correctly when used with dereference', async () => {
     const { bundle: res, problems } = await bundleDocument({
       externalRefResolver: new BaseResolver(),
-      config: new LintConfig({}),
+      config: new StyleguideConfig({}),
       document: testDocument,
       dereference: true,
     });
@@ -98,47 +108,25 @@ describe('bundle', () => {
   });
 
   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: []
-        }
+          headers: [],
+        },
       }),
-      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml')
+      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml'),
     });
 
     expect(problems).toHaveLength(0);
-    expect(fetchMock).toHaveBeenCalledWith(
-      "https://someexternal.schema",
-      {
-        headers: {}
-      }
-    );
+    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({
@@ -153,4 +141,50 @@ describe('bundle', () => {
     expect(problems).toHaveLength(0);
     expect(res.parsed).toMatchSnapshot();
   });
+
+  it('should add to meta ref from redocly registry', async () => {
+    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: 'https://api.redocly.com/registry/params'
+        components:
+          parameters:
+            shared_a:
+              name: shared-a
+      `,
+      ''
+    );
+
+    const config = await makeConfig({}, { 'registry-dependencies': 'on' });
+
+    const {
+      bundle: result,
+      problems,
+      ...meta
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver({
+        http: {
+          customFetch: fetchMock,
+          headers: [],
+        },
+      }),
+    });
+
+    const parsedMeta = JSON.parse(JSON.stringify(meta));
+
+    expect(problems).toHaveLength(0);
+    expect(parsedMeta).toMatchSnapshot();
+  });
 });