@redocly/openapi-core 1.0.0-beta.95 → 1.0.0-beta.98

package/src/config/config-resolvers.ts

@@ -11,7 +11,14 @@ import {
   prefixRules,
   transformConfig,
 } from './utils';
-import type { LintRawConfig, Plugin, RawConfig, ResolvedApi, ResolvedLintConfig } from './types';
+import type {
+  LintRawConfig,
+  Plugin,
+  RawConfig,
+  ResolvedApi,
+  ResolvedLintConfig,
+  RuleConfig,
+} from './types';
 import { isNotString, isString, notUndefined, parseYaml } from '../utils';
 import { Config } from './config';
 
@@ -175,7 +182,7 @@ export async function resolveApis({
   return resolvedApis;
 }
 
-export async function resolveLint(
+async function resolveAndMergeNestedLint(
   {
     lintConfig,
     configPath = '',
@@ -213,7 +220,7 @@ export async function resolveLint(
         ? new URL(presetItem, configPath).href
         : path.resolve(path.dirname(configPath), presetItem);
       const extendedLintConfig = await loadExtendLintConfig(pathItem, resolver);
-      return await resolveLint(
+      return await resolveAndMergeNestedLint(
         {
           lintConfig: extendedLintConfig,
           configPath: pathItem,
@@ -245,6 +252,23 @@ export async function resolveLint(
   };
 }
 
+export async function resolveLint(
+  lintOpts: {
+    lintConfig?: LintRawConfig;
+    configPath?: string;
+    resolver?: BaseResolver;
+  },
+  parentConfigPaths: string[] = [],
+  extendPaths: string[] = [],
+): Promise<ResolvedLintConfig> {
+  const resolvedLint = await resolveAndMergeNestedLint(lintOpts, parentConfigPaths, extendPaths);
+
+  return {
+    ...resolvedLint,
+    rules: resolvedLint.rules && groupLintAssertionRules(resolvedLint.rules),
+  };
+}
+
 export function resolvePreset(presetName: string, plugins: Plugin[]): ResolvedLintConfig {
   const { pluginId, configName } = parsePresetName(presetName);
   const plugin = plugins.find((p) => p.id === pluginId);
@@ -302,3 +326,34 @@ function getMergedLintRawConfig(configLint: LintRawConfig, apiLint?: LintRawConf
   };
   return resultLint;
 }
+
+function groupLintAssertionRules(
+  rules: Record<string, RuleConfig> | undefined,
+): Record<string, RuleConfig> | undefined {
+  if (!rules) {
+    return rules;
+  }
+
+  // Create a new record to avoid mutating original
+  const transformedRules: Record<string, RuleConfig> = {};
+
+  // Collect assertion rules
+  const assertions = [];
+  for (const [ruleKey, rule] of Object.entries(rules)) {
+    if (ruleKey.startsWith('assert/') && typeof rule === 'object' && rule !== null) {
+      const assertion = rule;
+      assertions.push({
+        ...assertion,
+        assertionId: ruleKey.replace('assert/', ''),
+      });
+    } else {
+      // If it's not an assertion, keep it as is
+      transformedRules[ruleKey] = rule;
+    }
+  }
+  if (assertions.length > 0) {
+    transformedRules.assertions = assertions;
+  }
+
+  return transformedRules;
+}

package/src/config/config.ts

@@ -19,25 +19,34 @@ import type {
 } from './types';
 import { getResolveConfig } from './utils';
 
+// Alias environment here so this file can work in browser environments too.
+export const env = typeof process !== 'undefined' ? process.env || {} : {};
+
 export const IGNORE_FILE = '.redocly.lint-ignore.yaml';
 const IGNORE_BANNER =
   `# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.\n` +
   `# See https://redoc.ly/docs/cli/ for more information.\n`;
 
 export const DEFAULT_REGION = 'us';
-const REDOCLY_DOMAIN = process.env.REDOCLY_DOMAIN;
-export const DOMAINS: { [region in Region]: string } = {
-  us: 'redocly.com',
-  eu: 'eu.redocly.com',
-};
-
-// FIXME: temporary fix for our lab environments
-if (REDOCLY_DOMAIN?.endsWith('.redocly.host')) {
-  DOMAINS[REDOCLY_DOMAIN.split('.')[0] as Region] = REDOCLY_DOMAIN;
-}
-if (REDOCLY_DOMAIN === 'redoc.online') {
-  DOMAINS[REDOCLY_DOMAIN as Region] = REDOCLY_DOMAIN;
+
+function getDomains() {
+  const domains: { [region in Region]: string } = {
+    us: 'redocly.com',
+    eu: 'eu.redocly.com',
+  };
+
+  // FIXME: temporary fix for our lab environments
+  const domain = env.REDOCLY_DOMAIN;
+  if (domain?.endsWith('.redocly.host')) {
+    domains[domain.split('.')[0] as Region] = domain;
+  }
+  if (domain === 'redoc.online') {
+    domains[domain as Region] = domain;
+  }
+  return domains;
 }
+
+export const DOMAINS = getDomains();
 export const AVAILABLE_REGIONS = Object.keys(DOMAINS) as Region[];
 
 export class LintConfig {

package/src/format/format.ts

@@ -14,6 +14,7 @@ const coreVersion = require('../../package.json').version;
 
 import { NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject } from '../walk';
 import { getCodeframe, getLineColLocation } from './codeframes';
+import { env } from "../config";
 
 export type Totals = {
   errors: number;
@@ -202,7 +203,7 @@ export function formatProblems(
             : undefined,
         };
 
-        if (process.env.FORMAT_JSON_WITH_CODEFRAMES) {
+        if (env.FORMAT_JSON_WITH_CODEFRAMES) {
           const location = p.location[0]; // TODO: support multiple locations
           const loc = getLineColLocation(location);
           (problem as any).codeframe = getCodeframe(loc, color);

package/src/redocly/index.ts

@@ -1,9 +1,9 @@
 import { existsSync, readFileSync, writeFileSync, unlinkSync } from 'fs';
 import { resolve } from 'path';
 import { homedir } from 'os';
-import { red, green, gray, yellow } from 'colorette';
+import { green } from 'colorette';
 import { RegistryApi } from './registry-api';
-import { DEFAULT_REGION, DOMAINS, AVAILABLE_REGIONS } from '../config/config';
+import { DEFAULT_REGION, DOMAINS, AVAILABLE_REGIONS, env } from '../config/config';
 import { RegionalToken, RegionalTokenWithValidity } from './redocly-client-types';
 import { isNotEmptyObject } from '../utils';
 
@@ -11,7 +11,6 @@ import type { AccessTokens, Region } from '../config/types';
 
 const TOKEN_FILENAME = '.redocly-config.json';
 
-let REDOCLY_DOMAIN: string; // workaround for the isRedoclyRegistryURL, see more below
 export class RedoclyClient {
   private accessTokens: AccessTokens = {};
   private region: Region;
@@ -21,31 +20,20 @@ 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] : 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,
-     * which breaks assignment.
-     */
-    REDOCLY_DOMAIN = this.domain; // isRedoclyRegistryURL depends on the value to be set
+    env.REDOCLY_DOMAIN = this.domain; // isRedoclyRegistryURL depends on the value to be set
     this.registryApi = new RegistryApi(this.accessTokens, this.region);
   }
 
   loadRegion(region?: Region) {
     if (region && !DOMAINS[region]) {
-      process.stdout.write(
-        red(
-          `Invalid argument: region in config file.\nGiven: ${green(
-            region,
-          )}, choices: "us", "eu".\n`,
-        ),
-      );
-      process.exit(1);
+      throw new Error(`Invalid argument: region in config file.\nGiven: ${green(region)}, choices: "us", "eu".`);
     }
 
-    if (process.env.REDOCLY_DOMAIN) {
+    if (env.REDOCLY_DOMAIN) {
       return (AVAILABLE_REGIONS.find(
-        (region) => DOMAINS[region as Region] === process.env.REDOCLY_DOMAIN,
+        (region) => DOMAINS[region as Region] === env.REDOCLY_DOMAIN,
       ) || DEFAULT_REGION) as Region;
     }
     return region || DEFAULT_REGION;
@@ -65,18 +53,7 @@ export class RedoclyClient {
   }
 
   async getAuthorizationHeader(): Promise<string | undefined> {
-    const token = this.accessTokens[this.region];
-    // print this only if there is token but invalid
-    if (token && !this.isAuthorizedWithRedoclyByRegion()) {
-      process.stderr.write(
-        `${yellow(
-          'Warning:',
-        )} invalid Redocly API key. Use "npx @redocly/openapi-cli login" to provide your API key\n`,
-      );
-      return undefined;
-    }
-
-    return token;
+    return this.accessTokens[this.region];
   }
   // </backward compatibility: portal>
 
@@ -96,10 +73,10 @@ export class RedoclyClient {
           }),
       });
     }
-    if (process.env.REDOCLY_AUTHORIZATION) {
+    if (env.REDOCLY_AUTHORIZATION) {
       this.setAccessTokens({
         ...this.accessTokens,
-        [this.region]: process.env.REDOCLY_AUTHORIZATION,
+        [this.region]: env.REDOCLY_AUTHORIZATION,
       });
     }
   }
@@ -164,15 +141,11 @@ export class RedoclyClient {
 
   async login(accessToken: string, verbose: boolean = false) {
     const credentialsPath = resolve(homedir(), TOKEN_FILENAME);
-    process.stdout.write(gray('\n  Logging in...\n'));
 
     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'),
-      );
-      process.exit(1);
+      throw new Error('Authorization failed. Please check if you entered a valid API key.');
     }
 
     const credentials = {
@@ -183,7 +156,6 @@ export class RedoclyClient {
     this.accessTokens = credentials;
     this.registryApi.setAccessTokens(credentials);
     writeFileSync(credentialsPath, JSON.stringify(credentials, null, 2));
-    process.stdout.write(green('  Authorization confirmed. ✅\n\n'));
   }
 
   logout(): void {
@@ -191,12 +163,11 @@ export class RedoclyClient {
     if (existsSync(credentialsPath)) {
       unlinkSync(credentialsPath);
     }
-    process.stdout.write('Logged out from the Redocly account. ✋\n');
   }
 }
 
 export function isRedoclyRegistryURL(link: string): boolean {
-  const domain = REDOCLY_DOMAIN || process.env.REDOCLY_DOMAIN || DOMAINS[DEFAULT_REGION];
+  const domain = env.REDOCLY_DOMAIN || DOMAINS[DEFAULT_REGION];
 
   const legacyDomain = domain === 'redocly.com' ? 'redoc.ly' : domain;
 

package/src/redocly/registry-api-types.ts

@@ -16,6 +16,7 @@ export namespace RegistryApiTypes {
     filePaths: string[];
     branch?: string;
     isUpsert?: boolean;
+    isPublic?: boolean;
   }
 
   export interface PrepareFileuploadOKResponse {

package/src/redocly/registry-api.ts

@@ -104,6 +104,7 @@ export class RegistryApi {
     filePaths,
     branch,
     isUpsert,
+    isPublic,
   }: RegistryApiTypes.PushApiParams) {
     const response = await this.request(
       `/${organizationId}/${name}/${version}`,
@@ -118,6 +119,7 @@ export class RegistryApi {
           filePaths,
           branch,
           isUpsert,
+          isPublic,
         }),
       },
       this.region,

package/src/rules/common/assertions/index.ts

@@ -7,7 +7,7 @@ export const Assertions: Oas3Rule | Oas2Rule = (opts: object) => {
 
   // As 'Assertions' has an array of asserts,
   // that array spreads into an 'opts' object on init rules phase here
-  // https://github.com/Redocly/openapi-cli/blob/master/packages/core/src/config/config.ts#L311
+  // https://github.com/Redocly/redocly-cli/blob/master/packages/core/src/config/config.ts#L311
   // that is why we need to iterate through 'opts' values;
   // before - filter only object 'opts' values
   const assertions: any[] = Object.values(opts).filter(

package/src/types/oas2.ts

@@ -88,6 +88,7 @@ const Operation: NodeType = {
     security: listOf('SecurityRequirement'),
     'x-codeSamples': listOf('XCodeSample'),
     'x-code-samples': listOf('XCodeSample'), // deprecated
+    'x-hideTryItPanel': { type: 'boolean' },
   },
   required: ['responses'],
 };
@@ -287,6 +288,7 @@ const Schema: NodeType = {
     xml: 'Xml',
     externalDocs: 'ExternalDocs',
     example: { isExample: true },
+    'x-tags': { type: 'array', items: { type: 'string' } },
   },
 };
 

package/src/types/oas3.ts

@@ -163,6 +163,7 @@ const Operation: NodeType = {
     callbacks: mapOf('Callback'),
     'x-codeSamples': listOf('XCodeSample'),
     'x-code-samples': listOf('XCodeSample'), // deprecated
+    'x-hideTryItPanel': { type: 'boolean' },
   },
   required: ['responses'],
 };
@@ -315,6 +316,7 @@ const Schema: NodeType = {
     xml: 'Xml',
     example: { isExample: true },
     deprecated: { type: 'boolean' },
+    'x-tags': { type: 'array', items: { type: 'string' } },
   },
 };
 
@@ -372,7 +374,7 @@ const ImplicitFlow: NodeType = {
     scopes: { type: 'object', additionalProperties: { type: 'string' } }, // TODO: validate scopes
     authorizationUrl: { type: 'string' },
   },
-  required: ['authorizationUrl', 'scopes']
+  required: ['authorizationUrl', 'scopes'],
 };
 
 const PasswordFlow: NodeType = {

package/src/types/oas3_1.ts

@@ -74,6 +74,7 @@ const Operation: NodeType = {
     callbacks: mapOf('Callback'),
     'x-codeSamples': listOf('XCodeSample'),
     'x-code-samples': listOf('XCodeSample'), // deprecated
+    'x-hideTryItPanel': { type: 'boolean' },
   },
 };
 
@@ -163,6 +164,7 @@ const Schema: NodeType = {
     deprecated: { type: 'boolean' },
     const: null,
     $comment: { type: 'string' },
+    'x-tags': { type: 'array', items: { type: 'string' } },
   },
 };
 

package/src/types/redocly-yaml.ts

@@ -526,6 +526,7 @@ const ConfigReferenceDocs: NodeType = {
     hideSchemaPattern: { type: 'boolean' },
     hideSchemaTitles: { type: 'boolean' },
     hideSingleRequestSampleTab: { type: 'boolean' },
+    hideTryItPanel: { type: 'boolean' },
     htmlTemplate: { type: 'string' },
     jsonSampleExpandLevel: { type: 'string' },
     labels: 'ConfigLabels',
@@ -545,6 +546,7 @@ const ConfigReferenceDocs: NodeType = {
     routingBasePath: { type: 'string' },
     samplesTabsMaxCount: { type: 'number' },
     schemaExpansionLevel: { type: 'string' },
+    schemaDefinitionsTagName: { type: 'string' },
     scrollYOffset: { type: 'string' },
     searchAutoExpand: { type: 'boolean' },
     searchFieldLevelBoost: { type: 'number' },

package/src/typings/openapi.ts

@@ -77,6 +77,7 @@ export interface Oas3Operation {
   servers?: Oas3Server[];
   'x-codeSamples'?: Oas3XCodeSample[];
   'x-code-samples'?: Oas3XCodeSample[]; // deprecated
+  'x-hideTryItPanel'?: boolean;
 }
 
 export interface Oas3Parameter {
@@ -149,6 +150,7 @@ export interface Oas3Schema {
   example?: any;
 
   xml?: Oas3Xml;
+  'x-tags'?: string[];
 }
 
 export interface Oas3_1Schema extends Oas3Schema {

package/src/typings/swagger.ts

@@ -73,6 +73,7 @@ export interface Oas2Operation {
   security?: Oas2SecurityRequirement[];
   'x-codeSamples'?: Oas2XCodeSample[];
   'x-code-samples'?: Oas2XCodeSample[]; // deprecated
+  'x-hideTryItPanel'?: boolean;
 }
 
 export type Oas2Parameter = Oas2BodyParameter | Oas2SimpleParameter;
@@ -177,6 +178,7 @@ export interface Oas2Schema {
   example?: any;
 
   xml?: Oas2Xml;
+  'x-tags'?: string[];
 }
 
 export type Oas2ParameterLocation = 'query' | 'header' | 'path' | 'formData';

package/src/utils.ts

@@ -5,6 +5,7 @@ import * as pluralize from 'pluralize';
 import { parseYaml } from './js-yaml';
 import { UserContext } from './walk';
 import type { HttpResolveConfig } from './config';
+import { env } from "./config";
 
 export { parseYaml, stringifyYaml } from './js-yaml';
 
@@ -51,7 +52,7 @@ export async function readFileFromUrl(url: string, config: HttpResolveConfig) {
   for (const header of config.headers) {
     if (match(url, header.matches)) {
       headers[header.name] =
-        header.envVariable !== undefined ? process.env[header.envVariable] || '' : header.value;
+        header.envVariable !== undefined ? env[header.envVariable] || '' : header.value;
     }
   }
 
@@ -66,7 +67,7 @@ export async function readFileFromUrl(url: string, config: HttpResolveConfig) {
   return { body: await req.text(), mimeType: req.headers.get('content-type') };
 }
 
-export function match(url: string, pattern: string) {
+function match(url: string, pattern: string) {
   if (!pattern.match(/^https?:\/\//)) {
     // if pattern doesn't specify protocol directly, do not match against it
     url = url.replace(/^https?:\/\//, '');