feat!: new @scalar/openapi-types package (#175)

* feat: add new @scalar/openapi-types package

* docs(changeset): feat: new @scalar/openapi-types package

* chore: reset version

* chore: clean up, add type tests

* chore: mark @scalar/openapi-types as external

* test: add custom extensions

Author: hanspagel

.changeset/rude-rivers-smell.md

@@ -0,0 +1,6 @@
+---
+'@scalar/openapi-parser': minor
+'@scalar/openapi-types': minor
+---
+
+feat: new @scalar/openapi-types package

README.md

@@ -16,15 +16,9 @@ Modern OpenAPI parser written in TypeScript with support for OpenAPI 3.1, OpenAP
 - [ ] Amazing error output
 - [ ] Support for OpenAPI 4.0 👀
 
-## Limitations
-
-References are hard and the following features aren’t implemented yet (but will be in the future):
-
-- URLs
-
 ## Installation
 
-```
+```bash
 npm add @scalar/openapi-parser
 ```
 
@@ -148,6 +142,29 @@ validate(specification, {
 })
 ```
 
+### TypeScript
+
+If you just look for our types, you can install the package separately:
+
+```bash
+npm add @scalar/openapi-types
+```
+
+And use it like this:
+
+```ts
+import type { OpenAPI } from '@scalar/openapi-types'
+
+const file: OpenAPI.Document = {
+  openapi: '3.1.0',
+  info: {
+    title: 'Hello World',
+    version: '1.0.0',
+  },
+  paths: {},
+}
+```
+
 ### Advanced: URL and file references
 
 You can reference other files, too. To do that, the parser needs to know what files are available.

packages/openapi-parser/README.md

@@ -10,7 +10,7 @@ Modern OpenAPI parser written in TypeScript, with support for Swagger 2.0, OpenA
 
 ## Installation
 
-```
+```bash
 npm add @scalar/openapi-parser
 ```
 

packages/openapi-parser/package.json

@@ -58,7 +58,8 @@
     "rollup": "^4.19.2",
     "rollup-plugin-output-size": "^1.4.1",
     "rollup-plugin-webpack-stats": "^1.0.1",
-    "tinybench": "^2.8.0"
+    "tinybench": "^2.8.0",
+    "@scalar/openapi-types": "workspace:*"
   },
   "dependencies": {
     "ajv": "^8.17.1",