@redocly/openapi-core 1.0.0-beta.117 → 1.0.0-beta.118

package/lib/types/oas3_1.js

@@ -18,6 +18,7 @@ const Root = {
     },
     required: ['openapi', 'info'],
     requiredOneOf: ['paths', 'components', 'webhooks'],
+    extensionsPrefix: 'x-',
 };
 const License = {
     properties: {
@@ -26,6 +27,7 @@ const License = {
         identifier: { type: 'string' },
     },
     required: ['name'],
+    extensionsPrefix: 'x-',
 };
 const Info = {
     properties: {
@@ -38,6 +40,7 @@ const Info = {
         license: 'License',
     },
     required: ['title', 'version'],
+    extensionsPrefix: 'x-',
 };
 const Components = {
     properties: {
@@ -52,6 +55,7 @@ const Components = {
         callbacks: 'NamedCallbacks',
         pathItems: 'NamedPathItems',
     },
+    extensionsPrefix: 'x-',
 };
 const Operation = {
     properties: {
@@ -74,6 +78,7 @@ const Operation = {
         'x-code-samples': _1.listOf('XCodeSample'),
         'x-hideTryItPanel': { type: 'boolean' },
     },
+    extensionsPrefix: 'x-',
 };
 const Schema = {
     properties: {
@@ -167,6 +172,7 @@ const Schema = {
         $comment: { type: 'string' },
         'x-tags': { type: 'array', items: { type: 'string' } },
     },
+    extensionsPrefix: 'x-',
 };
 const SecurityScheme = {
     properties: {

package/lib/types/redocly-yaml.js

@@ -115,6 +115,7 @@ const nodeTypesList = [
     'XCodeSample',
     'XCodeSampleList',
     'WebhooksMap',
+    'SpecExtension',
 ];
 const ConfigStyleguide = {
     properties: {

package/lib/utils.d.ts

@@ -29,6 +29,7 @@ export declare function validateMimeType({ type, value }: any, { report, locatio
 export declare function validateMimeTypeOAS3({ type, value }: any, { report, location }: UserContext, allowedValues: string[]): void;
 export declare function isSingular(path: string): boolean;
 export declare function readFileAsStringSync(filePath: string): string;
+export declare function yamlAndJsonSyncReader<T>(filePath: string): T;
 export declare function isPathParameter(pathSegment: string): boolean;
 /**
  * Convert Windows backslash paths to slash paths: foo\\bar ➔ foo/bar

package/lib/utils.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.nextTick = exports.pickDefined = exports.keysOf = 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.isDefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.nextTick = exports.pickDefined = exports.keysOf = 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.yamlAndJsonSyncReader = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.readFileFromUrl = exports.isEmptyArray = exports.isEmptyObject = exports.isPlainObject = exports.isDefined = 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");
@@ -139,6 +139,11 @@ function readFileAsStringSync(filePath) {
     return fs.readFileSync(filePath, 'utf-8');
 }
 exports.readFileAsStringSync = readFileAsStringSync;
+function yamlAndJsonSyncReader(filePath) {
+    const content = fs.readFileSync(filePath, 'utf-8');
+    return js_yaml_1.parseYaml(content);
+}
+exports.yamlAndJsonSyncReader = yamlAndJsonSyncReader;
 function isPathParameter(pathSegment) {
     return pathSegment.startsWith('{') && pathSegment.endsWith('}');
 }

package/lib/visitors.d.ts

@@ -1,6 +1,6 @@
 import type { Oas3Definition, Oas3ExternalDocs, Oas3Info, Oas3Contact, Oas3Components, Oas3License, Oas3Schema, Oas3Header, Oas3Parameter, Oas3Operation, Oas3PathItem, Oas3ServerVariable, Oas3Server, Oas3MediaType, Oas3Response, Oas3Example, Oas3RequestBody, Oas3Tag, OasRef, Oas3SecurityScheme, Oas3SecurityRequirement, Oas3Encoding, Oas3Link, Oas3Xml, Oas3Discriminator, Oas3Callback } from './typings/openapi';
 import type { Oas2Definition, Oas2Tag, Oas2ExternalDocs, Oas2SecurityRequirement, Oas2Info, Oas2Contact, Oas2License, Oas2PathItem, Oas2Operation, Oas2Header, Oas2Response, Oas2Schema, Oas2Xml, Oas2Parameter, Oas2SecurityScheme } from './typings/swagger';
-import type { NormalizedNodeType } from './types';
+import { NormalizedNodeType } from './types';
 import type { Stack } from './utils';
 import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
@@ -107,6 +107,7 @@ declare type Oas3FlatVisitor = {
     AuthorizationCode?: VisitFunctionOrObject<Oas3SecurityScheme['flows']['authorizationCode']>;
     OAuth2Flows?: VisitFunctionOrObject<Oas3SecurityScheme['flows']>;
     SecurityScheme?: VisitFunctionOrObject<Oas3SecurityScheme>;
+    SpecExtension?: VisitFunctionOrObject<unknown>;
 };
 declare type Oas2FlatVisitor = {
     Root?: VisitFunctionOrObject<Oas2Definition>;
@@ -131,6 +132,7 @@ declare type Oas2FlatVisitor = {
     NamedResponses?: VisitFunctionOrObject<Record<string, Oas2Response>>;
     NamedParameters?: VisitFunctionOrObject<Record<string, Oas2Parameter>>;
     SecurityScheme?: VisitFunctionOrObject<Oas2SecurityScheme>;
+    SpecExtension?: VisitFunctionOrObject<unknown>;
 };
 declare type Oas3NestedVisitor = {
     [T in keyof Oas3FlatVisitor]: Oas3FlatVisitor[T] extends Function ? Oas3FlatVisitor[T] : Oas3FlatVisitor[T] & NestedVisitor<Oas3NestedVisitor>;

package/lib/visitors.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.normalizeVisitors = void 0;
+const types_1 = require("./types");
 const legacyTypesMap = {
     Root: 'DefinitionRoot',
     ServerVariablesMap: 'ServerVariableMap',
@@ -68,6 +69,9 @@ function normalizeVisitors(visitorsConfig, types) {
                 possibleChildren.add(from.items);
             }
         }
+        if (from.extensionsPrefix) {
+            possibleChildren.add(types_1.SpecExtension);
+        }
         for (const fromType of Array.from(possibleChildren.values())) {
             addWeakNodes(ruleConf, fromType, to, parentContext, stack);
         }

package/lib/walk.js

@@ -153,6 +153,9 @@ function walkDocument(opts) {
                     if (type.additionalProperties) {
                         props.push(...Object.keys(resolvedNode).filter((k) => !props.includes(k)));
                     }
+                    else if (type.extensionsPrefix) {
+                        props.push(...Object.keys(resolvedNode).filter((k) => k.startsWith(type.extensionsPrefix)));
+                    }
                     if (ref_utils_1.isRef(node)) {
                         props.push(...Object.keys(node).filter((k) => k !== '$ref' && !props.includes(k))); // properties on the same level as $ref
                     }
@@ -168,6 +171,11 @@ function walkDocument(opts) {
                             propType = type.additionalProperties;
                         if (typeof propType === 'function')
                             propType = propType(value, propName);
+                        if (propType === undefined &&
+                            type.extensionsPrefix &&
+                            propName.startsWith(type.extensionsPrefix)) {
+                            propType = types_1.SpecExtension;
+                        }
                         if (!types_1.isNamedType(propType) && (propType === null || propType === void 0 ? void 0 : propType.directResolveAs)) {
                             propType = propType.directResolveAs;
                             value = { $ref: value };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/openapi-core",
-  "version": "1.0.0-beta.117",
+  "version": "1.0.0-beta.118",
   "description": "",
   "main": "lib/index.js",
   "engines": {

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

@@ -23,6 +23,7 @@ rootType:
               type: string
             email:
               type: string
+          extensionsPrefix: x-
           name: Contact
         license:
           properties:
@@ -32,6 +33,7 @@ rootType:
               type: string
           required:
             - name
+          extensionsPrefix: x-
           name: License
         x-logo:
           properties:
@@ -47,6 +49,7 @@ rootType:
       required:
         - title
         - version
+      extensionsPrefix: x-
       name: Info
     servers:
       name: ServerList
@@ -62,6 +65,7 @@ rootType:
             properties: {}
         required:
           - url
+        extensionsPrefix: x-
         name: Server
     security:
       name: SecurityRequirementList
@@ -90,6 +94,7 @@ rootType:
                 type: string
             required:
               - url
+            extensionsPrefix: x-
             name: ExternalDocs
           x-traitTag:
             type: boolean
@@ -97,6 +102,7 @@ rootType:
             type: string
         required:
           - name
+        extensionsPrefix: x-
         name: Tag
     externalDocs:
       properties:
@@ -106,6 +112,7 @@ rootType:
           type: string
       required:
         - url
+      extensionsPrefix: x-
       name: ExternalDocs
     paths:
       properties: {}
@@ -139,6 +146,7 @@ rootType:
         callbacks:
           name: NamedCallbacks
           properties: {}
+      extensionsPrefix: x-
       name: Components
     x-webhooks:
       properties: {}
@@ -154,6 +162,7 @@ rootType:
             type: array
             items:
               type: string
+        extensionsPrefix: x-
         name: TagGroup
     x-ignoredHeaderParameters:
       type: array
@@ -163,6 +172,7 @@ rootType:
     - openapi
     - paths
     - info
+  extensionsPrefix: x-
   name: Root
 refTypes: {}
 visitorsData:

package/src/config/config-resolvers.ts

@@ -79,14 +79,18 @@ export function resolvePlugins(
     }
 
     if (isString(plugin)) {
-      const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
-      // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-      // @ts-ignore
-      return typeof __webpack_require__ === 'function'
-        ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-          // @ts-ignore
-          __non_webpack_require__(absoltePluginPath)
-        : require(absoltePluginPath);
+      try {
+        const absoltePluginPath = path.resolve(path.dirname(configPath), plugin);
+        // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+        // @ts-ignore
+        return typeof __webpack_require__ === 'function'
+          ? // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            __non_webpack_require__(absoltePluginPath)
+          : require(absoltePluginPath);
+      } catch (e) {
+        throw new Error(`Failed to load plugin "${plugin}". Please provide a valid path`);
+      }
     }
 
     return plugin;