feat(openapi-metadata): Update Scalar UI integration and add Scalar UI configuration options

[Ackuq]

Changes

This updates the Scalar UI integration to follow the default implementation from Scalar: https://guides.scalar.com/scalar/scalar-api-references/integrations/htmljs.

This also adds an optional configuration option when generating the UI, to e.g. customize theme or proxy.

How to Review

Simplest way to try this out is to locally link with a bare-bones service, e.g. an Express service and try out the options.

import express from "express";
import { generateScalarUI } from "openapi-metadata/ui";

const app = express();

app.get("/scalar", async (_req, res) => {
  const ui = generateScalarUI(
    "https://petstore3.swagger.io/api/v3/openapi.json",
    {
      theme: "kepler",
      hideModels: true,
      hideDarkModeToggle: true,
    }
  );
  res.send(ui);
});

app.listen("3000", () => {
  console.log(`Server is running on port 3000`);
});

Checklist

• Unit tests updated
• docs/ updated (if necessary)
• pnpm run update:examples run (only applicable for openapi-typescript)

[changeset-bot]

🦋 Changeset detected

Latest commit: fb57390

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

This PR includes changesets to release 1 package

Name	Type
openapi-metadata	Patch

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

[netlify]

❌ Deploy Preview for openapi-ts failed.

Name	Link
🔨 Latest commit	8ba731d
🔍 Latest deploy log	https://app.netlify.com/projects/openapi-ts/deploys/68a1b9b5a823080008d3f7dd

[drwpow]

Thanks for contributing, but unfortunately we won’t be releasing future versions of openapi-metadata as discussed on our roadmap. The TL;DR is we’re spread too thin to give this library the time and attention it needs. So with no releases planned, I’ll have to close this PR.

That said, this is MIT code! You can fork the existing copy, release your own version, etc. But unfortunately this maintainer team for now has to focus on upholding one good library instead of too many half-baked ones.