Resolving SyntaxError When Integrating MikroORM with NextJS
Challenge Encountered
While attempting to incorporate MikroORM v6.3.13 into a NextJS v14.2.14 project, I encountered a critical issue. At this point, my primary goal is to establish the setup correctly. To begin, I created a basic API where I aim to populate the SectionEntity:
export const dynamic = "force-dynamic";
export async function GET() {
const orm = await MikroORM.init(config);
const em = orm.em.fork();
try {
const section = new SectionEntity();
section.locale = "en";
section.page = "test";
section.type = "form";
section.key = "test_section";
await em.persistAndFlush(section);
console.log(section.createdAt);
return NextResponse.json("SUCCESS", { status: 200 });
} catch (error) {
return NextResponse.json({ error: `${error}` }, { status: 500 });
}
}
The specific error I'm facing is as follows:
import { Entity, PrimaryKey, Property, ManyToOne, type Rel } from "@mikro-orm/core";
SyntaxError: Cannot use import statement outside a module
at internalCompileFunction (node:internal/vm:128:18)
...
Upon verification, my mikro-orm configuration appears functional when executing npx mikro-orm-esm debug:
Current MikroORM CLI configuration
- dependencies:
...
Defining Entities
Here are the defined entities located in the folder ./server/entities:
import { Entity, PrimaryKey, Property, OneToMany, Collection } from "@mikro-orm/core";
...
Project TypeScript Configuration
In light of similar issues reported with MikroORM and NextJS, I explored potential solutions. Despite testing various remedies, none were effective or potentially broke other aspects of the project. Suggestions included adding
"type": "module"This represents my current tsconfig:
{
"compilerOptions": {
...
},
"include": [...],
"exclude": ["node_modules"]
}
In addressing this issue, I reviewed outdated solutions primarily focusing on NextJs implementations using pages router.
Resources Consulted:
- MikroORM Documentation
- GitHub Issue Thread
- NextJS Example from Documentation