DEV Community: Mite

🚀 Crudify 1.2.6: Major Improvements & New Features!

Mite — Mon, 10 Feb 2025 09:50:15 +0000

Hello, developers! 👋

We're excited to announce the latest updates to Crudify, our powerful NestJS library that simplifies CRUD operations. This update introduces significant improvements, fixes, and new features to make your API development even smoother. Let's dive into the details! 🎉

🔥 What's New in Crudify 1.2.6?

🚀 Removed: CrudifyLoggerModule

Starting from 1.2.6, we've removed CrudifyLoggerModule. Instead, you should now use CrudifyModule directly for logging functionalities. This change simplifies the module structure and enhances maintainability.

🔧 Fixes & Enhancements

🛠 QueryParser Fix (1.2.5)

Fixed an issue with the in operator in QueryParser, ensuring better query handling.

🚀 Improved DTO Support (1.2.4)

CrudifyController & CrudifyService now support CreateDto and UpdateDto, enhancing type safety and flexibility in create/update operations.

🗑 Soft Delete Support (1.2.4)

We've introduced soft delete functionality! Now, you can soft-delete records individually or in bulk, providing greater control over data retention.

🔥 Bulk Operation Control (1.2.4)

Added disableBulk in routes.disableBulk, allowing more granular control over bulk operations.

📌 OpenAPI Fix (1.2.4)

Resolved an issue where duplicate operationIds were being generated in Swagger/OpenAPI, improving documentation clarity.

🔧 Errsole Configuration Fix (1.2.4)

Fixed the default URI configuration for Errsole, ensuring proper logging setup.

💡 Other Notable Fixes & Changes

📜 Example Filters in Swagger (1.2.1)

Added example filters in Swagger UI to demonstrate advanced query filtering.

✅ Default Validation Pipe (1.2.1)

Now, UsePipes(new ValidationPipe({ transform: true })) is applied by default to enhance request validation.

📉 Removed CrudifySwaggerModule (1.2.1)

We've deprecated CrudifySwaggerModule. You should now use the classic Swagger configuration instead.

🔥 Upgrade Now!

To upgrade to the latest version, run:

npm update ncrudify

Or install it fresh:

npm install ncrudify@latest

For full documentation, check out our Wiki 📖.

💬 Feedback & Contributions

We love hearing from the community! If you encounter issues or have feature requests, feel free to open an issue or submit a PR on GitHub.

Happy coding! 🚀

Introducing New Features in Crudify: Streamline Your API Development

Mite — Wed, 22 Jan 2025 15:01:22 +0000

Are you tired of writing the same CRUD operations repeatedly for your Mongoose models? Say hello to Crudify! This NestJS library is designed to make your life easier by automatically generating RESTful CRUD endpoints for your Mongoose models. And now, with the latest updates, it’s even better! Let’s dive into what’s new in Crudify and how it can transform your development process.

🚀 What's New in Crudify

1. Advanced Query Parser

The new Query Parser in Crudify transforms URL query parameters into MongoDB-compatible queries. This feature supports:

Filtering with operators like eq, ne, gt, lt, in, and more.
Sorting results by multiple fields.
Pagination with skip and limit.
Population of references with nested options for filtering and sorting.

Here’s an example:

/users?name[starts]=John&age[gte]=30&sort=-createdAt&limit=10

This query fetches users whose names start with "John," are 30 years or older, sorted by creation date in descending order, and limited to 10 results.

2. Custom Decorators for Enhanced Flexibility

Easily add custom decorators to your routes, whether globally or individually. Use this feature to apply guards, add Swagger documentation, or manage authorization seamlessly.

@Crudify({
  model: { type: User },
  routes: {
    config: {
      findAll: {
        decorators: [
          ApiOperation({
            summary: 'Retrieve all users',
            description: 'Fetches all users from the database.',
          }),
        ],
      },
    },
  },
})
@Controller('users')
export class UserController {}

3. Integrated Logger Module

Debugging is now simpler with the new CrudifyLoggerModule. It intercepts uncaught errors and logs them for you. Configure it to suit your project’s needs, ensuring you never miss an important detail.

@Module({
  imports: [
    CrudifyLoggerModule.forRoot({
      uri: process.env.MONGODB_URI,
      dbName: process.env.MONGODB_LOGDB,
    }),
  ],
})
export class AppModule {}

4. Bulk Operations

Streamline your batch processing with new bulk endpoints:

POST /your-model/bulk: Create multiple records.
PATCH /your-model/bulk: Update multiple records.
DELETE /your-model/bulk: Delete multiple records.

5. Authorization Made Simple

Combine UseGuards with Crudify to manage route access control effectively. Protect specific routes or entire controllers with your custom authorization logic.

@Crudify({
  model: { type: User },
  routes: {
    config: {
      create: {
        decorators: [UseGuards(AuthGuard)],
      },
    },
  },
})
class UserController {}

💡 Why Use Crudify?

Save Time: Focus on building features instead of boilerplate code.
Customization: Tailor endpoints to your needs with ease.
Swagger Support: Automatically generate API documentation.
Seamless NestJS Integration: Fits perfectly into your existing projects.

🚀 Get Started Today

Ready to supercharge your NestJS development? Install Crudify and start building smarter APIs now:

npm install ncrudify

Check out the Crudify GitHub repository for more details, examples, and documentation. Don’t forget to give it a star if you find it helpful!

Let Crudify handle the repetitive tasks so you can focus on what truly matters: creating amazing applications.

Have you seen the new bulk operations?

Mite — Mon, 20 Jan 2025 13:33:21 +0000

Crudify: Automate Your Mongoose CRUD Operations in NestJS

Mite ・ Jan 9

#nestjs #mongodb #mongoose #swagger

Crudify: Automate Your Mongoose CRUD Operations in NestJS

Mite — Thu, 09 Jan 2025 13:09:57 +0000

Are you tired of writing repetitive CRUD logic for your Mongoose models? Meet Crudify, a NestJS library designed to simplify your development workflow by automatically generating RESTful CRUD endpoints. With just a few lines of code, you can set up a fully functional API, complete with Swagger documentation and built-in logging.

📚 What is Crudify?

Crudify is a powerful tool for NestJS developers who work with Mongoose. It reduces boilerplate code by automating the creation of CRUD (Create, Read, Update, Delete) endpoints for your models. But that’s not all! It also provides automatic Swagger documentation and integrates a logger to handle uncaught errors, making your API more maintainable and developer-friendly.

With Crudify, you can:

🚀 Automatically generate CRUD endpoints for your Mongoose models.
📖 Get fully functional Swagger UI without any additional setup.
🛠️ Customize endpoints to fit your specific needs.
🧰 Simplify debugging with integrated logging.

🛠️ Quick Setup

1. Install Dependencies

npm install ncrudify

2. Define Your Model

import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document } from 'mongoose';

@Schema()
export class User extends Document {
  @Prop({ required: true }) name: string;
  @Prop({ required: true, unique: true }) email: string;
  @Prop() age: number;
}

export const UserSchema = SchemaFactory.createForClass(User);

3. Create a Service

import { Injectable } from '@nestjs/common';
import { Model } from 'mongoose';
import { InjectModel } from '@nestjs/mongoose';
import { CrudifyService } from 'ncrudify';

@Injectable()
export class UserService extends CrudifyService<User> {
  constructor(@InjectModel(User.name) userModel: Model<User>) {
    super(userModel);
  }
}

4. Build a Controller

import { Controller } from '@nestjs/common';
import { UserService } from './user.service';
import { Crudify, CrudifyController } from 'ncrudify';

@Crudify({ model: { type: User } })
@Controller('users')
export class UserController extends CrudifyController<User> {
  constructor(public service: UserService) {
    super(service);
  }
}

🌐 Swagger Integration

Crudify makes it effortless to set up Swagger documentation for your API. Swagger automatically documents all your CRUD endpoints, making it easier to test and share your API with your team or external users.

Once set up, you can access the Swagger UI at http://localhost:3000/api, where you’ll find a user-friendly interface to interact with your API.

1. Import `CrudifySwaggerModule` in `AppModule`:

import { Module } from '@nestjs/common';
import { MongooseModule } from '@nestjs/mongoose';
import { CrudifySwaggerModule } from 'ncrudify';

@Module({
  imports: [
    MongooseModule.forRoot(process.env.MONGODB_URI),
    CrudifySwaggerModule,
  ],
})
export class AppModule {}

2. Setup Swagger in `main.ts`:

import { NestFactory } from '@nestjs/core';
import { CrudifySwaggerModule } from 'ncrudify';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  CrudifySwaggerModule.setupSwagger(app);
  await app.listen(3000);
}
bootstrap();

🧰 Integrated Logging

Crudify includes a logger to capture and manage uncaught errors, making your debugging process more efficient. The logger is based on Errsole, a tool designed to help developers track runtime errors and improve error handling.

How to Enable the Logger

1. Import `CrudifyLoggerModule` in `AppModule`:

import { CrudifyLoggerModule } from 'ncrudify';

@Module({
  imports: [CrudifyLoggerModule],
})
export class AppModule {}

2. Access the Logger UI

By default, the Crudify Logger listens on http://localhost:3001. You can access this interface to see all uncaught errors, including stack traces and request details, which makes identifying and fixing issues faster.

Customize the Logger

You can adjust the logger’s configuration by providing custom options, such as log levels or output destinations, to match your project’s needs.

🔎 Advanced Query Filters

Crudify supports powerful query filters using a simple format:

field=[$operator]:value

Examples

age=[$gt]:30 - Find users older than 30.
name=[$eq]:John - Find users named John.

Supported Operators

$eq: Equal to
$ne: Not equal to
$gt: Greater than
$lt: Less than
$gte: Greater than or equal to
$lte: Less than or equal to
$cont: Contains (for strings)
$excl: Does not contain (for strings)
$in: In a set of values
$notin: Not in a set of values
$isnull: Is null
$notnull: Is not null
$between: Between two values

💡 Boost Your Productivity

Crudify is more than just a tool for generating endpoints. It’s a productivity booster for NestJS developers, helping you focus on what matters: building great applications. By handling the repetitive parts of CRUD operations, Swagger setup, and error logging, Crudify saves you time and effort.

👉 GitHub: Crudify

❤️ Support on Buy Me a Coffee.

Nextjs tech stack

Mite — Sun, 05 Jan 2025 02:51:44 +0000

DEV Community: Mite

🚀 Crudify 1.2.6: Major Improvements & New Features!

🔥 What's New in Crudify 1.2.6?

🚀 Removed: CrudifyLoggerModule

🔧 Fixes & Enhancements

🛠 QueryParser Fix (1.2.5)

🚀 Improved DTO Support (1.2.4)

🗑 Soft Delete Support (1.2.4)

🔥 Bulk Operation Control (1.2.4)

📌 OpenAPI Fix (1.2.4)

🔧 Errsole Configuration Fix (1.2.4)

💡 Other Notable Fixes & Changes

📜 Example Filters in Swagger (1.2.1)

✅ Default Validation Pipe (1.2.1)

📉 Removed CrudifySwaggerModule (1.2.1)

🔥 Upgrade Now!

💬 Feedback & Contributions

Introducing New Features in Crudify: Streamline Your API Development

🚀 What's New in Crudify

1. Advanced Query Parser

2. Custom Decorators for Enhanced Flexibility

3. Integrated Logger Module

4. Bulk Operations

5. Authorization Made Simple

💡 Why Use Crudify?

🚀 Get Started Today

Have you seen the new bulk operations?

Crudify: Automate Your Mongoose CRUD Operations in NestJS

Mite ・ Jan 9

Crudify: Automate Your Mongoose CRUD Operations in NestJS

📚 What is Crudify?

🛠️ Quick Setup

1. Install Dependencies

2. Define Your Model

3. Create a Service

4. Build a Controller

🌐 Swagger Integration

1. Import CrudifySwaggerModule in AppModule:

2. Setup Swagger in main.ts:

🧰 Integrated Logging

How to Enable the Logger

1. Import CrudifyLoggerModule in AppModule:

2. Access the Logger UI

Customize the Logger

🔎 Advanced Query Filters

Examples

Supported Operators

💡 Boost Your Productivity

Nextjs tech stack

1. Import `CrudifySwaggerModule` in `AppModule`:

2. Setup Swagger in `main.ts`:

1. Import `CrudifyLoggerModule` in `AppModule`: