A progressive Node.js framework for building efficient and scalable server-side applications.
\n\n
\n\n\n\n\n\n
\n\n## Description\n\n[Dynamoose](https://dynamoosejs.com/) module for [Nest](https://github.com/nestjs/nest).\n\n## Installation\n\n```bash\n$ npm install --save nestjs-dynamoose dynamoose\n```\n\n## Example Project\n\nA [AWS NestJS Starter](https://github.com/hardyscc/aws-nestjs-starter) project has been created to demo the usage of this library.\n\n## Quick Start\n\n**1. Add import into your app module**\n\n`src/app.module.ts`\n\n```ts\nimport { DynamooseModule } from 'nestjs-dynamoose';\nimport { UserModule } from './user/user.module';\n\n@Module({\n imports: [\n DynamooseModule.forRoot(),\n UserModule,\n ],\n})\nexport class AppModule {\n```\n\n`forRoot()` optionally accepts the following options defined by `DynamooseModuleOptions`:\n\n```ts\ninterface DynamooseModuleOptions {\n aws?: {\n accessKeyId?: string;\n secretAccessKey?: string;\n region?: string;\n };\n local?: boolean | string;\n ddb?: DynamoDB;\n table?: TableOptionsOptional;\n logger?: boolean | LoggerService;\n}\n```\n\nThere is also `forRootAsync(options: DynamooseModuleAsyncOptions)` if you want to use a factory with dependency injection.\n\n**2. Create a schema**\n\n`src/user/user.schema.ts`\n\n```ts\nimport { Schema } from 'dynamoose';\n\nexport const UserSchema = new Schema({\n id: {\n type: String,\n hashKey: true,\n },\n name: {\n type: String,\n },\n email: {\n type: String,\n },\n});\n```\n\n`src/user/user.interface.ts`\n\n```ts\nexport interface UserKey {\n id: string;\n}\n\nexport interface User extends UserKey {\n name: string;\n email?: string;\n}\n```\n\n`UserKey` holds the hashKey/partition key and (optionally) the rangeKey/sort key. `User` holds all attributes of the document/item. When creating this two interfaces and using when injecting your model you will have typechecking when using operations like `Model.update()`.\n\n**3. Add the models you want to inject to your modules**\n\nThis can be a feature module (as shown below) or within the root AppModule next to `DynamooseModule.forRoot()`.\n\n`src/user/user.module.ts`\n\n```ts\nimport { DynamooseModule } from 'nestjs-dynamoose';\nimport { UserSchema } from './user.schema';\nimport { UserService } from './user.service';\n\n@Module({\n imports: [\n DynamooseModule.forFeature([{\n name: 'User',\n schema: UserSchema,\n options: {\n tableName: 'user',\n },\n }]),\n ],\n providers: [\n UserService,\n ...\n ],\n})\nexport class UserModule {}\n```\n\n> `options.tableName` is optional. If it is not provided, `name` will be used as the table name.\n\nThere is also `forFeatureAsync(factories?: AsyncModelFactory[])` if you want to use a factory with dependency injection. Notes that the first parameter of the `useFactory` callback is reserved for future use, so please just add `_,` to ignore it.\n\nThe following example will use `USER_TABLE_NAME` environment variable as the table name.\n\n```ts\nimport { DynamooseModule } from 'nestjs-dynamoose';\nimport { UserSchema } from './user.schema';\nimport { UserService } from './user.service';\n\n@Module({\n imports: [\n ConfigModule.forRoot({ isGlobal: true }),\n DynamooseModule.forFeatureAsync([\n {\n name: 'User',\n useFactory: (_, configService: ConfigService) => {\n return {\n schema: UserSchema,\n options: {\n tableName: configService.get('USER_TABLE_NAME'),\n },\n };\n },\n inject: [ConfigService],\n },\n ]),\n ],\n providers: [\n UserService,\n ...\n ],\n})\nexport class UserModule {}\n```\n\n**4. Inject and use your model**\n\n`src/user/user.service.ts`\n\n```ts\nimport { Injectable } from '@nestjs/common';\nimport { InjectModel, Model } from 'nestjs-dynamoose';\nimport { User, UserKey } from './user.interface';\n\n@Injectable()\nexport class UserService {\n constructor(\n @InjectModel('User')\n private userModel: Model,\n ) {}\n\n create(user: User) {\n return this.userModel.create(user);\n }\n\n update(key: UserKey, user: Partial) {\n return this.userModel.update(key, user);\n }\n\n findOne(key: UserKey) {\n return this.userModel.get(key);\n }\n\n findAll() {\n return this.userModel.scan().exec();\n }\n}\n```\n\n## Additional Example\n\n**1. Transaction Support**\n\nBoth `User` and `Account` model objects will commit in same transaction.\n\n```ts\nimport { Injectable } from '@nestjs/common';\nimport { InjectModel, Model, TransactionSupport } from 'nestjs-dynamoose';\nimport { User, UserKey } from './user.interface';\nimport { Account, AccountKey } from './account.interface';\n\n@Injectable()\nexport class UserService extends TransactionSupport {\n constructor(\n @InjectModel('User')\n private userModel: Model,\n @InjectModel('Account')\n private accountModel: Model,\n ) {\n super();\n }\n\n async create(user: User, account: Account) {\n await this.transaction([\n this.userModel.transaction.create(user),\n this.accountModel.transaction.create(account),\n ]);\n }\n}\n```\n\n**2. Serializers Support**\n\nDefine the additional `serializers` under `DynamooseModule.forFeature()`.\n\n```ts\n@Module({\n imports: [\n DynamooseModule.forFeature([\n {\n name: 'User',\n schema: UserSchema,\n serializers: {\n frontend: { exclude: ['status'] },\n },\n },\n ]),\n ],\n ...\n})\nexport class UserModule {}\n```\n\nCall the `serialize` function to exclude the `status` field.\n\n```ts\n@Injectable()\nexport class UserService {\n ...\n async create(user: User) {\n const createdUser = await this.userModel.create(user);\n return createdUser.serialize('frontend');\n }\n ...\n}\n```\n\n## License\n\nDynamoose module for Nest is [MIT licensed](LICENSE).\n","readmeFilename":"README.md"}
![\"Nest](\"https://nestjs.com/img/logo_text.svg\"){kind=logo}
\n![\"NPM](\"https://img.shields.io/npm/v/nestjs-dynamoose\")
![\"Package](\"https://img.shields.io/github/license/hardyscc/nestjs-dynamoose\")
![\"NPM](\"https://img.shields.io/npm/dm/nestjs-dynamoose.svg\")
\n![\"CI\"](\"https://github.com/hardyscc/nestjs-dynamoose/workflows/Node.js%20CI/badge.svg\"){kind=icon}
\n![](\"https://img.shields.io/twitter/follow/hardyscchk.svg?style=social&label=Follow\")
\n