@furkanogutcu/nest-common 0.0.3 → 1.0.1

package/README.md

@@ -12,6 +12,10 @@ This package is designed to standardize structures you repeatedly use in your Ne
 - [Installation](#installation)
 - [Features](#features)
   - [Exceptions](#1-exceptions)
+  - [API Responses](#2-api-responses)
+  - [Validators and Pipes](#3-validators-and-pipes)
+  - [Decorators](#4-decorators)
+  - [Utilities](#5-utilities)
 - [Development](#development)
 - [License](#license)
 
@@ -39,25 +43,27 @@ No additional installation steps are needed beyond installing the package.
 
 - **Custom Exception Classes**: Comprehensive set of HTTP-based exception classes for consistent error responses.
 
-  | Exception Class | HTTP Status | Description |
-  |-----------------|-------------|-------------|
-  | `AppException` | - | Base exception class for all custom exceptions |
-  | `AppBadRequestException` | 400 | For invalid input, malformed requests |
-  | `AppUnauthorizedException` | 401 | For authentication failures |
-  | `AppForbiddenException` | 403 | For authorization failures |
-  | `AppNotFoundException` | 404 | For resources that couldn't be found |
-  | `AppConflictException` | 409 | For conflicting requests (e.g., duplicate entries) |
-  | `AppUnprocessableEntityException` | 422 | For semantically incorrect requests |
-  | `AppInternalException` | 500 | For server-side errors |
-  | `AppTooManyRequestException` | 429 | For rate limiting scenarios |
-  | `AppValidationException` | 400 | Specifically for input validation errors |
+  | Exception Class                   | HTTP Status | Description                                        |
+  | --------------------------------- | ----------- | -------------------------------------------------- |
+  | `AppException`                    | -           | Base exception class for all custom exceptions     |
+  | `AppBadRequestException`          | 400         | For invalid input, malformed requests              |
+  | `AppUnauthorizedException`        | 401         | For authentication failures                        |
+  | `AppForbiddenException`           | 403         | For authorization failures                         |
+  | `AppNotFoundException`            | 404         | For resources that couldn't be found               |
+  | `AppConflictException`            | 409         | For conflicting requests (e.g., duplicate entries) |
+  | `AppUnprocessableEntityException` | 422         | For semantically incorrect requests                |
+  | `AppInternalException`            | 500         | For server-side errors                             |
+  | `AppTooManyRequestException`      | 429         | For rate limiting scenarios                        |
+  | `AppValidationException`          | 400         | Specifically for input validation errors           |
 
 - **Global Exception Filter**: Automatically catches and transforms exceptions throughout your application.
+
   - Centralized error handling logic
   - Consistent error response format
   - Easy to configure through NestJS's dependency injection
 
 - **Exception Transformers**: Converts various error types to standardized app exceptions.
+
   - NestJS built-in exception transformer
   - TypeORM exception transformer
 
@@ -155,6 +161,168 @@ The `type` field in validation error details can have the following values:
 
 For more detailed information about the filters, transformers, and interfaces included in the exceptions package, please check the source code.
 
+### 2. API Responses
+
+#### Features
+
+- **Standardized Response Types**: Comprehensive set of response interfaces for consistent API responses.
+  - `APIResponse`: Generic type for creating standardized responses
+  - `APIResponseOnlyMessage`: Simple message-only response
+  - `PaginatedAPIResponse`: Response format for paginated data with metadata
+
+#### Usage
+
+```typescript
+import { Controller, Get, Post, Body, Param, Query } from '@nestjs/common';
+import {
+  APIResponse,
+  APIResponseOnlyMessage,
+  PaginatedAPIResponse,
+  Pagination,
+  PaginationParams,
+} from '@furkanogutcu/nest-common';
+import { User } from './user.entity';
+import { CreateUserDto } from './dto/create-user.dto';
+
+@Controller('users')
+export class UsersController {
+  constructor(private readonly usersService: UsersService) {}
+
+  @Get()
+  async findAll(@Pagination() { skip, take }: PaginationParams): Promise<PaginatedAPIResponse<User>> {
+    const { items, metadata } = await this.usersService.findAll({ skip, take });
+
+    return {
+      data: items,
+      metadata,
+    };
+  }
+
+  @Get(':id')
+  async findOne(@Param('id') id: string): Promise<APIResponse<'user', User>> {
+    const user = await this.usersService.findOne(id);
+
+    return {
+      user,
+    };
+  }
+
+  @Post()
+  async create(@Body() createUserDto: CreateUserDto): Promise<APIResponseOnlyMessage> {
+    await this.usersService.create(createUserDto);
+
+    return {
+      message: 'User created successfully',
+    };
+  }
+}
+```
+
+### 3. Validators and Pipes
+
+#### Features
+
+- **Zod Validation Pipe**: Extended validation pipe for NestJS using Zod schema validation.
+
+  - Seamless integration with NestJS validation pipeline
+  - Throws consistent `AppValidationException` on validation errors
+  - Compatible with Zod schemas
+
+- **Common Validation Schemas**:
+  - `paginationSchema`: For standardizing pagination parameters
+  - `orderBySchema`: For standardizing sorting/ordering parameters
+  - `searchSchema`: For standardizing search parameters
+
+#### Usage
+
+##### Setting up validation globally
+
+```typescript
+import { Module } from '@nestjs/common';
+import { APP_PIPE } from '@nestjs/core';
+import { AppZodValidationPipe } from '@furkanogutcu/nest-common';
+
+@Module({
+  imports: [
+    // Your other modules
+  ],
+  controllers: [
+    // Your controllers
+  ],
+  providers: [
+    // Your other providers
+    {
+      provide: APP_PIPE,
+      useClass: AppZodValidationPipe,
+    },
+  ],
+})
+export class AppModule {}
+```
+
+### 4. Decorators
+
+#### Features
+
+- **Parameter Decorators**: Decorators for common query parameter extraction and validation.
+  - `@Pagination()`: Extracts and validates pagination parameters
+  - `@OrderBy()`: Extracts and validates ordering parameters
+  - `@Search()`: Extracts and validates search parameters
+
+#### Usage
+
+```typescript
+import { Controller, Get } from '@nestjs/common';
+import { Pagination, OrderBy, Search, PaginationParams, OrderByParam, SearchParams } from '@furkanogutcu/nest-common';
+
+@Controller('users')
+export class UsersController {
+  @Get()
+  findAll(
+    @Pagination() { skip, take }: PaginationParams,
+    @OrderBy<User>(['created_at']) orderBy: OrderByParam<User>,
+    @Search<User>(['email']) search: SearchParams<User>,
+  ) {
+    // Implement your service call with these validated parameters
+    return this.usersService.findAll({ skip, take, orderBy, where: search });
+  }
+}
+```
+
+### 5. Utilities
+
+#### Features
+
+- **Asynchronous Utilities**:
+  - `exponentialRetry`: Retry a function with exponential backoff
+  - `sleep`: Simple promise-based delay utility
+
+#### Usage
+
+```typescript
+import { exponentialRetry, sleep } from '@furkanogutcu/nest-common';
+
+// Retry a function with exponential backoff
+async function fetchWithRetry() {
+  return exponentialRetry(
+    async () => {
+      // Potentially failing operation (e.g., API call)
+      return await externalApiCall();
+    },
+    {
+      maxAttempts: 5, // Maximum of 5 attempts
+      baseDelayMs: 1000, // Starting delay of 1000ms (will grow exponentially)
+    },
+  );
+}
+
+// Simple delay utility
+async function processWithDelay() {
+  await sleep(2000); // Wait for 2 seconds
+  // Continue execution
+}
+```
+
 ## Development
 
 ### Requirements

package/dist/decorators/index.d.ts

@@ -0,0 +1,3 @@
+export * from './order-by.decorator';
+export * from './pagination.decorator';
+export * from './search.decorator';

package/dist/decorators/index.js

@@ -0,0 +1,20 @@
+"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("./order-by.decorator"), exports);
+__exportStar(require("./pagination.decorator"), exports);
+__exportStar(require("./search.decorator"), exports);
+//# sourceMappingURL=index.js.map

package/dist/decorators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/decorators/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,yDAAuC;AACvC,qDAAmC"}

package/dist/decorators/order-by.decorator.d.ts

@@ -0,0 +1,3 @@
+import { FindOptionsOrder } from 'typeorm';
+export type OrderByParam<Entity> = FindOptionsOrder<Entity> | undefined;
+export declare const OrderBy: <Entity>(fields: (keyof Entity)[]) => ParameterDecorator;

package/dist/decorators/order-by.decorator.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderBy = void 0;
+const common_1 = require("@nestjs/common");
+const order_by_validation_1 = require("../validations/order-by.validation");
+const OrderBy = (fields) => (0, common_1.createParamDecorator)((data, ctx) => {
+    const request = ctx.switchToHttp().getRequest();
+    const orderBySchema = (0, order_by_validation_1.createOrderBySchema)(fields);
+    return orderBySchema.parse(request.query).order_by;
+})();
+exports.OrderBy = OrderBy;
+//# sourceMappingURL=order-by.decorator.js.map

package/dist/decorators/order-by.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-by.decorator.js","sourceRoot":"","sources":["../../src/decorators/order-by.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AAIxE,4EAAyE;AAIlE,MAAM,OAAO,GAAG,CAAS,MAAwB,EAAE,EAAE,CAC1D,IAAA,6BAAoB,EAAC,CAAC,IAAa,EAAE,GAAqB,EAAwB,EAAE;IAClF,MAAM,OAAO,GAAY,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IAEzD,MAAM,aAAa,GAAG,IAAA,yCAAmB,EAAC,MAAkB,CAAC,CAAC;IAE9D,OAAO,aAAa,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,QAAe,CAAC;AAC5D,CAAC,CAAC,EAAE,CAAC;AAPM,QAAA,OAAO,WAOb"}

package/dist/decorators/pagination.decorator.d.ts

@@ -0,0 +1 @@
+export declare const Pagination: (...dataOrPipes: unknown[]) => ParameterDecorator;

package/dist/decorators/pagination.decorator.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pagination = void 0;
+const common_1 = require("@nestjs/common");
+const pagination_validation_1 = require("../validations/pagination.validation");
+exports.Pagination = (0, common_1.createParamDecorator)((data, ctx) => {
+    const request = ctx.switchToHttp().getRequest();
+    return pagination_validation_1.paginationSchema.parse(request.query);
+});
+//# sourceMappingURL=pagination.decorator.js.map

package/dist/decorators/pagination.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.decorator.js","sourceRoot":"","sources":["../../src/decorators/pagination.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AAGxE,gFAAwE;AAE3D,QAAA,UAAU,GAAG,IAAA,6BAAoB,EAAC,CAAC,IAAa,EAAE,GAAqB,EAAE,EAAE;IACtF,MAAM,OAAO,GAAY,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IAEzD,OAAO,wCAAgB,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC/C,CAAC,CAAC,CAAC"}

package/dist/decorators/search.decorator.d.ts

@@ -0,0 +1,3 @@
+import { FindOptionsWhere } from 'typeorm';
+export type SearchParams<Entity> = FindOptionsWhere<Entity> | undefined;
+export declare const Search: <Entity>(fields: (keyof Entity)[]) => ParameterDecorator;

package/dist/decorators/search.decorator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Search = void 0;
+const common_1 = require("@nestjs/common");
+const typeorm_1 = require("typeorm");
+const search_validation_1 = require("../validations/search.validation");
+const Search = (fields) => (0, common_1.createParamDecorator)((data, ctx) => {
+    const request = ctx.switchToHttp().getRequest();
+    const parsed = search_validation_1.searchSchema.parse(request.query);
+    if (!parsed.q)
+        return;
+    return fields.map((field) => ({
+        [field]: (0, typeorm_1.Raw)((alias) => `CAST(${alias} AS TEXT) ILIKE :searchTerm`, { searchTerm: `%${parsed.q}%` }),
+    }));
+})();
+exports.Search = Search;
+//# sourceMappingURL=search.decorator.js.map

package/dist/decorators/search.decorator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.decorator.js","sourceRoot":"","sources":["../../src/decorators/search.decorator.ts"],"names":[],"mappings":";;;AAAA,2CAAwE;AAExE,qCAAgD;AAEhD,wEAAgE;AAIzD,MAAM,MAAM,GAAG,CAAS,MAAwB,EAAE,EAAE,CACzD,IAAA,6BAAoB,EAAC,CAAC,IAAa,EAAE,GAAqB,EAAwB,EAAE;IAClF,MAAM,OAAO,GAAY,GAAG,CAAC,YAAY,EAAE,CAAC,UAAU,EAAE,CAAC;IAEzD,MAAM,MAAM,GAAG,gCAAY,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAEjD,IAAI,CAAC,MAAM,CAAC,CAAC;QAAE,OAAO;IAEtB,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAC5B,CAAC,KAAK,CAAC,EAAE,IAAA,aAAG,EAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,KAAK,6BAA6B,EAAE,EAAE,UAAU,EAAE,IAAI,MAAM,CAAC,CAAC,GAAG,EAAE,CAAC;KACrG,CAAC,CAAQ,CAAC;AACb,CAAC,CAAC,EAAE,CAAC;AAXM,QAAA,MAAM,UAWZ"}

package/dist/index.d.ts

@@ -1 +1,6 @@
+export * from './decorators';
 export * from './exceptions';
+export * from './pipes';
+export * from './responses';
+export * from './utils';
+export * from './validations';

package/dist/index.js

@@ -14,5 +14,10 @@ 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("./decorators"), exports);
 __exportStar(require("./exceptions"), exports);
+__exportStar(require("./pipes"), exports);
+__exportStar(require("./responses"), exports);
+__exportStar(require("./utils"), exports);
+__exportStar(require("./validations"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA6B;AAC7B,+CAA6B;AAC7B,0CAAwB;AACxB,8CAA4B;AAC5B,0CAAwB;AACxB,gDAA8B"}

package/dist/pipes/app-zod-validation.pipe.d.ts

@@ -0,0 +1,5 @@
+import { ZodValidationPipe } from '@anatine/zod-nestjs';
+import { ArgumentMetadata } from '@nestjs/common';
+export declare class AppZodValidationPipe extends ZodValidationPipe {
+    transform(value: unknown, metadata: ArgumentMetadata): unknown;
+}

package/dist/pipes/app-zod-validation.pipe.js

@@ -0,0 +1,28 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppZodValidationPipe = void 0;
+const zod_nestjs_1 = require("@anatine/zod-nestjs");
+const common_1 = require("@nestjs/common");
+const exceptions_1 = require("../exceptions");
+let AppZodValidationPipe = class AppZodValidationPipe extends zod_nestjs_1.ZodValidationPipe {
+    transform(value, metadata) {
+        const zodSchema = metadata?.metatype?.zodSchema;
+        if (!zodSchema)
+            return value;
+        const parseResult = zodSchema.safeParse(value);
+        if (!parseResult.success)
+            throw new exceptions_1.AppValidationException(parseResult.error);
+        return parseResult.data;
+    }
+};
+exports.AppZodValidationPipe = AppZodValidationPipe;
+exports.AppZodValidationPipe = AppZodValidationPipe = __decorate([
+    (0, common_1.Injectable)()
+], AppZodValidationPipe);
+//# sourceMappingURL=app-zod-validation.pipe.js.map

package/dist/pipes/app-zod-validation.pipe.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-zod-validation.pipe.js","sourceRoot":"","sources":["../../src/pipes/app-zod-validation.pipe.ts"],"names":[],"mappings":";;;;;;;;;AAAA,oDAAsE;AACtE,2CAA8D;AAE9D,8CAAuD;AAGhD,IAAM,oBAAoB,GAA1B,MAAM,oBAAqB,SAAQ,8BAAiB;IACzD,SAAS,CAAC,KAAc,EAAE,QAA0B;QAClD,MAAM,SAAS,GAAI,QAAQ,EAAE,QAAyB,EAAE,SAAS,CAAC;QAElE,IAAI,CAAC,SAAS;YAAE,OAAO,KAAK,CAAC;QAE7B,MAAM,WAAW,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE/C,IAAI,CAAC,WAAW,CAAC,OAAO;YAAE,MAAM,IAAI,mCAAsB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAE9E,OAAO,WAAW,CAAC,IAAI,CAAC;IAC1B,CAAC;CACF,CAAA;AAZY,oDAAoB;+BAApB,oBAAoB;IADhC,IAAA,mBAAU,GAAE;GACA,oBAAoB,CAYhC"}

package/dist/pipes/index.d.ts

@@ -0,0 +1 @@
+export * from './app-zod-validation.pipe';

package/dist/pipes/index.js

@@ -0,0 +1,18 @@
+"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("./app-zod-validation.pipe"), exports);
+//# sourceMappingURL=index.js.map

package/dist/pipes/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pipes/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C"}

package/dist/responses/api-response.type.d.ts

@@ -0,0 +1,17 @@
+type APIResponseValue = any[] | Record<string, any>;
+export type APIResponse<T extends string[] | string, R = APIResponseValue> = {
+    [K in T extends string ? T : T[number]]: R;
+};
+export type APIResponseOnlyMessage = APIResponse<'message', string>;
+export type APIResponseMetadata = {
+    metadata: {
+        pagination: {
+            page: number;
+            per_page: number;
+            total_pages: number;
+            total_items: number;
+        };
+    };
+};
+export type PaginatedAPIResponse<R = APIResponseValue> = APIResponse<'data', R[]> & APIResponseMetadata;
+export {};

package/dist/responses/api-response.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-response.type.js.map

package/dist/responses/api-response.type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-response.type.js","sourceRoot":"","sources":["../../src/responses/api-response.type.ts"],"names":[],"mappings":""}

package/dist/responses/index.d.ts

@@ -0,0 +1 @@
+export * from './api-response.type';

package/dist/responses/index.js

@@ -0,0 +1,18 @@
+"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("./api-response.type"), exports);
+//# sourceMappingURL=index.js.map

package/dist/responses/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/responses/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC"}

package/dist/utils/exponential-retry.util.d.ts

@@ -0,0 +1,5 @@
+export interface ExponentialRetryOptions {
+    maxAttempts?: number;
+    baseDelayMs?: number;
+}
+export declare function exponentialRetry<T>(fn: () => Promise<T>, options?: ExponentialRetryOptions): Promise<T>;

package/dist/utils/exponential-retry.util.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exponentialRetry = exponentialRetry;
+const sleep_util_1 = require("./sleep.util");
+async function exponentialRetry(fn, options) {
+    const maxAttempts = options?.maxAttempts ?? 3;
+    const baseDelayMs = options?.baseDelayMs ?? 2000;
+    let lastError = null;
+    for (let attempt = 1; attempt <= maxAttempts; attempt++) {
+        try {
+            return await fn();
+        }
+        catch (error) {
+            lastError = error instanceof Error ? error : new Error(String(error));
+            if (attempt === maxAttempts)
+                throw lastError;
+            const delay = Math.pow(2, attempt) * baseDelayMs;
+            await (0, sleep_util_1.sleep)(delay);
+        }
+    }
+    throw lastError || new Error('Unknown error');
+}
+//# sourceMappingURL=exponential-retry.util.js.map

package/dist/utils/exponential-retry.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exponential-retry.util.js","sourceRoot":"","sources":["../../src/utils/exponential-retry.util.ts"],"names":[],"mappings":";;AAOA,4CAqBC;AA5BD,6CAAqC;AAO9B,KAAK,UAAU,gBAAgB,CAAI,EAAoB,EAAE,OAAiC;IAC/F,MAAM,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,CAAC,CAAC;IAC9C,MAAM,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,IAAI,CAAC;IAEjD,IAAI,SAAS,GAAiB,IAAI,CAAC;IAEnC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;QACxD,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,EAAE,CAAC;QACpB,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAEtE,IAAI,OAAO,KAAK,WAAW;gBAAE,MAAM,SAAS,CAAC;YAE7C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,WAAW,CAAC;YAEjD,MAAM,IAAA,kBAAK,EAAC,KAAK,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;IAED,MAAM,SAAS,IAAI,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;AAChD,CAAC"}

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './exponential-retry.util';
+export * from './sleep.util';

package/dist/utils/index.js

@@ -0,0 +1,19 @@
+"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("./exponential-retry.util"), exports);
+__exportStar(require("./sleep.util"), exports);
+//# sourceMappingURL=index.js.map

package/dist/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC;AACzC,+CAA6B"}

package/dist/utils/sleep.util.d.ts

@@ -0,0 +1 @@
+export declare const sleep: (timeout: number) => Promise<void>;

package/dist/utils/sleep.util.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = void 0;
+const sleep = async (timeout) => {
+    return await new Promise((resolve) => setTimeout(resolve, timeout));
+};
+exports.sleep = sleep;
+//# sourceMappingURL=sleep.util.js.map

package/dist/utils/sleep.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.util.js","sourceRoot":"","sources":["../../src/utils/sleep.util.ts"],"names":[],"mappings":";;;AAAO,MAAM,KAAK,GAAG,KAAK,EAAE,OAAe,EAAE,EAAE;IAC7C,OAAO,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AAC5E,CAAC,CAAC;AAFW,QAAA,KAAK,SAEhB"}

package/dist/validations/index.d.ts

@@ -0,0 +1,3 @@
+export * from './order-by.validation';
+export * from './pagination.validation';
+export * from './search.validation';

package/dist/validations/index.js

@@ -0,0 +1,20 @@
+"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("./order-by.validation"), exports);
+__exportStar(require("./pagination.validation"), exports);
+__exportStar(require("./search.validation"), exports);
+//# sourceMappingURL=index.js.map

package/dist/validations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/validations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAsC;AACtC,0DAAwC;AACxC,sDAAoC"}

package/dist/validations/order-by.validation.d.ts

@@ -0,0 +1,14 @@
+import { z } from 'zod';
+export declare const createOrderBySchema: (fields: string[]) => z.ZodObject<{
+    order_by: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodString, {
+        [x: string]: string;
+    }, string>, {
+        [x: string]: string;
+    }, string>>;
+}, "strip", z.ZodTypeAny, {
+    order_by?: {
+        [x: string]: string;
+    } | undefined;
+}, {
+    order_by?: string | undefined;
+}>;

package/dist/validations/order-by.validation.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOrderBySchema = void 0;
+const zod_1 = require("zod");
+const createOrderBySchema = (fields) => zod_1.z.object({
+    order_by: zod_1.z
+        .string()
+        .transform((val) => {
+        const [direction, field] = val.startsWith('-') ? ['desc', val.slice(1)] : ['asc', val];
+        return { [field]: direction };
+    })
+        .refine((val) => fields.includes(Object.keys(val)[0]), {
+        message: `Field must be one of: ${fields.join(', ')} `,
+    })
+        .optional(),
+});
+exports.createOrderBySchema = createOrderBySchema;
+//# sourceMappingURL=order-by.validation.js.map

package/dist/validations/order-by.validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-by.validation.js","sourceRoot":"","sources":["../../src/validations/order-by.validation.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEjB,MAAM,mBAAmB,GAAG,CAAC,MAAgB,EAAE,EAAE,CACtD,OAAC,CAAC,MAAM,CAAC;IACP,QAAQ,EAAE,OAAC;SACR,MAAM,EAAE;SACR,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;QACjB,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAEvF,OAAO,EAAE,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,CAAC;IAChC,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE;QACrD,OAAO,EAAE,yBAAyB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;KACvD,CAAC;SACD,QAAQ,EAAE;CACd,CAAC,CAAC;AAbQ,QAAA,mBAAmB,uBAa3B"}

package/dist/validations/pagination.validation.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+export declare const paginationSchema: z.ZodEffects<z.ZodObject<{
+    page: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+    per_page: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
+}, "strip", z.ZodTypeAny, {
+    page: number;
+    per_page: number;
+}, {
+    page?: number | undefined;
+    per_page?: number | undefined;
+}>, {
+    skip: number;
+    take: number;
+}, {
+    page?: number | undefined;
+    per_page?: number | undefined;
+}>;
+export type PaginationParams = z.output<typeof paginationSchema>;

package/dist/validations/pagination.validation.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.paginationSchema = void 0;
+const zod_1 = require("zod");
+exports.paginationSchema = zod_1.z
+    .object({
+    page: zod_1.z.coerce.number().int().positive().optional().default(1),
+    per_page: zod_1.z.coerce.number().int().positive().optional().default(20),
+})
+    .transform(({ page, per_page }) => {
+    return {
+        skip: (page - 1) * per_page,
+        take: per_page,
+    };
+});
+//# sourceMappingURL=pagination.validation.js.map

package/dist/validations/pagination.validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.validation.js","sourceRoot":"","sources":["../../src/validations/pagination.validation.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEX,QAAA,gBAAgB,GAAG,OAAC;KAC9B,MAAM,CAAC;IACN,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;IAC9D,QAAQ,EAAE,OAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;CACpE,CAAC;KACD,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE;IAChC,OAAO;QACL,IAAI,EAAE,CAAC,IAAI,GAAG,CAAC,CAAC,GAAG,QAAQ;QAC3B,IAAI,EAAE,QAAQ;KACf,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/validations/search.validation.d.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod';
+export declare const searchSchema: z.ZodObject<{
+    q: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    q?: string | undefined;
+}, {
+    q?: string | undefined;
+}>;

package/dist/validations/search.validation.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.searchSchema = void 0;
+const zod_1 = require("zod");
+exports.searchSchema = zod_1.z.object({
+    q: zod_1.z.string().optional(),
+});
+//# sourceMappingURL=search.validation.js.map

package/dist/validations/search.validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.validation.js","sourceRoot":"","sources":["../../src/validations/search.validation.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEX,QAAA,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IACnC,CAAC,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACzB,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@furkanogutcu/nest-common",
-  "version": "0.0.3",
+  "version": "1.0.1",
   "description": "Package of common structures for NestJS.",
   "author": "Furkan Ogutcu",
   "license": "MIT",
@@ -51,7 +51,8 @@
     "@nestjs/testing": "11.1.0",
     "@nestjs/platform-express": "^11.1.0",
     "zod": "^3.24.3",
-    "typeorm": "^0.3.22"
+    "typeorm": "^0.3.22",
+    "@anatine/zod-nestjs": "^2.0.12"
   },
   "dependencies": {},
   "devDependencies": {