nestjs-papr

Description

nestjs-papr is a module that integrates the Papr library with the Nest Framework.

It provides a way to define Papr models and use them in your Nest modules through dependency injection. This integration allows you to easily work with Papr models in your Nest application.

Supports:

• single MongoDB connection
• multiple MongoDD connections
• passing custom mongo client options
• passing custom database options
• passing custom collection options
• sync and async configuration
• automatic indexes creation

Getting started

Instalation

1# npm
2npm install nestjs-papr
3
4# pnpm
5pnpm add nestjs-papr
6
7# yarn
8yarn install nestjs-papr

Usage

1. Import ParpModule for root

1@Module({
2  imports: [
3    PaprModule.forRootAsync({
4      imports: [ConfigModule],
5      useFactory: (configService: ConfigService) => {
6        const { MONGODB_URI, MONGODB_DATABASE_NAME } =
7          configService.getConfig();
8        return {
9          uri: MONGODB_URI,
10          databaseName: MONGODB_DATABASE_NAME,
11          autoIndex: true, // Create indexes automatically
12          autoSchema: true, // Create schema validation automatically
13        };
14      },
15      inject: [ConfigService],
16    }),
17  ]
18})

2. Define your model

1// user.model.ts
2
3import { model, schema, types } from 'nestjs-papr';
4
5export const UserSchema = schema(
6  {
7    _id: types.objectId({ required: true }),
8    firstName: types.string({ required: true }),
9  },
10  {
11    timestamps: true,
12  },
13);
14export type UserDoc = (typeof UserSchema)[0];
15export type UserProps = Omit<UserDoc, '_id' | 'createdAt' | 'updatedAt'>;
16export type UserCollection = 'users'
17export const UserModelDef = model(UserCollection, UserSchema, { 
18  indexes: [
19    // Optional indexes here (IndexDescription[] type in mongodb);
20  ],
21  collectionOptions: {
22    // Optional collectionOptions here (CollectionOptions type in mongodb);
23  }
24});
25

3. Provide your model for feature

1@Module({
2  imports: [
3    PaprModule.forFeature([
4      UserModelDef,
5    ]),
6  ]
7})

4. Inject model into service and use it's power

1// module.service.ts
2
3import { Injectable } from '@nestjs/common';
4import { InjectModel } from 'nestjs-papr';
5import { UserModelDef, UserDoc, UserProps } from './models/user.model';
6
7@Injectable()
8export class ModuleService {
9  constructor(
10    @InjectModel(UserModelDef)
11    private readonly userModel: typeof UserModelDef.model,
12  ) {}
13  
14  async createUser(userProps: UserProps): Promise<UserDoc> {
15    return await this.userModel.insertOne({ ...userProps });
16  }
17}
18

Decorators

InjectModel = (modelDef: ModelDef, connectionName?: string) - inject model

InjectPapr = (connectionName: string) - inject Papr instance

InjectConnection = (name: string) - inject MongoClient instance

Configuration

1export interface PaprModuleOptions {
2
3  // MongoDB connection uri
4  uri?: string;
5  
6  // Connection name 
7  connectionName?: string;
8  
9  // MongoDB database name
10  databaseName?: string;
11  
12  // Custom MongoClient options
13  mongoClientOptions?: MongoClientOptions;
14  
15  // Custom database options
16  databaseOptions?: DbOptions;
17  
18  // Custom options for papr instance
19  paprOptions?: ModelOptions;
20  
21  // Number of attempts to connect to database
22  retryAttempts?: number;
23  
24  // Number of delay between attempts
25  retryDelay?: number;
26  
27  // Whether to create indexes automatically (default: false)
28  autoIndex?: boolean;
29  
30  // Whether to schema validation automatically  (default: false)
31  autoSchema?: boolean;
32  
33  connectionFactory?: (connection: any, name: string) => any;
34  connectionErrorFactory?: (error: Error) => Error;
35}

License

nestjs-papr is MIT licensed.