@redocly/openapi-core 1.0.0-beta.68 → 1.0.0-beta.72

package/lib/redocly/registry-api-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/redocly/registry-api.d.ts

@@ -0,0 +1,14 @@
+import { RegistryApiTypes } from './registry-api-types';
+import { AccessTokens, Region } from '../config/config';
+export declare class RegistryApi {
+    private accessTokens;
+    private region;
+    constructor(accessTokens: AccessTokens, region: Region);
+    get accessToken(): string | false | undefined;
+    getBaseUrl(region?: Region): string;
+    setAccessTokens(accessTokens: AccessTokens): this;
+    private request;
+    authStatus(accessToken: string, region: Region, verbose?: boolean): Promise<boolean>;
+    prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }: RegistryApiTypes.PrepareFileuploadParams): Promise<RegistryApiTypes.PrepareFileuploadOKResponse>;
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, }: RegistryApiTypes.PushApiParams): Promise<void>;
+}

package/lib/redocly/registry-api.js

@@ -0,0 +1,105 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RegistryApi = void 0;
+const node_fetch_1 = require("node-fetch");
+const config_1 = require("../config/config");
+const utils_1 = require("../utils");
+const version = require('../../package.json').version;
+class RegistryApi {
+    constructor(accessTokens, region) {
+        this.accessTokens = accessTokens;
+        this.region = region;
+    }
+    get accessToken() {
+        return utils_1.isNotEmptyObject(this.accessTokens) && this.accessTokens[this.region];
+    }
+    getBaseUrl(region = config_1.DEFAULT_REGION) {
+        return `https://api.${config_1.DOMAINS[region]}/registry`;
+    }
+    setAccessTokens(accessTokens) {
+        this.accessTokens = accessTokens;
+        return this;
+    }
+    request(path = '', options = {}, region) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const headers = Object.assign({}, options.headers || {}, { 'x-redocly-cli-version': version });
+            if (!headers.hasOwnProperty('authorization')) {
+                throw new Error('Unauthorized');
+            }
+            const response = yield node_fetch_1.default(`${this.getBaseUrl(region)}${path}`, Object.assign({}, options, { headers }));
+            if (response.status === 401) {
+                throw new Error('Unauthorized');
+            }
+            if (response.status === 404) {
+                const body = yield response.json();
+                throw new Error(body.code);
+            }
+            return response;
+        });
+    }
+    authStatus(accessToken, region, verbose = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const response = yield this.request('', { headers: { authorization: accessToken } }, region);
+                return response.ok;
+            }
+            catch (error) {
+                if (verbose) {
+                    console.log(error);
+                }
+                return false;
+            }
+        });
+    }
+    prepareFileUpload({ organizationId, name, version, filesHash, filename, isUpsert, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.request(`/${organizationId}/${name}/${version}/prepare-file-upload`, {
+                method: 'POST',
+                headers: {
+                    'content-type': 'application/json',
+                    authorization: this.accessToken,
+                },
+                body: JSON.stringify({
+                    filesHash,
+                    filename,
+                    isUpsert,
+                }),
+            }, this.region);
+            if (response.ok) {
+                return response.json();
+            }
+            throw new Error('Could not prepare file upload');
+        });
+    }
+    pushApi({ organizationId, name, version, rootFilePath, filePaths, branch, isUpsert, }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.request(`/${organizationId}/${name}/${version}`, {
+                method: 'PUT',
+                headers: {
+                    'content-type': 'application/json',
+                    authorization: this.accessToken
+                },
+                body: JSON.stringify({
+                    rootFilePath,
+                    filePaths,
+                    branch,
+                    isUpsert,
+                }),
+            }, this.region);
+            if (response.ok) {
+                return;
+            }
+            throw new Error('Could not push api');
+        });
+    }
+}
+exports.RegistryApi = RegistryApi;

package/lib/rules/common/no-invalid-parameter-examples.d.ts

@@ -0,0 +1 @@
+export declare const NoInvalidParameterExamples: any;

package/lib/rules/common/no-invalid-parameter-examples.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoInvalidParameterExamples = void 0;
+const utils_1 = require("../utils");
+const NoInvalidParameterExamples = (opts) => {
+    var _a;
+    const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
+    return {
+        Parameter: {
+            leave(parameter, ctx) {
+                if (parameter.example) {
+                    utils_1.validateExample(parameter.example, parameter.schema, ctx.location.child('example'), ctx, disallowAdditionalProperties);
+                }
+                if (parameter.examples) {
+                    for (const [key, example] of Object.entries(parameter.examples)) {
+                        if ('value' in example) {
+                            utils_1.validateExample(example.value, parameter.schema, ctx.location.child(['examples', key]), ctx, false);
+                        }
+                    }
+                }
+            },
+        },
+    };
+};
+exports.NoInvalidParameterExamples = NoInvalidParameterExamples;

package/lib/rules/common/no-invalid-schema-examples.d.ts

@@ -0,0 +1 @@
+export declare const NoInvalidSchemaExamples: any;

package/lib/rules/common/no-invalid-schema-examples.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoInvalidSchemaExamples = void 0;
+const utils_1 = require("../utils");
+const NoInvalidSchemaExamples = (opts) => {
+    var _a;
+    const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
+    return {
+        Schema: {
+            leave(schema, ctx) {
+                if (schema.examples) {
+                    for (const example of schema.examples) {
+                        utils_1.validateExample(example, schema, ctx.location.child(['examples', schema.examples.indexOf(example)]), ctx, disallowAdditionalProperties);
+                    }
+                }
+                if (schema.example) {
+                    utils_1.validateExample(schema.example, schema, ctx.location.child('example'), ctx, false);
+                }
+            },
+        },
+    };
+};
+exports.NoInvalidSchemaExamples = NoInvalidSchemaExamples;

package/lib/rules/common/paths-kebab-case.js

@@ -4,7 +4,7 @@ exports.PathsKebabCase = void 0;
 const PathsKebabCase = () => {
     return {
         PathItem(_path, { report, key }) {
-            const segments = key.substr(1).split('/');
+            const segments = key.substr(1).split('/').filter(s => s !== ''); // filter out empty segments
             if (!segments.every((segment) => /^{.+}$/.test(segment) || /^[a-z0-9-.]+$/.test(segment))) {
                 report({
                     message: `\`${key}\` does not use kebab-case.`,

package/lib/rules/common/registry-dependencies.js

@@ -3,21 +3,18 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RegistryDependencies = void 0;
 const redocly_1 = require("../../redocly");
 const RegistryDependencies = () => {
-    let redoclyClient;
     let registryDependencies = new Set();
     return {
         DefinitionRoot: {
-            leave() {
-                redoclyClient = new redocly_1.RedoclyClient();
-                if (process.env.UPDATE_REGISTRY && redoclyClient.hasToken()) {
-                    redoclyClient.updateDependencies(Array.from(registryDependencies.keys()));
-                }
+            leave(_, ctx) {
+                const data = ctx.getVisitorData();
+                data.links = Array.from(registryDependencies);
             },
         },
         ref(node) {
             if (node.$ref) {
                 const link = node.$ref.split('#/')[0];
-                if (redocly_1.RedoclyClient.isRegistryURL(link)) {
+                if (redocly_1.isRedoclyRegistryURL(link)) {
                     registryDependencies.add(link);
                 }
             }

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

@@ -1,6 +1,8 @@
 import { Oas2Decorator, Oas2Rule } from '../../visitors';
 export declare const rules: {
     spec: Oas2Rule;
+    'no-invalid-schema-examples': any;
+    'no-invalid-parameter-examples': any;
     'info-description': Oas2Rule;
     'info-contact': Oas2Rule;
     'info-license': Oas2Rule;

package/lib/rules/oas2/index.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decorators = exports.preprocessors = exports.rules = void 0;
 const spec_1 = require("../common/spec");
+const no_invalid_schema_examples_1 = require("../common/no-invalid-schema-examples");
+const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-examples");
 const info_description_1 = require("../common/info-description");
 const info_contact_1 = require("../common/info-contact");
 const info_license_url_1 = require("../common/info-license-url");
@@ -42,6 +44,8 @@ const tag_description_override_1 = require("../common/tag-description-override")
 const info_description_override_1 = require("../common/info-description-override");
 exports.rules = {
     spec: spec_1.OasSpec,
+    'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
+    'no-invalid-parameter-examples': no_invalid_parameter_examples_1.NoInvalidParameterExamples,
     'info-description': info_description_1.InfoDescription,
     'info-contact': info_contact_1.InfoContact,
     'info-license': info_license_url_1.InfoLicense,

package/lib/rules/oas3/index.js

@@ -48,6 +48,8 @@ const operation_description_override_1 = require("../common/operation-descriptio
 const tag_description_override_1 = require("../common/tag-description-override");
 const info_description_override_1 = require("../common/info-description-override");
 const path_excludes_patterns_1 = require("../common/path-excludes-patterns");
+const no_invalid_schema_examples_1 = require("../common/no-invalid-schema-examples");
+const no_invalid_parameter_examples_1 = require("../common/no-invalid-parameter-examples");
 exports.rules = {
     spec: spec_1.OasSpec,
     'info-description': info_description_1.InfoDescription,
@@ -93,6 +95,8 @@ exports.rules = {
     'request-mime-type': request_mime_type_1.RequestMimeType,
     'response-mime-type': response_mime_type_1.ResponseMimeType,
     'path-segment-plural': path_segment_plural_1.PathSegmentPlural,
+    'no-invalid-schema-examples': no_invalid_schema_examples_1.NoInvalidSchemaExamples,
+    'no-invalid-parameter-examples': no_invalid_parameter_examples_1.NoInvalidParameterExamples,
 };
 exports.preprocessors = {};
 exports.decorators = {

package/lib/rules/oas3/no-invalid-media-type-examples.js

@@ -1,18 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ValidContentExamples = void 0;
-const ajv_1 = require("../ajv");
 const ref_utils_1 = require("../../ref-utils");
+const utils_1 = require("../utils");
 const ValidContentExamples = (opts) => {
     var _a;
     const disallowAdditionalProperties = (_a = opts.disallowAdditionalProperties) !== null && _a !== void 0 ? _a : true;
     return {
         MediaType: {
-            leave(mediaType, { report, location, resolve }) {
+            leave(mediaType, ctx) {
+                const { location, resolve } = ctx;
                 if (!mediaType.schema)
                     return;
                 if (mediaType.example) {
-                    validateExample(mediaType.example, location.child('example'));
+                    utils_1.validateExample(mediaType.example, mediaType.schema, location.child('example'), ctx, disallowAdditionalProperties);
                 }
                 else if (mediaType.examples) {
                     for (const exampleName of Object.keys(mediaType.examples)) {
@@ -25,29 +26,7 @@ const ValidContentExamples = (opts) => {
                             dataLoc = resolved.location.child('value');
                             example = resolved.node;
                         }
-                        validateExample(example.value, dataLoc);
-                    }
-                }
-                function validateExample(example, dataLoc) {
-                    try {
-                        const { valid, errors } = ajv_1.validateJsonSchema(example, mediaType.schema, location.child('schema'), dataLoc.pointer, resolve, disallowAdditionalProperties);
-                        if (!valid) {
-                            for (let error of errors) {
-                                report({
-                                    message: `Example value must conform to the schema: ${error.message}.`,
-                                    location: Object.assign(Object.assign({}, new ref_utils_1.Location(dataLoc.source, error.instancePath)), { reportOnKey: error.keyword === 'additionalProperties' }),
-                                    from: location,
-                                    suggest: error.suggest,
-                                });
-                            }
-                        }
-                    }
-                    catch (e) {
-                        report({
-                            message: `Example validation errored: ${e.message}.`,
-                            location: location.child('schema'),
-                            from: location
-                        });
+                        utils_1.validateExample(example.value, mediaType.schema, dataLoc, ctx, disallowAdditionalProperties);
                     }
                 }
             },

package/lib/rules/utils.d.ts

@@ -1,4 +1,6 @@
 import { UserContext } from '../walk';
+import { Location } from '../ref-utils';
+import { Oas3Schema, Referenced } from '../typings/openapi';
 export declare function oasTypeOf(value: unknown): "string" | "number" | "bigint" | "boolean" | "symbol" | "undefined" | "object" | "function" | "array" | "null";
 /**
  * Checks if value matches specified JSON schema type
@@ -12,3 +14,4 @@ export declare function missingRequiredField(type: string, field: string): strin
 export declare function fieldNonEmpty(type: string, field: string): string;
 export declare function validateDefinedAndNonEmpty(fieldName: string, value: any, ctx: UserContext): void;
 export declare function getSuggest(given: string, variants: string[]): string[];
+export declare function validateExample(example: any, schema: Referenced<Oas3Schema>, dataLoc: Location, { resolve, location, report }: UserContext, disallowAdditionalProperties: boolean): void;

package/lib/rules/utils.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
+exports.validateExample = exports.getSuggest = exports.validateDefinedAndNonEmpty = exports.fieldNonEmpty = exports.missingRequiredField = exports.matchesJsonSchemaType = exports.oasTypeOf = void 0;
 const levenshtein = require("js-levenshtein");
+const ref_utils_1 = require("../ref-utils");
+const ajv_1 = require("./ajv");
 function oasTypeOf(value) {
     if (Array.isArray(value)) {
         return 'array';
@@ -80,3 +82,26 @@ function getSuggest(given, variants) {
     return distances.map((d) => d.variant);
 }
 exports.getSuggest = getSuggest;
+function validateExample(example, schema, dataLoc, { resolve, location, report }, disallowAdditionalProperties) {
+    try {
+        const { valid, errors } = ajv_1.validateJsonSchema(example, schema, location.child('schema'), dataLoc.pointer, resolve, disallowAdditionalProperties);
+        if (!valid) {
+            for (let error of errors) {
+                report({
+                    message: `Example value must conform to the schema: ${error.message}.`,
+                    location: Object.assign(Object.assign({}, new ref_utils_1.Location(dataLoc.source, error.instancePath)), { reportOnKey: error.keyword === 'additionalProperties' }),
+                    from: location,
+                    suggest: error.suggest,
+                });
+            }
+        }
+    }
+    catch (e) {
+        report({
+            message: `Example validation errored: ${e.message}.`,
+            location: location.child('schema'),
+            from: location,
+        });
+    }
+}
+exports.validateExample = validateExample;

package/lib/typings/openapi.d.ts

@@ -144,6 +144,9 @@ export interface Oas3Schema {
     example?: any;
     xml?: Oas3Xml;
 }
+export interface Oas3_1Schema extends Oas3Schema {
+    examples?: any[];
+}
 export interface Oas3Discriminator {
     propertyName: string;
     mapping?: {

package/lib/utils.d.ts

@@ -33,3 +33,4 @@ export declare function isPathParameter(pathSegment: string): boolean;
  * Convert Windows backslash paths to slash paths: foo\\bar ➔ foo/bar
  */
 export declare function slash(path: string): string;
+export declare function isNotEmptyObject(obj: any): boolean;

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.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.match = exports.readFileFromUrl = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
+exports.isNotEmptyObject = exports.slash = exports.isPathParameter = exports.readFileAsStringSync = exports.isSingular = exports.validateMimeTypeOAS3 = exports.validateMimeType = exports.splitCamelCaseIntoWords = exports.omitObjectProps = exports.pickObjectProps = exports.match = exports.readFileFromUrl = exports.isPlainObject = exports.notUndefined = exports.loadYaml = exports.popStack = exports.pushStack = exports.stringifyYaml = exports.parseYaml = void 0;
 const fs = require("fs");
 const minimatch = require("minimatch");
 const node_fetch_1 = require("node-fetch");
@@ -144,3 +144,7 @@ function slash(path) {
     return path.replace(/\\/g, '/');
 }
 exports.slash = slash;
+function isNotEmptyObject(obj) {
+    return !!obj && Object.keys(obj).length > 0;
+}
+exports.isNotEmptyObject = isNotEmptyObject;

package/lib/walk.d.ts

@@ -36,6 +36,7 @@ export declare type UserContext = {
     key: string | number;
     parent: any;
     oasVersion: OasVersion;
+    getVisitorData: () => Record<string, unknown>;
 };
 export declare type Loc = {
     line: number;
@@ -72,6 +73,7 @@ export declare type NormalizedProblem = {
 export declare type WalkContext = {
     problems: NormalizedProblem[];
     oasVersion: OasVersion;
+    visitorsData: Record<string, Record<string, unknown>>;
     refTypes?: Map<string, NormalizedNodeType>;
 };
 export declare function walkDocument<T>(opts: {

package/lib/walk.js

@@ -50,6 +50,7 @@ function walkDocument(opts) {
                         key,
                         parentLocations: {},
                         oasVersion: ctx.oasVersion,
+                        getVisitorData: getVisitorDataFn.bind(undefined, ruleId)
                     }, { node: resolvedNode, location: resolvedLocation, error });
                     if ((resolvedLocation === null || resolvedLocation === void 0 ? void 0 : resolvedLocation.source.absoluteRef) && ctx.refTypes) {
                         ctx.refTypes.set(resolvedLocation === null || resolvedLocation === void 0 ? void 0 : resolvedLocation.source.absoluteRef, type);
@@ -192,6 +193,7 @@ function walkDocument(opts) {
                         key,
                         parentLocations: {},
                         oasVersion: ctx.oasVersion,
+                        getVisitorData: getVisitorDataFn.bind(undefined, ruleId)
                     }, { node: resolvedNode, location: resolvedLocation, error });
                 }
             }
@@ -212,6 +214,7 @@ function walkDocument(opts) {
                 ignoreNextVisitorsOnNode: () => {
                     ignoreNextVisitorsOnNode = true;
                 },
+                getVisitorData: getVisitorDataFn.bind(undefined, ruleId),
             }, collectParents(context), context);
             return ignoreNextVisitorsOnNode;
         }
@@ -244,6 +247,10 @@ function walkDocument(opts) {
                     return Object.assign(Object.assign(Object.assign({}, currentLocation), { reportOnKey: false }), loc);
                 }) }));
         }
+        function getVisitorDataFn(ruleId) {
+            ctx.visitorsData[ruleId] = ctx.visitorsData[ruleId] || {};
+            return ctx.visitorsData[ruleId];
+        }
     }
 }
 exports.walkDocument = walkDocument;

package/package.json

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

package/src/bundle.ts

@@ -13,6 +13,7 @@ import { initRules } from './config/rules';
 import { reportUnresolvedRef } from './rules/no-unresolved-refs';
 import { isPlainObject } from './utils';
 import { OasRef } from './typings/openapi';
+import { isRedoclyRegistryURL } from './redocly';
 
 export type Oas3RuleSet = Record<string, Oas3Rule>;
 
@@ -29,6 +30,7 @@ export async function bundle(opts: {
   config: Config;
   dereference?: boolean;
   base?: string;
+  skipRedoclyRegistryRefs?: boolean;
 }) {
   const {
     ref,
@@ -63,8 +65,16 @@ export async function bundleDocument(opts: {
   customTypes?: Record<string, NodeType>;
   externalRefResolver: BaseResolver;
   dereference?: boolean;
+  skipRedoclyRegistryRefs?: boolean;
 }) {
-  const { document, config, customTypes, externalRefResolver, dereference = false } = opts;
+  const {
+    document,
+    config,
+    customTypes,
+    externalRefResolver,
+    dereference = false,
+    skipRedoclyRegistryRefs = false,
+  } = opts;
   const oasVersion = detectOpenAPI(document.parsed);
   const oasMajorVersion = openAPIMajor(oasVersion);
   const rules = config.getRulesForOasVersion(oasMajorVersion);
@@ -86,6 +96,7 @@ export async function bundleDocument(opts: {
     problems: [],
     oasVersion: oasVersion,
     refTypes: new Map<string, NormalizedNodeType>(),
+    visitorsData: {},
   };
 
   const bundleVisitor = normalizeVisitors(
@@ -94,7 +105,7 @@ export async function bundleDocument(opts: {
       {
         severity: 'error',
         ruleId: 'bundler',
-        visitor: makeBundleVisitor(oasMajorVersion, dereference, document),
+        visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document),
       },
       ...decorators,
     ],
@@ -121,6 +132,7 @@ export async function bundleDocument(opts: {
     fileDependencies: externalRefResolver.getFiles(),
     rootType: types.DefinitionRoot,
     refTypes: ctx.refTypes,
+    visitorsData: ctx.visitorsData,
   };
 }
 
@@ -165,7 +177,12 @@ function mapTypeToComponent(typeName: string, version: OasMajorVersion) {
 
 // function oas3Move
 
-function makeBundleVisitor(version: OasMajorVersion, dereference: boolean, rootDocument: Document) {
+function makeBundleVisitor(
+  version: OasMajorVersion,
+  dereference: boolean,
+  skipRedoclyRegistryRefs: boolean,
+  rootDocument: Document,
+) {
   let components: Record<string, Record<string, any>>;
 
   const visitor: Oas3Visitor | Oas2Visitor = {
@@ -183,6 +200,11 @@ function makeBundleVisitor(version: OasMajorVersion, dereference: boolean, rootD
         ) {
           return;
         }
+
+        if (skipRedoclyRegistryRefs && isRedoclyRegistryURL(node.$ref)) {
+          return;
+        }
+
         const componentType = mapTypeToComponent(ctx.type.name, version);
         if (!componentType) {
           replaceRef(node, resolved, ctx);

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

@@ -0,0 +1,35 @@
+import { loadConfig } from '../load';
+import { RedoclyClient } from '../../redocly';
+
+describe('loadConfig', () => {
+  it('should resolve config http header by US region', async () => {
+    jest.spyOn(RedoclyClient.prototype, 'getTokens').mockImplementation(
+      () => Promise.resolve([{ region: 'us', token: "accessToken", valid: true }])
+    );
+    const config = await loadConfig();
+    expect(config.resolve.http.headers).toStrictEqual([{
+      "matches": 'https://api.redoc.ly/registry/**',
+      "name": "Authorization",
+      "envVariable": undefined,
+      "value": "accessToken"
+    }, {
+      "matches": 'https://api.redocly.com/registry/**',
+      "name": "Authorization",
+      "envVariable": undefined,
+      "value": "accessToken"
+    }]);
+  });
+
+  it('should resolve config http header by EU region', async () => {
+    jest.spyOn(RedoclyClient.prototype, 'getTokens').mockImplementation(
+      () => Promise.resolve([{ region: 'eu', token: "accessToken", valid: true }])
+    );
+    const config = await loadConfig();
+    expect(config.resolve.http.headers).toStrictEqual([{
+      "matches": 'https://api.eu.redocly.com/registry/**',
+      "name": "Authorization",
+      "envVariable": undefined,
+      "value": "accessToken"
+    }]);
+  });
+});

package/src/config/all.ts

@@ -38,6 +38,8 @@ export default {
     },
     'request-mime-type': 'error',
     spec: 'error',
+    'no-invalid-schema-examples': 'error',
+    'no-invalid-parameter-examples': 'error',
   },
   oas3_0Rules: {
     'no-invalid-media-type-examples': 'error',

package/src/config/config.ts

@@ -123,11 +123,20 @@ export type ResolveConfig = {
   http: HttpResolveConfig;
 };
 
+export const DEFAULT_REGION = 'us';
+export type Region = 'us' | 'eu';
+export type AccessTokens = {[region in Region]?: string };
+export const DOMAINS: { [region in Region]: string } = {
+  us: 'redoc.ly',
+  eu: 'eu.redocly.com',
+};
+
 export type RawConfig = {
   referenceDocs?: any;
   apiDefinitions?: Record<string, string>;
   lint?: LintRawConfig;
   resolve?: RawResolveConfig;
+  region?: Region;
 };
 
 export class LintConfig {
@@ -385,6 +394,7 @@ export class Config {
   lint: LintConfig;
   resolve: ResolveConfig;
   licenseKey?: string;
+  region?: Region;
   constructor(public rawConfig: RawConfig, public configFile?: string) {
     this.apiDefinitions = rawConfig.apiDefinitions || {};
     this.lint = new LintConfig(rawConfig.lint || {}, configFile);
@@ -395,6 +405,7 @@ export class Config {
         customFetch: undefined,
       },
     };
+    this.region = rawConfig.region;
   }
 }