@redocly/openapi-core 1.0.0-beta.67 → 1.0.0-beta.71

package/__tests__/__snapshots__/bundle.test.ts.snap

@@ -99,3 +99,129 @@ components:
       name: shared-a
 
 `;
+
+exports[`bundle should not place referened schema inline when component in question is not of type "schemas" 1`] = `
+openapi: 3.0.0
+paths:
+  /pet:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/requestBody'
+components:
+  schemas:
+    requestBody:
+      content:
+        application/json:
+          schema:
+            type: object
+            properties:
+              a:
+                type: string
+              b:
+                type: number
+
+`;
+
+exports[`bundle should place referenced schema inline when referenced schema name resolves to original schema name 1`] = `
+openapi: 3.1.0
+info:
+  title: My API
+  description: It ain't so wonderful, but at least it's mine.
+  version: '1.0'
+  contact:
+    email: me@theintenet.com
+    name: me
+paths:
+  /test:
+    get:
+      summary: test
+      responses:
+        '200':
+          description: test
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/vendor'
+components:
+  schemas:
+    vendor:
+      title: vendor
+      type: object
+      description: Vendors
+      properties:
+        key:
+          type: string
+          description: System-assigned key for the vendor.
+          readOnly: true
+        id:
+          type: string
+          description: >
+            Unique identifier of the vendor.
+
+            You must specify a unique vendor ID when creating a vendor unless
+            document sequencing is configured, in which case the ID is
+            auto-generated.
+        name:
+          type: string
+          description: Name of the vendor.
+        isOneTimeUse:
+          type: boolean
+          description: One-time use
+          default: false
+    myvendor:
+      $ref: '#/components/schemas/vendor'
+    simple:
+      type: string
+    A:
+      type: string
+    test:
+      $ref: '#/components/schemas/rename-2'
+    rename:
+      type: string
+    rename-2:
+      type: number
+
+`;
+
+exports[`bundle should pull hosted schema 1`] = `
+openapi: 3.0.3
+info:
+  title: bugtest
+  version: '1.0'
+  description: Demo
+  license:
+    name: DEMO
+    url: https://demo.com
+servers:
+  - url: http://demo.com/api
+paths:
+  /customer:
+    summary: Customer scope
+    get:
+      summary: Get demo no refs
+      operationId: GetCustomer
+      description: Returns Demo No Refs
+      responses:
+        '200':
+          description: Demo No Refs
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Customer'
+components:
+  schemas:
+    Customer:
+      type: object
+      properties:
+        customerName:
+          type: string
+        accounts:
+          type: array
+          items:
+            $ref: '#/components/schemas/someexternal'
+    someexternal: External schema content
+
+`;

package/__tests__/bundle.test.ts

@@ -10,7 +10,7 @@ import { BaseResolver } from '../src/resolve';
 describe('bundle', () => {
   expect.addSnapshotSerializer(yamlSerializer);
 
-  const testDocument =  parseYamlToDocument(
+  const testDocument = parseYamlToDocument(
     outdent`
       openapi: 3.0.0
       paths:
@@ -77,4 +77,56 @@ describe('bundle', () => {
     expect(problems).toHaveLength(0);
     expect(res.parsed).toMatchSnapshot();
   });
+
+  it('should place referenced schema inline when referenced schema name resolves to original schema name', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({}),
+      ref: path.join(__dirname, 'fixtures/refs/externalref.yaml'),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should not place referened schema inline when component in question is not of type "schemas"', async () => {
+    const { bundle: res, problems } = await bundle({
+      config: new Config({}),
+      ref: path.join(__dirname, 'fixtures/refs/external-request-body.yaml'),
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(res.parsed).toMatchSnapshot();
+  });
+
+  it('should pull hosted schema', async () => {
+    const fetchMock = jest.fn(
+      () => Promise.resolve({
+        ok: true,
+        text: () => 'External schema content',
+        headers: {
+          get: () => ''
+        }
+      })
+    );
+
+    const { bundle: res, problems } = await bundle({
+      config: new Config({}),
+      externalRefResolver: new BaseResolver({
+        http: {
+          customFetch: fetchMock,
+          headers: []
+        }
+      }),
+      ref: path.join(__dirname, 'fixtures/refs/hosted.yaml')
+    });
+
+    expect(problems).toHaveLength(0);
+    expect(fetchMock).toHaveBeenCalledWith(
+      "https://someexternal.schema",
+      {
+        headers: {}
+      }
+    );
+    expect(res.parsed).toMatchSnapshot();
+  })
 });

package/__tests__/fixtures/refs/definitions.yaml

@@ -0,0 +1,3 @@
+$defs:
+  A:
+    type: string

package/__tests__/fixtures/refs/external-request-body.yaml

@@ -0,0 +1,13 @@
+openapi: 3.0.0
+paths:
+  /pet:
+    post:
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: ./requestBody.yaml
+components:
+  schemas:
+    requestBody:
+      $ref: ./requestBody.yaml

package/__tests__/fixtures/refs/externalref.yaml

@@ -0,0 +1,35 @@
+openapi: 3.1.0
+info:
+  title: My API
+  description: It ain't so wonderful, but at least it's mine.
+  version: '1.0'
+  contact:
+    email: me@theintenet.com
+    name: me
+paths:
+  /test:
+    get:
+      summary: 'test'
+      responses:
+        200:
+          description: test
+          content:
+            application/json:
+              schema:
+                $ref: ./vendor.schema.yaml
+components:
+  schemas:
+    vendor:
+      $ref: ./vendor.schema.yaml
+    myvendor:
+      $ref: ./vendor.schema.yaml
+    simple:
+      $ref: ./simple.yaml
+    A:
+      $ref: ./definitions.yaml#/$defs/A
+    test:
+      $ref: ./rename.yaml
+    rename:
+      type: string
+    rename-2:
+      $ref: ./rename.yaml

package/__tests__/fixtures/refs/hosted.yaml

@@ -0,0 +1,35 @@
+openapi: "3.0.3"
+info:
+  title: bugtest
+  version: "1.0"
+  description: Demo
+  license:
+    name: DEMO
+    url: https://demo.com
+servers:
+  - url: http://demo.com/api
+paths:
+  /customer:
+    summary: "Customer scope"
+    get:
+      summary: "Get demo no refs"
+      operationId: GetCustomer
+      description: "Returns Demo No Refs"
+      responses:
+        200:
+          description: Demo No Refs
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/Customer"  
+components:
+  schemas: 
+    Customer:
+      type: object
+      properties:
+        customerName:
+          type: string
+        accounts:
+          type: array
+          items:
+            $ref: "https://someexternal.schema"

package/__tests__/fixtures/refs/rename.yaml

@@ -0,0 +1 @@
+type: number

package/__tests__/fixtures/refs/requestBody.yaml

@@ -0,0 +1,9 @@
+content: 
+  application/json: 
+    schema: 
+      type: object
+      properties: 
+        a:
+          type: string
+        b:
+          type: number

package/__tests__/fixtures/refs/simple.yaml

@@ -0,0 +1 @@
+type: string

package/__tests__/fixtures/refs/vendor.schema.yaml

@@ -0,0 +1,20 @@
+title: vendor
+type: object
+description: Vendors
+properties:
+  key:
+    type: string
+    description: System-assigned key for the vendor.
+    readOnly: true
+  id:
+    type: string
+    description: |
+      Unique identifier of the vendor.
+      You must specify a unique vendor ID when creating a vendor unless document sequencing is configured, in which case the ID is auto-generated.
+  name:
+    type: string
+    description: Name of the vendor.
+  isOneTimeUse:
+    type: boolean
+    description: One-time use
+    default: false

package/__tests__/lint.test.ts

@@ -2,7 +2,7 @@ import outdent from 'outdent';
 import { detectOpenAPI } from '../src/oas-types';
 import { parseYamlToDocument } from './utils';
 
-describe.only('lint', () => {
+describe('lint', () => {
 	it('detect OpenAPI should throw an error when version is not string', () => {
 
 	const testDocument = parseYamlToDocument(

package/__tests__/login.test.ts

@@ -0,0 +1,17 @@
+import { RedoclyClient } from '../src/redocly';
+
+describe('login', () => {
+  it('should call login with setAccessTokens function', async () => {
+    const client = new RedoclyClient();
+    Object.defineProperty(client, 'registryApi', {
+      value: {
+        setAccessTokens: jest.fn(),
+        authStatus: jest.fn(() => true)
+      },
+      writable: true,
+      configurable: true
+    });
+    await client.login('token');
+    expect(client.registryApi.setAccessTokens).toHaveBeenCalled();
+  });
+});

package/lib/bundle.d.ts

@@ -15,12 +15,14 @@ export declare function bundle(opts: {
     config: Config;
     dereference?: boolean;
     base?: string;
+    skipRedoclyRegistryRefs?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];
     fileDependencies: Set<string>;
     rootType: NormalizedNodeType;
     refTypes: Map<string, NormalizedNodeType> | undefined;
+    visitorsData: Record<string, Record<string, unknown>>;
 }>;
 export declare function bundleDocument(opts: {
     document: Document;
@@ -28,10 +30,12 @@ export declare function bundleDocument(opts: {
     customTypes?: Record<string, NodeType>;
     externalRefResolver: BaseResolver;
     dereference?: boolean;
+    skipRedoclyRegistryRefs?: boolean;
 }): Promise<{
     bundle: Document;
     problems: import("./walk").NormalizedProblem[];
     fileDependencies: Set<string>;
     rootType: NormalizedNodeType;
     refTypes: Map<string, NormalizedNodeType> | undefined;
+    visitorsData: Record<string, Record<string, unknown>>;
 }>;

package/lib/bundle.js

@@ -23,6 +23,7 @@ const ref_utils_1 = require("./ref-utils");
 const rules_1 = require("./config/rules");
 const no_unresolved_refs_1 = require("./rules/no-unresolved-refs");
 const utils_1 = require("./utils");
+const redocly_1 = require("./redocly");
 var OasVersion;
 (function (OasVersion) {
     OasVersion["Version2"] = "oas2";
@@ -45,24 +46,29 @@ function bundle(opts) {
 exports.bundle = bundle;
 function bundleDocument(opts) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { document, config, customTypes, externalRefResolver, dereference = false } = opts;
+        const { document, config, customTypes, externalRefResolver, dereference = false, skipRedoclyRegistryRefs = false, } = opts;
         const oasVersion = oas_types_1.detectOpenAPI(document.parsed);
         const oasMajorVersion = oas_types_1.openAPIMajor(oasVersion);
         const rules = config.getRulesForOasVersion(oasMajorVersion);
-        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3) ? (oasVersion === OasVersion.Version3_1 ? oas3_1_1.Oas3_1Types : oas3_1.Oas3Types) : oas2_1.Oas2Types, oasVersion), config);
+        const types = types_1.normalizeTypes(config.extendTypes((customTypes !== null && customTypes !== void 0 ? customTypes : oasMajorVersion === oas_types_1.OasMajorVersion.Version3)
+            ? oasVersion === OasVersion.Version3_1
+                ? oas3_1_1.Oas3_1Types
+                : oas3_1.Oas3Types
+            : oas2_1.Oas2Types, oasVersion), config);
         const preprocessors = rules_1.initRules(rules, config, 'preprocessors', oasVersion);
         const decorators = rules_1.initRules(rules, config, 'decorators', oasVersion);
         const ctx = {
             problems: [],
             oasVersion: oasVersion,
             refTypes: new Map(),
+            visitorsData: {},
         };
         const bundleVisitor = visitors_1.normalizeVisitors([
             ...preprocessors,
             {
                 severity: 'error',
                 ruleId: 'bundler',
-                visitor: makeBundleVisitor(oasMajorVersion, dereference, document),
+                visitor: makeBundleVisitor(oasMajorVersion, dereference, skipRedoclyRegistryRefs, document),
             },
             ...decorators,
         ], types);
@@ -84,6 +90,7 @@ function bundleDocument(opts) {
             fileDependencies: externalRefResolver.getFiles(),
             rootType: types.DefinitionRoot,
             refTypes: ctx.refTypes,
+            visitorsData: ctx.visitorsData,
         };
     });
 }
@@ -127,7 +134,7 @@ function mapTypeToComponent(typeName, version) {
     }
 }
 // function oas3Move
-function makeBundleVisitor(version, dereference, rootDocument) {
+function makeBundleVisitor(version, dereference, skipRedoclyRegistryRefs, rootDocument) {
     let components;
     const visitor = {
         ref: {
@@ -142,6 +149,9 @@ function makeBundleVisitor(version, dereference, rootDocument) {
                     !dereference) {
                     return;
                 }
+                if (skipRedoclyRegistryRefs && redocly_1.isRedoclyRegistryURL(node.$ref)) {
+                    return;
+                }
                 const componentType = mapTypeToComponent(ctx.type.name, version);
                 if (!componentType) {
                     replaceRef(node, resolved, ctx);
@@ -210,6 +220,14 @@ function makeBundleVisitor(version, dereference, rootDocument) {
             return `#/${componentType}/${name}`;
         }
     }
+    function isEqualOrEqualRef(node, target, ctx) {
+        var _a;
+        if (ref_utils_1.isRef(node) &&
+            ((_a = ctx.resolve(node).location) === null || _a === void 0 ? void 0 : _a.absolutePointer) === target.location.absolutePointer) {
+            return true;
+        }
+        return isEqual(node, target.node);
+    }
     function getComponentName(target, componentType, ctx) {
         const [fileRef, pointer] = [target.location.source.absoluteRef, target.location.pointer];
         const componentsGroup = components[componentType];
@@ -219,17 +237,17 @@ function makeBundleVisitor(version, dereference, rootDocument) {
             name = refParts.pop() + (name ? `-${name}` : '');
             if (!componentsGroup ||
                 !componentsGroup[name] ||
-                isEqual(componentsGroup[name], target.node)) {
+                isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
                 return name;
             }
         }
         name = ref_utils_1.refBaseName(fileRef) + (name ? `_${name}` : '');
-        if (!componentsGroup[name] || isEqual(componentsGroup[name], target.node)) {
+        if (!componentsGroup[name] || isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
             return name;
         }
         const prevName = name;
         let serialId = 2;
-        while (componentsGroup[name] && !isEqual(componentsGroup[name], target.node)) {
+        while (componentsGroup[name] && !isEqualOrEqualRef(componentsGroup[name], target, ctx)) {
             name = `${prevName}-${serialId}`;
             serialId++;
         }

package/lib/config/all.js

@@ -38,6 +38,8 @@ exports.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/lib/config/config.d.ts

@@ -70,11 +70,20 @@ export declare type HttpResolveConfig = {
 export declare type ResolveConfig = {
     http: HttpResolveConfig;
 };
+export declare const DEFAULT_REGION = "us";
+export declare type Region = 'us' | 'eu';
+export declare type AccessTokens = {
+    [region in Region]?: string;
+};
+export declare const DOMAINS: {
+    [region in Region]: string;
+};
 export declare type RawConfig = {
     referenceDocs?: any;
     apiDefinitions?: Record<string, string>;
     lint?: LintRawConfig;
     resolve?: RawResolveConfig;
+    region?: Region;
 };
 export declare class LintConfig {
     rawConfig: LintRawConfig;
@@ -126,5 +135,6 @@ export declare class Config {
     lint: LintConfig;
     resolve: ResolveConfig;
     licenseKey?: string;
+    region?: Region;
     constructor(rawConfig: RawConfig, configFile?: string | undefined);
 }

package/lib/config/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Config = exports.LintConfig = exports.IGNORE_FILE = void 0;
+exports.Config = exports.LintConfig = exports.DOMAINS = exports.DEFAULT_REGION = exports.IGNORE_FILE = void 0;
 const fs = require("fs");
 const path = require("path");
 const path_1 = require("path");
@@ -12,6 +12,11 @@ const recommended_1 = require("./recommended");
 exports.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`;
+exports.DEFAULT_REGION = 'us';
+exports.DOMAINS = {
+    us: 'redoc.ly',
+    eu: 'eu.redocly.com',
+};
 class LintConfig {
     constructor(rawConfig, configFile) {
         this.rawConfig = rawConfig;
@@ -233,6 +238,7 @@ class Config {
                 customFetch: undefined,
             },
         };
+        this.region = rawConfig.region;
     }
 }
 exports.Config = Config;

package/lib/config/load.js

@@ -35,20 +35,29 @@ function loadConfig(configPath, customExtends) {
             rawConfig.lint.extends = customExtends;
         }
         const redoclyClient = new redocly_1.RedoclyClient();
-        if (redoclyClient.hasToken()) {
+        const tokens = yield redoclyClient.getTokens();
+        if (tokens.length) {
             if (!rawConfig.resolve)
                 rawConfig.resolve = {};
             if (!rawConfig.resolve.http)
                 rawConfig.resolve.http = {};
-            rawConfig.resolve.http.headers = [
-                {
-                    matches: `https://api.${process.env.REDOCLY_DOMAIN || 'redoc.ly'}/registry/**`,
+            rawConfig.resolve.http.headers = [...((_a = rawConfig.resolve.http.headers) !== null && _a !== void 0 ? _a : [])];
+            for (const item of tokens) {
+                const domain = config_1.DOMAINS[item.region];
+                rawConfig.resolve.http.headers.push({
+                    matches: `https://api.${domain}/registry/**`,
                     name: 'Authorization',
                     envVariable: undefined,
-                    value: (redoclyClient && (yield redoclyClient.getAuthorizationHeader())) || '',
-                },
-                ...((_a = rawConfig.resolve.http.headers) !== null && _a !== void 0 ? _a : []),
-            ];
+                    value: item.token,
+                }, 
+                //support redocly.com domain for future compatibility
+                ...(item.region === 'us' ? [{
+                        matches: `https://api.redocly.com/registry/**`,
+                        name: 'Authorization',
+                        envVariable: undefined,
+                        value: item.token,
+                    }] : []));
+            }
         }
         return new config_1.Config(Object.assign(Object.assign({}, rawConfig), { lint: Object.assign(Object.assign({}, rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint), { plugins: [...(((_b = rawConfig === null || rawConfig === void 0 ? void 0 : rawConfig.lint) === null || _b === void 0 ? void 0 : _b.plugins) || []), builtIn_1.defaultPlugin] }) }), configPath);
     });

package/lib/index.d.ts

@@ -8,7 +8,7 @@ export { Oas2Definition } from './typings/swagger';
 export { StatsAccumulator, StatsName } from './typings/common';
 export { normalizeTypes } from './types';
 export { Stats } from './rules/other/stats';
-export { Config, LintConfig, RawConfig, IGNORE_FILE } from './config/config';
+export { Config, LintConfig, RawConfig, IGNORE_FILE, Region } from './config/config';
 export { loadConfig } from './config/load';
 export { RedoclyClient } from './redocly';
 export { Source, BaseResolver, Document, resolveDocument, ResolveError, YamlParseError, makeDocumentFromString, } from './resolve';
@@ -19,5 +19,5 @@ export { normalizeVisitors } from './visitors';
 export { WalkContext, walkDocument, NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject, Loc, } from './walk';
 export { getAstNodeByPointer, getLineColLocation } from './format/codeframes';
 export { formatProblems, OutputFormat, getTotals, Totals } from './format/format';
-export { lint, lint as validate, lintDocument, lintFromString, lintConfig, } from './lint';
+export { lint, lint as validate, lintDocument, lintFromString, lintConfig } from './lint';
 export { bundle, bundleDocument } from './bundle';

package/lib/lint.js

@@ -51,6 +51,7 @@ function lintDocument(opts) {
         const ctx = {
             problems: [],
             oasVersion: oasVersion,
+            visitorsData: {},
         };
         const preprocessors = rules_1.initRules(rules, config, 'preprocessors', oasVersion);
         const regularRules = rules_1.initRules(rules, config, 'rules', oasVersion);
@@ -77,6 +78,7 @@ function lintConfig(opts) {
         const ctx = {
             problems: [],
             oasVersion: oas_types_1.OasVersion.Version3_0,
+            visitorsData: {},
         };
         const config = new config_1.LintConfig({
             plugins: [builtIn_1.defaultPlugin],

package/lib/redocly/index.d.ts

@@ -1,25 +1,31 @@
+import { RegistryApi } from './registry-api';
+import { AccessTokens, Region } from '../config/config';
 export declare class RedoclyClient {
-    private accessToken;
-    constructor();
-    hasToken(): boolean;
-    loadToken(): void;
+    private accessTokens;
+    private region;
+    domain: string;
+    registryApi: RegistryApi;
+    constructor(region?: Region);
+    loadRegion(region?: Region): Region;
+    getRegion(): Region;
+    hasTokens(): boolean;
+    setAccessTokens(accessTokens: AccessTokens): void;
+    loadTokens(): void;
+    getValidTokens(): Promise<{
+        region: string;
+        token: string;
+        valid: boolean;
+    }[]>;
+    getTokens(): Promise<{
+        region: string;
+        token: string;
+        valid: boolean;
+    }[]>;
+    isAuthorizedWithRedoclyByRegion(): Promise<boolean>;
     isAuthorizedWithRedocly(): Promise<boolean>;
-    verifyToken(accessToken: string, verbose?: boolean): Promise<boolean>;
-    getAuthorizationHeader(): Promise<string | undefined>;
+    readCredentialsFile(credentialsPath: string): any;
+    verifyToken(accessToken: string, region: Region, verbose?: boolean): Promise<boolean>;
     login(accessToken: string, verbose?: boolean): Promise<void>;
     logout(): void;
-    query(queryString: string, parameters?: {}, headers?: {}): Promise<any>;
-    static authorize(accessToken: string, options: {
-        queryName?: string;
-        verbose?: boolean;
-    }): Promise<any>;
-    updateDependencies(dependencies: string[] | undefined): Promise<void>;
-    updateDefinitionVersion(definitionId: number, versionId: number, updatePatch: object): Promise<void>;
-    getOrganizationId(organizationId: string): Promise<any>;
-    getDefinitionByName(name: string, organizationId: string): Promise<any>;
-    createDefinition(organizationId: string, name: string): Promise<any>;
-    createDefinitionVersion(definitionId: string, name: string, sourceType: string, source: any): Promise<any>;
-    getSignedUrl(organizationId: string, filesHash: string, fileName: string): Promise<any>;
-    getDefinitionVersion(organizationId: string, definitionName: string, versionName: string): Promise<any>;
-    static isRegistryURL(link: string): boolean;
 }
+export declare function isRedoclyRegistryURL(link: string): boolean;