refactor: use global type

scalar · Jun 20, 2024 · 6cddc37 · 6cddc37
1 parent 80f9995
commit 6cddc37
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 22 deletions.
diff --git a/packages/openapi-parser/src/lib/Validator/Validator.ts b/packages/openapi-parser/src/lib/Validator/Validator.ts
@@ -8,7 +8,12 @@ import {
   type OpenApiVersion,
   OpenApiVersions,
 } from '../../configuration'
-import type { AnyObject, Filesystem, ValidateResult } from '../../types'
+import type {
+  AnyObject,
+  Filesystem,
+  ThrowOnErrorOption,
+  ValidateResult,
+} from '../../types'
 import { details as getOpenApiVersion } from '../../utils/details'
 import { resolveReferences } from '../../utils/resolveReferences'
 import { transformErrors } from '../../utils/transformErrors'
@@ -47,7 +52,7 @@ export class Validator {
    */
   async validate(
     filesystem: Filesystem,
-    options?: { throwOnError?: boolean },
+    options?: ThrowOnErrorOption,
   ): Promise<ValidateResult> {
     const entrypoint = filesystem.find((file) => file.isEntrypoint)
     const specification = entrypoint?.specification

diff --git a/packages/openapi-parser/src/pipeline.ts b/packages/openapi-parser/src/pipeline.ts
@@ -1,4 +1,9 @@
-import type { AnyObject, DetailsResult, Filesystem } from './types'
+import type {
+  AnyObject,
+  DetailsResult,
+  Filesystem,
+  ThrowOnErrorOption,
+} from './types'
 import {
   dereference,
   details,
@@ -34,11 +39,6 @@ export type Queue = {
   tasks: Action[]
 }
 
-/**
- * If `true`, the function will throw an error if the document is invalid.
- */
-export type ThrowOnErrorOption = { throwOnError?: boolean }
-
 /**
  * JSON, YAML or object representation of an OpenAPI API definition
  */

diff --git a/packages/openapi-parser/src/types/index.ts b/packages/openapi-parser/src/types/index.ts
@@ -69,3 +69,12 @@ export type FilesystemEntry = {
   filename: string
   specification: AnyObject
 }
+
+export type ThrowOnErrorOption = {
+  /**
+   * If `true`, the function will throw an error if the document is invalid.
+   *
+   * @default false
+   */
+  throwOnError?: boolean
+}
diff --git a/packages/openapi-parser/src/utils/dereference.ts b/packages/openapi-parser/src/utils/dereference.ts
@@ -1,4 +1,9 @@
-import type { AnyObject, DereferenceResult, Filesystem } from '../types'
+import type {
+  AnyObject,
+  DereferenceResult,
+  Filesystem,
+  ThrowOnErrorOption,
+} from '../types'
 import { details } from './details'
 import { getEntrypoint } from './getEntrypoint'
 import { makeFilesystem } from './makeFilesystem'
@@ -9,7 +14,7 @@ import { resolveReferences } from './resolveReferences'
  */
 export async function dereference(
   value: string | AnyObject | Filesystem,
-  options?: { throwOnError?: boolean },
+  options?: ThrowOnErrorOption,
 ): Promise<DereferenceResult> {
   const filesystem = makeFilesystem(value)
 

diff --git a/packages/openapi-parser/src/utils/resolveReferences.ts b/packages/openapi-parser/src/utils/resolveReferences.ts
@@ -5,6 +5,7 @@ import type {
   ErrorObject,
   Filesystem,
   FilesystemEntry,
+  ThrowOnErrorOption,
 } from '../types'
 import { getEntrypoint } from './getEntrypoint'
 import { getSegmentsFromPath } from './getSegmentsFromPath'
@@ -38,10 +39,7 @@ export function resolveReferences(
   // Just a specification, or a set of files.
   input: AnyObject | Filesystem,
   // Additional options to control the behaviour
-  options?: {
-    // Throw an error if something goes wrong
-    throwOnError?: boolean
-  },
+  options?: ThrowOnErrorOption,
   // Fallback to the entrypoint
   file?: FilesystemEntry,
   // Errors that occurred during the process
@@ -159,7 +157,7 @@ function isCircular(schema: AnyObject) {
 function resolveUri(
   // 'foobar.json#/foo/bar'
   uri: string,
-  options: { throwOnError?: boolean },
+  options: ThrowOnErrorOption,
   // { filename: './foobar.json '}
   file: FilesystemEntry,
   // [ { filename: './foobar.json '} ]

diff --git a/packages/openapi-parser/src/utils/validate.ts b/packages/openapi-parser/src/utils/validate.ts
@@ -1,18 +1,19 @@
 import { Validator } from '../lib/Validator'
-import type { AnyObject, Filesystem, OpenAPI, ValidateResult } from '../types'
+import type {
+  AnyObject,
+  Filesystem,
+  OpenAPI,
+  ThrowOnErrorOption,
+  ValidateResult,
+} from '../types'
 import { makeFilesystem } from './makeFilesystem'
 
 /**
  * Validates an OpenAPI schema.
  */
 export async function validate(
   value: string | AnyObject | Filesystem,
-  options?: {
-    /**
-     * If `true`, the function will throw an error if the document is invalid.
-     */
-    throwOnError?: boolean
-  },
+  options?: ThrowOnErrorOption,
 ): Promise<ValidateResult> {
   const filesystem = makeFilesystem(value)