@redocly/openapi-core 1.0.0-beta.106 → 1.0.0-beta.109

package/src/env.ts

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

package/src/format/codeframes.ts

@@ -1,7 +1,7 @@
-import { gray, red, options as colorOptions } from 'colorette';
 import * as yamlAst from 'yaml-ast-parser';
 import { unescapePointer } from '../ref-utils';
 import { LineColLocationObject, Loc, LocationObject } from '../walk';
+import { colorize, colorOptions } from '../logger';
 
 type YAMLMapping = yamlAst.YAMLMapping & { kind: yamlAst.Kind.MAPPING };
 type YAMLMap = yamlAst.YamlMap & { kind: yamlAst.Kind.MAP };
@@ -36,17 +36,23 @@ export function getCodeframe(location: LineColLocationObject, color: boolean) {
     if (skipLines > 0 && i >= endLineNum - skipLines) break;
     const line = lines[i - 1] || '';
     if (line !== '') currentPad = padSize(line);
-    let startIdx = i === startLineNum ? start.col - 1 : currentPad;
-    let endIdx = i === endLineNum ? end.col - 1 : line.length;
+    const startIdx = i === startLineNum ? start.col - 1 : currentPad;
+    const endIdx = i === endLineNum ? end.col - 1 : line.length;
 
-    prefixedLines.push([`${i}`, markLine(line, startIdx, endIdx, red)]);
+    prefixedLines.push([`${i}`, markLine(line, startIdx, endIdx, colorize.red)]);
     if (!color) prefixedLines.push(['', underlineLine(line, startIdx, endIdx)]);
   }
 
   if (skipLines > 0) {
-    prefixedLines.push([`…`, `${whitespace(currentPad)}${gray(`< ${skipLines} more lines >`)}`]);
+    prefixedLines.push([
+      `…`,
+      `${whitespace(currentPad)}${colorize.gray(`< ${skipLines} more lines >`)}`,
+    ]);
     // print last line
-    prefixedLines.push([`${endLineNum}`, markLine(lines[endLineNum - 1], -1, end.col - 1, red)]);
+    prefixedLines.push([
+      `${endLineNum}`,
+      markLine(lines[endLineNum - 1], -1, end.col - 1, colorize.red),
+    ]);
 
     if (!color) prefixedLines.push(['', underlineLine(lines[endLineNum - 1], -1, end.col - 1)]);
   }
@@ -63,7 +69,7 @@ export function getCodeframe(location: LineColLocationObject, color: boolean) {
     line: string,
     startIdx: number = -1,
     endIdx: number = +Infinity,
-    variant = gray
+    variant = colorize.gray
   ) {
     if (!color) return line;
     if (!line) return line;
@@ -90,7 +96,7 @@ function printPrefixedLines(lines: [string, string][]): string {
   return existingLines
     .map(
       ([prefix, line]) =>
-        gray(leftPad(padLen, prefix) + ' |') +
+        colorize.gray(leftPad(padLen, prefix) + ' |') +
         (line ? ' ' + limitLineLength(line.substring(dedentLen)) : '')
     )
     .join('\n');
@@ -99,7 +105,7 @@ function printPrefixedLines(lines: [string, string][]): string {
 function limitLineLength(line: string, maxLen: number = MAX_LINE_LENGTH) {
   const overflowLen = line.length - maxLen;
   if (overflowLen > 0) {
-    const charsMoreText = gray(`...<${overflowLen} chars>`);
+    const charsMoreText = colorize.gray(`...<${overflowLen} chars>`);
     return line.substring(0, maxLen - charsMoreText.length) + charsMoreText;
   } else {
     return line;

package/src/format/format.ts

@@ -1,20 +1,12 @@
 import * as path from 'path';
-import {
-  options as colorOptions,
-  gray,
-  blue,
-  bgRed,
-  bgYellow,
-  black,
-  yellow,
-  red,
-} from 'colorette';
+import { colorOptions, colorize, logger } from '../logger';
+import { output } from '../output';
 
 const coreVersion = require('../../package.json').version;
 
 import { NormalizedProblem, ProblemSeverity, LineColLocationObject, LocationObject } from '../walk';
 import { getCodeframe, getLineColLocation } from './codeframes';
-import { env } from '../config';
+import { env } from '../env';
 
 export type Totals = {
   errors: number;
@@ -27,13 +19,13 @@ const ERROR_MESSAGE = {
 };
 
 const BG_COLORS = {
-  warn: (str: string) => bgYellow(black(str)),
-  error: bgRed,
+  warn: (str: string) => colorize.bgYellow(colorize.black(str)),
+  error: colorize.bgRed,
 };
 
 const COLORS = {
-  warn: yellow,
-  error: red,
+  warn: colorize.yellow,
+  error: colorize.red,
 };
 
 const SEVERITY_NAMES = {
@@ -52,7 +44,13 @@ function severityToNumber(severity: ProblemSeverity) {
   return severity === 'error' ? 1 : 2;
 }
 
-export type OutputFormat = 'codeframe' | 'stylish' | 'json' | 'checkstyle' | 'codeclimate';
+export type OutputFormat =
+  | 'codeframe'
+  | 'stylish'
+  | 'json'
+  | 'checkstyle'
+  | 'codeclimate'
+  | 'summary';
 
 export function getTotals(problems: (NormalizedProblem & { ignored?: boolean })[]): Totals {
   let errors = 0;
@@ -114,7 +112,7 @@ export function formatProblems(
     case 'codeframe':
       for (let i = 0; i < problems.length; i++) {
         const problem = problems[i];
-        process.stderr.write(`${formatCodeframe(problem, i)}\n`);
+        logger.info(`${formatCodeframe(problem, i)}\n`);
       }
       break;
     case 'stylish': {
@@ -122,40 +120,43 @@ export function formatProblems(
       for (const [file, { ruleIdPad, locationPad: positionPad, fileProblems }] of Object.entries(
         groupedByFile
       )) {
-        process.stderr.write(`${blue(path.relative(cwd, file))}:\n`);
+        logger.info(`${colorize.blue(path.relative(cwd, file))}:\n`);
 
         for (let i = 0; i < fileProblems.length; i++) {
           const problem = fileProblems[i];
-          process.stderr.write(`${formatStylish(problem, positionPad, ruleIdPad)}\n`);
+          logger.info(`${formatStylish(problem, positionPad, ruleIdPad)}\n`);
         }
 
-        process.stderr.write('\n');
+        logger.info('\n');
       }
       break;
     }
     case 'checkstyle': {
       const groupedByFile = groupByFiles(problems);
 
-      process.stdout.write('<?xml version="1.0" encoding="UTF-8"?>\n');
-      process.stdout.write('<checkstyle version="4.3">\n');
+      output.write('<?xml version="1.0" encoding="UTF-8"?>\n');
+      output.write('<checkstyle version="4.3">\n');
 
       for (const [file, { fileProblems }] of Object.entries(groupedByFile)) {
-        process.stdout.write(`<file name="${xmlEscape(path.relative(cwd, file))}">\n`);
+        output.write(`<file name="${xmlEscape(path.relative(cwd, file))}">\n`);
         fileProblems.forEach(formatCheckstyle);
-        process.stdout.write(`</file>\n`);
+        output.write(`</file>\n`);
       }
 
-      process.stdout.write(`</checkstyle>\n`);
+      output.write(`</checkstyle>\n`);
       break;
     }
     case 'codeclimate':
       outputForCodeClimate();
       break;
+    case 'summary':
+      formatSummary(problems);
+      break;
   }
 
   if (totalProblems - ignoredProblems > maxProblems) {
-    process.stderr.write(
-      `< ... ${totalProblems - maxProblems} more problems hidden > ${gray(
+    logger.info(
+      `< ... ${totalProblems - maxProblems} more problems hidden > ${colorize.gray(
         'increase with `--max-problems N`'
       )}\n`
     );
@@ -177,7 +178,7 @@ export function formatProblems(
         fingerprint: `${p.ruleId}${p.location.length > 0 ? '-' + p.location[0].pointer : ''}`,
       };
     });
-    process.stdout.write(JSON.stringify(issues, null, 2));
+    output.write(JSON.stringify(issues, null, 2));
   }
 
   function outputJSON() {
@@ -185,7 +186,7 @@ export function formatProblems(
       totals,
       version,
       problems: problems.map((p) => {
-        let problem = {
+        const problem = {
           ...p,
           location: p.location.map((location: any) => ({
             ...location,
@@ -211,7 +212,7 @@ export function formatProblems(
         return problem;
       }),
     };
-    process.stdout.write(JSON.stringify(resultObject, null, 2));
+    output.write(JSON.stringify(resultObject, null, 2));
   }
 
   function getBgColor(problem: NormalizedProblem) {
@@ -227,7 +228,7 @@ export function formatProblems(
     const location = problem.location[0]; // TODO: support multiple locations
     const relativePath = path.relative(cwd, location.source.absoluteRef);
     const loc = getLineColLocation(location);
-    const atPointer = location.pointer ? gray(`at ${location.pointer}`) : '';
+    const atPointer = location.pointer ? colorize.gray(`at ${location.pointer}`) : '';
     const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;
     return (
       `[${idx + 1}] ${bgColor(fileWithLoc)} ${atPointer}\n\n` +
@@ -236,7 +237,9 @@ export function formatProblems(
       getCodeframe(loc, color) +
       '\n\n' +
       formatFrom(cwd, problem.from) +
-      `${SEVERITY_NAMES[problem.severity]} was generated by the ${blue(problem.ruleId)} rule.\n\n`
+      `${SEVERITY_NAMES[problem.severity]} was generated by the ${colorize.blue(
+        problem.ruleId
+      )} rule.\n\n`
     );
   }
 
@@ -257,19 +260,40 @@ export function formatProblems(
     const severity = problem.severity == 'warn' ? 'warning' : 'error';
     const message = xmlEscape(problem.message);
     const source = xmlEscape(problem.ruleId);
-    process.stdout.write(
+    output.write(
       `<error line="${line}" column="${col}" severity="${severity}" message="${message}" source="${source}" />\n`
     );
   }
 }
 
+function formatSummary(problems: NormalizedProblem[]): void {
+  const counts: Record<string, { count: number; severity: ProblemSeverity }> = {};
+  for (const problem of problems) {
+    counts[problem.ruleId] = counts[problem.ruleId] || { count: 0, severity: problem.severity };
+    counts[problem.ruleId].count++;
+  }
+  const sorted = Object.entries(counts).sort(([, a], [, b]) => {
+    const severityDiff = severityToNumber(a.severity) - severityToNumber(b.severity);
+    return severityDiff || b.count - a.count;
+  });
+
+  for (const [ruleId, info] of sorted) {
+    const color = COLORS[info.severity];
+    const severityName = color(SEVERITY_NAMES[info.severity].toLowerCase().padEnd(7));
+    logger.info(`${severityName} ${ruleId}: ${info.count}\n`);
+  }
+
+  logger.info('\n');
+}
+
 function formatFrom(cwd: string, location?: LocationObject) {
   if (!location) return '';
   const relativePath = path.relative(cwd, location.source.absoluteRef);
   const loc = getLineColLocation(location);
   const fileWithLoc = `${relativePath}:${loc.start.line}:${loc.start.col}`;
+  const atPointer = location.pointer ? colorize.gray(`at ${location.pointer}`) : '';
 
-  return `referenced from ${blue(fileWithLoc)}\n\n`;
+  return `referenced from ${colorize.blue(fileWithLoc)} ${atPointer} \n\n`;
 }
 
 function formatDidYouMean(problem: NormalizedProblem) {
@@ -320,6 +344,7 @@ const groupByFiles = (problems: NormalizedProblem[]) => {
 };
 
 function xmlEscape(s: string): string {
+  // eslint-disable-next-line no-control-regex
   return s.replace(/[<>&"'\x00-\x1F\x7F\u0080-\uFFFF]/gu, (char) => {
     switch (char) {
       case '<':

package/src/index.ts

@@ -1,9 +1,9 @@
-export { BundleOutputFormat, readFileFromUrl, slash, doesYamlFileExist } 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';
 export { ConfigTypes } from './types/redocly-yaml';
-export {
+export type {
   Oas3Definition,
   Oas3_1Definition,
   Oas3Components,
@@ -15,9 +15,10 @@ export {
   Oas3Tag,
   Oas3_1Webhooks,
   Referenced,
+  OasRef,
 } from './typings/openapi';
-export { Oas2Definition } from './typings/swagger';
-export { StatsAccumulator, StatsName } from './typings/common';
+export type { Oas2Definition } from './typings/swagger';
+export type { StatsAccumulator, StatsName } from './typings/common';
 export { normalizeTypes } from './types';
 export { Stats } from './rules/other/stats';
 
@@ -34,6 +35,7 @@ export {
   findConfig,
   CONFIG_FILE_NAMES,
   RuleSeverity,
+  createConfig,
 } from './config';
 
 export { RedoclyClient, isRedoclyRegistryURL } from './redocly';

package/src/js-yaml/index.ts

@@ -1,4 +1,5 @@
 // TODO: add a type for "types" https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/js-yaml/index.d.ts
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 import { JSON_SCHEMA, types, LoadOptions, DumpOptions, load, dump } from 'js-yaml';
 

package/src/lint.ts

@@ -80,13 +80,13 @@ export async function lintDocument(opts: {
   const normalizedVisitors = normalizeVisitors([...preprocessors, ...regularRules] as any, types);
   const resolvedRefMap = await resolveDocument({
     rootDocument: document,
-    rootType: types.DefinitionRoot,
+    rootType: types.Root,
     externalRefResolver,
   });
 
   walkDocument({
     document,
-    rootType: types.DefinitionRoot,
+    rootType: types.Root,
     normalizedVisitors,
     resolvedRefMap,
     ctx,

package/src/logger.ts

@@ -0,0 +1,34 @@
+import * as colorette from 'colorette';
+export { options as colorOptions } from 'colorette';
+
+import { isBrowser } from './env';
+import { identity } from './utils';
+
+export const colorize = new Proxy(colorette, {
+  get(target: typeof colorette, prop: string): typeof identity {
+    if (isBrowser) {
+      return identity;
+    }
+
+    return (target as any)[prop];
+  },
+});
+class Logger {
+  protected stderr(str: string) {
+    return process.stderr.write(str);
+  }
+
+  info(str: string) {
+    return isBrowser ? console.log(str) : this.stderr(str);
+  }
+
+  warn(str: string) {
+    return isBrowser ? console.warn(str) : this.stderr(colorize.yellow(str));
+  }
+
+  error(str: string) {
+    return isBrowser ? console.error(str) : this.stderr(colorize.red(str));
+  }
+}
+
+export const logger = new Logger();

package/src/output.ts

@@ -0,0 +1,7 @@
+import { isBrowser } from './env';
+
+export const output = {
+  write(str: string) {
+    return isBrowser ? undefined : process.stdout.write(str);
+  },
+};

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';
 
@@ -29,7 +30,9 @@ 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".`
+        `Invalid argument: region in config file.\nGiven: ${colorize.green(
+          region
+        )}, choices: "us", "eu".`
       );
     }
 
@@ -152,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,11 +1,15 @@
 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 class RegistryApi {
   constructor(private accessTokens: AccessTokens, private region: Region) {}
 
@@ -23,7 +27,14 @@ export class RegistryApi {
   }
 
   private async request(path = '', options: RequestInit = {}, region?: Region) {
-    const headers = Object.assign({}, options.headers || {}, { 'x-redocly-cli-version': version });
+    const currentCommand =
+      typeof process !== 'undefined' ? process.env?.REDOCLY_CLI_COMMAND || '' : '';
+    const redoclyEnv = typeof process !== 'undefined' ? process.env?.REDOCLY_ENVIRONMENT || '' : '';
+
+    const headers = Object.assign({}, options.headers || {}, {
+      'x-redocly-cli-version': version,
+      'user-agent': `redocly-cli / ${version} ${currentCommand} ${redoclyEnv}`,
+    });
 
     if (!headers.hasOwnProperty('authorization')) {
       throw new Error('Unauthorized');
@@ -39,7 +50,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);
     }
 
@@ -71,7 +82,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`,
       {
@@ -107,7 +118,7 @@ export class RegistryApi {
     isPublic,
     batchId,
     batchSize,
-  }: RegistryApiTypes.PushApiParams) {
+  }: PushApiParams) {
     const response = await this.request(
       `/${organizationId}/${name}/${version}`,
       {

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 = '#/';
@@ -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()));
@@ -115,7 +115,9 @@ export class BaseResolver {
         const { body, mimeType } = await readFileFromUrl(absoluteRef, this.config.http);
         return new Source(absoluteRef, body, mimeType);
       } else {
-        return new Source(absoluteRef, await fs.promises.readFile(absoluteRef, 'utf-8'));
+        const content = await fs.promises.readFile(absoluteRef, 'utf-8');
+        // In some cases file have \r\n line delimeters like on windows, we should skip it.
+        return new Source(absoluteRef, content.replace(/\r\n/g, '\n'));
       }
     } catch (error) {
       throw new ResolveError(error);
@@ -323,7 +325,7 @@ export async function resolveDocument(opts: {
           : document;
       } catch (error) {
         const resolvedRef = {
-          resolved: false as false,
+          resolved: false as const,
           isRemote,
           document: undefined,
           error: error,
@@ -334,7 +336,7 @@ export async function resolveDocument(opts: {
       }
 
       let resolvedRef: ResolvedRef = {
-        resolved: true as true,
+        resolved: true as const,
         document: targetDoc,
         isRemote,
         node: document.parsed,
@@ -344,7 +346,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__/utils.test.ts

@@ -1,4 +1,10 @@
-import { fieldNonEmpty, matchesJsonSchemaType, missingRequiredField, oasTypeOf } from '../utils';
+import {
+  fieldNonEmpty,
+  matchesJsonSchemaType,
+  missingRequiredField,
+  oasTypeOf,
+  getAdditionalPropertiesOption,
+} from '../utils';
 
 describe('field-non-empty', () => {
   it('should match expected message', () => {
@@ -120,3 +126,35 @@ describe('oas-type-of', () => {
     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"
+      );
+    }
+  });
+});