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

package/lib/rules/oas3/index.js

@@ -20,13 +20,13 @@ const no_server_trailing_slash_1 = require("./no-server-trailing-slash");
 const info_description_1 = require("../common/info-description");
 const tag_description_1 = require("../common/tag-description");
 const info_contact_1 = require("../common/info-contact");
+const info_license_1 = require("../common/info-license");
 const info_license_url_1 = require("../common/info-license-url");
 const operation_description_1 = require("../common/operation-description");
 const no_unused_components_1 = require("./no-unused-components");
 const path_not_include_query_1 = require("../common/path-not-include-query");
 const parameter_description_1 = require("../common/parameter-description");
 const operation_singular_tag_1 = require("../common/operation-singular-tag");
-const license_url_1 = require("../common/license-url");
 const operation_security_defined_1 = require("../common/operation-security-defined");
 const no_unresolved_refs_1 = require("../no-unresolved-refs");
 const boolean_parameter_prefixes_1 = require("./boolean-parameter-prefixes");
@@ -54,11 +54,11 @@ exports.rules = {
     spec: spec_1.OasSpec,
     'info-description': info_description_1.InfoDescription,
     'info-contact': info_contact_1.InfoContact,
-    'info-license': info_license_url_1.InfoLicense,
-    'info-license-url': license_url_1.InfoLicenseUrl,
+    'info-license': info_license_1.InfoLicense,
+    'info-license-url': info_license_url_1.InfoLicenseUrl,
     'operation-2xx-response': operation_2xx_response_1.Operation2xxResponse,
     'operation-4xx-response': operation_4xx_response_1.Operation4xxResponse,
-    'assertions': assertions_1.Assertions,
+    assertions: assertions_1.Assertions,
     'operation-operationId-unique': operation_operationId_unique_1.OperationIdUnique,
     'operation-parameters-unique': operation_parameters_unique_1.OperationParametersUnique,
     'path-parameters-defined': path_params_defined_1.PathParamsDefined,

package/lib/rules/oas3/no-empty-servers.js

@@ -7,7 +7,7 @@ const NoEmptyServers = () => {
             if (!root.hasOwnProperty('servers')) {
                 report({
                     message: 'Servers must be present.',
-                    location: location.child(['openapi']).key()
+                    location: location.child(['openapi']).key(),
                 });
                 return;
             }

package/lib/rules/oas3/remove-unused-components.js

@@ -24,13 +24,13 @@ const RemoveUnusedComponents = () => {
                         name: key.toString(),
                     });
                 }
-            }
+            },
         },
         DefinitionRoot: {
             leave(root, ctx) {
                 const data = ctx.getVisitorData();
                 data.removedCount = 0;
-                components.forEach(usageInfo => {
+                components.forEach((usageInfo) => {
                     const { used, componentType, name } = usageInfo;
                     if (!used && componentType) {
                         let componentChild = root.components[componentType];

package/lib/rules/other/stats.js

@@ -3,10 +3,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Stats = void 0;
 const Stats = (statsAccumulator) => {
     return {
-        ExternalDocs: { leave() { statsAccumulator.externalDocs.total++; } },
-        ref: { enter(ref) { statsAccumulator.refs.items.add(ref['$ref']); } },
-        Tag: { leave(tag) { statsAccumulator.tags.items.add(tag.name); } },
-        Link: { leave(link) { statsAccumulator.links.items.add(link.operationId); } },
+        ExternalDocs: {
+            leave() {
+                statsAccumulator.externalDocs.total++;
+            },
+        },
+        ref: {
+            enter(ref) {
+                statsAccumulator.refs.items.add(ref['$ref']);
+            },
+        },
+        Tag: {
+            leave(tag) {
+                statsAccumulator.tags.items.add(tag.name);
+            },
+        },
+        Link: {
+            leave(link) {
+                statsAccumulator.links.items.add(link.operationId);
+            },
+        },
         DefinitionRoot: {
             leave() {
                 statsAccumulator.parameters.total = statsAccumulator.parameters.items.size;
@@ -18,27 +34,40 @@ const Stats = (statsAccumulator) => {
         WebhooksMap: {
             Operation: {
                 leave(operation) {
-                    operation.tags.forEach((tag) => { statsAccumulator.tags.items.add(tag); });
-                }
-            }
+                    operation.tags.forEach((tag) => {
+                        statsAccumulator.tags.items.add(tag);
+                    });
+                },
+            },
         },
         PathMap: {
             PathItem: {
-                leave() { statsAccumulator.pathItems.total++; },
+                leave() {
+                    statsAccumulator.pathItems.total++;
+                },
                 Operation: {
                     leave(operation) {
                         statsAccumulator.operations.total++;
-                        operation.tags && operation.tags.forEach((tag) => { statsAccumulator.tags.items.add(tag); });
-                    }
+                        operation.tags &&
+                            operation.tags.forEach((tag) => {
+                                statsAccumulator.tags.items.add(tag);
+                            });
+                    },
                 },
-                Parameter: { leave(parameter) {
+                Parameter: {
+                    leave(parameter) {
                         statsAccumulator.parameters.items.add(parameter.name);
-                    } },
+                    },
+                },
             },
         },
         NamedSchemas: {
-            Schema: { leave() { statsAccumulator.schemas.total++; } }
-        }
+            Schema: {
+                leave() {
+                    statsAccumulator.schemas.total++;
+                },
+            },
+        },
     };
 };
 exports.Stats = Stats;

package/lib/rules/utils.d.ts

@@ -1,7 +1,7 @@
 import { UserContext } from '../walk';
 import { Location } from '../ref-utils';
 import { Oas3Schema, Referenced } from '../typings/openapi';
-export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array" | "null";
+export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "integer" | "array" | "null";
 /**
  * Checks if value matches specified JSON schema type
  *

package/lib/rules/utils.js

@@ -11,6 +11,9 @@ function oasTypeOf(value) {
     else if (value === null) {
         return 'null';
     }
+    else if (Number.isInteger(value)) {
+        return 'integer';
+    }
     else {
         return typeof value;
     }
@@ -25,7 +28,7 @@ exports.oasTypeOf = oasTypeOf;
  */
 function matchesJsonSchemaType(value, type, nullable) {
     if (nullable && value === null) {
-        return value === null;
+        return true;
     }
     switch (type) {
         case 'array':

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

@@ -53,6 +53,7 @@ const builtInRulesList = [
     'no-invalid-parameter-examples',
     'response-contains-header',
     'response-contains-property',
+    'scalar-property-missing-example',
 ];
 const nodeTypesList = [
     'DefinitionRoot',
@@ -111,7 +112,8 @@ const ConfigRoot = {
             properties: {},
             additionalProperties: { properties: { type: 'string' } },
         },
-        lint: 'RootConfigLint',
+        styleguide: 'RootConfigStyleguide',
+        lint: 'RootConfigStyleguide',
         'features.openapi': 'ConfigReferenceDocs',
         referenceDocs: 'ConfigReferenceDocs',
         'features.mockServer': 'ConfigMockServer',
@@ -136,7 +138,7 @@ const ConfigApisProperties = {
                 type: 'string',
             },
         },
-        lint: 'ConfigLint',
+        styleguide: 'ConfigStyleguide',
         'features.openapi': 'ConfigReferenceDocs',
         'features.mockServer': 'ConfigMockServer',
     },
@@ -152,7 +154,7 @@ const ConfigHTTP = {
         },
     },
 };
-const ConfigLint = {
+const ConfigStyleguide = {
     properties: {
         extends: {
             type: 'array',
@@ -175,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: {},
@@ -764,8 +766,8 @@ exports.ConfigTypes = {
     ConfigRoot,
     ConfigApis,
     ConfigApisProperties,
-    RootConfigLint,
-    ConfigLint,
+    RootConfigStyleguide,
+    ConfigStyleguide,
     ConfigReferenceDocs,
     ConfigMockServer,
     ConfigHTTP,

package/lib/utils.d.ts

@@ -1,5 +1,5 @@
 import { UserContext } from './walk';
-import type { HttpResolveConfig } from './config';
+import { HttpResolveConfig } from './config';
 export { parseYaml, stringifyYaml } from './js-yaml';
 export declare type StackFrame<T> = {
     prev: StackFrame<T> | null;
@@ -38,5 +38,6 @@ export declare function isNotEmptyObject(obj: any): boolean;
 export declare function isString(value: unknown): value is string;
 export declare function isNotString<T>(value: string | T): value is T;
 export declare function assignExisting<T>(target: Record<string, T>, obj: Record<string, T>): void;
-export declare const getMatchingStatusCodeRange: (code: number | string) => string;
+export declare function getMatchingStatusCodeRange(code: number | string): string;
 export declare function isCustomRuleId(id: string): boolean;
+export declare function doesYamlFileExist(filePath: string): boolean;

package/lib/utils.js

@@ -9,8 +9,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.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");
@@ -173,9 +174,17 @@ function assignExisting(target, obj) {
     }
 }
 exports.assignExisting = assignExisting;
-const getMatchingStatusCodeRange = (code) => `${code}`.replace(/^(\d)\d\d$/, (_, firstDigit) => `${firstDigit}XX`);
+function getMatchingStatusCodeRange(code) {
+    return `${code}`.replace(/^(\d)\d\d$/, (_, firstDigit) => `${firstDigit}XX`);
+}
 exports.getMatchingStatusCodeRange = getMatchingStatusCodeRange;
 function isCustomRuleId(id) {
     return id.includes('/');
 }
 exports.isCustomRuleId = isCustomRuleId;
+function doesYamlFileExist(filePath) {
+    return ((path_1.extname(filePath) === '.yaml' || path_1.extname(filePath) === '.yml') &&
+        fs.hasOwnProperty('existsSync') &&
+        fs.existsSync(filePath));
+}
+exports.doesYamlFileExist = doesYamlFileExist;

package/lib/walk.d.ts

@@ -14,25 +14,13 @@ export declare type ResolveResult<T extends NonUndefined> = {
     location: undefined;
     error?: ResolveError | YamlParseError;
 };
-export declare type ResolveFn<T> = (node: Referenced<T>, from?: string) => {
-    location: Location;
-    node: T;
-} | {
-    location: undefined;
-    node: undefined;
-};
+export declare type ResolveFn = <T>(node: Referenced<T>, from?: string) => ResolveResult<T>;
 export declare type UserContext = {
     report(problem: Problem): void;
     location: Location;
     rawNode: any;
     rawLocation: Location;
-    resolve<T>(node: Referenced<T>): {
-        location: Location;
-        node: T;
-    } | {
-        location: undefined;
-        node: undefined;
-    };
+    resolve: ResolveFn;
     parentLocations: Record<string, Location>;
     type: NormalizedNodeType;
     key: string | number;

package/lib/walk.js

@@ -32,6 +32,25 @@ function walkDocument(opts) {
     walkNode(document.parsed, rootType, new ref_utils_1.Location(document.source, '#/'), undefined, '');
     function walkNode(node, type, location, parent, key) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        const resolve = (ref, from = currentLocation.source.absoluteRef) => {
+            if (!ref_utils_1.isRef(ref))
+                return { location, node: ref };
+            const refId = resolve_1.makeRefId(from, ref.$ref);
+            const resolvedRef = resolvedRefMap.get(refId);
+            if (!resolvedRef) {
+                return {
+                    location: undefined,
+                    node: undefined,
+                };
+            }
+            const { resolved, node, document, nodePointer, error } = resolvedRef;
+            const newLocation = resolved
+                ? new ref_utils_1.Location(document.source, nodePointer)
+                : error instanceof resolve_1.YamlParseError
+                    ? new ref_utils_1.Location(error.source, '')
+                    : undefined;
+            return { location: newLocation, node, error };
+        };
         const rawLocation = location;
         let currentLocation = location;
         const { node: resolvedNode, location: resolvedLocation, error } = resolve(node);
@@ -224,25 +243,6 @@ function walkDocument(opts) {
             }, collectParents(context), context);
             return { ignoreNextVisitorsOnNode };
         }
-        function resolve(ref, from = currentLocation.source.absoluteRef) {
-            if (!ref_utils_1.isRef(ref))
-                return { location, node: ref };
-            const refId = resolve_1.makeRefId(from, ref.$ref);
-            const resolvedRef = resolvedRefMap.get(refId);
-            if (!resolvedRef) {
-                return {
-                    location: undefined,
-                    node: undefined,
-                };
-            }
-            const { resolved, node, document, nodePointer, error } = resolvedRef;
-            const newLocation = resolved
-                ? new ref_utils_1.Location(document.source, nodePointer)
-                : error instanceof resolve_1.YamlParseError
-                    ? new ref_utils_1.Location(error.source, '')
-                    : undefined;
-            return { location: newLocation, node, error };
-        }
         function reportFn(ruleId, severity, opts) {
             const loc = opts.location
                 ? Array.isArray(opts.location)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.103",
+  "version": "1.0.0-beta.106",
   "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": [

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: