@redocly/openapi-core 1.0.0-beta.111 → 1.0.0-beta.113

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.pickDefined = 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.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");
@@ -205,6 +205,12 @@ function identity(value) {
     return value;
 }
 exports.identity = identity;
+function keysOf(obj) {
+    if (!obj)
+        return [];
+    return Object.keys(obj);
+}
+exports.keysOf = keysOf;
 function pickDefined(obj) {
     if (!obj)
         return undefined;
@@ -217,3 +223,9 @@ function pickDefined(obj) {
     return res;
 }
 exports.pickDefined = pickDefined;
+function nextTick() {
+    new Promise((resolve) => {
+        setTimeout(resolve);
+    });
+}
+exports.nextTick = nextTick;

package/lib/visitors.d.ts

@@ -4,11 +4,12 @@ import type { NormalizedNodeType } from './types';
 import type { Stack } from './utils';
 import type { UserContext, ResolveResult, ProblemSeverity } from './walk';
 import type { Location } from './ref-utils';
+export declare type SkipFunctionContext = Pick<UserContext, 'location' | 'rawNode' | 'resolve' | 'rawLocation'>;
 export declare type VisitFunction<T> = (node: T, ctx: UserContext & {
     ignoreNextVisitorsOnNode: () => void;
 }, parents?: any, context?: any) => void;
 declare type VisitRefFunction = (node: OasRef, ctx: UserContext, resolved: ResolveResult<any>) => void;
-declare type SkipFunction<T> = (node: T, key: string | number) => boolean;
+declare type SkipFunction<T> = (node: T, key: string | number, ctx: SkipFunctionContext) => boolean;
 declare type VisitObject<T> = {
     enter?: VisitFunction<T>;
     leave?: VisitFunction<T>;

package/lib/visitors.js

@@ -12,6 +12,7 @@ const legacyTypesMap = {
     HeadersMap: 'HeaderMap',
     LinksMap: 'LinkMap',
     OAuth2Flows: 'SecuritySchemeFlows',
+    Responses: 'ResponsesMap',
 };
 function normalizeVisitors(visitorsConfig, types) {
     const normalizedVisitors = {};

package/lib/walk.js

@@ -112,7 +112,13 @@ function walkDocument(opts) {
                             location: resolvedLocation,
                             nextLevelTypeActivated: null,
                             withParentNode: (_g = (_f = context.parent) === null || _f === void 0 ? void 0 : _f.activatedOn) === null || _g === void 0 ? void 0 : _g.value.node,
-                            skipped: (_k = (((_j = (_h = context.parent) === null || _h === void 0 ? void 0 : _h.activatedOn) === null || _j === void 0 ? void 0 : _j.value.skipped) || (skip === null || skip === void 0 ? void 0 : skip(resolvedNode, key)))) !== null && _k !== void 0 ? _k : false,
+                            skipped: (_k = (((_j = (_h = context.parent) === null || _h === void 0 ? void 0 : _h.activatedOn) === null || _j === void 0 ? void 0 : _j.value.skipped) ||
+                                (skip === null || skip === void 0 ? void 0 : skip(resolvedNode, key, {
+                                    location,
+                                    rawLocation,
+                                    resolve,
+                                    rawNode: node,
+                                })))) !== null && _k !== void 0 ? _k : false,
                         };
                         context.activatedOn = utils_1.pushStack(context.activatedOn, activatedOn);
                         let ctx = context.parent;

package/package.json

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

package/src/__tests__/bundle.test.ts

@@ -187,4 +187,50 @@ describe('bundle', () => {
     expect(problems).toHaveLength(0);
     expect(parsedMeta).toMatchSnapshot();
   });
+
+  it('should bundle refs using $anchors', async () => {
+    const testDocument = parseYamlToDocument(
+      outdent`
+        openapi: 3.1.0
+        components:
+          schemas:
+            User:
+              type: object
+              properties:
+                profile:
+                  $ref: '#user-profile'
+            UserProfile:
+              $anchor: user-profile
+              type: string
+      `,
+      ''
+    );
+
+    const config = await makeConfig({});
+
+    const {
+      bundle: { parsed },
+      problems,
+    } = await bundleDocument({
+      document: testDocument,
+      config: config,
+      externalRefResolver: new BaseResolver(),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(parsed).toMatchInlineSnapshot(`
+      openapi: 3.1.0
+      components:
+        schemas:
+          User:
+            type: object
+            properties:
+              profile:
+                $ref: '#user-profile'
+          UserProfile:
+            $anchor: user-profile
+            type: string
+
+    `);
+  });
 });

package/src/__tests__/lint.test.ts

@@ -61,11 +61,13 @@ describe('lint', () => {
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
           assert/operation-summary-length:
-            subject: Operation
-            property: summary
+            subject: 
+              type: Operation
+              property: summary
             message: Operation summary should start with an active verb
-            local/checkWordsCount: 
-              min: 3
+            assertions:
+              local/checkWordsCount: 
+                min: 3
       features.openapi:
         showConsole: true
         layout:
@@ -247,7 +249,24 @@ describe('lint', () => {
     );
     const results = await lintConfig({ document });
 
-    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "from": undefined,
+          "location": Array [
+            Object {
+              "pointer": "#/referenceDocs",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`referenceDocs\` is not expected here.",
+          "ruleId": "configuration spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
   });
 
   it("'plugins' shouldn't be allowed in 'apis'", async () => {

package/src/benchmark/benches/rebilly.yaml

@@ -4238,10 +4238,11 @@ components:
               type: integer
               readOnly: true
             dueReminderTime:
-              description: Time past due reminder event will be triggered
+              description: Date and time at which a past due reminder event is triggered.
               nullable: true
-              allOf:
-                - $ref: '#/components/schemas/ServerTimestamp'
+              type: string
+              format: date-time
+              readOnly: true
             dueReminderNumber:
               description: Number of past due reminder events triggered
               type: integer
@@ -9524,10 +9525,11 @@ components:
           allOf:
             - $ref: '#/components/schemas/ServerTimestamp'
         expirationReminderTime:
-          description: Time expiration reminder event will be triggered
+          description: Date and time at which an expiration reminder event is triggered.
           nullable: true
-          allOf:
-            - $ref: '#/components/schemas/ServerTimestamp'
+          type: string
+          format: date-time
+          readOnly: true
         expirationReminderNumber:
           description: Number of expiration reminder events triggered
           type: integer
@@ -10226,9 +10228,10 @@ components:
               readOnly: true
             reviewTime:
               description: Date and time of manual review.
+              type: string
               nullable: true
-              allOf:
-                - $ref: '#/components/schemas/ServerTimestamp'
+              format: date-time
+              readOnly: true
             documentMatches:
               $ref: '#/components/schemas/KycDocumentMatches'
             _links:
@@ -10587,19 +10590,22 @@ components:
         deliveryAddress:
           description: Delivery address
           nullable: true
+          type: object
           allOf:
             - $ref: '#/components/schemas/ContactObject'
         billingAddress:
           description: Billing address
           nullable: true
+          type: object
           allOf:
             - $ref: '#/components/schemas/ContactObject'
         riskMetadata:
           nullable: true
+          type: object
           example: null
-          description: >-
-            Risk metadata. If null, the value would coalesce to the risk
-            metadata captured when creating the payment token.
+          description: |-
+            Risk metadata.
+            If null, the value would coalesce to the risk metadata captured when creating the payment token.
           allOf:
             - $ref: '#/components/schemas/RiskMetadata'
         activationTime:
@@ -10842,18 +10848,16 @@ components:
                   type: string
                   format: date-time
             invoiceTimeShift:
-              description: >
-                You can shift issue time and due time of invoices for this
-                subscription.
+              description: |-
+                You can shift issue time and due time of invoices for this subscription.
 
-                This setting overrides plan settings. To use plan settings, set
-                `null`.
-
-                To use multiple plans in one subscription they all must have the
-                same billing period,
+                This setting overrides plan settings.
+                To use plan settings, set `null`.
 
+                To use multiple plans in one subscription they all must have the same billing period,
                 this property allows to subscribe to different plans.
               nullable: true
+              type: object
               example: null
               allOf:
                 - $ref: '#/components/schemas/InvoiceTimeShift'
@@ -10898,19 +10902,21 @@ components:
               type: integer
               readOnly: true
             renewalReminderTime:
-              description: Time renewal reminder event will be triggered
+              description: Time renewal reminder event will be triggered.
               nullable: true
-              allOf:
-                - $ref: '#/components/schemas/ServerTimestamp'
+              type: string
+              format: date-time
+              readOnly: true
             renewalReminderNumber:
               description: Number of renewal reminder events triggered
               type: integer
               readOnly: true
             trialReminderTime:
-              description: Time renewal reminder event will be triggered
+              description: Time renewal reminder event will be triggered.
               nullable: true
-              allOf:
-                - $ref: '#/components/schemas/ServerTimestamp'
+              type: string
+              format: date-time
+              readOnly: true
             trialReminderNumber:
               description: Number of renewal reminder events triggered
               type: integer
@@ -11807,10 +11813,12 @@ components:
         paymentInstrument:
           $ref: '#/components/schemas/PaymentInstrument'
         billingAddress:
-          description: >-
-            Billing Address. If not supplied, we use the billing address
-            associated with the payment instrument, and then customer.
+          description: |-
+            Billing address.
+            If not supplied, the billing address associated
+            with the payment instrument is used, and then customer.
           nullable: true
+          type: object
           allOf:
             - $ref: '#/components/schemas/ContactObject'
         requestId:

package/src/config/__tests__/__snapshots__/config-resolvers.test.ts.snap

@@ -39,7 +39,6 @@ Object {
     "assertions": "warn",
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
-    "info-description": "warn",
     "info-license": "warn",
     "info-license-url": "warn",
     "local/operation-id-not-test": "error",
@@ -73,7 +72,7 @@ Object {
 }
 `;
 
-exports[`resolveStyleguideConfig should resolve extends with local file config witch contains path to nested config 1`] = `
+exports[`resolveStyleguideConfig should resolve extends with local file config which contains path to nested config 1`] = `
 Object {
   "decorators": Object {},
   "doNotResolveExamples": undefined,
@@ -129,7 +128,6 @@ Object {
     ],
     "boolean-parameter-prefixes": "error",
     "info-contact": "off",
-    "info-description": "warn",
     "info-license": "warn",
     "info-license-url": "warn",
     "local/operation-id-not-test": "error",

package/src/config/__tests__/config-resolvers.test.ts

@@ -1,5 +1,5 @@
 import { colorize } from '../../logger';
-import { asserts } from '../../rules/common/assertions/asserts';
+import { Asserts, asserts } from '../../rules/common/assertions/asserts';
 import { resolveStyleguideConfig, resolveApis, resolveConfig } from '../config-resolvers';
 const path = require('path');
 
@@ -100,7 +100,7 @@ describe('resolveStyleguideConfig', () => {
     }).toThrow('Circular dependency in config file');
   });
 
-  it('should resolve extends with local file config witch contains path to nested config', async () => {
+  it('should resolve extends with local file config which contains path to nested config', async () => {
     const styleguideConfig = {
       extends: ['local-config-with-file.yaml'],
     };
@@ -143,7 +143,7 @@ describe('resolveStyleguideConfig', () => {
 
     expect(plugins).toBeDefined();
     expect(plugins?.length).toBe(2);
-    expect(asserts['test-plugin/checkWordsCount']).toBeDefined();
+    expect(asserts['test-plugin/checkWordsCount' as keyof Asserts]).toBeDefined();
   });
 
   it('should throw error when custom assertion load not exist plugin', async () => {
@@ -163,7 +163,7 @@ describe('resolveStyleguideConfig', () => {
       );
     }
 
-    expect(asserts['test-plugin/checkWordsCount']).toBeDefined();
+    expect(asserts['test-plugin/checkWordsCount' as keyof Asserts]).toBeDefined();
   });
 
   it('should correctly merge assertions from nested config', async () => {
@@ -197,7 +197,7 @@ describe('resolveStyleguideConfig', () => {
     ]);
   });
 
-  it('should resolve extends with url file config witch contains path to nested config', async () => {
+  it('should resolve extends with url file config which contains path to nested config', async () => {
     const styleguideConfig = {
       // This points to ./fixtures/resolve-remote-configs/remote-config.yaml
       extends: [
@@ -342,7 +342,7 @@ describe('resolveApis', () => {
 });
 
 describe('resolveConfig', () => {
-  it('should add recommended to top level by default', async () => {
+  it('should NOT add recommended to top level by default IF there is a config file', async () => {
     const rawConfig: RawConfig = {
       apis: {
         petstore: {
@@ -373,7 +373,6 @@ describe('resolveConfig', () => {
     expect(apis['petstore'].styleguide.pluginPaths!.map(removeAbsolutePath)).toEqual([]);
 
     expect(apis['petstore'].styleguide.rules).toEqual({
-      ...(await recommendedStyleguidePreset).rules,
       'operation-2xx-response': 'warn',
       'operation-4xx-response': 'error',
     });

package/src/config/__tests__/fixtures/load-redocly.yaml

@@ -0,0 +1,2 @@
+  rules:
+    info-contact: warn

package/src/config/__tests__/fixtures/resolve-config/local-config-with-custom-function.yaml

@@ -1,14 +1,15 @@
-lint:
   rules:
     no-invalid-media-type-examples: warn
     operation-4xx-response: off
     assert/tag-description:
-      subject: Tag
-      property: description
+      subject: 
+        type: Tag
+        property: description
       message: Tag description must have at least 3 words.
       severity: error
-      test-plugin/checkWordsCount:
-        min: 3
+      assertions:
+        test-plugin/checkWordsCount:
+          min: 3
   plugins:
     - plugin.js
   extends:

package/src/config/__tests__/fixtures/resolve-config/local-config-with-wrong-custom-function.yaml

@@ -1,4 +1,3 @@
-lint:
   rules:
     no-invalid-media-type-examples: warn
     operation-4xx-response: off

package/src/config/__tests__/load.test.ts

@@ -49,7 +49,10 @@ describe('loadConfig', () => {
 
   it('should call callback if such passed', async () => {
     const mockFn = jest.fn();
-    await loadConfig({ processRawConfig: mockFn });
+    await loadConfig({
+      configPath: path.join(__dirname, './fixtures/load-redocly.yaml'),
+      processRawConfig: mockFn,
+    });
     expect(mockFn).toHaveBeenCalled();
   });
 });

package/src/config/all.ts

@@ -2,7 +2,6 @@ import type { PluginStyleguideConfig } from './types';
 
 export default {
   rules: {
-    'info-description': 'error',
     'info-contact': 'error',
     'info-license': 'error',
     'info-license-url': 'error',

package/src/config/config-resolvers.ts

@@ -22,10 +22,16 @@ import type {
   DeprecatedInRawConfig,
 } from './types';
 import { isBrowser } from '../env';
-import { isNotString, isString, isDefined, parseYaml } from '../utils';
+import { isNotString, isString, isDefined, parseYaml, keysOf } from '../utils';
 import { Config } from './config';
 import { colorize, logger } from '../logger';
-import { asserts, buildAssertCustomFunction } from '../rules/common/assertions/asserts';
+import {
+  Asserts,
+  AssertionFn,
+  asserts,
+  buildAssertCustomFunction,
+} from '../rules/common/assertions/asserts';
+import type { Assertion, AssertionDefinition, RawAssertion } from '../rules/common/assertions';
 
 export async function resolveConfig(rawConfig: RawConfig, configPath?: string): Promise<Config> {
   if (rawConfig.styleguide?.extends?.some(isNotString)) {
@@ -35,25 +41,15 @@ export async function resolveConfig(rawConfig: RawConfig, configPath?: string):
   }
 
   const resolver = new BaseResolver(getResolveConfig(rawConfig.resolve));
-  const configExtends = rawConfig?.styleguide?.extends ?? ['recommended'];
-  const recommendedFallback = !rawConfig?.styleguide?.extends;
-  const styleguideConfig = {
-    ...rawConfig?.styleguide,
-    extends: configExtends,
-    recommendedFallback,
-  };
 
   const apis = await resolveApis({
-    rawConfig: {
-      ...rawConfig,
-      styleguide: styleguideConfig,
-    },
+    rawConfig,
     configPath,
     resolver,
   });
 
   const styleguide = await resolveStyleguideConfig({
-    styleguideConfig,
+    styleguideConfig: rawConfig.styleguide,
     configPath,
     resolver,
   });
@@ -409,26 +405,17 @@ function groupStyleguideAssertionRules({
   const transformedRules: Record<string, RuleConfig> = {};
 
   // Collect assertion rules
-  const assertions = [];
+  const assertions: Assertion[] = [];
   for (const [ruleKey, rule] of Object.entries(rules)) {
     if (ruleKey.startsWith('assert/') && typeof rule === 'object' && rule !== null) {
-      const assertion = rule;
+      const assertion = rule as RawAssertion;
+
       if (plugins) {
-        for (const field of Object.keys(assertion)) {
-          const [pluginId, fn] = field.split('/');
-          if (!pluginId || !fn) continue;
-          const plugin = plugins.find((plugin) => plugin.id === pluginId);
-          if (!plugin) {
-            throw Error(colorize.red(`Plugin ${colorize.blue(pluginId)} isn't found.`));
-          }
-          if (!plugin.assertions || !plugin.assertions[fn]) {
-            throw Error(
-              `Plugin ${colorize.red(
-                pluginId
-              )} doesn't export assertions function with name ${colorize.red(fn)}.`
-            );
-          }
-          asserts[field] = buildAssertCustomFunction(plugin.assertions[fn]);
+        registerCustomAssertions(plugins, assertion);
+
+        // We may have custom assertion inside where block
+        for (const context of assertion.where || []) {
+          registerCustomAssertions(plugins, context);
         }
       }
       assertions.push({
@@ -446,3 +433,29 @@ function groupStyleguideAssertionRules({
 
   return transformedRules;
 }
+
+function registerCustomAssertions(plugins: Plugin[], assertion: AssertionDefinition) {
+  for (const field of keysOf(assertion.assertions)) {
+    const [pluginId, fn] = field.split('/');
+
+    if (!pluginId || !fn) continue;
+
+    const plugin = plugins.find((plugin) => plugin.id === pluginId);
+
+    if (!plugin) {
+      throw Error(colorize.red(`Plugin ${colorize.blue(pluginId)} isn't found.`));
+    }
+
+    if (!plugin.assertions || !plugin.assertions[fn]) {
+      throw Error(
+        `Plugin ${colorize.red(
+          pluginId
+        )} doesn't export assertions function with name ${colorize.red(fn)}.`
+      );
+    }
+
+    (asserts as Asserts & { [name: string]: AssertionFn })[field] = buildAssertCustomFunction(
+      plugin.assertions[fn]
+    );
+  }
+}

package/src/config/config.ts

@@ -4,7 +4,7 @@ import { parseYaml, stringifyYaml } from '../js-yaml';
 import { slash, doesYamlFileExist } from '../utils';
 import { NormalizedProblem } from '../walk';
 import { OasVersion, OasMajorVersion, Oas2RuleSet, Oas3RuleSet } from '../oas-types';
-import { env } from '../env';
+import { isBrowser, env } from '../env';
 
 import type { NodeType } from '../types';
 import type {
@@ -17,6 +17,7 @@ import type {
   ResolvedConfig,
   ResolvedStyleguideConfig,
   RuleConfig,
+  RuleSettings,
 } from './types';
 import { getResolveConfig } from './utils';
 
@@ -50,7 +51,7 @@ function getIgnoreFilePath(configFile?: string): string | undefined {
       ? path.join(path.dirname(configFile), IGNORE_FILE)
       : path.join(configFile, IGNORE_FILE);
   } else {
-    return typeof process === 'undefined' ? undefined : path.join(process.cwd(), IGNORE_FILE);
+    return isBrowser ? undefined : path.join(process.cwd(), IGNORE_FILE);
   }
 }
 
@@ -183,7 +184,7 @@ export class StyleguideConfig {
     return extendedTypes;
   }
 
-  getRuleSettings(ruleId: string, oasVersion: OasVersion) {
+  getRuleSettings(ruleId: string, oasVersion: OasVersion): RuleSettings {
     this._usedRules.add(ruleId);
     this._usedVersions.add(oasVersion);
     const settings = this.rules[oasVersion][ruleId] || 'off';
@@ -196,7 +197,7 @@ export class StyleguideConfig {
     }
   }
 
-  getPreprocessorSettings(ruleId: string, oasVersion: OasVersion) {
+  getPreprocessorSettings(ruleId: string, oasVersion: OasVersion): RuleSettings {
     this._usedRules.add(ruleId);
     this._usedVersions.add(oasVersion);
 
@@ -210,7 +211,7 @@ export class StyleguideConfig {
     }
   }
 
-  getDecoratorSettings(ruleId: string, oasVersion: OasVersion) {
+  getDecoratorSettings(ruleId: string, oasVersion: OasVersion): RuleSettings {
     this._usedRules.add(ruleId);
     this._usedVersions.add(oasVersion);
     const settings = this.decorators[oasVersion][ruleId] || 'off';