[openapi-metadata] Support for CommonJS

[acs]

Description

Hi team!

We are trying to use openapi-metadata in a large TypeScript project which is based on CommonJS (we plan to migrate to ESM at some point but not yet). It seems that openapi-metadata does not support CommonJS (the TS compiler suggest to change 'moduleResolution' setting 'node16', 'nodenext', or 'bundler'.).

Do you plan to support CommonJS in openapi-metadata?

Than you for your effort and time in this great project

-- Alvaro

Proposal

Support CommonJS in openapi-metadata

Extra

• I’m willing to open a PR (see CONTRIBUTING.md)

[kerwanp]

Hi @acs,

You are right openapi-metadata does not support CJS, there is in fact a legacy tsup.config.ts file but is not used anymore. We are directly using tsc.

I've opened a pull-request #2115. It would be great if you could build the library yourself and tell me if everything works as intended!

[acs]

Thanks guys! I have seen that this is already included in 0.2.0. We have added a task for testing it in Feb. I will report the results here. We are in a MVP testing tsoc and openapi-metadata for a large TS project.

[acs]

@kerwanp trying to use openapi-metadata importing it with CommonJS we get the error:

Uncaught Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: 
	Package subpath './dist/decorators' is not defined by "exports" in 
		/Users/acs/devel/backend/node_modules/openapi-metadata/package.json

[kerwanp]

@acs could you show me your require ?
It seems you are trying to import decorators using ./dist/decorators where it should just be ./decorators.

// Not good
const { ApiOperation } = require('openapi-metadata/dist/decorators')

// Good
const { ApiOperation } = require('openapi-metadata/decorators')

[acs]

@kerwanp I am sorry about the delay. let me recheck how we are importing ApiOperation.

import { ApiOperation } from 'openapi-metadata/dist/decorators';

Ups, pretty strange we do it that way! Maybe the IDE (WebStorm) suggested that for some reason. Yes, it is Webstorm which suggests importing it that way in our Typescript code.

If I try to import the library as:

import { ApiOperation } from 'openapi-metadata/decorators';

the module can not be found. The error message is:

src/infrastructure/controllers/company-controllers/company-employee-off-boarding-controller.ts:11:30 - error TS2307: Cannot find module 'openapi-metadata/decorators' or its corresponding type declarations.
  There are types at '/Users/acs/devel/backend/node_modules/openapi-metadata/dist/decorators/index.d.mts', but this result could not be resolved under your current 'moduleResolution' setting. Consider updating to 'node16', 'nodenext', or 'bundler'.

The version installed is:

~/devel/backend git:[BI-8440]
npm list | grep openapi
├── [email protected]