Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/antongolub/nestjs-esm-fix
Patch Nestjs app ESM bundles to make them work RHRN
https://github.com/antongolub/nestjs-esm-fix
esbuild esm nestjs tsc
Last synced: 2 months ago
JSON representation
Patch Nestjs app ESM bundles to make them work RHRN
- Host: GitHub
- URL: https://github.com/antongolub/nestjs-esm-fix
- Owner: antongolub
- License: mit
- Created: 2022-08-15T13:18:03.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-08-30T09:31:06.000Z (over 1 year ago)
- Last Synced: 2024-11-01T13:34:33.569Z (2 months ago)
- Topics: esbuild, esm, nestjs, tsc
- Language: JavaScript
- Homepage:
- Size: 156 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# nestjs-esm-fix
[](https://github.com/antongolub/nestjs-esm-fix/actions/workflows/ci.yaml)
[](https://codeclimate.com/github/antongolub/nestjs-esm-fix/maintainability)
[](https://codeclimate.com/github/antongolub/nestjs-esm-fix/test_coverage)
[](https://www.npmjs.com/package/nestjs-esm-fix)
> Patch [Nestjs](https://github.com/nestjs/nest) app ESM bundles to make them work RHRN
> ⚠️ This is a temporary solution until Nestjs is fixed
## Stack
* [Nestjs 9.x](https://github.com/nestjs/nest). _10.x and above were not tested at all_
* [esbuild 0.15.x](https://github.com/evanw/esbuild)
## Problems
> https://github.com/nestjs/nest-cli/issues/1157
> https://github.com/nestjs/swagger/issues/1450
> https://github.com/evanw/esbuild/pull/509
> https://github.com/evanw/esbuild/issues/566
1. `openapi` is not defined. https://github.com/nestjs/swagger/issues/1450
```js
__decorate([
Post('event-unsafe-batch'),
HttpCode(200),
openapi.ApiResponse({ status: 200, type: String }),
__param(0, Body()),
__param(1, Req()),
__metadata("design:type", Function),
__metadata("design:paramtypes", [Object, Object]),
__metadata("design:returntype", Promise)
], EventUnsafeController.prototype, "logEventBatch", null);
```
2. openapi / class-validator DTOs are referenced by `require` API. https://github.com/microsoft/TypeScript/issues/43329
```js
export class CspReportDto {
static _OPENAPI_METADATA_FACTORY() {
return { timestamp: { required: false, type: () => Object }, 'csp-report': { required: true, type: () => require("./csp.dto.js").CspReport } };
}
}
```
3. NodeJS builtins are referenced via `require` API.
```js
var require_async4 = __commonJS({
"node_modules/resolve/lib/async.js"(exports, module2) {
var fs2 = require("fs");
```
4. esbuild-compiled ESM bundle cannot refer to `views/redoc.handlebars`
```js
const redocFilePath = path_1.default.join(__dirname, "..", "views", "redoc.handlebars");
```
5. `_OPENAPI_METADATA_FACTORY` class fields may be empty, so the swagger declaration cannot be properly rendered.
```js
var Meta = class {
};
// →
var Meta = class {
static _OPENAPI_METADATA_FACTORY() {
return { appName: { required: false, type: () => String }, appHost: { required: false, type: () => String }, appVersion: { required: false, type: () => String }, appNamespace: { required: false, type: () => String }, appConfig: { required: false, type: () => typeof (_a3 = typeof Record !== "undefined" && Record) === "function" ? _a3 : Object }, deviceInfo: { required: false, type: () => typeof (_b3 = typeof Record !== "undefined" && Record) === "function" ? _b3 : Object }, userAgent: { required: false, type: () => String }, envProfile: { required: false, enum: typeof (_c = typeof import_substrate2.EnvironmentProfile !== "undefined" && import_substrate2.EnvironmentProfile) === "function" ? _c : Object } }
}
};
```
6. Extra type wrappers cannot be processed by openapi / `class-validator` / `class-transformer`
```js
__metadata("design:type", typeof (_d = typeof Array !== "undefined" && Array) === "function" ? _d : Object)
__metadata("design:type", typeof (_e = typeof import_substrate2.LogLevel !== "undefined" && import_substrate2.LogLevel) === "function" ? _e : Object)
// →
__metadata("design:type", Array)
__metadata("design:type", import_substrate2.LogLevel)
```
## Solution
Old good monkey patching.
## Install
```bash
yarn add -D nestjs-esm-fix
```
## Usage
### CLI
```bash
nestjs-esm-fix target/**/*.js
nestjs-esm-fix --target=target/**/*.js
nestjs-esm-fix --target=**/* --cwd=target
```
| Option | Description | Default |
|---------------------------|------------------------------------------------------------------------------------------------------------------------|-----------------|
| `--target` | Pattern to match files to fix. | `**/*` |
| `--cwd` | Current working dir. | `process.cwd()` |
| `--openapi-complex-types` | Simplify `__metadata("design:type")` declarations. | `true` |
| `--openapi-meta` | Restore `static OPENAPI_METADATA_FACTORY` if missing. | `true` |
| `--openapi-var` | Inject openapi variable. Set `--no-openapi-var` to disable. | `true` |
| `--dirname-var` | Inject `__dirname` and `__filename` polyfills. | `true` |
| `--importify` | Replace `require` with `import` API for Nodejs builtins. Replace `type: () => require(smth)` statements with `import`. | `true` |
| `--require-main` | Inject `main` field for `require` API polyfill. | `true` |
| `--redoc-tpl` | Inject `redoc.hbs` templates. | `true` |
### JS API
```js
import { fix } from 'nestjs-esm-fix'
await fix({
cwd: '.',
target: 'target/**/*.js',
openapiComplexTypes: true,
openapiVar: true,
openapiMeta: true,
dirnameVar: true,
importify: true,
requireMain: true,
redocTpl: true
})
```
## License
[MIT](./LICENSE)