nestify-js 0.0.0 → 0.1.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 kasukabe tsumugi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,408 @@
-# claris
+# Nestify
 
-For kt.js related refactoring.
+[中文版本 README.zh.md](./README.zh.md)
+
+> ⚠️ **Warning**: This is not an official release version. APIs may change in the future.
+
+**Injecorator** is a portmanteau of "inject" and "decorator" - a dependency injection framework for Fastify that uses modern Stage 3 decorators instead of the legacy decorators used by NestJS.
+
+This project was created because NestJS uses the old decorator syntax, but we wanted to leverage the new Stage 3 decorator specification for better type safety and modern JavaScript features.
+
+## Installation
+
+```bash
+pnpm add nestify-js
+```
+
+## API Documentation
+
+Using of decorators looks basically like they are in NestJS, but with modern Stage 3 syntax.
+
+> Note: It is recommended to set "strictPropertyInitialization": false in your tsconfig.json to avoid linting issues when using property injection.
+
+### HTTP Method Decorators
+
+These decorators are used to define HTTP routes on controller methods:
+
+```typescript
+import { Get, Post, Put, Patch, Delete, HttpMethod } from 'nestify-js';
+
+@Controller('/api')
+class UserController {
+  @Get('/users')
+  getUsers() {
+    return { users: [] };
+  }
+
+  @Post('/users')
+  createUser() {
+    return { message: 'User created' };
+  }
+
+  @Put('/users/:id')
+  updateUser() {
+    return { message: 'User updated' };
+  }
+
+  @Patch('/users/:id')
+  patchUser() {
+    return { message: 'User patched' };
+  }
+
+  @Delete('/users/:id')
+  deleteUser() {
+    return { message: 'User deleted' };
+  }
+
+  @(HttpMethod('OPTIONS')('/users'))
+  optionsUsers() {
+    return { methods: ['GET', 'POST'] };
+  }
+}
+```
+
+### Route Configuration
+
+#### `@Controller(prefix?: string)`
+
+Marks a class as a controller and optionally sets a route prefix:
+
+```typescript
+@Controller('/api/v1')
+class ApiController {
+  @Get('/health')
+  health() {
+    return { status: 'ok' };
+  }
+}
+// This creates route: GET /api/v1/health
+```
+
+#### `@ApiSchema(schema)`
+
+Sets OpenAPI/Swagger schema information for routes:
+
+```typescript
+@Controller('/users')
+class UserController {
+  @Get('/:id')
+  @ApiSchema({
+    summary: 'Get user by ID',
+    description: 'Retrieves a user by their unique identifier',
+    tags: ['users'],
+  })
+  getUser() {
+    return { user: {} };
+  }
+}
+```
+
+#### `@Opt(options)`
+
+Sets additional Fastify route options:
+
+```typescript
+@Controller('/files')
+class FileController {
+  @Post('/upload')
+  @Opt({
+    bodyLimit: 1048576, // 1MB
+    attachValidation: true,
+  })
+  uploadFile() {
+    return { uploaded: true };
+  }
+}
+```
+
+### Dependency Injection
+
+#### `@Injectable()`
+
+Marks a class as a service that can be injected:
+
+```typescript
+@Injectable()
+class UserService {
+  getUsers() {
+    return [{ id: 1, name: 'John' }];
+  }
+}
+```
+
+#### `@Inject(token)`
+
+Injects dependencies into class properties:
+
+```typescript
+@Injectable()
+class UserController {
+  @Inject(UserService)
+  userService: UserService; // here might be linted by typescript, you can set "strictPropertyInitialization": false in tsconfig.json
+
+  @Inject('DATABASE_URL')
+  databaseUrl: string;
+
+  getUsers() {
+    return this.userService.getUsers();
+  }
+}
+```
+
+#### `@Module(options)`
+
+Defines a module with providers, controllers, imports, and exports:
+
+```typescript
+@Module({
+  imports: [DatabaseModule],
+  providers: [UserService],
+  controllers: [UserController],
+  exports: [UserService],
+})
+class UserModule {}
+```
+
+### Middleware System
+
+#### Guards
+
+Guards control access to routes:
+
+```typescript
+@Guard()
+class AuthGuard implements InjecoratorGuard {
+  canActivate(context: ExecutionContext): boolean {
+    const request = context.switchToHttp().getRequest();
+    return request.headers.authorization != null;
+  }
+}
+
+@Controller('/admin')
+@UseGuards(AuthGuard)
+class AdminController {
+  @Get('/dashboard')
+  getDashboard() {
+    return { data: 'sensitive' };
+  }
+}
+```
+
+#### Interceptors
+
+Interceptors can modify request/response flow:
+
+```typescript
+@Interceptor()
+class LoggingInterceptor implements InjecoratorInterceptor {
+  intercept(context: ExecutionContext) {
+    const start = Date.now();
+    console.log('Request started');
+
+    return () => {
+      console.log(`Request completed in ${Date.now() - start}ms`);
+    };
+  }
+}
+
+@Controller('/api')
+@UseInterceptors(LoggingInterceptor)
+class ApiController {
+  @Get('/data')
+  getData() {
+    return { data: 'example' };
+  }
+}
+```
+
+#### Pipes
+
+Pipes transform and validate input data:
+
+```typescript
+@Pipe()
+class ValidationPipe implements InjecoratorPipe {
+  transform(context: ExecutionContext, input: any[]) {
+    // Transform and validate input
+    return input;
+  }
+}
+
+@Controller('/users')
+class UserController {
+  @Post('/')
+  @Body({ type: 'object', required: ['name', 'email'] })
+  createUser(@Body() body: any) {
+    return { user: body };
+  }
+
+  @Get('/')
+  @Query({ type: 'object' })
+  getUsers(@Query() query: any) {
+    return { users: [], query };
+  }
+
+  @Get('/:id')
+  @Params({ type: 'object', required: ['id'] })
+  getUser(@Params() params: any) {
+    return { user: { id: params.id } };
+  }
+
+  @Get('/ip')
+  getUserIP(@Ip() ip: string) {
+    return { ip };
+  }
+
+  @Post('/raw')
+  handleRaw(@Raw() raw: any) {
+    return { received: true };
+  }
+}
+```
+
+#### Filters
+
+Filters handle exceptions:
+
+```typescript
+@Filter(HttpException)
+class HttpExceptionFilter implements InjecoratorFilter {
+  catch(exception: HttpException, context: ExecutionContext) {
+    const response = context.switchToHttp().getReply();
+    response.status(exception.status).send({
+      error: exception.message,
+      timestamp: new Date().toISOString(),
+    });
+  }
+}
+
+@Controller('/api')
+@UseFilters(HttpExceptionFilter)
+class ApiController {
+  @Get('/error')
+  throwError() {
+    throw new HttpException('Something went wrong', 400);
+  }
+}
+```
+
+## Complete Usage Example
+
+```typescript
+import fastify from 'fastify';
+import {
+  Module,
+  Controller,
+  Injectable,
+  Inject,
+  Get,
+  Post,
+  Body,
+  Params,
+  UseGuards,
+  Guard,
+  apply,
+} from 'nestify-js';
+
+// Service
+@Injectable()
+class UserService {
+  private users = [
+    { id: 1, name: 'Alice' },
+    { id: 2, name: 'Bob' },
+  ];
+
+  getUsers() {
+    return this.users;
+  }
+
+  getUserById(id: number) {
+    return this.users.find((user) => user.id === id);
+  }
+
+  createUser(userData: { name: string }) {
+    const user = { id: Date.now(), ...userData };
+    this.users.push(user);
+    return user;
+  }
+}
+
+// Guard
+@Guard()
+class AuthGuard {
+  canActivate(context) {
+    // Simple auth check
+    const request = context.switchToHttp().getRequest();
+    return request.headers.authorization === 'Bearer valid-token';
+  }
+}
+
+// Controller
+@Controller('/api/users')
+class UserController {
+  @Inject(UserService)
+  userService: UserService;
+
+  @Get('/')
+  getUsers() {
+    return this.userService.getUsers();
+  }
+
+  @Get('/:id')
+  @Params({
+    type: 'object',
+    properties: { id: { type: 'number' } },
+    required: ['id'],
+  })
+  getUser(@Params() params: { id: number }) {
+    return this.userService.getUserById(params.id);
+  }
+
+  @Post('/')
+  @UseGuards(AuthGuard)
+  @Body({
+    type: 'object',
+    properties: { name: { type: 'string' } },
+    required: ['name'],
+  })
+  createUser(@Body() body: { name: string }) {
+    return this.userService.createUser(body);
+  }
+}
+
+// Module
+@Module({
+  providers: [UserService, AuthGuard],
+  controllers: [UserController],
+})
+class AppModule {}
+
+// Application setup
+const app = fastify({ logger: true });
+
+await apply(app, {
+  rootModule: AppModule,
+});
+
+await app.listen({ port: 3000 });
+console.log('Server running on http://localhost:3000');
+```
+
+## Features
+
+- ✅ Modern Stage 3 decorators
+- ✅ Dependency injection with circular dependency support
+- ✅ HTTP method decorators (GET, POST, PUT, PATCH, DELETE)
+- ✅ Route parameters, query, and body validation
+- ✅ Guards for authentication/authorization
+- ✅ Interceptors for request/response transformation
+- ✅ Pipes for data transformation and validation
+- ✅ Exception filters
+- ✅ Module system with imports/exports
+- ✅ OpenAPI/Swagger schema support
+- ✅ Built-in HTTP exceptions
+- ✅ Execution context for middleware
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1 @@
+Object.defineProperty(exports,Symbol.toStringTag,{value:`Module`});let e=require("@nestify-js/core"),t=require("@nestify-js/shared");async function n(t,n){return(0,e.fastifyInjecorator)(t,{...n,setup:n.setup??e.setupBasicPipes})}Object.defineProperty(exports,"APP_FILTER",{enumerable:!0,get:function(){return t.APP_FILTER}}),Object.defineProperty(exports,"APP_GUARD",{enumerable:!0,get:function(){return t.APP_GUARD}}),Object.defineProperty(exports,"APP_INTERCEPTOR",{enumerable:!0,get:function(){return t.APP_INTERCEPTOR}}),Object.defineProperty(exports,"APP_LOGGER",{enumerable:!0,get:function(){return t.APP_LOGGER}}),Object.defineProperty(exports,"APP_PIPE",{enumerable:!0,get:function(){return t.APP_PIPE}}),Object.defineProperty(exports,"HttpStatus",{enumerable:!0,get:function(){return t.HttpStatus}}),exports.apply=n,Object.keys(e).forEach(function(t){t!=="default"&&!Object.prototype.hasOwnProperty.call(exports,t)&&Object.defineProperty(exports,t,{enumerable:!0,get:function(){return e[t]}})});var r=require("@nestify-js/schema");Object.keys(r).forEach(function(e){e!=="default"&&!Object.prototype.hasOwnProperty.call(exports,e)&&Object.defineProperty(exports,e,{enumerable:!0,get:function(){return r[e]}})});var i=require("@nestify-js/swagger");Object.keys(i).forEach(function(e){e!=="default"&&!Object.prototype.hasOwnProperty.call(exports,e)&&Object.defineProperty(exports,e,{enumerable:!0,get:function(){return i[e]}})});

package/dist/index.d.cts

@@ -0,0 +1,19 @@
+import { FastifyInjecoratorOptions } from "@nestify-js/core";
+import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR, APP_LOGGER, APP_PIPE, HttpStatus } from "@nestify-js/shared";
+import { FastifyInstance } from "fastify";
+export * from "@nestify-js/core";
+export * from "@nestify-js/schema";
+export * from "@nestify-js/swagger";
+
+//#region src/index.d.ts
+/**
+ * Apply Nestify modules to a Fastify instance.
+ *
+ * Unlike the core `fastifyInjecorator`, this wrapper automatically
+ * registers basic pipes (Body, Params, Query, Ip, Raw) via `setupBasicPipes`.
+ *
+ * Pass `setup` explicitly to override the default behavior.
+ */
+declare function apply(app: FastifyInstance, opts: Partial<FastifyInjecoratorOptions>): Promise<void>;
+//#endregion
+export { APP_FILTER, APP_GUARD, APP_INTERCEPTOR, APP_LOGGER, APP_PIPE, HttpStatus, apply };

package/dist/index.d.mts

@@ -0,0 +1,19 @@
+import { FastifyInjecoratorOptions } from "@nestify-js/core";
+import { APP_FILTER, APP_GUARD, APP_INTERCEPTOR, APP_LOGGER, APP_PIPE, HttpStatus } from "@nestify-js/shared";
+import { FastifyInstance } from "fastify";
+export * from "@nestify-js/core";
+export * from "@nestify-js/schema";
+export * from "@nestify-js/swagger";
+
+//#region src/index.d.ts
+/**
+ * Apply Nestify modules to a Fastify instance.
+ *
+ * Unlike the core `fastifyInjecorator`, this wrapper automatically
+ * registers basic pipes (Body, Params, Query, Ip, Raw) via `setupBasicPipes`.
+ *
+ * Pass `setup` explicitly to override the default behavior.
+ */
+declare function apply(app: FastifyInstance, opts: Partial<FastifyInjecoratorOptions>): Promise<void>;
+//#endregion
+export { APP_FILTER, APP_GUARD, APP_INTERCEPTOR, APP_LOGGER, APP_PIPE, HttpStatus, apply };

package/dist/index.mjs

@@ -0,0 +1 @@
+import{fastifyInjecorator as e,setupBasicPipes as t}from"@nestify-js/core";import{APP_FILTER as n,APP_GUARD as r,APP_INTERCEPTOR as i,APP_LOGGER as a,APP_PIPE as o,HttpStatus as s}from"@nestify-js/shared";export*from"@nestify-js/core";export*from"@nestify-js/schema";export*from"@nestify-js/swagger";async function c(n,r){return e(n,{...r,setup:r.setup??t})}export{n as APP_FILTER,r as APP_GUARD,i as APP_INTERCEPTOR,a as APP_LOGGER,o as APP_PIPE,s as HttpStatus,c as apply};

package/package.json

@@ -1,19 +1,64 @@
-{
+{
   "name": "nestify-js",
-  "version": "0.0.0",
-  "description": "For fastify injecorator related refactoring",
-  "license": "MIT",
+  "version": "0.1.3",
+  "description": "A NestJS like fastify plugin for dependency injection",
+  "description_zh": "一个类似于 NestJS 的 Fastify 依赖注入插件",
+  "purpose": "npm",
   "type": "module",
-  "private": false,
-  "keywords": [
-    "kt.js"
-  ],
-  "main": "index.js",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "default": "./dist/index.cjs",
+      "require": "./dist/index.cjs"
+    }
+  },
   "files": [
-    "index.js",
-    "README.md"
+    "dist"
   ],
-  "publishConfig": {
-    "access": "public"
+  "author": {
+    "name": "Kasukabe Tsumugi",
+    "email": "futami16237@gmail.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/baendlorel/nestify-js"
+  },
+  "keywords": [
+    "nestjs",
+    "decorator",
+    "fastify",
+    "typescript",
+    "javascript"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@fastify/autoload": "^6.3.1",
+    "@fastify/one-line-logger": "^2.1.0",
+    "@fastify/sensible": "^6.0.4",
+    "@fastify/static": "^9.1.3",
+    "axios": "^1.18.1",
+    "fastify": "^5.9.0",
+    "@nestify-js/core": "0.1.3",
+    "@nestify-js/swagger": "0.1.0",
+    "@nestify-js/schema": "0.1.0"
+  },
+  "peerDependencies": {
+    "@fastify/multipart": "^9.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@fastify/multipart": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@rollup/plugin-replace": "^6.0.3",
+    "@types/node": "^26.1.0",
+    "rollup-plugin-func-macro": "^1.2.3",
+    "tsdown": "^0.22.3",
+    "typescript": "^6.0.3"
   }
 }

package/index.js

@@ -1 +0,0 @@
-export {};