chore: reduce bundle size

.changeset/strong-students-act.md

@@ -0,0 +1,5 @@
+---
+'@scalar/openapi-parser': patch
+---
+
+chore: reduce bundle size

demo/src/App.vue

@@ -1,5 +1,10 @@
 <script setup lang="ts">
-import { fetchUrlsPlugin, openapi } from '@scalar/openapi-parser'
+import {
+  dereference,
+  fetchUrlsPlugin,
+  load,
+  toJson,
+} from '@scalar/openapi-parser'
 import { watchDebounced } from '@vueuse/core'
 import { onMounted, ref, watch } from 'vue'
 
@@ -47,14 +52,14 @@ watch(value, async (newValue) => {
 watchDebounced(
   value,
   async (newValue) => {
-    result.value = (
-      await openapi()
-        .load(newValue, {
-          plugins: [fetchUrlsPlugin()],
-        })
-        .dereference()
-        .get()
-    )?.schema
+    const content = await load(newValue, {
+      plugins: [fetchUrlsPlugin()],
+    })
+    const { schema } = await dereference(content)
+
+    if (schema) {
+      result.value = toJson(schema)
+    }
   },
   {
     debounce: 500,

packages/openapi-parser/package.json

@@ -45,7 +45,6 @@
     "@types/node": "^20.12.12"
   },
   "dependencies": {
-    "@humanwhocodes/momoa": "^3.0.2",
     "ajv": "^8.13.0",
     "ajv-draft-04": "^1.0.0",
     "ajv-formats": "^3.0.1",

packages/openapi-parser/src/configuration.ts

@@ -1,6 +1,3 @@
-import Ajv04 from 'ajv-draft-04'
-import Ajv2020 from 'ajv/dist/2020'
-
 import Swagger20 from '../schemas/v2.0/schema.json'
 import OpenApi30 from '../schemas/v3.0/schema.json'
 import OpenApi31 from '../schemas/v3.1/schema.json'
@@ -20,14 +17,6 @@ export const OpenApiVersions = Object.keys(
   OpenApiSpecifications,
 ) as OpenApiVersion[]
 
-/**
- * Configure available JSON Schema versions
- */
-export const jsonSchemaVersions = {
-  'http://json-schema.org/draft-04/schema#': Ajv04,
-  'https://json-schema.org/draft/2020-12/schema': Ajv2020,
-}
-
 /**
  * List of error messages used in the Validator
  */

packages/openapi-parser/src/lib/Validator/Validator.ts

@@ -1,17 +1,26 @@
+import Ajv04 from 'ajv-draft-04'
 import addFormats from 'ajv-formats'
+import Ajv2020 from 'ajv/dist/2020'
 
 import {
   ERRORS,
   OpenApiSpecifications,
   type OpenApiVersion,
   OpenApiVersions,
-  jsonSchemaVersions,
 } from '../../configuration'
 import type { AnyObject, Filesystem, ValidateResult } from '../../types'
 import { details as getOpenApiVersion } from '../../utils'
 import { resolveReferences } from '../../utils/resolveReferences'
 import { transformErrors } from '../../utils/transformErrors'
 
+/**
+ * Configure available JSON Schema versions
+ */
+export const jsonSchemaVersions = {
+  'http://json-schema.org/draft-04/schema#': Ajv04,
+  'https://json-schema.org/draft/2020-12/schema': Ajv2020,
+}
+
 export class Validator {
   public version: string
 

packages/openapi-parser/src/pipeline.test.ts

@@ -1,6 +1,6 @@
 import { join } from 'node:path'
 import { describe, expect, it } from 'vitest'
-import YAML from 'yaml'
+import { stringify } from 'yaml'
 
 import { openapi } from '.'
 import { readFilesPlugin } from './utils/load/plugins/readFilesPlugin'
@@ -271,7 +271,7 @@ describe('pipeline', () => {
   it('toYaml', async () => {
     const result = await openapi().load(specification).toYaml()
 
-    expect(result).toBe(YAML.stringify(specification))
+    expect(result).toBe(stringify(specification))
   })
 
   it('dereference', async () => {

packages/openapi-parser/src/utils/betterAjvErrors/index.ts

@@ -1,5 +1,3 @@
-import { parse } from '@humanwhocodes/momoa'
-
 import prettify from './helpers'
 
 type BetterAjvErrorsOptions = {
@@ -28,13 +26,11 @@ export function betterAjvErrors(
   const { indent = null, json = null } = options
 
   const jsonRaw = json || JSON.stringify(data, null, indent)
-  const jsonAst = parse(jsonRaw)
 
   const customErrorToStructure = (error) => error.getError()
   const customErrors = prettify(errors, {
     data,
     schema,
-    jsonAst,
     jsonRaw,
   })
 

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

@@ -1,4 +1,4 @@
-import YAML from 'yaml'
+import { parse } from 'yaml'
 
 export function isYaml(value: string) {
   // Line breaks
@@ -7,7 +7,7 @@ export function isYaml(value: string) {
   }
 
   try {
-    YAML.parse(value)
+    parse(value)
     return true
   } catch (error) {
     console.log('ADSAS', error)

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

@@ -1,6 +1,6 @@
 import path from 'node:path'
 import { describe, expect, it } from 'vitest'
-import YAML from 'yaml'
+import { stringify } from 'yaml'
 
 import { getEntrypoint } from '../getEntrypoint'
 import { load } from './load'
@@ -60,7 +60,7 @@ describe('load', async () => {
 
   it('loads YAML string', async () => {
     const filesystem = await load(
-      YAML.stringify({
+      stringify({
         openapi: '3.1.0',
         info: {
           title: 'Hello World',
@@ -140,7 +140,7 @@ describe('load', async () => {
     // @ts-expect-error only partially patched
     global.fetch = async () => ({
       text: async () =>
-        YAML.stringify({
+        stringify({
           openapi: '3.1.0',
           info: {
             title: 'Hello World',
@@ -257,7 +257,7 @@ describe('load', async () => {
       if (url === 'https://example.com/openapi.yaml') {
         return {
           text: async () =>
-            YAML.stringify({
+            stringify({
               openapi: '3.1.0',
               info: {
                 title: 'Hello World',
@@ -345,7 +345,7 @@ describe('load', async () => {
     }
 
     const filesystem = await load(
-      YAML.stringify({
+      stringify({
         openapi: '3.1.0',
         info: {
           title: 'Hello World',

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

@@ -1,4 +1,4 @@
-import YAML from 'yaml'
+import { parse } from 'yaml'
 
 import { AnyObject, Filesystem } from '../types'
 import { isFilesystem } from './isFilesystem'
@@ -18,7 +18,7 @@ export function normalize(
     try {
       return JSON.parse(specification)
     } catch (error) {
-      return YAML.parse(specification)
+      return parse(specification)
     }
   }
 

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

@@ -1,5 +1,5 @@
-import YAML from 'yaml'
+import { stringify } from 'yaml'
 
 import { AnyObject } from '../types'
 
-export const toYaml = (value: AnyObject) => YAML.stringify(value)
+export const toYaml = (value: AnyObject) => stringify(value)

packages/openapi-parser/vite.config.ts

@@ -12,7 +12,14 @@ export default defineConfig({
       formats: ['es'],
     },
     rollupOptions: {
-      external: [...builtinModules, ...builtinModules.map((m) => `node:${m}`)],
+      external: [
+        ...builtinModules,
+        ...builtinModules.map((m) => `node:${m}`),
+        'ajv/dist/2020',
+        'ajv-draft-04',
+        'ajv-formats',
+        'yaml',
+      ],
     },
   },
   test: {