feat!: new @scalar/openapi-types package

[hanspagel]

We modified and extended the openapi-types package for our use case. We’re basically allowing any user input, but still maintaining the types based on the OpenAPI specification.

With this PR, we’re exposing those types as a separate, dependency-free package called @scalar/openapi-types. Even comes with basic type tests. :)

Note: This is a breaking change. Instead of importing types from @scalar/openapi-parser, users now have to import from @scalar/openapi-types.

Usage

npm add @scalar/openapi-types

And use it like this:

import type { OpenAPI } from '@scalar/openapi-types'

const file: OpenAPI.Document = {
  openapi: '3.1.0',
  info: {
    title: 'Hello World',
    version: '1.0.0',
  },
  paths: {},
}

[changeset-bot]

🦋 Changeset detected

Latest commit: 5c955c8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@scalar/openapi-parser	Minor
@scalar/openapi-types	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[relativeci]

#141 Bundle Size — 74.91KiB (0%).

5c955c8(current) vs aec9f22 main#137(baseline)

Bundle metrics  no changes

	Current #141	Baseline #137
Initial JS	74.91KiB	74.91KiB
Initial CSS	0B	0B
Cache Invalidation	0%	0%
Chunks	45	45
Assets	45	45
Modules	45	45
Duplicate Modules	0	0
Duplicate Code	0%	0%
Packages	0	0
Duplicate Packages	0	0

Bundle size by type  no changes

	Current #141	Baseline #137
JS	74.91KiB	74.91KiB

Bundle analysis report Branch feat/new-types-package Project dashboard

---

^{Generated by RelativeCI Documentation Report issue}

[cloudflare-workers-and-pages]

Deploying openapi-parser with    Cloudflare Pages

Latest commit:	5c955c8
Status:	✅  Deploy successful!
Preview URL:	https://c3e716fd.openapi-parser.pages.dev
Branch Preview URL:	https://feat-new-types-package.openapi-parser.pages.dev

View logs

[amritk]

sick!

[amritk]

hey @hanspagel we are going to move the types into the monorepo so I'll copy them over, then there should be no breaking changes here. We can also just re-export them after for a single source of truth