@scalar/openapi-parser 0.22.3 → 0.23.0

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @scalar/openapi-parser
 
+## 0.23.0
+
+### Minor Changes
+
+- [#7121](https://github.com/scalar/scalar/pull/7121) [`9661e81`](https://github.com/scalar/scalar/commit/9661e81907d1a9b74ba30f270f2d6c8e49834cd5) Thanks [@marcalexiei](https://github.com/marcalexiei)! - feat(oas-utils): make `dereference` synchronous
+
+- [#7092](https://github.com/scalar/scalar/pull/7092) [`134ff5f`](https://github.com/scalar/scalar/commit/134ff5f32aa6842696bf146c7e0817b1662905eb) Thanks [@baywet](https://github.com/baywet)! - feat - parser - adds support for OpenAPI 3.2.0
+
+### Patch Changes
+
+- [#7116](https://github.com/scalar/scalar/pull/7116) [`2239843`](https://github.com/scalar/scalar/commit/2239843150ed16d1ca35b0b1f8e90cd3e35be7ce) Thanks [@baywet](https://github.com/baywet)! - docs adds a mention that OpenAPI 3.2.0 is now supported
+
+- [#7092](https://github.com/scalar/scalar/pull/7092) [`134ff5f`](https://github.com/scalar/scalar/commit/134ff5f32aa6842696bf146c7e0817b1662905eb) Thanks [@baywet](https://github.com/baywet)! - feat: update OpenAPI 3.0 and 3.1 JSON schemas for validation
+
+- [#7182](https://github.com/scalar/scalar/pull/7182) [`c84b7c5`](https://github.com/scalar/scalar/commit/c84b7c5e81be83dacbdfcbf9cb1e558dfdc3faa1) Thanks [@baywet](https://github.com/baywet)! - [fix] adds missing dereference options export in parser
+
+- [#7094](https://github.com/scalar/scalar/pull/7094) [`eba18d0`](https://github.com/scalar/scalar/commit/eba18d06267a163a8f91396a66f817100ee59461) Thanks [@geoffgscott](https://github.com/geoffgscott)! - Migrate to workspace store as primary source of truth.
+
+- [#7196](https://github.com/scalar/scalar/pull/7196) [`a821986`](https://github.com/scalar/scalar/commit/a821986332141e69d26885b2d2b32eb0c49f416c) Thanks [@marcalexiei](https://github.com/marcalexiei)! - fix(openapi-parser): remove internal unneeded async logic without changing the public API
+
+- [#7149](https://github.com/scalar/scalar/pull/7149) [`e23229d`](https://github.com/scalar/scalar/commit/e23229dfbd9613b5047b28b57901f2fc5a6e33e6) Thanks [@baywet](https://github.com/baywet)! - [docs] updates readme to bundle method and adds migration from load guidance
+
+- Updated dependencies [[`11a6e64`](https://github.com/scalar/scalar/commit/11a6e6405d4f30f001a16d6afda4d2b759c0ed09), [`2239843`](https://github.com/scalar/scalar/commit/2239843150ed16d1ca35b0b1f8e90cd3e35be7ce), [`134ff5f`](https://github.com/scalar/scalar/commit/134ff5f32aa6842696bf146c7e0817b1662905eb), [`6ca835e`](https://github.com/scalar/scalar/commit/6ca835e5afd3e8c603e073e7c83f2cdd961a0f69), [`43bc5e8`](https://github.com/scalar/scalar/commit/43bc5e8b90dc0edf7176d0ddfc64bf3212494458)]:
+  - @scalar/openapi-upgrader@0.1.4
+  - @scalar/openapi-types@0.5.1
+  - @scalar/json-magic@0.7.0
+
 ## 0.22.3
 
 ### Patch Changes

package/README.md

@@ -5,7 +5,7 @@
 [![License](https://img.shields.io/npm/l/%40scalar%2Fopenapi-parser)](https://www.npmjs.com/package/@scalar/openapi-parser)
 [![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)
 
-Modern OpenAPI parser written in TypeScript with support for OpenAPI 3.1, OpenAPI 3.0 and Swagger 2.0.
+Modern OpenAPI parser written in TypeScript with support for OpenAPI 3.2, 3.1, 3.0 and Swagger 2.0.
 
 ## Installation
 
@@ -180,12 +180,13 @@ const file: OpenAPI.Document = {
 You can reference other files, too. To do that, the parser needs to know what files are available.
 
 ```ts
-import { dereference, load } from '@scalar/openapi-parser'
-import { fetchUrls } from '@scalar/openapi-parser/plugins/fetch-urls'
-import { readFiles } from '@scalar/openapi-parser/plugins/read-files'
+import { bundle } from "@scalar/json-magic/bundle"
+import { fetchUrls } from "@scalar/json-magic/bundle/plugins/browser"
+import { readFiles } from "@scalar/json-magic/bundle/plugins/node"
+import { dereference } from '@scalar/openapi-parser'
 
 // Load a file and all referenced files
-const { filesystem } = await load('./openapi.yaml', {
+const data = await bundle('./openapi.yaml', {
   plugins: [
     readFiles(),
     fetchUrls({
@@ -194,25 +195,27 @@ const { filesystem } = await load('./openapi.yaml', {
   ],
 })
 
-// Instead of just passing a single specification, pass the whole “filesystem”
-const result = await dereference(filesystem)
+// Instead of just passing a single specification, pass the whole data object
+const result = await dereference(data)
 ```
 
-As you see, `load()` supports plugins. You can write your own plugin, if you'd like to fetch API defintions from another data source, for example your database. Look at the source code of the `readFiles` to learn how this could look like.
+As you see, `bundle()` supports plugins. You can write your own plugin, if you'd like to fetch API definitions from another data source, for example your database. Look at the source code of the `readFiles` to learn how this could look like.
 
 #### Directly load URLs
 
 Once the `fetchUrls` plugin is loaded, you can also just pass an URL:
 
 ```ts
-import { dereference, load } from '@scalar/openapi-parser'
-import { fetchUrls } from '@scalar/openapi-parser/plugins/fetch-urls'
+import { bundle } from "@scalar/json-magic/bundle"
+import { fetchUrls, parseJson, parseYaml } from "@scalar/json-magic/bundle/plugins/browser"
+import { readFiles } from "@scalar/json-magic/bundle/plugins/node"
+import { dereference } from '@scalar/openapi-parser'
 
 // Load a file and all referenced files
-const { filesystem } = await load(
+const data = await bundle(
   'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=yaml',
   {
-    plugins: [fetchUrls()],
+    plugins: [readFiles(), fetchUrls(), parseYaml(), parseJson()],
   },
 )
 ```
@@ -222,11 +225,39 @@ const { filesystem } = await load(
 If you're using the package in a browser environment, you may run into CORS issues when fetching from URLs. You can intercept the requests, for example to use a proxy, though:
 
 ```ts
-import { dereference, load } from '@scalar/openapi-parser'
-import { fetchUrls } from '@scalar/openapi-parser/plugins/fetch-urls'
+import { bundle } from "@scalar/json-magic/bundle"
+import { fetchUrls, parseJson, parseYaml } from "@scalar/json-magic/bundle/plugins/browser"
+import { readFiles } from "@scalar/json-magic/bundle/plugins/node"
+import { dereference } from '@scalar/openapi-parser'
+
+// Load a file and all referenced files
+const result = await bundle(
+  'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=yaml',
+  {
+    plugins: [
+      fetchUrls({
+        fetch: (url) => fetch(url.replace('BANANA.net', 'jsdelivr.net')),
+      }).get('https://cdn.BANANA.net/npm/@scalar/galaxy/dist/latest.yaml'),
+    ],
+  },
+)
+```
+
+#### Migration from the load method
+
+If you were previously using the `load()` method and want to migrate to the latest bundle method, the following diff illustrates the changes to apply.
+
+```diff
+-import { dereference, load } from '@scalar/openapi-parser'
+-import { fetchUrls } from '@scalar/openapi-parser/plugins/fetch-urls'
++import { bundle } from "@scalar/json-magic/bundle"
++import { fetchUrls, parseJson, parseYaml } from "@scalar/json-magic/bundle/plugins/browser"
++import { readFiles } from "@scalar/json-magic/bundle/plugins/node"
++import { dereference } from '@scalar/openapi-parser'
 
 // Load a file and all referenced files
-const { filesystem } = await load(
+-const { filesystem } = await load(
++const result = await bundle(
   'https://registry.scalar.com/@scalar/apis/galaxy/latest?format=yaml',
   {
     plugins: [
@@ -242,14 +273,15 @@ const { filesystem } = await load(
 
 We are API nerds. You too? Let's chat on Discord: <https://discord.gg/scalar>
 
-## Thank you!
+## Thank you
 
 Thanks a ton for all the help and inspiration:
 
 - [@philsturgeon](https://github.com/philsturgeon) to make sure we build something we won't hate.
 - We took a lot of inspiration from [@seriousme](https://github.com/seriousme) and his package [openapi-schema-validator](https://github.com/seriousme/openapi-schema-validator) early-on.
 - You could consider this package the modern successor of [@apidevtools/swagger-parser](https://github.com/APIDevTools/swagger-parser), we even test against it to make sure we're getting the same results (where intended).
-- We stole a lot of example specification from [@mermade](https://github.com/mermade) to test against.
+- We stole a lot of example documents from [@mermade](https://github.com/mermade) to test against.
+- Thanks [@baywet](https://github.com/baywet) for adding OpenAPI 3.2 support.
 
 ## License