chore: improve types (#122)

* chore: remove some @ts-ignore

* chore: remove more @ts-ignores

* chore: remove some @ts-expect-error comments

* chore: restore deleted code

Author: hanspagel

demo/src/App.vue

@@ -2,7 +2,7 @@
 import { dereference, fetchUrlsPlugin, load } from '@scalar/openapi-parser'
 import { watchDebounced } from '@vueuse/core'
 import { onMounted, ref, watch } from 'vue'
-// @ts-ignore
+// @ts-expect-error Package doesn’t come with types
 import JsonViewer from 'vue-json-viewer'
 
 const value = ref(

packages/openapi-parser/src/utils/dereference.test.ts

@@ -147,7 +147,6 @@ it('resolves a simple reference', async () => {
 
   // Original
   expect(
-    // @ts-ignore
     result.specification.paths['/test'].get.responses['200'].content[
       'application/json'
     ].schema,
@@ -157,7 +156,6 @@ it('resolves a simple reference', async () => {
 
   // Resolved references
   expect(
-    // @ts-ignore
     result.schema.paths['/test'].get.responses['200'].content[
       'application/json'
     ].schema,

packages/openapi-parser/src/utils/load/load.test.ts

@@ -137,18 +137,18 @@ describe('load', async () => {
   })
 
   it('loads url', async () => {
-    // @ts-expect-error only partially patched
-    global.fetch = async () => ({
-      text: async () =>
-        stringify({
-          openapi: '3.1.0',
-          info: {
-            title: 'Hello World',
-            version: '1.0.0',
-          },
-          paths: {},
-        }),
-    })
+    global.fetch = async () =>
+      ({
+        text: async () =>
+          stringify({
+            openapi: '3.1.0',
+            info: {
+              title: 'Hello World',
+              version: '1.0.0',
+            },
+            paths: {},
+          }),
+      }) as Response
 
     const { filesystem } = await load('https://example.com/openapi.yaml', {
       plugins: [readFilesPlugin(), fetchUrlsPlugin()],
@@ -209,12 +209,10 @@ describe('load', async () => {
   })
 
   it('limits the number of requests', async () => {
-    // @ts-expect-error only partially patched
-    global.fetch = async () => {
-      return {
+    global.fetch = async () =>
+      ({
         text: async () => 'FOOBAR',
-      }
-    }
+      }) as unknown as Response
 
     const { filesystem } = await load(
       {
@@ -252,7 +250,6 @@ describe('load', async () => {
   })
 
   it('loads referenced urls', async () => {
-    // @ts-expect-error only partially patched
     global.fetch = async (url: string) => {
       if (url === 'https://example.com/openapi.yaml') {
         return {
@@ -273,7 +270,7 @@ describe('load', async () => {
                 },
               },
             }),
-        }
+        } as Response
       }
 
       if (url === 'https://example.com/foobar.json') {
@@ -289,7 +286,7 @@ describe('load', async () => {
                 },
               },
             }),
-        }
+        } as Response
       }
     }
 
@@ -327,8 +324,7 @@ describe('load', async () => {
   })
 
   it('loads string with url reference', async () => {
-    // @ts-expect-error only partially patched
-    global.fetch = async (url: string) => {
+    global.fetch = async () => {
       return {
         text: async () =>
           JSON.stringify({
@@ -341,7 +337,7 @@ describe('load', async () => {
               },
             },
           }),
-      }
+      } as Response
     }
 
     const { filesystem } = await load(

packages/openapi-parser/src/utils/load/plugins/fetchUrlsPlugin.test.ts

@@ -26,16 +26,16 @@ describe('fetchUrlsPlugin', async () => {
   })
 
   it('fetches the URL', async () => {
-    // @ts-expect-error only partially patched
-    global.fetch = async (url: string) => ({
-      text: async () => {
-        if (url === 'http://example.com/specification/openapi.yaml') {
-          return 'OK'
-        }
+    global.fetch = async (url: string) =>
+      ({
+        text: async () => {
+          if (url === 'http://example.com/specification/openapi.yaml') {
+            return 'OK'
+          }
 
-        throw new Error('Not found')
-      },
-    })
+          throw new Error('Not found')
+        },
+      }) as Response
 
     expect(
       await fetchUrlsPlugin().get(
@@ -45,16 +45,16 @@ describe('fetchUrlsPlugin', async () => {
   })
 
   it('rewrites the URL', async () => {
-    // @ts-expect-error only partially patched
-    global.fetch = async (url: string) => ({
-      text: async () => {
-        if (url === 'http://foobar.com/specification/openapi.yaml') {
-          return 'OK'
-        }
+    global.fetch = async (url: string) =>
+      ({
+        text: async () => {
+          if (url === 'http://foobar.com/specification/openapi.yaml') {
+            return 'OK'
+          }
 
-        throw new Error('Not found')
-      },
-    })
+          throw new Error('Not found')
+        },
+      }) as Response
 
     expect(
       await fetchUrlsPlugin({

packages/openapi-parser/src/utils/resolveReferences.test.ts

@@ -375,7 +375,6 @@ describe('resolveReferences', () => {
     const { schema } = resolveReferences(specification)
 
     // Assertion
-    // @ts-ignore
     expect(schema.swagger).toBe('2.0')
     expect(
       schema.paths['/foobar'].post.responses[200].schema.properties.dictionaries
@@ -519,7 +518,6 @@ describe('resolveReferences', () => {
     const { schema } = resolveReferences(filesystem)
 
     expect(
-      // @ts-ignore
       schema.paths['/foobar'].post.requestBody.content['application/json']
         .schema.example,
     ).toBe('foobar')
@@ -572,7 +570,6 @@ describe('resolveReferences', () => {
 
     const { schema } = resolveReferences(filesystem)
     expect(
-      // @ts-ignore
       schema.paths['/foobar'].post.requestBody.content['application/json']
         .schema.example,
     ).toBe('foobar')
@@ -634,7 +631,6 @@ describe('resolveReferences', () => {
 
     const { schema } = resolveReferences(filesystem)
     expect(
-      // @ts-ignore
       schema.paths['/foobar'].post.requestBody.content['application/json']
         .schema.example,
     ).toBe('foobar')

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

@@ -59,17 +59,16 @@ export function upgradeFromThreeToThreeOne(specification: AnyObject) {
   // Multipart file uploads with a binary file
   specification = traverse(specification, (schema) => {
     if (schema.type === 'object' && schema.properties !== undefined) {
-      for (const [_, value] of Object.entries(schema.properties)) {
+      // Types
+      const entries: [string, any][] = Object.entries(schema.properties)
+
+      for (const [_, value] of entries) {
         if (
-          value !== undefined &&
-          // @ts-ignore
+          typeof value === 'object' &&
           value.type === 'string' &&
-          // @ts-ignore
           value.format === 'binary'
         ) {
-          // @ts-ignore
           value.contentEncoding = 'application/octet-stream'
-          // @ts-ignore
           delete value.format
         }
       }

packages/openapi-parser/tests/openapi3-examples/3.0/fail/schemaProperties.test.ts

@@ -11,7 +11,6 @@ describe('schemaProperties', () => {
 
     expect(errors).not.toBe(undefined)
     expect(errors).not.toStrictEqual([])
-    // @ts-ignore
     expect(errors[0]?.message).toBe(
       'Can’t resolve external reference: ../resources/myobject.yml',
     )

packages/openapi-parser/tests/openapi3-examples/3.0/pass/cyclical.test.ts

@@ -46,10 +46,9 @@ describe('cyclical', () => {
     )
     const category =
       result.schema.components.schemas.top.properties.cat.properties
-    expect(
-      // @ts-ignore
-      category.subcategories.items.properties.subcategories.type,
-    ).toEqual('array')
+    expect(category.subcategories.items.properties.subcategories.type).toEqual(
+      'array',
+    )
   })
 
   it.todo('resolves circular dependencies in referenced files', async () => {