@manulz/nest-tools 1.1.0

package/dist/index.d.mts

@@ -0,0 +1,141 @@
+import * as _nestjs_common from '@nestjs/common';
+import { NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { Observable } from 'rxjs';
+
+interface GenerateResourceOptions {
+    name: string;
+    spec?: boolean;
+    flat?: boolean;
+    dryRun?: boolean;
+    cwd?: string;
+}
+declare function generateResource(options: GenerateResourceOptions): Promise<void>;
+
+interface GenerateCleanArchitectureOptions {
+    name: string;
+    dryRun?: boolean;
+    cwd?: string;
+}
+declare function generateCleanArchitecture(options: GenerateCleanArchitectureOptions): Promise<void>;
+
+interface RunCommandOptions {
+    cwd?: string;
+    dryRun?: boolean;
+    silent?: boolean;
+}
+declare function runCommand(command: string, options?: RunCommandOptions): Promise<{
+    stdout: string;
+    stderr: string;
+}>;
+
+declare const logger: {
+    info: (msg: string) => void;
+    success: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string) => void;
+    step: (step: string, detail?: string) => void;
+};
+
+declare function toKebabCase(str: string): string;
+declare function toPascalCase(str: string): string;
+declare function toCamelCase(str: string): string;
+
+interface NestToolsConfig {
+    spec?: boolean;
+    flat?: boolean;
+    architecture?: 'standard' | 'clean';
+    packageManager?: 'npm' | 'yarn' | 'pnpm';
+}
+declare const DEFAULT_CONFIG: NestToolsConfig;
+declare function loadConfig(cwd?: string): Promise<NestToolsConfig>;
+declare function createDefaultConfig(cwd?: string): Promise<string>;
+
+interface DoctorReport {
+    isNestProject: boolean;
+    issues: string[];
+    recommendations: string[];
+}
+declare function runDoctor(cwd?: string): Promise<DoctorReport>;
+
+declare const IS_PUBLIC_KEY = "isPublic";
+/**
+ * Decorator to mark routes as public, skipping global authentication guards.
+ *
+ * @example
+ * ```typescript
+ * @Public()
+ * @Get('health')
+ * checkHealth() {
+ *   return { status: 'ok' };
+ * }
+ * ```
+ */
+declare const Public: () => _nestjs_common.CustomDecorator<string>;
+
+/**
+ * Parameter decorator to easily retrieve the authenticated user from the Request object.
+ *
+ * @example
+ * ```typescript
+ * @Get('profile')
+ * getProfile(@CurrentUser() user: UserEntity) {
+ *   return user;
+ * }
+ *
+ * @Get('id')
+ * getId(@CurrentUser('id') userId: string) {
+ *   return userId;
+ * }
+ * ```
+ */
+declare const CurrentUser: (...dataOrPipes: (string | _nestjs_common.PipeTransform<any, any> | _nestjs_common.Type<_nestjs_common.PipeTransform<any, any>> | undefined)[]) => ParameterDecorator;
+
+interface StandardApiResponse<T> {
+    statusCode: number;
+    success: boolean;
+    data: T;
+    timestamp: string;
+}
+/**
+ * Global or controller interceptor that wraps successful responses in a standard JSON envelope.
+ *
+ * @example
+ * ```typescript
+ * // In main.ts
+ * app.useGlobalInterceptors(new TransformResponseInterceptor());
+ * ```
+ */
+declare class TransformResponseInterceptor<T> implements NestInterceptor<T, StandardApiResponse<T>> {
+    intercept(context: ExecutionContext, next: CallHandler): Observable<StandardApiResponse<T>>;
+}
+
+type SortOrder = 'ASC' | 'DESC' | 'asc' | 'desc';
+declare class PaginationQueryDto {
+    page?: number;
+    limit?: number;
+    sortBy?: string;
+    order?: SortOrder;
+    search?: string;
+    get skip(): number;
+    get take(): number;
+}
+
+interface PaginationMeta {
+    itemCount: number;
+    totalItems: number;
+    itemsPerPage: number;
+    totalPages: number;
+    currentPage: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+}
+interface PaginatedResult<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
+/**
+ * Creates a paginated response object with calculated metadata.
+ */
+declare function createPaginatedResponse<T>(items: T[], totalItems: number, page?: number, limit?: number): PaginatedResult<T>;
+
+export { CurrentUser, DEFAULT_CONFIG, type DoctorReport, type GenerateCleanArchitectureOptions, type GenerateResourceOptions, IS_PUBLIC_KEY, type NestToolsConfig, type PaginatedResult, type PaginationMeta, PaginationQueryDto, Public, type RunCommandOptions, type SortOrder, type StandardApiResponse, TransformResponseInterceptor, createDefaultConfig, createPaginatedResponse, generateCleanArchitecture, generateResource, loadConfig, logger, runCommand, runDoctor, toCamelCase, toKebabCase, toPascalCase };

package/dist/index.d.ts

@@ -0,0 +1,141 @@
+import * as _nestjs_common from '@nestjs/common';
+import { NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { Observable } from 'rxjs';
+
+interface GenerateResourceOptions {
+    name: string;
+    spec?: boolean;
+    flat?: boolean;
+    dryRun?: boolean;
+    cwd?: string;
+}
+declare function generateResource(options: GenerateResourceOptions): Promise<void>;
+
+interface GenerateCleanArchitectureOptions {
+    name: string;
+    dryRun?: boolean;
+    cwd?: string;
+}
+declare function generateCleanArchitecture(options: GenerateCleanArchitectureOptions): Promise<void>;
+
+interface RunCommandOptions {
+    cwd?: string;
+    dryRun?: boolean;
+    silent?: boolean;
+}
+declare function runCommand(command: string, options?: RunCommandOptions): Promise<{
+    stdout: string;
+    stderr: string;
+}>;
+
+declare const logger: {
+    info: (msg: string) => void;
+    success: (msg: string) => void;
+    warn: (msg: string) => void;
+    error: (msg: string) => void;
+    step: (step: string, detail?: string) => void;
+};
+
+declare function toKebabCase(str: string): string;
+declare function toPascalCase(str: string): string;
+declare function toCamelCase(str: string): string;
+
+interface NestToolsConfig {
+    spec?: boolean;
+    flat?: boolean;
+    architecture?: 'standard' | 'clean';
+    packageManager?: 'npm' | 'yarn' | 'pnpm';
+}
+declare const DEFAULT_CONFIG: NestToolsConfig;
+declare function loadConfig(cwd?: string): Promise<NestToolsConfig>;
+declare function createDefaultConfig(cwd?: string): Promise<string>;
+
+interface DoctorReport {
+    isNestProject: boolean;
+    issues: string[];
+    recommendations: string[];
+}
+declare function runDoctor(cwd?: string): Promise<DoctorReport>;
+
+declare const IS_PUBLIC_KEY = "isPublic";
+/**
+ * Decorator to mark routes as public, skipping global authentication guards.
+ *
+ * @example
+ * ```typescript
+ * @Public()
+ * @Get('health')
+ * checkHealth() {
+ *   return { status: 'ok' };
+ * }
+ * ```
+ */
+declare const Public: () => _nestjs_common.CustomDecorator<string>;
+
+/**
+ * Parameter decorator to easily retrieve the authenticated user from the Request object.
+ *
+ * @example
+ * ```typescript
+ * @Get('profile')
+ * getProfile(@CurrentUser() user: UserEntity) {
+ *   return user;
+ * }
+ *
+ * @Get('id')
+ * getId(@CurrentUser('id') userId: string) {
+ *   return userId;
+ * }
+ * ```
+ */
+declare const CurrentUser: (...dataOrPipes: (string | _nestjs_common.PipeTransform<any, any> | _nestjs_common.Type<_nestjs_common.PipeTransform<any, any>> | undefined)[]) => ParameterDecorator;
+
+interface StandardApiResponse<T> {
+    statusCode: number;
+    success: boolean;
+    data: T;
+    timestamp: string;
+}
+/**
+ * Global or controller interceptor that wraps successful responses in a standard JSON envelope.
+ *
+ * @example
+ * ```typescript
+ * // In main.ts
+ * app.useGlobalInterceptors(new TransformResponseInterceptor());
+ * ```
+ */
+declare class TransformResponseInterceptor<T> implements NestInterceptor<T, StandardApiResponse<T>> {
+    intercept(context: ExecutionContext, next: CallHandler): Observable<StandardApiResponse<T>>;
+}
+
+type SortOrder = 'ASC' | 'DESC' | 'asc' | 'desc';
+declare class PaginationQueryDto {
+    page?: number;
+    limit?: number;
+    sortBy?: string;
+    order?: SortOrder;
+    search?: string;
+    get skip(): number;
+    get take(): number;
+}
+
+interface PaginationMeta {
+    itemCount: number;
+    totalItems: number;
+    itemsPerPage: number;
+    totalPages: number;
+    currentPage: number;
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+}
+interface PaginatedResult<T> {
+    data: T[];
+    meta: PaginationMeta;
+}
+/**
+ * Creates a paginated response object with calculated metadata.
+ */
+declare function createPaginatedResponse<T>(items: T[], totalItems: number, page?: number, limit?: number): PaginatedResult<T>;
+
+export { CurrentUser, DEFAULT_CONFIG, type DoctorReport, type GenerateCleanArchitectureOptions, type GenerateResourceOptions, IS_PUBLIC_KEY, type NestToolsConfig, type PaginatedResult, type PaginationMeta, PaginationQueryDto, Public, type RunCommandOptions, type SortOrder, type StandardApiResponse, TransformResponseInterceptor, createDefaultConfig, createPaginatedResponse, generateCleanArchitecture, generateResource, loadConfig, logger, runCommand, runDoctor, toCamelCase, toKebabCase, toPascalCase };