@redocly/openapi-core 1.0.0-beta.89 → 1.0.0-beta.92

package/lib/rules/common/assertions/utils.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOrdered = exports.getIntersectionLength = exports.buildSubjectVisitor = exports.buildVisitorObject = void 0;
+const asserts_1 = require("./asserts");
+function buildVisitorObject(subject, context, subjectVisitor) {
+    if (!context) {
+        return { [subject]: subjectVisitor };
+    }
+    let currentVisitorLevel = {};
+    const visitor = currentVisitorLevel;
+    for (let index = 0; index < context.length; index++) {
+        const node = context[index];
+        if (context.length === index + 1 && node.type === subject) {
+            // Visitors don't work properly for the same type nested nodes, so
+            // as a workaround for that we don't create separate visitor for the last element
+            // which is the same as subject;
+            // we will check includes/excludes it in the last visitor.
+            continue;
+        }
+        const matchParentKeys = node.matchParentKeys;
+        const excludeParentKeys = node.excludeParentKeys;
+        if (matchParentKeys && excludeParentKeys) {
+            throw new Error(`Both 'matchParentKeys' and 'excludeParentKeys' can't be under one context item`);
+        }
+        if (matchParentKeys || excludeParentKeys) {
+            currentVisitorLevel[node.type] = {
+                skip: (_value, key) => {
+                    if (matchParentKeys) {
+                        return !matchParentKeys.includes(key);
+                    }
+                    if (excludeParentKeys) {
+                        return excludeParentKeys.includes(key);
+                    }
+                },
+            };
+        }
+        else {
+            currentVisitorLevel[node.type] = {};
+        }
+        currentVisitorLevel = currentVisitorLevel[node.type];
+    }
+    currentVisitorLevel[subject] = subjectVisitor;
+    return visitor;
+}
+exports.buildVisitorObject = buildVisitorObject;
+function buildSubjectVisitor(properties, asserts, context) {
+    return function (node, { report, location, key, type }) {
+        // We need to check context's last node if it has the same type as subject node;
+        // if yes - that means we didn't create context's last node visitor,
+        // so we need to handle 'matchParentKeys' and 'excludeParentKeys' conditions here;
+        if (context) {
+            const lastContextNode = context[context.length - 1];
+            if (lastContextNode.type === type.name) {
+                const matchParentKeys = lastContextNode.matchParentKeys;
+                const excludeParentKeys = lastContextNode.excludeParentKeys;
+                if (matchParentKeys && !matchParentKeys.includes(key)) {
+                    return;
+                }
+                if (excludeParentKeys && excludeParentKeys.includes(key)) {
+                    return;
+                }
+            }
+        }
+        if (properties) {
+            properties = Array.isArray(properties) ? properties : [properties];
+        }
+        for (const assert of asserts) {
+            if (properties) {
+                for (const property of properties) {
+                    runAssertion(node[property], assert, location.child(property), report);
+                }
+            }
+            else {
+                runAssertion(Object.keys(node), assert, location.key(), report);
+            }
+        }
+    };
+}
+exports.buildSubjectVisitor = buildSubjectVisitor;
+function getIntersectionLength(keys, properties) {
+    const props = new Set(properties);
+    let count = 0;
+    for (const key of keys) {
+        if (props.has(key)) {
+            count++;
+        }
+    }
+    return count;
+}
+exports.getIntersectionLength = getIntersectionLength;
+function isOrdered(value, options) {
+    const direction = options.direction || options;
+    const property = options.property;
+    for (let i = 1; i < value.length; i++) {
+        let currValue = value[i];
+        let prevVal = value[i - 1];
+        if (property) {
+            if (!value[i][property] || !value[i - 1][property]) {
+                return false; // property doesn't exist, so collection is not ordered
+            }
+            currValue = value[i][property];
+            prevVal = value[i - 1][property];
+        }
+        const result = direction === 'asc' ? currValue >= prevVal : currValue <= prevVal;
+        if (!result) {
+            return false;
+        }
+    }
+    return true;
+}
+exports.isOrdered = isOrdered;
+function runAssertion(values, assert, location, report) {
+    const lintResult = asserts_1.asserts[assert.name](values, assert.conditions);
+    if (!lintResult) {
+        report({
+            message: assert.message || `The ${assert.assertId} doesn't meet required conditions`,
+            location,
+            forceSeverity: assert.severity,
+            suggest: assert.suggest,
+            ruleId: assert.assertId,
+        });
+    }
+}

package/lib/rules/oas2/index.d.ts

@@ -15,6 +15,7 @@ export declare const rules: {
     'no-path-trailing-slash': Oas2Rule;
     'operation-2xx-response': Oas2Rule;
     'operation-4xx-response': Oas2Rule;
+    assertions: Oas2Rule;
     'operation-operationId-unique': Oas2Rule;
     'operation-parameters-unique': Oas2Rule;
     'path-parameters-defined': Oas2Rule;

package/lib/rules/oas2/index.js

@@ -16,6 +16,7 @@ const no_enum_type_mismatch_1 = require("../common/no-enum-type-mismatch");
 const no_path_trailing_slash_1 = require("../common/no-path-trailing-slash");
 const operation_2xx_response_1 = require("../common/operation-2xx-response");
 const operation_4xx_response_1 = require("../common/operation-4xx-response");
+const assertions_1 = require("../common/assertions");
 const operation_operationId_unique_1 = require("../common/operation-operationId-unique");
 const operation_parameters_unique_1 = require("../common/operation-parameters-unique");
 const path_params_defined_1 = require("../common/path-params-defined");
@@ -54,6 +55,7 @@ exports.rules = {
     'no-path-trailing-slash': no_path_trailing_slash_1.NoPathTrailingSlash,
     'operation-2xx-response': operation_2xx_response_1.Operation2xxResponse,
     'operation-4xx-response': operation_4xx_response_1.Operation4xxResponse,
+    '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/index.js

@@ -4,6 +4,7 @@ exports.preprocessors = exports.rules = void 0;
 const spec_1 = require("../common/spec");
 const operation_2xx_response_1 = require("../common/operation-2xx-response");
 const operation_4xx_response_1 = require("../common/operation-4xx-response");
+const assertions_1 = require("../common/assertions");
 const operation_operationId_unique_1 = require("../common/operation-operationId-unique");
 const operation_parameters_unique_1 = require("../common/operation-parameters-unique");
 const path_params_defined_1 = require("../common/path-params-defined");
@@ -54,6 +55,7 @@ exports.rules = {
     'info-license-url': license_url_1.InfoLicenseUrl,
     'operation-2xx-response': operation_2xx_response_1.Operation2xxResponse,
     'operation-4xx-response': operation_4xx_response_1.Operation4xxResponse,
+    '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/types/redocly-yaml.js

@@ -5,16 +5,24 @@ const _1 = require(".");
 const utils_1 = require("../utils");
 const ConfigRoot = {
     properties: {
-        apiDefinitions: {
-            type: 'object',
-            properties: {},
-            additionalProperties: { properties: { type: 'string' } },
-        },
-        lint: 'ConfigLint',
-        referenceDocs: 'ConfigReferenceDocs',
+        organization: { type: 'string' },
+        apis: 'ConfigApis',
+        lint: 'RootConfigLint',
+        'features.openapi': 'ConfigReferenceDocs',
         'features.mockServer': 'ConfigMockServer',
     },
 };
+const ConfigApis = {
+    properties: {},
+    additionalProperties: 'ConfigApisProperties',
+};
+const ConfigApisProperties = {
+    properties: {
+        root: { type: 'string' },
+        lint: 'ConfigLint',
+        'features.openapi': 'ConfigReferenceDocs',
+    },
+};
 const ConfigHTTP = {
     properties: {
         headers: {
@@ -27,10 +35,6 @@ const ConfigHTTP = {
 };
 const ConfigLint = {
     properties: {
-        plugins: {
-            type: 'array',
-            items: { type: 'string' },
-        },
         extends: {
             type: 'array',
             items: {
@@ -57,6 +61,12 @@ const ConfigLint = {
         },
     },
 };
+const RootConfigLint = {
+    properties: Object.assign({ plugins: {
+            type: 'array',
+            items: { type: 'string' },
+        } }, ConfigLint.properties),
+};
 const ConfigLanguage = {
     properties: {
         label: { type: 'string' },
@@ -454,6 +464,9 @@ const ConfigMockServer = {
 };
 exports.ConfigTypes = {
     ConfigRoot,
+    ConfigApis,
+    ConfigApisProperties,
+    RootConfigLint,
     ConfigLint,
     ConfigReferenceDocs,
     ConfigMockServer,

package/lib/visitors.d.ts

@@ -156,8 +156,8 @@ export declare type NormalizedOasVisitors<T extends BaseVisitor> = {
         leave: Array<VisitorNode<any>>;
     };
 };
-export declare type Oas3Rule = (options: Record<string, any>) => Oas3Visitor;
-export declare type Oas2Rule = (options: Record<string, any>) => Oas2Visitor;
+export declare type Oas3Rule = (options: Record<string, any>) => Oas3Visitor | Oas3Visitor[];
+export declare type Oas2Rule = (options: Record<string, any>) => Oas2Visitor | Oas2Visitor[];
 export declare type Oas3Preprocessor = (options: Record<string, any>) => Oas3TransformVisitor;
 export declare type Oas2Preprocessor = (options: Record<string, any>) => Oas2TransformVisitor;
 export declare type Oas3Decorator = (options: Record<string, any>) => Oas3TransformVisitor;

package/lib/walk.d.ts

@@ -60,6 +60,7 @@ export declare type Problem = {
     location?: Partial<LocationObject> | Array<Partial<LocationObject>>;
     from?: LocationObject;
     forceSeverity?: ProblemSeverity;
+    ruleId?: string;
 };
 export declare type NormalizedProblem = {
     message: string;

package/lib/walk.js

@@ -240,7 +240,7 @@ function walkDocument(opts) {
                     ? opts.location
                     : [opts.location]
                 : [Object.assign(Object.assign({}, currentLocation), { reportOnKey: false })];
-            ctx.problems.push(Object.assign(Object.assign({ ruleId, severity: opts.forceSeverity || severity }, opts), { suggest: opts.suggest || [], location: loc.map((loc) => {
+            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);
                 }) }));
         }

package/package.json

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

package/src/__tests__/lint.test.ts

@@ -46,7 +46,7 @@ describe('lint', () => {
   it('lintConfig should work', async () => {
     const document = parseYamlToDocument(
       outdent`
-      apiDefinitions: error string
+      apis: error string
       lint:
         plugins:
           - './local-plugin.js'
@@ -58,7 +58,7 @@ describe('lint', () => {
           no-invalid-media-type-examples: error
           path-http-verbs-order: error
           boolean-parameter-prefixes: off
-      referenceDocs:
+      features.openapi:
         showConsole: true
         layout:
           scope: section
@@ -78,12 +78,12 @@ describe('lint', () => {
         Object {
           "location": Array [
             Object {
-              "pointer": "#/apiDefinitions",
+              "pointer": "#/apis",
               "reportOnKey": false,
               "source": "",
             },
           ],
-          "message": "Expected type \`object\` but got \`string\`.",
+          "message": "Expected type \`ConfigApis\` (object) but got \`string\`",
           "ruleId": "spec",
           "severity": "error",
           "suggest": Array [],
@@ -91,7 +91,7 @@ describe('lint', () => {
         Object {
           "location": Array [
             Object {
-              "pointer": "#/referenceDocs/layout",
+              "pointer": "#/features.openapi/layout",
               "reportOnKey": false,
               "source": "",
             },
@@ -105,6 +105,40 @@ describe('lint', () => {
     `);
   });
 
+  it("'plugins' shouldn't be allowed in 'apis' -> 'lint' field", async () => {
+    const document = parseYamlToDocument(
+      outdent`
+      apis: 
+        lint: 
+          plugins: 
+            - './local-plugin.js'
+      lint:
+        plugins:
+          - './local-plugin.js'
+      `,
+      '',
+    );
+    const results = await lintConfig({ document });
+
+    expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "location": Array [
+            Object {
+              "pointer": "#/apis/lint/plugins",
+              "reportOnKey": true,
+              "source": "",
+            },
+          ],
+          "message": "Property \`plugins\` is not expected here.",
+          "ruleId": "spec",
+          "severity": "error",
+          "suggest": Array [],
+        },
+      ]
+    `);
+  });
+
   it("'const' can have any type", async () => {
     const document = parseYamlToDocument(
       outdent`
@@ -140,7 +174,7 @@ describe('lint', () => {
     const results = await lintDocument({
       externalRefResolver: new BaseResolver(),
       document,
-      config: makeConfig({ spec: 'error', }),
+      config: makeConfig({ spec: 'error' }),
     });
 
     expect(replaceSourceWithRef(results)).toMatchInlineSnapshot(`Array []`);

package/src/bundle.ts

@@ -130,7 +130,7 @@ export async function bundleDocument(opts: {
         visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document, resolvedRefMap),
       },
       ...decorators,
-    ],
+    ] as any,
     types,
   );
 

package/src/config/all.ts

@@ -19,6 +19,7 @@ export default {
     'operation-description': 'error',
     'operation-2xx-response': 'error',
     'operation-4xx-response': 'error',
+    'assertions': 'error',
     'operation-operationId': 'error',
     'operation-summary': 'error',
     'operation-operationId-unique': 'error',

package/src/config/config.ts

@@ -1,7 +1,7 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import { dirname } from 'path';
-import { red, blue } from 'colorette';
+import { red, blue, yellow, green } from 'colorette';
 import { parseYaml, stringifyYaml } from '../js-yaml';
 import { notUndefined, slash } from '../utils';
 import {
@@ -695,17 +695,20 @@ export function transformConfig(rawConfig: DeprecatedRawConfig | RawConfig): Raw
     throw new Error("Do not use 'referenceDocs' field. Use 'features.openapi' instead.\n");
   }
   const { apiDefinitions, referenceDocs, ...rest } = rawConfig as DeprecatedRawConfig & RawConfig;
-  // TODO: put links to the changelog and uncomment this after successful release of ReferenceDocs/Redoc, Portal and Workflows
-  // if (apiDefinitions) {
-  //   process.stderr.write(
-  //     `The ${yellow('apiDefinitions')} field is deprecated. Use ${green('apis')} instead, see changelog: <link>\n`
-  //   );
-  // }
-  // if (referenceDocs) {
-  //   process.stderr.write(
-  //     `The ${yellow('referenceDocs')} field is deprecated. Use ${green('features.openapi')} instead, see changelog: <link>\n`
-  //   );
-  // }
+  if (apiDefinitions) {
+    process.stderr.write(
+      `The ${yellow('apiDefinitions')} field is deprecated. Use ${green(
+        'apis',
+      )} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`,
+    );
+  }
+  if (referenceDocs) {
+    process.stderr.write(
+      `The ${yellow('referenceDocs')} field is deprecated. Use ${green(
+        'features.openapi',
+      )} instead. Read more about this change: https://redocly.com/docs/api-registry/guides/migration-guide-config-file/#changed-properties\n`,
+    );
+  }
   return {
     'features.openapi': referenceDocs,
     apis: transformApiDefinitionsToApis(apiDefinitions),

package/src/config/minimal.ts

@@ -18,6 +18,7 @@ export default {
     'operation-description': 'off',
     'operation-2xx-response': 'warn',
     'operation-4xx-response': 'off',
+    'assertions': 'warn',
     'operation-operationId': 'warn',
     'operation-summary': 'warn',
     'operation-operationId-unique': 'warn',

package/src/config/recommended.ts

@@ -17,6 +17,7 @@ export default {
     'path-parameters-defined': 'error',
     'operation-description': 'off',
     'operation-2xx-response': 'warn',
+    'assertions': 'warn',
     'operation-4xx-response': 'warn',
     'operation-operationId': 'warn',
     'operation-summary': 'error',

package/src/config/rules.ts

@@ -24,14 +24,23 @@ export function initRules<T extends Function, P extends RuleSet<T>>(
           return undefined;
         }
 
-        const visitor = rule(ruleSettings);
+        const visitors = rule(ruleSettings);
+
+        if (Array.isArray(visitors)) {
+          return visitors.map((visitor: any) => ({
+            severity: ruleSettings.severity,
+            ruleId,
+            visitor: visitor,
+          }))
+        }
 
         return {
           severity: ruleSettings.severity,
           ruleId,
-          visitor,
+          visitor: visitors, // note: actually it is only one visitor object
         };
       }),
     )
+    .flatMap(visitor => visitor)
     .filter(notUndefined);
 }

package/src/lint.ts

@@ -11,7 +11,7 @@ import { LintConfig, Config } from './config/config';
 import { normalizeTypes } from './types';
 import { initRules } from './config/rules';
 import { releaseAjvInstance } from './rules/ajv';
-import { detectOpenAPI, OasMajorVersion, OasVersion, openAPIMajor } from './oas-types';
+import { detectOpenAPI, Oas3RuleSet, OasMajorVersion, OasVersion, openAPIMajor } from './oas-types';
 import { ConfigTypes } from './types/redocly-yaml';
 import { OasSpec } from './rules/common/spec';
 import { defaultPlugin } from './config/builtIn';
@@ -76,8 +76,8 @@ export async function lintDocument(opts: {
   };
 
   const preprocessors = initRules(rules as any, config, 'preprocessors', oasVersion);
-  const regularRules = initRules(rules as any, config, 'rules', oasVersion);
-  const normalizedVisitors = normalizeVisitors([...preprocessors, ...regularRules], types);
+  const regularRules = initRules(rules as Oas3RuleSet[], config, 'rules', oasVersion);
+  const normalizedVisitors = normalizeVisitors([...preprocessors, ...regularRules] as any, types);
   const resolvedRefMap = await resolveDocument({
     rootDocument: document,
     rootType: types.DefinitionRoot,

package/src/redocly/index.ts

@@ -19,9 +19,7 @@ export class RedoclyClient {
   constructor(region?: Region) {
     this.region = this.loadRegion(region);
     this.loadTokens();
-    this.domain = region
-      ? DOMAINS[region]
-      : process.env.REDOCLY_DOMAIN || DOMAINS[DEFAULT_REGION];
+    this.domain = region ? DOMAINS[region] : process.env.REDOCLY_DOMAIN || DOMAINS[DEFAULT_REGION];
 
     /*
      * We can't use process.env here because it is replaced by a const in some client-side bundles,
@@ -34,7 +32,11 @@ export class RedoclyClient {
   loadRegion(region?: Region) {
     if (region && !DOMAINS[region]) {
       process.stdout.write(
-        red(`Invalid argument: region in config file.\nGiven: ${green(region)}, choices: "us", "eu".\n`),
+        red(
+          `Invalid argument: region in config file.\nGiven: ${green(
+            region,
+          )}, choices: "us", "eu".\n`,
+        ),
       );
       process.exit(1);
     }
@@ -86,37 +88,36 @@ export class RedoclyClient {
     if (isNotEmptyObject(credentials)) {
       this.setAccessTokens({
         ...credentials,
-        ...(credentials.token && !credentials[this.region] && {
-          [this.region]: credentials.token
-        })
-      })
+        ...(credentials.token &&
+          !credentials[this.region] && {
+            [this.region]: credentials.token,
+          }),
+      });
     }
     if (process.env.REDOCLY_AUTHORIZATION) {
       this.setAccessTokens({
         ...this.accessTokens,
-        [this.region]: process.env.REDOCLY_AUTHORIZATION
-      })
+        [this.region]: process.env.REDOCLY_AUTHORIZATION,
+      });
     }
   }
 
-  getAllTokens (): RegionalToken[] {
-    return (<[Region, string][]>Object.entries(this.accessTokens)).filter(
-      ([region]) => AVAILABLE_REGIONS.includes(region)
-    ).map(
-      ([region, token]) => ({ region, token })
-    );
+  getAllTokens(): RegionalToken[] {
+    return (<[Region, string][]>Object.entries(this.accessTokens))
+      .filter(([region]) => AVAILABLE_REGIONS.includes(region))
+      .map(([region, token]) => ({ region, token }));
   }
 
   async getValidTokens(): Promise<RegionalTokenWithValidity[]> {
-    const validTokens = <RegionalTokenWithValidity[]>[];
+    const allTokens = this.getAllTokens();
 
-    for (const { token, region } of this.getAllTokens()) {
-      if (await this.verifyToken(token, region)) {
-        validTokens.push({ token, region, valid: true });
-      }
-    }
-    
-    return validTokens;
+    const verifiedTokens = await Promise.allSettled(
+      allTokens.map(({ token, region }) => this.verifyToken(token, region)),
+    );
+
+    return allTokens
+      .filter((_, index) => verifiedTokens[index].status === 'fulfilled')
+      .map(({ token, region }) => ({ token, region, valid: true }));
   }
 
   async getTokens() {
@@ -124,9 +125,23 @@ export class RedoclyClient {
   }
 
   async isAuthorizedWithRedoclyByRegion(): Promise<boolean> {
-    if (!this.hasTokens()) return false;
+    if (!this.hasTokens()) {
+      return false;
+    }
+
     const accessToken = this.accessTokens[this.region];
-    return !!accessToken && await this.verifyToken(accessToken, this.region);
+
+    if (!accessToken) {
+      return false;
+    }
+
+    try {
+      await this.verifyToken(accessToken, this.region);
+
+      return true;
+    } catch (err) {
+      return false;
+    }
   }
 
   async isAuthorizedWithRedocly(): Promise<boolean> {
@@ -137,8 +152,11 @@ export class RedoclyClient {
     return existsSync(credentialsPath) ? JSON.parse(readFileSync(credentialsPath, 'utf-8')) : {};
   }
 
-  async verifyToken(accessToken: string, region: Region, verbose: boolean = false): Promise<boolean> {
-    if (!accessToken) return false;
+  async verifyToken(
+    accessToken: string,
+    region: Region,
+    verbose: boolean = false,
+  ): Promise<{ viewerId: string; organizations: string[] }> {
     return this.registryApi.authStatus(accessToken, region, verbose);
   }
 
@@ -146,8 +164,9 @@ export class RedoclyClient {
     const credentialsPath = resolve(homedir(), TOKEN_FILENAME);
     process.stdout.write(gray('\n  Logging in...\n'));
 
-    const authorized = await this.verifyToken(accessToken, this.region, verbose);
-    if (!authorized) {
+    try {
+      await this.verifyToken(accessToken, this.region, verbose);
+    } catch (err) {
       process.stdout.write(
         red('Authorization failed. Please check if you entered a valid API key.\n'),
       );