refactor: better decorators interop

docs/Migration to v4.md

@@ -12,10 +12,36 @@ Update dependencies:
 
 | Dependency | Minimal supported version |
 | ---------- | ------------------------- |
-| Node.js    | 18.18.0                   |
+| Node.js    | 20.12.0                   |
 | TypeScript | 5.0.0                     |
 | Fastify    | 4.0.0                     |
 
+### ControllerType was renamed
+
+Replace usages of `ControllerType` with `Scope`:
+
+_before_:
+
+```typescript
+import { Controller, ControllerType } from 'fastify-decorators';
+
+@Controller({
+  route: '/',
+  type: ControllerType.SINGLETON,
+})
+```
+
+_after_:
+
+```typescript
+import { Controller, Scope } from 'fastify-decorators';
+
+@Controller({
+  route: '/',
+  scope: Scope.SINGLETON,
+})
+```
+
 ### Built-in DI was moved to plugin
 
 [`@fastify-decorators/simple-di`]: https://www.npmjs.com/package/@fastify-decorators/simple-di

examples/async-initializer/package.json

@@ -13,16 +13,16 @@
   },
   "dependencies": {
     "@fastify-decorators/simple-di": "^4.0.0-next.5",
-    "fastify": "^4.27.0",
+    "fastify": "^5.0.0",
     "fastify-decorators": "^4.0.0-next.5"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.7",
-    "@types/node": "~18.18.6",
+    "@types/jest": "^29.5.13",
+    "@types/node": "~20.12.14",
     "jest": "^29.7.0",
     "jest-resolve": "^29.7.0",
     "jest-ts-webcompat-resolver": "^1.0.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.6.2"
   },
   "jest-junit": {

examples/async-initializer/tsconfig.base.json

@@ -3,9 +3,10 @@
     /* Visit https://aka.ms/tsconfig.json to read more about this file */
 
     /* Basic Options */
-    "target": "ES2022",
+    "target": "ES2023",
     "module": "ESNext",
     "outDir": "./dist",
+    "lib": ["ES2023"],
 
     /* Strict Type-Checking Options */
     "strict": true,

examples/aws-lambda/package.json

@@ -12,19 +12,19 @@
   },
   "dependencies": {
     "@fastify-decorators/simple-di": "^4.0.0-next.5",
-    "@fastify/aws-lambda": "^4.1.0",
-    "fastify": "^4.27.0",
+    "@fastify/aws-lambda": "^5.0.0",
+    "fastify": "^5.0.0",
     "fastify-decorators": "^4.0.0-next.5"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.7",
-    "@types/node": "~18.18.6",
-    "@vercel/ncc": "^0.38.0",
+    "@types/jest": "^29.5.13",
+    "@types/node": "~20.12.14",
+    "@vercel/ncc": "^0.38.2",
     "cross-env": "^7.0.3",
     "jest": "^29.7.0",
     "jest-resolve": "^29.7.0",
     "jest-ts-webcompat-resolver": "^1.0.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.2.5",
     "tslib": "^2.7.0",
     "typescript": "^5.6.2"
   },

examples/aws-lambda/tsconfig.base.json

@@ -3,9 +3,10 @@
     /* Visit https://aka.ms/tsconfig.json to read more about this file */
 
     /* Basic Options */
-    "target": "ES2022",
+    "target": "ES2023",
     "module": "ESNext",
     "outDir": "./dist",
+    "lib": ["ES2023"],
 
     /* Strict Type-Checking Options */
     "strict": true,

examples/controllers/package.json

@@ -13,7 +13,7 @@
   },
   "dependencies": {
     "@fastify-decorators/simple-di": "^4.0.0-next.5",
-    "fastify": "^4.27.0",
+    "fastify": "^5.0.0",
     "fastify-decorators": "^4.0.0-next.5"
   },
   "devDependencies": {
@@ -22,7 +22,7 @@
     "jest": "^29.7.0",
     "jest-resolve": "^29.7.0",
     "jest-ts-webcompat-resolver": "^1.0.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.6.2",
     "undici": "^6.19.8"
   },

examples/controllers/src/error-handling/stateful.controller.ts

@@ -1,10 +1,10 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, ErrorHandler, GET } from 'fastify-decorators';
+import { Controller, ErrorHandler, GET, Scope } from 'fastify-decorators';
 import { ErrorType } from './error-type.js';
 
 @Controller({
   route: '/stateful/error-handling',
-  type: ControllerType.REQUEST,
+  scope: Scope.SINGLETON,
 })
 export default class StatelessController {
   @GET({

examples/controllers/src/error-handling/stateless.controller.ts

@@ -1,10 +1,10 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, ErrorHandler, GET } from 'fastify-decorators';
+import { Controller, ErrorHandler, GET, Scope } from 'fastify-decorators';
 import { ErrorType } from './error-type.js';
 
 @Controller({
   route: '/stateless/error-handling',
-  type: ControllerType.REQUEST,
+  scope: Scope.PER_REQUEST,
 })
 export default class StatelessController {
   @GET({

examples/controllers/src/hooks/stateful.controller.ts

@@ -1,9 +1,9 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, Hook } from 'fastify-decorators';
+import { Controller, GET, Hook, Scope } from 'fastify-decorators';
 
 @Controller({
   route: '/stateful/hooks',
-  type: ControllerType.SINGLETON,
+  scope: Scope.SINGLETON,
 })
 export default class StatefulController {
   @GET()

examples/controllers/src/hooks/stateless.controller.ts

@@ -1,9 +1,9 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, Hook } from 'fastify-decorators';
+import { Controller, GET, Hook, Scope } from 'fastify-decorators';
 
 @Controller({
   route: '/stateless/hooks',
-  type: ControllerType.REQUEST,
+  scope: Scope.PER_REQUEST,
 })
 export default class StatelessController {
   @GET()

examples/controllers/src/start.ts

@@ -1,9 +1,9 @@
 import { app } from './index.js';
 
-const hostname = '127.0.0.1';
+const host = '127.0.0.1';
 const port = 3003;
 
-app.listen(port, hostname, (error, address) => {
+app.listen({ port, host }, (error, address) => {
   if (error != null) {
     console.error(error);
     process.exit(-1);

examples/controllers/src/states/stateful.controller.ts

@@ -1,12 +1,12 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, POST } from 'fastify-decorators';
+import { Controller, GET, POST, Scope } from 'fastify-decorators';
 
 type State = Record<string, unknown>;
 
 @Controller({
   route: '/stateful',
   // This is default type, just here for consistency with stateless controller
-  type: ControllerType.SINGLETON,
+  scope: Scope.SINGLETON,
 })
 export default class StatefulController {
   private state: State = {};

examples/controllers/src/states/stateless.controller.ts

@@ -1,11 +1,11 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, POST } from 'fastify-decorators';
+import { Controller, GET, POST, Scope } from 'fastify-decorators';
 
 type State = Record<string, unknown>;
 
 @Controller({
   route: '/stateless',
-  type: ControllerType.REQUEST,
+  scope: Scope.PER_REQUEST,
 })
 export default class StatelessController {
   private state: State = {};

examples/controllers/tsconfig.base.json

@@ -3,9 +3,10 @@
     /* Visit https://aka.ms/tsconfig.json to read more about this file */
 
     /* Basic Options */
-    "target": "ES2022",
+    "target": "ES2023",
     "module": "ESNext",
     "outDir": "./dist",
+    "lib": ["ES2023"],
 
     /* Strict Type-Checking Options */
     "strict": true,

examples/ecmascript-decorators/package.json

@@ -12,16 +12,16 @@
     "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules --no-warnings\" jest"
   },
   "dependencies": {
-    "fastify": "^4.27.0",
+    "fastify": "^5.0.0",
     "fastify-decorators": "^4.0.0-next.5"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.7",
-    "@types/node": "~18.18.6",
+    "@types/jest": "^29.5.13",
+    "@types/node": "~20.12.14",
     "jest": "^29.7.0",
     "jest-resolve": "^29.7.0",
     "jest-ts-webcompat-resolver": "^1.0.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.6.2",
     "undici": "^6.19.8"
   },

examples/ecmascript-decorators/src/error-handling/stateful.controller.ts

@@ -1,10 +1,10 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, ErrorHandler, GET } from 'fastify-decorators';
+import { Controller, ErrorHandler, GET, Scope } from 'fastify-decorators';
 import { ErrorType } from './error-type.js';
 
 @Controller({
   route: '/stateful/error-handling',
-  type: ControllerType.REQUEST,
+  scope: Scope.SINGLETON,
 })
 export default class StatelessController {
   @GET({

examples/ecmascript-decorators/src/error-handling/stateless.controller.ts

@@ -1,10 +1,10 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, ErrorHandler, GET } from 'fastify-decorators';
+import { Controller, ErrorHandler, GET, Scope } from 'fastify-decorators';
 import { ErrorType } from './error-type.js';
 
 @Controller({
   route: '/stateless/error-handling',
-  type: ControllerType.REQUEST,
+  scope: Scope.PER_REQUEST,
 })
 export default class StatelessController {
   @GET({

examples/ecmascript-decorators/src/hooks/stateful.controller.ts

@@ -1,9 +1,9 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, Hook } from 'fastify-decorators';
+import { Controller, GET, Hook, Scope } from 'fastify-decorators';
 
 @Controller({
   route: '/stateful/hooks',
-  type: ControllerType.SINGLETON,
+  scope: Scope.SINGLETON,
 })
 export default class StatefulController {
   @GET()

examples/ecmascript-decorators/src/hooks/stateless.controller.ts

@@ -1,9 +1,9 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, Hook } from 'fastify-decorators';
+import { Controller, GET, Hook, Scope } from 'fastify-decorators';
 
 @Controller({
   route: '/stateless/hooks',
-  type: ControllerType.REQUEST,
+  scope: Scope.PER_REQUEST,
 })
 export default class StatelessController {
   @GET()

examples/ecmascript-decorators/src/start.ts

@@ -1,9 +1,9 @@
 import { app } from './index.js';
 
-const hostname = '127.0.0.1';
+const host = '127.0.0.1';
 const port = 3003;
 
-app.listen(port, hostname, (error, address) => {
+app.listen({ port, host }, (error, address) => {
   if (error != null) {
     console.error(error);
     process.exit(-1);

examples/ecmascript-decorators/src/states/stateful.controller.ts

@@ -1,12 +1,12 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, POST } from 'fastify-decorators';
+import { Controller, GET, POST, Scope } from 'fastify-decorators';
 
 type State = Record<string, unknown>;
 
 @Controller({
   route: '/stateful',
   // This is default type, just here for consistency with stateless controller
-  type: ControllerType.SINGLETON,
+  scope: Scope.SINGLETON,
 })
 export default class StatefulController {
   private state: State = {};

examples/ecmascript-decorators/src/states/stateless.controller.ts

@@ -1,11 +1,11 @@
 import { FastifyReply, FastifyRequest } from 'fastify';
-import { Controller, ControllerType, GET, POST } from 'fastify-decorators';
+import { Controller, GET, POST, Scope } from 'fastify-decorators';
 
 type State = Record<string, unknown>;
 
 @Controller({
   route: '/stateless',
-  type: ControllerType.REQUEST,
+  scope: Scope.PER_REQUEST,
 })
 export default class StatelessController {
   private state: State = {};

examples/ecmascript-decorators/test/unit/user.controller.test.ts

@@ -1,13 +1,14 @@
-import { FastifyInstance } from 'fastify';
-import { configureControllerTest } from '@fastify-decorators/simple-di/testing';
+import fastify, { FastifyInstance } from 'fastify';
 import { users } from '../../src/user/user.js';
 import UserController from '../../src/user/user.controller.js';
+import { bootstrap } from 'fastify-decorators';
 
 describe('Controller: User', () => {
   let app: FastifyInstance;
   beforeEach(async () => {
-    app = await configureControllerTest({
-      controller: UserController,
+    app = await fastify();
+    await app.register(bootstrap, {
+      controllers: [UserController],
     });
   });
   afterEach(() => users.clear());

examples/ecmascript-decorators/tsconfig.base.json

@@ -3,9 +3,10 @@
     /* Visit https://aka.ms/tsconfig.json to read more about this file */
 
     /* Basic Options */
-    "target": "ES2022",
+    "target": "ES2023",
     "module": "ESNext",
     "outDir": "./dist",
+    "lib": ["ES2023"],
 
     /* Strict Type-Checking Options */
     "strict": true,
@@ -14,10 +15,7 @@
     "moduleResolution": "Node",
     "esModuleInterop": true,
 
-    /* FIXME: TAKE A LOOK AT ME, I AM OMITED */
-    // "experimentalDecorators": false,
-    /* FIXME: TAKE A LOOK AT ME, I AM OMITED AS WELL */
-    // "emitDecoratorMetadata": true,
+    "experimentalDecorators": false,
 
     /* Advanced Options */
     "skipLibCheck": true,