fix: types

Author: hanspagel

packages/openapi-parser/src/pipeline.ts

@@ -1,10 +1,4 @@
-import type {
-  AnyObject,
-  DereferenceResult,
-  DetailsResult,
-  Filesystem,
-  OpenAPI,
-} from './types'
+import type { AnyObject, DetailsResult, Filesystem } from './types'
 import {
   dereference,
   details,

packages/openapi-parser/src/types/index.ts

@@ -1,4 +1,4 @@
-import { ERRORS } from '../configuration'
+import { ERRORS, OpenApiVersion } from '../configuration'
 import type { OpenAPI } from './openapi-types'
 
 export type {
@@ -32,7 +32,7 @@ export type FilterResult = {
 }
 
 export type DetailsResult = {
-  version: string
+  version: OpenApiVersion
   specificationType: string
   specificationVersion: string
 }

packages/openapi-parser/src/utils/details.ts

@@ -11,7 +11,7 @@ export function details(specification: AnyObject): DetailsResult {
 
     if (typeof value === 'string' && value.startsWith(version)) {
       return {
-        version: version as OpenApiVersion,
+        version: version,
         specificationType,
         specificationVersion: value,
       }

packages/openapi-parser/src/utils/workThroughQueue.ts

@@ -1,21 +1,30 @@
 import type { Queue } from '../pipeline'
-import type { DereferenceResult, Filesystem } from '../types'
-import { makeFilesystem } from './makeFilesystem'
+import type {
+  DereferenceResult,
+  Filesystem,
+  FilterResult,
+  LoadResult,
+  UpgradeResult,
+  ValidateResult,
+} from '../types'
+
+type WorkThroughQueueResult = Partial<
+  LoadResult &
+    DereferenceResult &
+    ValidateResult &
+    UpgradeResult &
+    FilterResult & {
+      filesystem: Filesystem
+    }
+>
 
 /**
  * Run through a queue of tasks
  */
 export async function workThroughQueue(queue: Queue): // TODO: Better type
-Promise<
-  Partial<
-    DereferenceResult & {
-      filesystem: Filesystem
-    }
-  >
-> {
+Promise<WorkThroughQueueResult> {
   let specification = queue.specification
 
-  // TODO: Be more specific
   let result: any
 
   // Run through all tasks in the queue
@@ -40,16 +49,5 @@ Promise<
     }
   }
 
-  /**
-   * TODO: This is a terrible hack. All functions should return the same format, but they don’t.
-   * The dereference function returns a DereferenceResult, but others return a Filesystem.
-   */
-  // const isMoreThanJustTheSpecification = Object.keys(specification).includes(
-  //   'specificationVersion',
-  // )
-
   return result
-  // return isMoreThanJustTheSpecification
-  //   ? (specification as any)
-  //   : makeFilesystem(specification as Filesystem)
 }