feat: Export ./oas30 and ./oas31

[koooge]

Hi there, this is a proposal for import syntax for compatibility with v3 code. It is helpful since we can upgrade openapi3-ts without code changes like oas31.OpenAPIObject.

// Both are ok
import { oas31 } from 'openapi3-ts';
import { OpenAPIObject, OpenApiBuilder } from 'openapi3-ts/oas31';

Also, it would fix #107

[RobinTail]

it does not work with ESM now

SyntaxError: Named export 'oas30' not found. The requested module 'openapi3-ts' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export, for example using:

[RobinTail]

Not sure why, but such imports are not appreciated by Typescript, however they are operational if ignored. ¯_(ツ)_/¯

[RobinTail]

No, actually my build fails to make DTS with such imports

src/open-api.ts(8,8): error TS2307: Cannot find module 'openapi3-ts/oas30' or its corresponding type declarations.
Error: error occured in dts build
DTS Build error
RollupError: Failed to compile. Check the logs above.

[RobinTail]

Something is not right with it.

[koooge]

Ah, I guess your tsconfig.json has moduleResolution: "node" which cannot resolve the exports field. As one option, node16 would work tho.

[RobinTail]

It is.
Could you tell me please, @koooge , does it mean, that the minimum Node version of my package (that depends on openapi3-ts) should be upgraded from 14 to 16 ?

[koooge]

I would say node version does not matter. It is due to the config of typescript. If you use tsc with "moduleResolution": "node" , this approach would not work.

[RobinTail]

Ok. Thank you.
But there is another problem.
Still, my ESM setup does not work with the following error regarding ./oas30 import:

SyntaxError: Named export 'isReferenceObject' not found. The requested module 'openapi3-ts/oas30' is a CommonJS module, which may not support all module.exports as named exports.
CommonJS modules can always be imported via the default export, for example using:

import pkg from 'openapi3-ts/oas30';

I use ts-node-esm command (of ts-node) as a runner.

[RobinTail]

It thinks that /oas30 is CommonJS, @koooge .

It can be fixed by placing package.json file inside ./dist/mjs having {"type": "module"}.

However, it does not end on it. It can not find files being imported by oas30.js withing having .jsextensions in the import statements. I believe the ESM build should actually have the explicitly specified extensions. Probably the ESM compiler need to be configured. CC @pjmolina

However, this is a well-known issue, which I'm not sure what is the right solution to,
microsoft/TypeScript#16577 (comment)

[koooge]

That's because moduleResolution node(=node10) checks "main" in pckage.json. Use "moduleResolution": "node16" or bundler as a workaround. For support tsc, we need to export only "." and create dist/oas30 & dist/oas31 I suppose.