fix: max call stack exceeded (#116)

* chore: skip if no plugin has been found

* chore: use list of references, if it’s there already

* chore: deal with strange function return

* test: enable max call stack exceeded files

* fix: build

* refactor: define types for a few more utils, rename pipeline to openapi

* refactor: streamline all returns

* docs: update examples

* docs(changeset): refactor!: most functions return an object now

* docs(changeset): fix: max call stack exceeded error

* fix: benchmarks

* chore: clean up

* fix: types

* chore: add alias again, add json viewer component

* chore: allow more alias nodes

* fix: TS issues

Author: hanspagel

.changeset/sweet-mangos-lay.md

@@ -0,0 +1,5 @@
+---
+'@scalar/openapi-parser': minor
+---
+
+refactor!: most functions return an object now

.changeset/young-coins-run.md

@@ -0,0 +1,5 @@
+---
+'@scalar/openapi-parser': patch
+---
+
+fix: max call stack exceeded error

README.md

@@ -44,12 +44,12 @@ const file = `{
   "paths": {}
 }`
 
-const result = await validate(file)
+const { valid, errors } = await validate(file)
 
-console.log(result.valid)
+console.log(valid)
 
-if (!result.valid) {
-  console.log(result.errors)
+if (!valid) {
+  console.log(errors)
 }
 ```
 
@@ -67,7 +67,7 @@ const specification = `{
   "paths": {}
 }`
 
-const result = await dereference(specification)
+const { schema, errors } = await dereference(specification)
 ```
 
 ### Modify an OpenAPI specification
@@ -84,7 +84,7 @@ const specification = `{
   "paths": {}
 }`
 
-const result = filter(specification, (schema) => !schema?.['x-internal'])
+const { specification } = filter(specification, (schema) => !schema?.['x-internal'])
 ```
 
 ### Upgrade your OpenAPI specification
@@ -96,7 +96,7 @@ There’s an `upgrade` command to upgrade all your OpenAPI specifications to the
 ```ts
 import { upgrade } from '@scalar/openapi-parser'
 
-const result = upgrade({
+const { specification } = upgrade({
   openapi: '3.0.0',
   info: {
     title: 'Hello World',
@@ -105,7 +105,7 @@ const result = upgrade({
   paths: {},
 })
 
-console.log(result.openapi)
+console.log(specification.openapi)
 // Output: 3.1.0
 ```
 
@@ -141,7 +141,7 @@ import {
 } from '@scalar/openapi-parser'
 
 // Load a file and all referenced files
-const filesystem = await load('./openapi.yaml', {
+const { filesystem } = await load('./openapi.yaml', {
   plugins: [readFilesPlugin(), fetchUrlsPlugin()],
 })
 

demo/package.json

@@ -17,6 +17,7 @@
     "@vitejs/plugin-vue": "^5.0.5",
     "typescript": "^5.2.2",
     "vite": "^5.2.12",
+    "vue-json-viewer": "3",
     "vue-tsc": "^2.0.19"
   }
 }

demo/src/App.vue

@@ -1,12 +1,9 @@
 <script setup lang="ts">
-import {
-  dereference,
-  fetchUrlsPlugin,
-  load,
-  toJson, // validate,
-} from '@scalar/openapi-parser'
+import { dereference, fetchUrlsPlugin, load } from '@scalar/openapi-parser'
 import { watchDebounced } from '@vueuse/core'
 import { onMounted, ref, watch } from 'vue'
+// @ts-ignore
+import JsonViewer from 'vue-json-viewer'
 
 const value = ref(
   JSON.stringify(
@@ -35,7 +32,7 @@ const value = ref(
   ),
 )
 
-const result = ref('')
+const result = ref({})
 
 onMounted(() => {
   const savedValue = window.localStorage.getItem('value')
@@ -52,16 +49,14 @@ watch(value, async (newValue) => {
 watchDebounced(
   value,
   async (newValue) => {
-    const content = await load(newValue, {
+    const { filesystem } = await load(newValue, {
       plugins: [fetchUrlsPlugin()],
     })
 
-    // console.log(await validate(content))
-
-    const { schema } = await dereference(content)
+    const { schema } = await dereference(filesystem)
 
     if (schema) {
-      result.value = toJson(schema)
+      result.value = schema
     }
   },
   {
@@ -84,7 +79,9 @@ watchDebounced(
         v-model="value" />
     </div>
     <div class="preview-right">
-      <pre id="output">{{ result }}</pre>
+      <json-viewer
+        :value="result"
+        :expand-depth="3"></json-viewer>
     </div>
   </div>
 </template>
@@ -110,11 +107,9 @@ watchDebounced(
   width: 50%;
   height: 100%;
   font-size: 1rem;
-  padding: 20px;
   border-radius: 5px;
-  background: #000;
-  color: #fff;
   overflow: auto;
+  border: 1px solid #ccc;
 }
 
 textarea {
@@ -125,13 +120,18 @@ textarea {
   resize: none;
   padding: 0;
   margin: 0;
-  font-size: 1rem;
+  font-size: 0.9rem;
+  line-height: 1.4;
   font-family: monospace;
   border: 1px solid #ccc;
-  padding: 20px;
+  padding: 15px 20px;
   border-radius: 5px;
 }
 
+.jv-container .jv-code {
+  padding: 20px;
+}
+
 pre {
   margin: 0;
 }

demo/vite.config.ts

@@ -11,20 +11,20 @@ export default defineConfig({
   //     external: [...builtinModules, ...builtinModules.map((m) => `node:${m}`)],
   //   },
   // },
-  // resolve: {
-  //   alias: [
-  //     // Resolve the uncompiled source code for all @scalar packages
-  //     // It’s working with the alias, too. It’s just required to enable HMR.
-  //     // It also does not match components since we want the built version
-  //     {
-  //       // Resolve the uncompiled source code for @scalar/openapi-parser packages
-  //       find: '@scalar/openapi-parser',
-  //       replacement: path.resolve(
-  //         __dirname,
-  //         // '../packages/openapi-parser/dist/index.js',
-  //         '../packages/openapi-parser/src/index.ts',
-  //       ),
-  //     },
-  //   ],
-  // },
+  resolve: {
+    alias: [
+      // Resolve the uncompiled source code for all @scalar packages
+      // It’s working with the alias, too. It’s just required to enable HMR.
+      // It also does not match components since we want the built version
+      {
+        // Resolve the uncompiled source code for @scalar/openapi-parser packages
+        find: '@scalar/openapi-parser',
+        replacement: path.resolve(
+          __dirname,
+          // '../packages/openapi-parser/dist/index.js',
+          '../packages/openapi-parser/src/index.ts',
+        ),
+      },
+    ],
+  },
 })

packages/openapi-parser/README.md

@@ -47,12 +47,12 @@ const file = `{
   "paths": {}
 }`
 
-const result = await validate(file)
+const { valid, errors } = await validate(file)
 
-console.log(result.valid)
+console.log(valid)
 
-if (!result.valid) {
-  console.log(result.errors)
+if (!valid) {
+  console.log(errors)
 }
 ```
 
@@ -70,7 +70,7 @@ const file = `{
   "paths": {}
 }`
 
-const result = await dereference(file)
+const { version } = await dereference(file)
 
-console.log(result.version)
+console.log(version)
 ```