nesties 1.0.1

package/.eslintignore

@@ -0,0 +1,4 @@
+webpack.config.js
+dist/*
+build/*
+*.js

package/.eslintrc.js

@@ -0,0 +1,25 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: 'tsconfig.json',
+    tsconfigRootDir : __dirname, 
+    sourceType: 'module',
+  },
+  plugins: ['@typescript-eslint/eslint-plugin'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended',
+  ],
+  root: true,
+  env: {
+    node: true,
+    jest: true,
+  },
+  ignorePatterns: ['.eslintrc.js'],
+  rules: {
+    '@typescript-eslint/interface-name-prefix': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/explicit-module-boundary-types': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "singleQuote": true,
+  "trailingComma": "all"
+}

package/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Nanahira
+
+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

@@ -0,0 +1,250 @@
+# Nesties
+
+**Nest.js utilities**
+
+Nesties is a utility library for Nest.js applications, designed to simplify and enhance common patterns such as decorators, response structures, and request validation. This library provides a set of utilities to streamline your development workflow and improve code reuse and clarity when working with Nest.js.
+
+## Features
+
+- **Decorator Merging**: Merge multiple property, method, class, and parameter decorators.
+- **Predefined API Responses**: Simplified and consistent response structures for APIs.
+- **Data Validation Pipes**: Validation pipe utilities to handle query and body validation effortlessly.
+- **Custom Guards**: Easily implement token-based guards and API header validation.
+- **Pagination and Return DTOs**: DTOs for standard and paginated API responses.
+
+## Installation
+
+To install Nesties, use npm or yarn:
+
+```bash
+npm install nesties
+```
+
+or
+
+```bash
+yarn add nesties
+```
+
+## Usage
+
+### 1. Merging Decorators
+
+Nesties allows you to merge multiple decorators of the same type (property, method, class, or parameter). This is useful when you want to combine the functionality of several decorators into one.
+
+- **Property Decorator**
+
+```typescript
+import { MergePropertyDecorators } from 'nesties';
+
+const CombinedPropertyDecorator = MergePropertyDecorators([Decorator1, Decorator2]);
+```
+
+- **Method Decorator**
+
+```typescript
+import { MergeMethodDecorators } from 'nesties';
+
+const CombinedMethodDecorator = MergeMethodDecorators([Decorator1, Decorator2]);
+```
+
+- **Class Decorator**
+
+```typescript
+import { MergeClassDecorators } from 'nesties';
+
+const CombinedClassDecorator = MergeClassDecorators([Decorator1, Decorator2]);
+```
+
+- **Parameter Decorator**
+
+```typescript
+import { MergeParameterDecorators } from 'nesties';
+
+const CombinedParameterDecorator = MergeParameterDecorators([Decorator1, Decorator2]);
+```
+
+### 2. API Response Decorators
+
+Nesties includes a utility for defining API error responses conveniently.
+
+```typescript
+import { ApiError } from 'nesties';
+
+@ApiError(401, 'Unauthorized access')
+```
+
+### 3. Validation Pipes
+
+Nesties provides utilities for creating validation pipes with automatic data transformation and validation.
+
+- **Data Pipe**
+
+```typescript
+import { DataPipe } from 'nesties';
+
+const validationPipe = DataPipe();
+```
+
+- **Decorators for Request Validation**
+
+```typescript
+import { DataQuery, DataBody } from 'nesties';
+
+class ExampleController {
+    myMethod(@DataQuery() query: MyQueryDto, @DataBody() body: MyBodyDto) {
+    // ...
+    }
+}
+```
+
+## Usage
+
+### 4. Return Message DTOs
+
+Nesties provides a set of DTOs for consistent API response structures, and it also includes a utility function `ReturnMessageDto` to generate DTOs dynamically based on the provided class type.
+
+- **BlankReturnMessageDto**: A basic structure for returning status and message information.
+- **GenericReturnMessageDto**: A generic version for responses that include data.
+- **PaginatedReturnMessageDto**: For paginated responses, including metadata about pagination.
+- **ReturnMessageDto**: A utility function for generating DTOs based on a class type.
+
+```typescript
+import { BlankReturnMessageDto, GenericReturnMessageDto, PaginatedReturnMessageDto, ReturnMessageDto } from 'nesties';
+
+const response = new GenericReturnMessageDto(200, 'Operation successful', myData);
+```
+
+#### Example Usage of `ReturnMessageDto`
+
+`ReturnMessageDto` allows you to generate a DTO dynamically based on the structure of a provided class. This is useful when you want to create a standardized response that includes custom data types.
+
+Suppose we have a `User` class:
+
+```typescript
+import { ApiProperty } from '@nestjs/swagger';
+
+class User {
+@ApiProperty({ description: 'The unique ID of the user', type: Number })
+id: number;
+
+@ApiProperty({ description: 'The name of the user', type: String })
+name: string;
+
+@ApiProperty({ description: 'The email address of the user', type: String })
+email: string;
+}
+```
+
+You can create a return message DTO for this class:
+
+```typescript
+import { ReturnMessageDto } from 'nesties';
+
+class UserReturnMessageDto extends ReturnMessageDto(User) {}
+
+const response = new UserReturnMessageDto(200, 'Success', { id: 1, name: 'John Doe', email: 'john.doe@example.com' });
+```
+
+This approach automatically creates a DTO structure with the properties of `User` integrated as the data field, ensuring consistency and reusability in your API responses.
+
+
+```
+
+### 5. Token Guard
+
+Nesties includes a `TokenGuard` class that validates server tokens from the request headers. This can be used with the `RequireToken` decorator for routes requiring token validation.
+
+```typescript
+import { RequireToken } from 'nesties';
+
+@Controller('secure')
+export class SecureController {
+@Get()
+@RequireToken()
+secureEndpoint() {
+// This endpoint requires a token
+}
+}
+```
+
+#### How to Use `TokenGuard`
+
+1. **Set the `SERVER_TOKEN` in the Configuration**
+
+   In your Nest.js configuration, make sure to set up the `SERVER_TOKEN` using the `@nestjs/config` package.
+
+   ```typescript
+   import { ConfigModule } from '@nestjs/config';
+
+   @Module({
+      imports: [ConfigModule.forRoot()],
+   })
+   export class AppModule {}
+   ```
+
+   In your environment file (`.env`), define your token:
+
+   ```
+   SERVER_TOKEN=your-secure-token
+   ```
+
+2. **Token Validation with `TokenGuard`**
+
+   `TokenGuard` checks the request headers for a token called `x-server-token`. If this token matches the one defined in your configuration, the request is allowed to proceed. If the token is missing or incorrect, a `401 Unauthorized` error is thrown.
+
+   This approach is ideal for simple token-based authentication for APIs. It provides a lightweight method to protect routes without implementing a full OAuth or JWT-based system.
+
+3. **Use `RequireToken` Decorator**
+
+   Apply the `RequireToken` decorator to your controller methods to enforce token validation:
+
+   ```typescript
+   import { Controller, Get } from '@nestjs/common';
+   import { RequireToken } from 'nesties';
+
+   @Controller('api')
+   export class ApiController {
+   @Get('protected')
+   @RequireToken()
+   protectedRoute() {
+   return { message: 'This is a protected route' };
+   }
+   }
+   ```
+
+   In this example, the `protectedRoute` method will only be accessible if the request includes the correct `x-server-token` header.
+
+## DTO Classes
+
+- **BlankReturnMessageDto**: A basic DTO for standardized API responses.
+- **BlankPaginatedReturnMessageDto**: A DTO for paginated API responses.
+- **GenericReturnMessageDto**: A generic DTO for returning data of any type.
+- **StringReturnMessageDto**: A simple DTO for string responses.
+
+```typescript
+import { StringReturnMessageDto } from 'nesties';
+
+const response = new StringReturnMessageDto(200, 'Success', 'This is a string response');
+```
+
+## Configuration
+
+The `TokenGuard` class uses the `ConfigService` from `@nestjs/config` to access configuration values, such as the `SERVER_TOKEN`. Make sure you have `@nestjs/config` installed and configured in your Nest.js project.
+
+```typescript
+import { ConfigModule } from '@nestjs/config';
+
+@Module({
+imports: [ConfigModule.forRoot()],
+})
+export class AppModule {}
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or report issues.
+
+## License
+
+Nesties is MIT licensed.

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './src/insert-field';
+export * from './src/merge';
+export * from './src/return-message';
+export * from './src/openapi';
+export * from './src/pipe';
+export * from './src/token.guard';

package/dist/index.js

@@ -0,0 +1,23 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/insert-field"), exports);
+__exportStar(require("./src/merge"), exports);
+__exportStar(require("./src/return-message"), exports);
+__exportStar(require("./src/openapi"), exports);
+__exportStar(require("./src/pipe"), exports);
+__exportStar(require("./src/token.guard"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,qDAAmC;AACnC,8CAA4B;AAC5B,uDAAqC;AACrC,gDAA8B;AAC9B,6CAA2B;AAC3B,oDAAkC"}

package/dist/src/insert-field.d.ts

@@ -0,0 +1,24 @@
+import { ApiPropertyOptions } from '@nestjs/swagger';
+export type AnyClass = new (...args: any[]) => any;
+export type ClassOrArray = AnyClass | [AnyClass];
+export type ClassType<T> = new (...args: any[]) => T;
+export type TypeFromClass<T> = T extends new (...args: any[]) => infer U ? U : never;
+export type ParamsFromClass<T> = T extends new (...args: infer U) => any ? U : never;
+export type ParseType<IC extends ClassOrArray> = IC extends [infer U] ? TypeFromClass<U>[] : TypeFromClass<IC>;
+export declare function getClassFromClassOrArray(o: ClassOrArray): AnyClass;
+export interface InsertOptions<C extends ClassOrArray = ClassOrArray> {
+    type: C;
+    options?: ApiPropertyOptions;
+}
+type TypeFromInsertOptions<O extends InsertOptions> = O extends InsertOptions<infer C> ? ParseType<C> | (O extends {
+    options: {
+        required: true;
+    };
+} ? never : undefined) : never;
+type Merge<T, U> = {
+    [K in keyof T | keyof U]: K extends keyof T ? T[K] : K extends keyof U ? U[K] : never;
+};
+export declare function InsertField<C extends AnyClass, M extends Record<string, InsertOptions>>(cl: C, map: M, newName?: string): new (...args: ParamsFromClass<C>) => Merge<{
+    [F in keyof M]: TypeFromInsertOptions<M[F]>;
+}, TypeFromClass<C>>;
+export {};

package/dist/src/insert-field.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClassFromClassOrArray = getClassFromClassOrArray;
+exports.InsertField = InsertField;
+const swagger_1 = require("@nestjs/swagger");
+function getClassFromClassOrArray(o) {
+    return o instanceof Array ? o[0] : o;
+}
+function InsertField(cl, map, newName) {
+    const extendedCl = class extends cl {
+    };
+    for (const key in map) {
+        (0, swagger_1.ApiProperty)({
+            type: map[key].type,
+            ...(map[key].options || {}),
+        })(extendedCl.prototype, key);
+    }
+    Object.defineProperty(extendedCl, 'name', {
+        value: newName || cl.name,
+    });
+    return extendedCl;
+}
+//# sourceMappingURL=insert-field.js.map

package/dist/src/insert-field.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"insert-field.js","sourceRoot":"","sources":["../../src/insert-field.ts"],"names":[],"mappings":";;AAeA,4DAEC;AAsBD,kCAwBC;AA/DD,6CAAkE;AAelE,SAAgB,wBAAwB,CAAC,CAAe;IACtD,OAAO,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC;AAsBD,SAAgB,WAAW,CAIzB,EAAK,EACL,GAAM,EACN,OAAgB;IAOhB,MAAM,UAAU,GAAG,KAAM,SAAQ,EAAE;KAAG,CAAC;IACvC,KAAK,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,IAAA,qBAAW,EAAC;YACV,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI;YACnB,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,OAAO,IAAI,EAAE,CAAC;SAC5B,CAAC,CAAC,UAAU,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;IAChC,CAAC;IACD,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE;QACxC,KAAK,EAAE,OAAO,IAAI,EAAE,CAAC,IAAI;KAC1B,CAAC,CAAC;IACH,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/dist/src/merge.d.ts

@@ -0,0 +1,4 @@
+export declare function MergePropertyDecorators(decs: PropertyDecorator[]): PropertyDecorator;
+export declare function MergeMethodDecorators(decs: MethodDecorator[]): MethodDecorator;
+export declare function MergeClassDecorators(decs: ClassDecorator[]): ClassDecorator;
+export declare function MergeParameterDecorators(decs: ParameterDecorator[]): ParameterDecorator;

package/dist/src/merge.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MergePropertyDecorators = MergePropertyDecorators;
+exports.MergeMethodDecorators = MergeMethodDecorators;
+exports.MergeClassDecorators = MergeClassDecorators;
+exports.MergeParameterDecorators = MergeParameterDecorators;
+function MergePropertyDecorators(decs) {
+    return (obj, key) => {
+        for (const dec of decs) {
+            dec(obj, key);
+        }
+    };
+}
+function MergeMethodDecorators(decs) {
+    return (obj, key, descriptor) => {
+        for (const dec of decs) {
+            dec(obj, key, descriptor);
+        }
+    };
+}
+function MergeClassDecorators(decs) {
+    return (obj) => {
+        for (const dec of decs) {
+            dec(obj);
+        }
+    };
+}
+function MergeParameterDecorators(decs) {
+    return (obj, key, index) => {
+        for (const dec of decs) {
+            dec(obj, key, index);
+        }
+    };
+}
+//# sourceMappingURL=merge.js.map

package/dist/src/merge.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"merge.js","sourceRoot":"","sources":["../../src/merge.ts"],"names":[],"mappings":";;AAAA,0DAQC;AAED,sDAQC;AAED,oDAMC;AAED,4DAQC;AApCD,SAAgB,uBAAuB,CACrC,IAAyB;IAEzB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAClB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QAChB,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,qBAAqB,CACnC,IAAuB;IAEvB,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,EAAE,EAAE;QAC9B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,oBAAoB,CAAC,IAAsB;IACzD,OAAO,CAAC,GAAG,EAAE,EAAE;QACb,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,GAAG,CAAC,GAAG,CAAC,CAAC;QACX,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAgB,wBAAwB,CACtC,IAA0B;IAE1B,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE;QACzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACvB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACvB,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/src/openapi.d.ts

@@ -0,0 +1 @@
+export declare const ApiError: (status: number, description: string) => MethodDecorator & ClassDecorator;

package/dist/src/openapi.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiError = void 0;
+const return_message_1 = require("./return-message");
+const swagger_1 = require("@nestjs/swagger");
+const ApiError = (status, description) => (0, swagger_1.ApiResponse)({ status, type: return_message_1.BlankReturnMessageDto, description });
+exports.ApiError = ApiError;
+//# sourceMappingURL=openapi.js.map

package/dist/src/openapi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi.js","sourceRoot":"","sources":["../../src/openapi.ts"],"names":[],"mappings":";;;AAAA,qDAAyD;AACzD,6CAA8C;AAEvC,MAAM,QAAQ,GAAG,CAAC,MAAc,EAAE,WAAmB,EAAE,EAAE,CAC9D,IAAA,qBAAW,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,sCAAqB,EAAE,WAAW,EAAE,CAAC,CAAC;AADvD,QAAA,QAAQ,YAC+C"}

package/dist/src/pipe.d.ts

@@ -0,0 +1,4 @@
+import { PipeTransform, Type, ValidationPipe } from '@nestjs/common';
+export declare const DataPipe: () => ValidationPipe;
+export declare const DataQuery: (...extraPipes: (Type<PipeTransform> | PipeTransform)[]) => ParameterDecorator;
+export declare const DataBody: (...extraPipes: (Type<PipeTransform> | PipeTransform)[]) => ParameterDecorator;

package/dist/src/pipe.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataBody = exports.DataQuery = exports.DataPipe = void 0;
+const common_1 = require("@nestjs/common");
+const DataPipe = () => new common_1.ValidationPipe({
+    transform: true,
+    transformOptions: { enableImplicitConversion: true },
+});
+exports.DataPipe = DataPipe;
+const createDataPipeDec = (nestFieldDec) => (...extraPipes) => nestFieldDec((0, exports.DataPipe)(), ...extraPipes);
+exports.DataQuery = createDataPipeDec(common_1.Query);
+exports.DataBody = createDataPipeDec(common_1.Body);
+//# sourceMappingURL=pipe.js.map

package/dist/src/pipe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipe.js","sourceRoot":"","sources":["../../src/pipe.ts"],"names":[],"mappings":";;;AAAA,2CAMwB;AAEjB,MAAM,QAAQ,GAAG,GAAG,EAAE,CAC3B,IAAI,uBAAc,CAAC;IACjB,SAAS,EAAE,IAAI;IACf,gBAAgB,EAAE,EAAE,wBAAwB,EAAE,IAAI,EAAE;CACrD,CAAC,CAAC;AAJQ,QAAA,QAAQ,YAIhB;AAEL,MAAM,iBAAiB,GACrB,CACE,YAEuB,EACvB,EAAE,CACJ,CAAC,GAAG,UAAmD,EAAE,EAAE,CACzD,YAAY,CAAC,IAAA,gBAAQ,GAAE,EAAE,GAAG,UAAU,CAAC,CAAC;AAE/B,QAAA,SAAS,GAAG,iBAAiB,CAAC,cAAK,CAAC,CAAC;AACrC,QAAA,QAAQ,GAAG,iBAAiB,CAAC,aAAI,CAAC,CAAC"}

package/dist/src/return-message.d.ts

@@ -0,0 +1,41 @@
+import { HttpException } from '@nestjs/common';
+import { AnyClass, ClassOrArray, ParseType } from './insert-field';
+export interface PageSettingsWise {
+    pageCount: number;
+    recordsPerPage: number;
+}
+export interface BlankReturnMessage {
+    statusCode: number;
+    message: string;
+    success: boolean;
+}
+export interface ReturnMessage<T> extends BlankReturnMessage {
+    data?: T;
+}
+export declare class BlankReturnMessageDto implements BlankReturnMessage {
+    statusCode: number;
+    message: string;
+    success: boolean;
+    constructor(statusCode: number, message?: string);
+    toException(): HttpException;
+}
+export declare class BlankPaginatedReturnMessageDto extends BlankReturnMessageDto implements PageSettingsWise {
+    total: number;
+    totalPages: number;
+    pageCount: number;
+    recordsPerPage: number;
+    constructor(statusCode: number, message: string, total: number, pageSettings: PageSettingsWise);
+}
+export declare class GenericReturnMessageDto<T> extends BlankReturnMessageDto implements ReturnMessage<T> {
+    data?: T;
+    constructor(statusCode: number, message?: string, data?: T);
+}
+export declare function ReturnMessageDto<T extends ClassOrArray>(type: T): new (statusCode: number, message: string, data: ParseType<T>) => GenericReturnMessageDto<ParseType<T>>;
+export declare class GenericPaginatedReturnMessageDto<T> extends BlankPaginatedReturnMessageDto implements PageSettingsWise, ReturnMessage<T[]> {
+    data: T[];
+    constructor(statusCode: number, message: string, data: T[], total: number, pageSettings: PageSettingsWise);
+}
+export declare function PaginatedReturnMessageDto<T extends AnyClass>(type: T): new (statusCode: number, message: string, data: InstanceType<T>[], total: number, pageSettings: PageSettingsWise) => GenericPaginatedReturnMessageDto<InstanceType<T>>;
+export declare class StringReturnMessageDto extends GenericReturnMessageDto<string> {
+    data: string;
+}

package/dist/src/return-message.js

@@ -0,0 +1,110 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringReturnMessageDto = exports.GenericPaginatedReturnMessageDto = exports.GenericReturnMessageDto = exports.BlankPaginatedReturnMessageDto = exports.BlankReturnMessageDto = void 0;
+exports.ReturnMessageDto = ReturnMessageDto;
+exports.PaginatedReturnMessageDto = PaginatedReturnMessageDto;
+const swagger_1 = require("@nestjs/swagger");
+const common_1 = require("@nestjs/common");
+const insert_field_1 = require("./insert-field");
+class BlankReturnMessageDto {
+    constructor(statusCode, message) {
+        this.statusCode = statusCode;
+        this.message = message || 'success';
+        this.success = statusCode < 400;
+    }
+    toException() {
+        return new common_1.HttpException(this, this.statusCode);
+    }
+}
+exports.BlankReturnMessageDto = BlankReturnMessageDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Return code', type: Number }),
+    __metadata("design:type", Number)
+], BlankReturnMessageDto.prototype, "statusCode", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Return message', type: String }),
+    __metadata("design:type", String)
+], BlankReturnMessageDto.prototype, "message", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Whether success.', type: Boolean }),
+    __metadata("design:type", Boolean)
+], BlankReturnMessageDto.prototype, "success", void 0);
+class BlankPaginatedReturnMessageDto extends BlankReturnMessageDto {
+    constructor(statusCode, message, total, pageSettings) {
+        super(statusCode, message);
+        this.total = total;
+        this.pageCount = pageSettings.pageCount;
+        this.recordsPerPage = pageSettings.recordsPerPage;
+        this.totalPages = Math.ceil(total / pageSettings.recordsPerPage);
+    }
+}
+exports.BlankPaginatedReturnMessageDto = BlankPaginatedReturnMessageDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Total record count.', type: Number }),
+    __metadata("design:type", Number)
+], BlankPaginatedReturnMessageDto.prototype, "total", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Total page count.', type: Number }),
+    __metadata("design:type", Number)
+], BlankPaginatedReturnMessageDto.prototype, "totalPages", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Current page.', type: Number }),
+    __metadata("design:type", Number)
+], BlankPaginatedReturnMessageDto.prototype, "pageCount", void 0);
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Records per page.', type: Number }),
+    __metadata("design:type", Number)
+], BlankPaginatedReturnMessageDto.prototype, "recordsPerPage", void 0);
+class GenericReturnMessageDto extends BlankReturnMessageDto {
+    constructor(statusCode, message, data) {
+        super(statusCode, message);
+        this.data = data;
+    }
+}
+exports.GenericReturnMessageDto = GenericReturnMessageDto;
+function ReturnMessageDto(type) {
+    return (0, insert_field_1.InsertField)(GenericReturnMessageDto, {
+        data: {
+            type,
+            options: {
+                required: false,
+                description: 'Return data.',
+            },
+        },
+    }, `${(0, insert_field_1.getClassFromClassOrArray)(type).name}ReturnMessageDto`);
+}
+class GenericPaginatedReturnMessageDto extends BlankPaginatedReturnMessageDto {
+    constructor(statusCode, message, data, total, pageSettings) {
+        super(statusCode, message, total, pageSettings);
+        this.data = data;
+    }
+}
+exports.GenericPaginatedReturnMessageDto = GenericPaginatedReturnMessageDto;
+function PaginatedReturnMessageDto(type) {
+    return (0, insert_field_1.InsertField)(GenericPaginatedReturnMessageDto, {
+        data: {
+            type: [type],
+            options: {
+                required: false,
+                description: 'Return data.',
+            },
+        },
+    }, `${(0, insert_field_1.getClassFromClassOrArray)(type).name}PaginatedReturnMessageDto`);
+}
+class StringReturnMessageDto extends GenericReturnMessageDto {
+}
+exports.StringReturnMessageDto = StringReturnMessageDto;
+__decorate([
+    (0, swagger_1.ApiProperty)({ description: 'Return data.', type: String, required: false }),
+    __metadata("design:type", String)
+], StringReturnMessageDto.prototype, "data", void 0);
+//# sourceMappingURL=return-message.js.map

package/dist/src/return-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"return-message.js","sourceRoot":"","sources":["../../src/return-message.ts"],"names":[],"mappings":";;;;;;;;;;;;AAgFA,4CAoBC;AAmBD,8DAsBC;AA7ID,6CAA8C;AAC9C,2CAA+C;AAC/C,iDAMwB;AAiBxB,MAAa,qBAAqB;IAOhC,YAAY,UAAkB,EAAE,OAAgB;QAC9C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,SAAS,CAAC;QACpC,IAAI,CAAC,OAAO,GAAG,UAAU,GAAG,GAAG,CAAC;IAClC,CAAC;IAED,WAAW;QACT,OAAO,IAAI,sBAAa,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAClD,CAAC;CACF;AAhBD,sDAgBC;AAdC;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;yDACvC;AAEnB;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;sDAC7C;AAEhB;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,kBAAkB,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;;sDAC/C;AAYnB,MAAa,8BACX,SAAQ,qBAAqB;IAW7B,YACE,UAAkB,EAClB,OAAe,EACf,KAAa,EACb,YAA8B;QAE9B,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC3B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,SAAS,GAAG,YAAY,CAAC,SAAS,CAAC;QACxC,IAAI,CAAC,cAAc,GAAG,YAAY,CAAC,cAAc,CAAC;QAClD,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;IACnE,CAAC;CACF;AAxBD,wEAwBC;AAnBC;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,qBAAqB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;6DACpD;AAEd;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;kEAC7C;AAEnB;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,eAAe,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;iEAC1C;AAElB;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,mBAAmB,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;sEACzC;AAezB,MAAa,uBACX,SAAQ,qBAAqB;IAI7B,YAAY,UAAkB,EAAE,OAAgB,EAAE,IAAQ;QACxD,KAAK,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AATD,0DASC;AAED,SAAgB,gBAAgB,CAC9B,IAAO;IAMP,OAAO,IAAA,0BAAW,EAChB,uBAAuB,EACvB;QACE,IAAI,EAAE;YACJ,IAAI;YACJ,OAAO,EAAE;gBACP,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,cAAc;aAC5B;SACF;KACF,EACD,GAAG,IAAA,uCAAwB,EAAC,IAAI,CAAC,CAAC,IAAI,kBAAkB,CACzD,CAAC;AACJ,CAAC;AAED,MAAa,gCACX,SAAQ,8BAA8B;IAItC,YACE,UAAkB,EAClB,OAAe,EACf,IAAS,EACT,KAAa,EACb,YAA8B;QAE9B,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;QAChD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;CACF;AAfD,4EAeC;AAED,SAAgB,yBAAyB,CACvC,IAAO;IAQP,OAAO,IAAA,0BAAW,EAChB,gCAAgC,EAChC;QACE,IAAI,EAAE;YACJ,IAAI,EAAE,CAAC,IAAI,CAAC;YACZ,OAAO,EAAE;gBACP,QAAQ,EAAE,KAAK;gBACf,WAAW,EAAE,cAAc;aAC5B;SACF;KACF,EACD,GAAG,IAAA,uCAAwB,EAAC,IAAI,CAAC,CAAC,IAAI,2BAA2B,CAClE,CAAC;AACJ,CAAC;AAED,MAAa,sBAAuB,SAAQ,uBAA+B;CAG1E;AAHD,wDAGC;AADC;IADC,IAAA,qBAAW,EAAC,EAAE,WAAW,EAAE,cAAc,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;;oDAC/D"}

package/dist/src/token.guard.d.ts

@@ -0,0 +1,9 @@
+import { CanActivate, ExecutionContext } from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+export declare class TokenGuard implements CanActivate {
+    private config;
+    private token;
+    constructor(config: ConfigService);
+    canActivate(context: ExecutionContext): Promise<boolean>;
+}
+export declare const RequireToken: () => MethodDecorator;

package/dist/src/token.guard.js

@@ -0,0 +1,48 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequireToken = exports.TokenGuard = void 0;
+const common_1 = require("@nestjs/common");
+const config_1 = require("@nestjs/config");
+const swagger_1 = require("@nestjs/swagger");
+const return_message_1 = require("./return-message");
+const merge_1 = require("./merge");
+const openapi_1 = require("./openapi");
+let TokenGuard = class TokenGuard {
+    constructor(config) {
+        this.config = config;
+        this.token = this.config.get('SERVER_TOKEN');
+    }
+    async canActivate(context) {
+        const request = context.switchToHttp().getRequest();
+        const token = request.headers['x-server-token'];
+        if (this.token && token !== this.token) {
+            throw new return_message_1.BlankReturnMessageDto(401, 'Unauthorized').toException();
+        }
+        return true;
+    }
+};
+exports.TokenGuard = TokenGuard;
+exports.TokenGuard = TokenGuard = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [config_1.ConfigService])
+], TokenGuard);
+const RequireToken = () => (0, merge_1.MergeMethodDecorators)([
+    (0, common_1.UseGuards)(TokenGuard),
+    (0, swagger_1.ApiHeader)({
+        name: 'x-server-token',
+        description: '服务器 token',
+        required: false,
+    }),
+    (0, openapi_1.ApiError)(401, '服务器 Token 不正确'),
+]);
+exports.RequireToken = RequireToken;
+//# sourceMappingURL=token.guard.js.map

package/dist/src/token.guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token.guard.js","sourceRoot":"","sources":["../../src/token.guard.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,2CAKwB;AACxB,2CAA+C;AAC/C,6CAA4C;AAC5C,qDAAyD;AACzD,mCAAgD;AAChD,uCAAqC;AAG9B,IAAM,UAAU,GAAhB,MAAM,UAAU;IAErB,YAAoB,MAAqB;QAArB,WAAM,GAAN,MAAM,CAAe;QADjC,UAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAS,cAAc,CAAC,CAAC;IACZ,CAAC;IAE7C,KAAK,CAAC,WAAW,CAAC,OAAyB;QACzC,MAAM,OAAO,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;QACpD,MAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC;QAChD,IAAI,IAAI,CAAC,KAAK,IAAI,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACvC,MAAM,IAAI,sCAAqB,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC,WAAW,EAAE,CAAC;QACrE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;CACF,CAAA;AAZY,gCAAU;qBAAV,UAAU;IADtB,IAAA,mBAAU,GAAE;qCAGiB,sBAAa;GAF9B,UAAU,CAYtB;AAEM,MAAM,YAAY,GAAG,GAAG,EAAE,CAC/B,IAAA,6BAAqB,EAAC;IACpB,IAAA,kBAAS,EAAC,UAAU,CAAC;IACrB,IAAA,mBAAS,EAAC;QACR,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,WAAW;QACxB,QAAQ,EAAE,KAAK;KAChB,CAAC;IACF,IAAA,kBAAQ,EAAC,GAAG,EAAE,eAAe,CAAC;CAC/B,CAAC,CAAC;AATQ,QAAA,YAAY,gBASpB"}

package/index.ts

@@ -0,0 +1,6 @@
+export * from './src/insert-field';
+export * from './src/merge';
+export * from './src/return-message';
+export * from './src/openapi';
+export * from './src/pipe';
+export * from './src/token.guard';

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "nesties",
+  "description": "Nest.js utilities",
+  "version": "1.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "lint": "eslint --fix .",
+    "build": "rimraf dist && tsc",
+    "test": "jest --passWithNoTests",
+    "start": "node dist/index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://code.mycard.moe/3rdeye/nesties.git"
+  },
+  "author": "Nanahira <nanahira@momobako.com>",
+  "license": "MIT",
+  "keywords": [],
+  "bugs": {
+    "url": "https://code.mycard.moe/3rdeye/nesties/issues"
+  },
+  "homepage": "https://code.mycard.moe/3rdeye/nesties",
+  "jest": {
+    "moduleFileExtensions": [
+      "js",
+      "json",
+      "ts"
+    ],
+    "rootDir": "tests",
+    "testRegex": ".*\\.spec\\.ts$",
+    "transform": {
+      "^.+\\.(t|j)s$": "ts-jest"
+    },
+    "collectCoverageFrom": [
+      "**/*.(t|j)s"
+    ],
+    "coverageDirectory": "../coverage",
+    "testEnvironment": "node"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^10.4.6",
+    "@nestjs/config": "^3.3.0",
+    "@nestjs/swagger": "^7.4.2",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.8.1",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "eslint": "8.22.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.6.3"
+  },
+  "peerDependencies": {
+    "@nestjs/common": "^9.4.0 || ^10.0.0",
+    "@nestjs/swagger": "^7.1.8 || ^6.3.0",
+    "@nestjs/config": "^3.0.0"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,20 @@
+{
+	"compilerOptions": {
+		"outDir": "dist",
+		"module": "commonjs",
+		"target": "es2021",
+		"esModuleInterop": true,
+		"emitDecoratorMetadata": true,
+		"experimentalDecorators": true,
+		"declaration": true,
+		"sourceMap": true
+	},
+	"compileOnSave": true,
+	"allowJs": true,
+	"include": [
+		"*.ts",
+		"src/**/*.ts",
+		"test/**/*.ts",
+		"tests/**/*.ts"
+	]
+}