@los_generic/shared NPM

@los_generic/shared

A public shared library containing DTOs, interfaces, utilities, and other common code for LOS applications.

Installation

npm install @los_generic/shared

Features

DTOs: Reusable Data Transfer Objects with validation
- Country DTOs (CreateCountryDto, UpdateCountryDto)
- More DTOs can be added as needed
Interfaces: Common TypeScript interfaces
- Pagination interfaces
- Base interfaces
Utils: Utility functions
- Pagination utilities
- More utilities can be added as needed

Usage Examples

Using DTOs

import { CreateCountryDto, UpdateCountryDto } from '@los_generic/shared';

@Post()
async createCountry(@Body() createCountryDto: CreateCountryDto) {
  // DTO will automatically validate the input
  return this.countryService.create(createCountryDto);
}

@Put(':id')
async updateCountry(
  @Param('id') id: string,
  @Body() updateCountryDto: UpdateCountryDto
) {
  return this.countryService.update(id, updateCountryDto);
}

Using Pagination

import { 
  PaginationParams, 
  createPaginatedResponse,
  getPaginationParams 
} from '@los_generic/shared';

@Get()
async findAll(@Query() query: PaginationParams) {
  const params = getPaginationParams(query);
  const [items, total] = await this.repository.findAndCount({
    skip: (params.page - 1) * params.limit,
    take: params.limit,
    order: { [params.sortBy]: params.sortOrder }
  });
  
  return createPaginatedResponse(items, total, params);
}

Development

Install dependencies:

npm install

Build the package:

npm run build

Watch for changes during development:

npm run watch

Publishing

This package is published as a public package under the @los_generic organization.

# For bug fixes (0.0.x)
npm run patch

# For new features (0.x.0)
npm run minor

# For breaking changes (x.0.0)
npm run major

Dependencies

Peer Dependencies

@nestjs/common: ^10.0.0
class-transformer: ^0.5.1
class-validator: ^0.14.0

Make sure these peer dependencies are installed in your project.

Project Structure

src/
├── modules/
│   └── country/
│       ├── dto/
│       │   ├── create-country.dto.ts
│       │   └── update-country.dto.ts
│       ├── index.ts
│       └── pattern.ts
└── index.ts