@redocly/openapi-core 1.0.0-beta.105 → 1.0.0-beta.108

package/src/redocly/index.ts

@@ -1,11 +1,12 @@
 import { existsSync, readFileSync, writeFileSync, unlinkSync } from 'fs';
 import { resolve } from 'path';
 import { homedir } from 'os';
-import { green } from 'colorette';
 import { RegistryApi } from './registry-api';
-import { DEFAULT_REGION, DOMAINS, AVAILABLE_REGIONS, env } from '../config/config';
+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';
 
@@ -28,12 +29,16 @@ export class RedoclyClient {
 
   loadRegion(region?: Region) {
     if (region && !DOMAINS[region]) {
-      throw new Error(`Invalid argument: region in config file.\nGiven: ${green(region)}, choices: "us", "eu".`);
+      throw new Error(
+        `Invalid argument: region in config file.\nGiven: ${colorize.green(
+          region
+        )}, choices: "us", "eu".`
+      );
     }
 
     if (env.REDOCLY_DOMAIN) {
       return (AVAILABLE_REGIONS.find(
-        (region) => DOMAINS[region as Region] === env.REDOCLY_DOMAIN,
+        (region) => DOMAINS[region as Region] === env.REDOCLY_DOMAIN
       ) || DEFAULT_REGION) as Region;
     }
     return region || DEFAULT_REGION;
@@ -91,7 +96,7 @@ export class RedoclyClient {
     const allTokens = this.getAllTokens();
 
     const verifiedTokens = await Promise.allSettled(
-      allTokens.map(({ token, region }) => this.verifyToken(token, region)),
+      allTokens.map(({ token, region }) => this.verifyToken(token, region))
     );
 
     return allTokens
@@ -134,7 +139,7 @@ export class RedoclyClient {
   async verifyToken(
     accessToken: string,
     region: Region,
-    verbose: boolean = false,
+    verbose: boolean = false
   ): Promise<{ viewerId: string; organizations: string[] }> {
     return this.registryApi.authStatus(accessToken, region, verbose);
   }
@@ -150,7 +155,7 @@ export class RedoclyClient {
 
     const credentials = {
       ...this.readCredentialsFile(credentialsPath),
-      [this.region!]: accessToken,
+      [this.region]: accessToken,
       token: accessToken, // FIXME: backward compatibility, remove on 1.0.0
     };
     this.accessTokens = credentials;

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

@@ -1,34 +1,32 @@
-export namespace RegistryApiTypes {
-  interface VersionParams {
-    organizationId: string;
-    name: string;
-    version: string;
-  }
+interface VersionParams {
+  organizationId: string;
+  name: string;
+  version: string;
+}
 
-  export interface PrepareFileuploadParams extends VersionParams {
-    filesHash: string;
-    filename: string;
-    isUpsert?: boolean;
-  }
+export interface PrepareFileuploadParams extends VersionParams {
+  filesHash: string;
+  filename: string;
+  isUpsert?: boolean;
+}
 
-  export interface PushApiParams extends VersionParams {
-    rootFilePath: string;
-    filePaths: string[];
-    branch?: string;
-    isUpsert?: boolean;
-    isPublic?: boolean;
-    batchId?: string;
-    batchSize?: number;
-  }
+export interface PushApiParams extends VersionParams {
+  rootFilePath: string;
+  filePaths: string[];
+  branch?: string;
+  isUpsert?: boolean;
+  isPublic?: boolean;
+  batchId?: string;
+  batchSize?: number;
+}
 
-  export interface PrepareFileuploadOKResponse {
-    filePath: string;
-    signedUploadUrl: string;
-  }
+export interface PrepareFileuploadOKResponse {
+  filePath: string;
+  signedUploadUrl: string;
+}
 
-  export interface NotFoundProblemResponse {
-    status: 404;
-    title: 'Not Found';
-    code: 'ORGANIZATION_NOT_FOUND' | 'API_VERSION_NOT_FOUND';
-  }
+export interface NotFoundProblemResponse {
+  status: 404;
+  title: 'Not Found';
+  code: 'ORGANIZATION_NOT_FOUND' | 'API_VERSION_NOT_FOUND';
 }

package/src/redocly/registry-api.ts

@@ -1,10 +1,17 @@
 import fetch, { RequestInit, HeadersInit } from 'node-fetch';
-import { RegistryApiTypes } from './registry-api-types';
+import type {
+  NotFoundProblemResponse,
+  PrepareFileuploadOKResponse,
+  PrepareFileuploadParams,
+  PushApiParams,
+} from './registry-api-types';
+import type { AccessTokens, Region } from '../config/types';
 import { DEFAULT_REGION, DOMAINS } from '../config/config';
 import { isNotEmptyObject } from '../utils';
 const version = require('../../package.json').version;
 
-import type { AccessTokens, Region } from '../config/types';
+export const currentCommand =
+  typeof process !== 'undefined' ? process.env?.REDOCLY_CLI_COMMAND || '' : '';
 
 export class RegistryApi {
   constructor(private accessTokens: AccessTokens, private region: Region) {}
@@ -23,7 +30,10 @@ export class RegistryApi {
   }
 
   private async request(path = '', options: RequestInit = {}, region?: Region) {
-    const headers = Object.assign({}, options.headers || {}, { 'x-redocly-cli-version': version });
+    const headers = Object.assign({}, options.headers || {}, {
+      'x-redocly-cli-version': version,
+      'user-agent': `redocly-cli / ${version} ${currentCommand}`,
+    });
 
     if (!headers.hasOwnProperty('authorization')) {
       throw new Error('Unauthorized');
@@ -31,7 +41,7 @@ export class RegistryApi {
 
     const response = await fetch(
       `${this.getBaseUrl(region)}${path}`,
-      Object.assign({}, options, { headers }),
+      Object.assign({}, options, { headers })
     );
 
     if (response.status === 401) {
@@ -39,7 +49,7 @@ export class RegistryApi {
     }
 
     if (response.status === 404) {
-      const body: RegistryApiTypes.NotFoundProblemResponse = await response.json();
+      const body: NotFoundProblemResponse = await response.json();
       throw new Error(body.code);
     }
 
@@ -49,7 +59,7 @@ export class RegistryApi {
   async authStatus(
     accessToken: string,
     region: Region,
-    verbose = false,
+    verbose = false
   ): Promise<{ viewerId: string; organizations: string[] }> {
     try {
       const response = await this.request('', { headers: { authorization: accessToken } }, region);
@@ -71,7 +81,7 @@ export class RegistryApi {
     filesHash,
     filename,
     isUpsert,
-  }: RegistryApiTypes.PrepareFileuploadParams): Promise<RegistryApiTypes.PrepareFileuploadOKResponse> {
+  }: PrepareFileuploadParams): Promise<PrepareFileuploadOKResponse> {
     const response = await this.request(
       `/${organizationId}/${name}/${version}/prepare-file-upload`,
       {
@@ -86,7 +96,7 @@ export class RegistryApi {
           isUpsert,
         }),
       },
-      this.region,
+      this.region
     );
 
     if (response.ok) {
@@ -106,8 +116,8 @@ export class RegistryApi {
     isUpsert,
     isPublic,
     batchId,
-    batchSize
-  }: RegistryApiTypes.PushApiParams) {
+    batchSize,
+  }: PushApiParams) {
     const response = await this.request(
       `/${organizationId}/${name}/${version}`,
       {
@@ -123,10 +133,10 @@ export class RegistryApi {
           isUpsert,
           isPublic,
           batchId,
-          batchSize
+          batchSize,
         }),
       },
-      this.region,
+      this.region
     );
 
     if (response.ok) {

package/src/ref-utils.ts

@@ -1,5 +1,6 @@
 import { Source } from './resolve';
 import { OasRef } from './typings/openapi';
+import { isTruthy } from './utils';
 
 export function joinPointer(base: string, key: string | number) {
   if (base === '') base = '#/';
@@ -18,8 +19,8 @@ export class Location {
       this.source,
       joinPointer(
         this.pointer,
-        (Array.isArray(components) ? components : [components]).map(escapePointer).join('/'),
-      ),
+        (Array.isArray(components) ? components : [components]).map(escapePointer).join('/')
+      )
     );
   }
 
@@ -45,7 +46,7 @@ export function parseRef(ref: string): { uri: string | null; pointer: string[] }
   const [uri, pointer] = ref.split('#/');
   return {
     uri: uri || null,
-    pointer: pointer ? pointer.split('/').map(unescapePointer).filter(Boolean) : [],
+    pointer: pointer ? pointer.split('/').map(unescapePointer).filter(isTruthy) : [],
   };
 }
 

package/src/resolve.ts

@@ -91,7 +91,7 @@ export function makeDocumentFromString(sourceString: string, absoluteRef: string
 export class BaseResolver {
   cache: Map<string, Promise<Document | ResolveError>> = new Map();
 
-  constructor(private config: ResolveConfig = { http: { headers: [] } }) {}
+  constructor(protected config: ResolveConfig = { http: { headers: [] } }) {}
 
   getFiles() {
     return new Set(Array.from(this.cache.keys()));
@@ -232,7 +232,7 @@ export async function resolveDocument(opts: {
     rootNode: any,
     rootNodeDocument: Document,
     rootNodePointer: string,
-    type: any,
+    type: any
   ) {
     const rootNodeDocAbsoluteRef = rootNodeDocument.source.absoluteRef;
 
@@ -295,7 +295,7 @@ export async function resolveDocument(opts: {
               resolvedRef.node,
               resolvedRef.document,
               resolvedRef.nodePointer!,
-              type,
+              type
             );
           }
         });
@@ -306,7 +306,7 @@ export async function resolveDocument(opts: {
     async function followRef(
       document: Document,
       ref: OasRef,
-      refStack: RefFrame,
+      refStack: RefFrame
     ): Promise<ResolvedRef> {
       if (hasRef(refStack.prev, ref)) {
         throw new Error('Self-referencing circular pointer');
@@ -316,11 +316,14 @@ export async function resolveDocument(opts: {
       let targetDoc: Document;
       try {
         targetDoc = isRemote
-          ? ((await externalRefResolver.resolveDocument(document.source.absoluteRef, uri!)) as Document)
+          ? ((await externalRefResolver.resolveDocument(
+              document.source.absoluteRef,
+              uri!
+            )) as Document)
           : document;
       } catch (error) {
         const resolvedRef = {
-          resolved: false as false,
+          resolved: false as const,
           isRemote,
           document: undefined,
           error: error,
@@ -331,7 +334,7 @@ export async function resolveDocument(opts: {
       }
 
       let resolvedRef: ResolvedRef = {
-        resolved: true as true,
+        resolved: true as const,
         document: targetDoc,
         isRemote,
         node: document.parsed,
@@ -341,7 +344,7 @@ export async function resolveDocument(opts: {
       let target = targetDoc.parsed as any;
 
       const segments = pointer;
-      for (let segment of segments) {
+      for (const segment of segments) {
         if (typeof target !== 'object') {
           target = undefined;
           break;

package/src/rules/__tests__/no-unresolved-refs.test.ts

@@ -15,7 +15,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               requestBody:
                 $ref: 'invalid.yaml'
       `,
-      path.join(__dirname, 'foobar.yaml'),
+      path.join(__dirname, 'foobar.yaml')
     );
 
     const results = await lintDocument({
@@ -55,7 +55,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               requestBody:
                 $ref: 'fixtures/invalid-yaml.yaml'
       `,
-      path.join(__dirname, 'foobar.yaml'),
+      path.join(__dirname, 'foobar.yaml')
     );
 
     const results = await lintDocument({
@@ -112,7 +112,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               requestBody:
                 $ref: 'fixtures/ref.yaml'
       `,
-      path.join(__dirname, 'foobar.yaml'),
+      path.join(__dirname, 'foobar.yaml')
     );
 
     const results = await lintDocument({
@@ -136,7 +136,7 @@ describe('oas3 boolean-parameter-prefixes', () => {
               requestBody:
                 $ref: '#/components/requestBodies/a'
       `,
-      path.join(__dirname, 'foobar.yaml'),
+      path.join(__dirname, 'foobar.yaml')
     );
 
     const results = await lintDocument({

package/src/rules/__tests__/utils.test.ts

@@ -0,0 +1,160 @@
+import {
+  fieldNonEmpty,
+  matchesJsonSchemaType,
+  missingRequiredField,
+  oasTypeOf,
+  getAdditionalPropertiesOption,
+} from '../utils';
+
+describe('field-non-empty', () => {
+  it('should match expected message', () => {
+    const message = fieldNonEmpty('Car', 'color');
+    expect(message).toBe('Car object `color` must be non-empty string.');
+  });
+});
+
+describe('matches-json-schema-type', () => {
+  it('should report true on a null value with nullable type', () => {
+    const results = matchesJsonSchemaType(null, 'string', true);
+    expect(results).toBe(true);
+  });
+
+  it('should report true on a value and type integer', () => {
+    const results = matchesJsonSchemaType(123, 'integer', false);
+    expect(results).toBe(true);
+  });
+
+  it('should report false when the value is not integer and type is integer', () => {
+    const results = matchesJsonSchemaType(3.14, 'integer', false);
+    expect(results).toBe(false);
+  });
+
+  it('should report true when the value is a number and type is number', () => {
+    const results = matchesJsonSchemaType(3.14, 'number', false);
+    expect(results).toBe(true);
+  });
+
+  it('should report true when the value is an integer and type is number', () => {
+    const results = matchesJsonSchemaType(3, 'number', false);
+    expect(results).toBe(true);
+  });
+
+  it('should report true when the value is true and type is boolean', () => {
+    const results = matchesJsonSchemaType(true, 'boolean', false);
+    expect(results).toBe(true);
+  });
+
+  it('should report true when the value is false and type is boolean', () => {
+    const results = matchesJsonSchemaType(false, 'boolean', false);
+    expect(results).toBe(true);
+  });
+
+  it('should report true when the value is a string and type is boolean', () => {
+    const results = matchesJsonSchemaType('test', 'boolean', false);
+    expect(results).toBe(false);
+  });
+
+  it('should report true on an array value with array type', () => {
+    const results = matchesJsonSchemaType(['foo', 'bar'], 'array', false);
+    expect(results).toBe(true);
+  });
+
+  it('should report false on an array value with object type', () => {
+    const results = matchesJsonSchemaType(['foo', 'bar'], 'object', false);
+    expect(results).toBe(false);
+  });
+
+  it('should report true on an object value with object type', () => {
+    const car = { type: 'Fiat', model: '500', color: 'white' };
+    const results = matchesJsonSchemaType(car, 'object', true);
+    expect(results).toBe(true);
+  });
+
+  it('should report false on an object value with array type', () => {
+    const car = { type: 'Fiat', model: '500', color: 'white' };
+    const results = matchesJsonSchemaType(car, 'array', true);
+    expect(results).toBe(false);
+  });
+});
+
+describe('missing-required-field', () => {
+  it('should match expected message for missing required field', () => {
+    const message = missingRequiredField('Car', 'color');
+    expect(message).toBe('Car object should contain `color` field.');
+  });
+});
+
+describe('oas-type-of', () => {
+  it('should report the correct oas type for a string', () => {
+    const results = oasTypeOf('word');
+    expect(results).toBe('string');
+  });
+
+  it('should report the correct oas type for an integer', () => {
+    const results = oasTypeOf(123);
+    expect(results).toBe('integer');
+  });
+
+  it('should report the correct oas type for a number', () => {
+    const results = oasTypeOf(3.14);
+    expect(results).toBe('number');
+  });
+
+  it('should report the correct oas type for a null value', () => {
+    const results = oasTypeOf(null);
+    expect(results).toBe('null');
+  });
+
+  it('should report the correct oas type for a true boolean', () => {
+    const results = oasTypeOf(true);
+    expect(results).toBe('boolean');
+  });
+
+  it('should report the correct oas type for a false boolean', () => {
+    const results = oasTypeOf(false);
+    expect(results).toBe('boolean');
+  });
+
+  it('should report the correct oas type for an array', () => {
+    const results = oasTypeOf(['foo', 'bar']);
+    expect(results).toBe('array');
+  });
+
+  it('should report the correct oas type for an object', () => {
+    const car = { type: 'Fiat', model: '500', color: 'white' };
+    const results = oasTypeOf(car);
+    expect(results).toBe('object');
+  });
+});
+
+describe('get-additional-properties-option', () => {
+  it('should return actual option', () => {
+    const options = {
+      allowAdditionalProperties: true,
+    };
+    expect(getAdditionalPropertiesOption(options)).toBeTruthy();
+  });
+
+  it('should reverse option', () => {
+    const options = {
+      disallowAdditionalProperties: true,
+    };
+    expect(getAdditionalPropertiesOption(options)).toBeFalsy();
+  });
+
+  it('should throw error with message', () => {
+    const options = {
+      allowAdditionalProperties: true,
+      disallowAdditionalProperties: false,
+    };
+
+    try {
+      getAdditionalPropertiesOption(options);
+    } catch (error) {
+      expect(error).toBeInstanceOf(Error);
+      expect(error.message).toEqual(
+        "Do not use 'disallowAdditionalProperties' field. Use 'allowAdditionalProperties' instead.\n"
+      );
+    }
+  });
+});

package/src/rules/ajv.ts

@@ -8,7 +8,7 @@ export function releaseAjvInstance() {
   ajvInstance = null;
 }
 
-function getAjv(resolve: ResolveFn, disallowAdditionalProperties: boolean) {
+function getAjv(resolve: ResolveFn, allowAdditionalProperties: boolean) {
   if (!ajvInstance) {
     ajvInstance = new Ajv({
       schemaId: '$id',
@@ -20,7 +20,7 @@ function getAjv(resolve: ResolveFn, disallowAdditionalProperties: boolean) {
       discriminator: true,
       allowUnionTypes: true,
       validateFormats: false, // TODO: fix it
-      defaultAdditionalProperties: !disallowAdditionalProperties,
+      defaultAdditionalProperties: allowAdditionalProperties,
       loadSchemaSync(base: string, $ref: string) {
         const resolvedRef = resolve({ $ref }, base.split('#')[0]);
         if (!resolvedRef || !resolvedRef.location) return false;
@@ -36,9 +36,9 @@ function getAjvValidator(
   schema: any,
   loc: Location,
   resolve: ResolveFn,
-  disallowAdditionalProperties: boolean,
+  allowAdditionalProperties: boolean
 ): ValidateFunction | undefined {
-  const ajv = getAjv(resolve, disallowAdditionalProperties);
+  const ajv = getAjv(resolve, allowAdditionalProperties);
 
   if (!ajv.getSchema(loc.absolutePointer)) {
     ajv.addSchema({ $id: loc.absolutePointer, ...schema }, loc.absolutePointer);
@@ -53,9 +53,9 @@ export function validateJsonSchema(
   schemaLoc: Location,
   instancePath: string,
   resolve: ResolveFn,
-  disallowAdditionalProperties: boolean,
+  allowAdditionalProperties: boolean
 ): { valid: boolean; errors: (ErrorObject & { suggest?: string[] })[] } {
-  const validate = getAjvValidator(schema, schemaLoc, resolve, disallowAdditionalProperties);
+  const validate = getAjvValidator(schema, schemaLoc, resolve, allowAdditionalProperties);
   if (!validate) return { valid: true, errors: [] }; // unresolved refs are reported
 
   const valid = validate(data, {
@@ -73,8 +73,7 @@ export function validateJsonSchema(
 
   function beatifyErrorMessage(error: ErrorObject) {
     let message = error.message;
-    let suggest =
-      error.keyword === 'enum' ? error.params.allowedValues : undefined;
+    const suggest = error.keyword === 'enum' ? error.params.allowedValues : undefined;
     if (suggest) {
       message += ` ${suggest.map((e: any) => `"${e}"`).join(', ')}`;
     }

package/src/rules/common/__tests__/info-description.test.ts

@@ -11,7 +11,7 @@ describe('Oas3 info-description', () => {
           info:
             version: '1.0'
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -49,7 +49,7 @@ describe('Oas3 info-description', () => {
             version: '1.0'
             description: ''
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -86,7 +86,7 @@ describe('Oas3 info-description', () => {
           info:
             description: test description
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

package/src/rules/common/__tests__/info-license.test.ts

@@ -11,7 +11,7 @@ describe('Oas3 info-license', () => {
           info:
             version: '1.0'
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -48,7 +48,7 @@ describe('Oas3 info-license', () => {
               name: MIT
               url: google.com
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

package/src/rules/common/__tests__/license-url.test.ts

@@ -12,7 +12,7 @@ describe('Oas3 license-url', () => {
             license:
               name: MIT
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({
@@ -49,7 +49,7 @@ describe('Oas3 license-url', () => {
               name: MIT
               url: google.com
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({

package/src/rules/common/__tests__/no-ambiguous-paths.test.ts

@@ -40,7 +40,7 @@ describe('no-ambiguous-paths', () => {
             get:
               summary: List all pets
         `,
-      'foobar.yaml',
+      'foobar.yaml'
     );
 
     const results = await lintDocument({