@redocly/openapi-core 1.10.2 → 1.10.4

package/src/config/config.ts

@@ -10,7 +10,7 @@ import {
   Oas3RuleSet,
   Async2RuleSet,
 } from '../oas-types';
-import { isBrowser } from '../env';
+import { isBrowser, env } from '../env';
 
 import type { NodeType } from '../types';
 import type {
@@ -35,6 +35,25 @@ 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';
+
+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;
+}
+
 function getIgnoreFilePath(configFile?: string): string | undefined {
   if (configFile) {
     return doesYamlFileExist(configFile)
@@ -45,6 +64,9 @@ function getIgnoreFilePath(configFile?: string): string | undefined {
   }
 }
 
+export const DOMAINS = getDomains();
+export const AVAILABLE_REGIONS = Object.keys(DOMAINS) as Region[];
+
 export class StyleguideConfig {
   plugins: Plugin[];
   ignore: Record<string, Record<string, Set<string>>> = {};

package/src/config/load.ts

@@ -3,7 +3,7 @@ import * as path from 'path';
 import { RedoclyClient } from '../redocly';
 import { isEmptyObject, doesYamlFileExist } from '../utils';
 import { parseYaml } from '../js-yaml';
-import { Config } from './config';
+import { Config, DOMAINS } from './config';
 import { ConfigValidationError, transformConfig } from './utils';
 import { resolveConfig, resolveConfigFileAndRefs } from './config-resolvers';
 import { bundleConfig } from '../bundle';
@@ -12,7 +12,6 @@ import type { Document } from '../resolve';
 import type { RegionalTokenWithValidity } from '../redocly/redocly-client-types';
 import type { RawConfig, RawUniversalConfig, Region } from './types';
 import type { BaseResolver, ResolvedRefMap } from '../resolve';
-import { DOMAINS } from '../redocly/domains';
 
 async function addConfigMetadata({
   rawConfig,

package/src/config/types.ts

@@ -243,16 +243,3 @@ export type RulesFields =
   | 'oas3_0Decorators'
   | 'oas3_1Decorators'
   | 'async2Decorators';
-
-export enum AuthProviderType {
-  OIDC = 'OIDC',
-  SAML2 = 'SAML2',
-  BASIC = 'BASIC',
-}
-
-export enum ApigeeDevOnboardingIntegrationAuthType {
-  SERVICE_ACCOUNT = 'SERVICE_ACCOUNT',
-  OAUTH2 = 'OAUTH2',
-}
-
-export const DEFAULT_TEAM_CLAIM_NAME = 'https://redocly.com/sso/teams';

package/src/decorators/common/registry-dependencies.ts

@@ -1,5 +1,5 @@
 import { UserContext } from '../../walk';
-import { isRedoclyRegistryURL } from '../../redocly/domains';
+import { isRedoclyRegistryURL } from '../../redocly';
 
 import { Oas3Decorator, Oas2Decorator } from '../../visitors';
 

package/src/env.ts

@@ -1,5 +1,7 @@
 export const isBrowser =
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  typeof window !== 'undefined' || typeof process === 'undefined'; // main and worker thread
+  typeof window !== 'undefined' ||
+  typeof process === 'undefined' ||
+  (process?.platform as any) === 'browser'; // main and worker thread
 export const env = isBrowser ? {} : process.env || {};

package/src/index.ts

@@ -1,11 +1,4 @@
-export {
-  BundleOutputFormat,
-  readFileFromUrl,
-  slash,
-  doesYamlFileExist,
-  isTruthy,
-  getProxyAgent,
-} from './utils';
+export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist, isTruthy } from './utils';
 export { Oas3_1Types } from './types/oas3_1';
 export { Oas3Types } from './types/oas3';
 export { Oas2Types } from './types/oas2';
@@ -48,9 +41,7 @@ export {
   ResolvedApi,
 } from './config';
 
-export { RedoclyClient } from './redocly';
-
-export * from './redocly/domains';
+export { RedoclyClient, isRedoclyRegistryURL } from './redocly';
 
 export {
   Source,

package/src/redocly/__tests__/redocly-client.test.ts

@@ -1,4 +1,3 @@
-import { setRedoclyDomain } from '../domains';
 import { RedoclyClient } from '../index';
 
 jest.mock('node-fetch', () => ({
@@ -17,7 +16,6 @@ describe('RedoclyClient', () => {
 
   afterEach(() => {
     delete process.env.REDOCLY_DOMAIN;
-    setRedoclyDomain('');
   });
 
   it('should resolve the US domain by default', () => {
@@ -42,19 +40,19 @@ describe('RedoclyClient', () => {
   });
 
   it('should resolve domain by EU region prioritizing flag over env variable', () => {
-    setRedoclyDomain(testRedoclyDomain);
+    process.env.REDOCLY_DOMAIN = testRedoclyDomain;
     const client = new RedoclyClient('eu');
     expect(client.domain).toBe(REDOCLY_DOMAIN_EU);
   });
 
   it('should resolve domain by US region prioritizing flag over env variable', () => {
-    setRedoclyDomain(testRedoclyDomain);
+    process.env.REDOCLY_DOMAIN = testRedoclyDomain;
     const client = new RedoclyClient('us');
     expect(client.domain).toBe(REDOCLY_DOMAIN_US);
   });
 
   it('should resolve domain by US region when REDOCLY_DOMAIN consists EU domain', () => {
-    setRedoclyDomain(REDOCLY_DOMAIN_EU);
+    process.env.REDOCLY_DOMAIN = REDOCLY_DOMAIN_EU;
     const client = new RedoclyClient();
     expect(client.getRegion()).toBe('eu');
   });

package/src/redocly/index.ts

@@ -2,19 +2,13 @@ import { existsSync, readFileSync, writeFileSync, unlinkSync } from 'fs';
 import { resolve } from 'path';
 import { homedir } from 'os';
 import { RegistryApi } from './registry-api';
+import { DEFAULT_REGION, DOMAINS, AVAILABLE_REGIONS } from '../config/config';
 import { env } from '../env';
 import { RegionalToken, RegionalTokenWithValidity } from './redocly-client-types';
 import { isNotEmptyObject } from '../utils';
 import { colorize } from '../logger';
 
 import type { AccessTokens, Region } from '../config/types';
-import {
-  AVAILABLE_REGIONS,
-  DEFAULT_REGION,
-  DOMAINS,
-  getRedoclyDomain,
-  setRedoclyDomain,
-} from './domains';
 
 export const TOKEN_FILENAME = '.redocly-config.json';
 
@@ -29,7 +23,7 @@ export class RedoclyClient {
     this.loadTokens();
     this.domain = region ? DOMAINS[region] : env.REDOCLY_DOMAIN || DOMAINS[DEFAULT_REGION];
 
-    setRedoclyDomain(this.domain);
+    env.REDOCLY_DOMAIN = this.domain; // isRedoclyRegistryURL depends on the value to be set
     this.registryApi = new RegistryApi(this.accessTokens, this.region);
   }
 
@@ -42,9 +36,9 @@ export class RedoclyClient {
       );
     }
 
-    if (getRedoclyDomain()) {
+    if (env.REDOCLY_DOMAIN) {
       return (AVAILABLE_REGIONS.find(
-        (region) => DOMAINS[region as Region] === getRedoclyDomain()
+        (region) => DOMAINS[region as Region] === env.REDOCLY_DOMAIN
       ) || DEFAULT_REGION) as Region;
     }
     return region || DEFAULT_REGION;
@@ -102,7 +96,7 @@ export class RedoclyClient {
     const allTokens = this.getAllTokens();
 
     const verifiedTokens = await Promise.allSettled(
-      allTokens.map(({ token }) => this.verifyToken(token))
+      allTokens.map(({ token, region }) => this.verifyToken(token, region))
     );
 
     return allTokens
@@ -126,7 +120,7 @@ export class RedoclyClient {
     }
 
     try {
-      await this.verifyToken(accessToken);
+      await this.verifyToken(accessToken, this.region);
 
       return true;
     } catch (err) {
@@ -144,16 +138,17 @@ export class RedoclyClient {
 
   async verifyToken(
     accessToken: string,
+    region: Region,
     verbose: boolean = false
   ): Promise<{ viewerId: string; organizations: string[] }> {
-    return this.registryApi.authStatus(accessToken, verbose);
+    return this.registryApi.authStatus(accessToken, region, verbose);
   }
 
   async login(accessToken: string, verbose: boolean = false) {
     const credentialsPath = resolve(homedir(), TOKEN_FILENAME);
 
     try {
-      await this.verifyToken(accessToken, verbose);
+      await this.verifyToken(accessToken, this.region, verbose);
     } catch (err) {
       throw new Error('Authorization failed. Please check if you entered a valid API key.');
     }
@@ -175,3 +170,18 @@ export class RedoclyClient {
     }
   }
 }
+
+export function isRedoclyRegistryURL(link: string): boolean {
+  const domain = env.REDOCLY_DOMAIN || DOMAINS[DEFAULT_REGION];
+
+  const legacyDomain = domain === 'redocly.com' ? 'redoc.ly' : domain;
+
+  if (
+    !link.startsWith(`https://api.${domain}/registry/`) &&
+    !link.startsWith(`https://api.${legacyDomain}/registry/`)
+  ) {
+    return false;
+  }
+
+  return true;
+}

package/src/redocly/registry-api.ts

@@ -6,8 +6,8 @@ import type {
   PushApiParams,
 } from './registry-api-types';
 import type { AccessTokens, Region } from '../config/types';
-import { getProxyAgent, isNotEmptyObject } from '../utils';
-import { getRedoclyDomain } from './domains';
+import { DEFAULT_REGION, DOMAINS } from '../config/config';
+import { isNotEmptyObject } from '../utils';
 
 const version = require('../../package.json').version;
 
@@ -18,8 +18,8 @@ export class RegistryApi {
     return isNotEmptyObject(this.accessTokens) && this.accessTokens[this.region];
   }
 
-  getBaseUrl() {
-    return `https://api.${getRedoclyDomain()}/registry`;
+  getBaseUrl(region: Region = DEFAULT_REGION) {
+    return `https://api.${DOMAINS[region]}/registry`;
   }
 
   setAccessTokens(accessTokens: AccessTokens) {
@@ -27,7 +27,7 @@ export class RegistryApi {
     return this;
   }
 
-  private async request(path = '', options: RequestInit = {}) {
+  private async request(path = '', options: RequestInit = {}, region?: Region) {
     const currentCommand =
       typeof process !== 'undefined' ? process.env?.REDOCLY_CLI_COMMAND || '' : '';
     const redoclyEnv = typeof process !== 'undefined' ? process.env?.REDOCLY_ENVIRONMENT || '' : '';
@@ -42,8 +42,8 @@ export class RegistryApi {
     }
 
     const response = await fetch(
-      `${this.getBaseUrl()}${path}`,
-      Object.assign({}, options, { headers, agent: getProxyAgent() })
+      `${this.getBaseUrl(region)}${path}`,
+      Object.assign({}, options, { headers })
     );
 
     if (response.status === 401) {
@@ -60,10 +60,11 @@ export class RegistryApi {
 
   async authStatus(
     accessToken: string,
+    region: Region,
     verbose = false
   ): Promise<{ viewerId: string; organizations: string[] }> {
     try {
-      const response = await this.request('', { headers: { authorization: accessToken } });
+      const response = await this.request('', { headers: { authorization: accessToken } }, region);
 
       return await response.json();
     } catch (error) {
@@ -96,7 +97,8 @@ export class RegistryApi {
           filename,
           isUpsert,
         }),
-      }
+      },
+      this.region
     );
 
     if (response.ok) {
@@ -118,22 +120,26 @@ export class RegistryApi {
     batchId,
     batchSize,
   }: PushApiParams) {
-    const response = await this.request(`/${organizationId}/${name}/${version}`, {
-      method: 'PUT',
-      headers: {
-        'content-type': 'application/json',
-        authorization: this.accessToken,
-      } as HeadersInit,
-      body: JSON.stringify({
-        rootFilePath,
-        filePaths,
-        branch,
-        isUpsert,
-        isPublic,
-        batchId,
-        batchSize,
-      }),
-    });
+    const response = await this.request(
+      `/${organizationId}/${name}/${version}`,
+      {
+        method: 'PUT',
+        headers: {
+          'content-type': 'application/json',
+          authorization: this.accessToken,
+        } as HeadersInit,
+        body: JSON.stringify({
+          rootFilePath,
+          filePaths,
+          branch,
+          isUpsert,
+          isPublic,
+          batchId,
+          batchSize,
+        }),
+      },
+      this.region
+    );
 
     if (response.ok) {
       return;

package/src/types/redocly-yaml.ts

@@ -1,4 +1,4 @@
-import { rootRedoclyConfigSchema } from './portal-config-schema';
+import { rootRedoclyConfigSchema } from '@redocly/config';
 import { listOf } from '.';
 import { omitObjectProps, pickObjectProps, isCustomRuleId } from '../utils';
 import { getNodeTypesFromJSONSchema } from './json-schema-adapter';
@@ -1050,7 +1050,7 @@ const ConfigReferenceDocs: NodeType = {
     preserveOriginalExtensionsName: { type: 'boolean' },
     markdownHeadingsAnchorLevel: { type: 'number' },
   },
-  additionalProperties: { type: 'string' },
+  additionalProperties: {},
 };
 
 const ConfigMockServer: NodeType = {

package/src/utils.ts

@@ -5,10 +5,9 @@ import fetch from 'node-fetch';
 import * as pluralize from 'pluralize';
 import { parseYaml } from './js-yaml';
 import { UserContext } from './walk';
+import { HttpResolveConfig } from './config';
 import { env } from './env';
 import { logger, colorize } from './logger';
-import { HttpResolveConfig } from './config';
-import { HttpsProxyAgent } from 'https-proxy-agent';
 
 export { parseYaml, stringifyYaml } from './js-yaml';
 
@@ -275,8 +274,3 @@ export function nextTick() {
 function getUpdatedFieldName(updatedField: string, updatedObject?: string) {
   return `${typeof updatedObject !== 'undefined' ? `${updatedObject}.` : ''}${updatedField}`;
 }
-
-export function getProxyAgent() {
-  const proxy = process.env.HTTPS_PROXY || process.env.HTTP_PROXY;
-  return proxy ? new HttpsProxyAgent(proxy) : undefined;
-}