Consider turning public API synchronous and splitting away Node.js specific functionality

[segevfiner]

Turning the core library into pure JS that can be safely used in browser or Node.js without polyfills or warnings. Keeping Node.js functionality to a separate export or to the CLI only.

This can also possibly make the API synchronous, which will make it easier to use in some places.

[thim81]

hi @segevfiner,

Since we are reading/writing YAML files, I though it was required make the API async.
I assume you want to use OpenAPI-format as a library in an NodeJS or browser setup?

Would you recommend converting the project to Typescript codebase? Would that make things easier?

[segevfiner]

I just wanted to integrate it with Fastify swagger plugins, but the callback there are synchronous.

The actual logic is synchronous, it's just the file reading stuff that isn't so I thought it might be possible to split stuff around so we can get synchronous functions and separate async ones that support reading files.

[segevfiner]

Kinda what I thought is having the first entry point openapi-format have pure synchronous functions that can be freely used in Browser or Node.js, and don't depend on any Node.js, or brower functionality. And the existing Node.js/async functionality moved to another entrypoint openapi-format/node that wraps the main openapi-format. Multiple exports can be achieved cleanly today in Node.js and browser bundlers using the package.json exports field.