├── .prettierrc ├── nest-cli.json ├── src ├── shared │ ├── index.ts │ ├── ports │ │ └── id-generator.ts │ └── adapters │ │ └── uuid-generator.ts ├── books │ ├── dto │ │ ├── create-book.dto.ts │ │ └── update-book.dto.ts │ ├── commands │ │ ├── delete-book │ │ │ ├── delete-book.command.ts │ │ │ └── delete-book.handler.ts │ │ ├── create-book │ │ │ ├── create-book.command.ts │ │ │ └── create-book.handler.ts │ │ ├── update-book │ │ │ ├── update-book.command.ts │ │ │ └── update-book.handler.ts │ │ └── index.ts │ ├── queries │ │ ├── list-books │ │ │ ├── list-books.query.ts │ │ │ └── list-books.handler.ts │ │ ├── get-book │ │ │ ├── get-book.query.ts │ │ │ └── get-book.handler.ts │ │ └── index.ts │ ├── repository │ │ ├── book-repository.ts │ │ └── memory │ │ │ ├── fixtures │ │ │ └── books.ts │ │ │ └── book-repository-memory.adapter.ts │ ├── books.module.ts │ ├── entities │ │ └── book.entity.ts │ └── books.controller.ts ├── app.module.ts └── main.ts ├── tsconfig.build.json ├── tsconfig.json ├── .gitignore ├── README.md ├── .eslintrc.js ├── package.json └── LICENSE /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "singleQuote": true, 3 | "trailingComma": "all" 4 | } -------------------------------------------------------------------------------- /nest-cli.json: -------------------------------------------------------------------------------- 1 | { 2 | "collection": "@nestjs/schematics", 3 | "sourceRoot": "src" 4 | } 5 | -------------------------------------------------------------------------------- /src/shared/index.ts: -------------------------------------------------------------------------------- 1 | export * from './ports/id-generator'; 2 | export * from './adapters/uuid-generator'; 3 | -------------------------------------------------------------------------------- /src/books/dto/create-book.dto.ts: -------------------------------------------------------------------------------- 1 | export interface CreateBookDto { 2 | title: string; 3 | author: string; 4 | } 5 | -------------------------------------------------------------------------------- /src/books/dto/update-book.dto.ts: -------------------------------------------------------------------------------- 1 | export interface UpdateBookDto { 2 | title: string; 3 | author: string; 4 | } 5 | -------------------------------------------------------------------------------- /src/shared/ports/id-generator.ts: -------------------------------------------------------------------------------- 1 | export abstract class IdGenerator { 2 | abstract generateId(): string; 3 | } 4 | -------------------------------------------------------------------------------- /tsconfig.build.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./tsconfig.json", 3 | "exclude": ["node_modules", "test", "dist", "**/*spec.ts"] 4 | } 5 | -------------------------------------------------------------------------------- /src/books/commands/delete-book/delete-book.command.ts: -------------------------------------------------------------------------------- 1 | export class DeleteBookCommand { 2 | constructor(public id: string) {} 3 | } 4 | -------------------------------------------------------------------------------- /src/books/queries/list-books/list-books.query.ts: -------------------------------------------------------------------------------- 1 | import { IQuery } from '@nestjs/cqrs'; 2 | 3 | export class ListBooksQuery implements IQuery {} 4 | -------------------------------------------------------------------------------- /src/books/queries/get-book/get-book.query.ts: -------------------------------------------------------------------------------- 1 | import { IQuery } from '@nestjs/cqrs'; 2 | 3 | export class GetBookQuery implements IQuery { 4 | constructor(public id: string) {} 5 | } 6 | -------------------------------------------------------------------------------- /src/app.module.ts: -------------------------------------------------------------------------------- 1 | import { Module } from '@nestjs/common'; 2 | import { BooksModule } from './books/books.module'; 3 | 4 | @Module({ 5 | imports: [BooksModule], 6 | }) 7 | export class AppModule {} 8 | -------------------------------------------------------------------------------- /src/books/commands/create-book/create-book.command.ts: -------------------------------------------------------------------------------- 1 | import { CreateBookDto } from 'src/books/dto/create-book.dto'; 2 | 3 | export class CreateBookCommand { 4 | constructor(public payload: CreateBookDto) {} 5 | } 6 | -------------------------------------------------------------------------------- /src/books/queries/index.ts: -------------------------------------------------------------------------------- 1 | import { GetBookHandler } from './get-book/get-book.handler'; 2 | import { ListBooksHandler } from './list-books/list-books.handler'; 3 | 4 | export const QueryHandlers = [GetBookHandler, ListBooksHandler]; 5 | -------------------------------------------------------------------------------- /src/books/commands/update-book/update-book.command.ts: -------------------------------------------------------------------------------- 1 | import { UpdateBookDto } from 'src/books/dto/update-book.dto'; 2 | 3 | export class UpdateBookCommand { 4 | constructor(public id: string, public payload: UpdateBookDto) {} 5 | } 6 | -------------------------------------------------------------------------------- /src/main.ts: -------------------------------------------------------------------------------- 1 | import { NestFactory } from '@nestjs/core'; 2 | import { AppModule } from './app.module'; 3 | 4 | async function bootstrap() { 5 | const app = await NestFactory.create(AppModule, { cors: true }); 6 | await app.listen(3000); 7 | } 8 | bootstrap(); 9 | -------------------------------------------------------------------------------- /src/shared/adapters/uuid-generator.ts: -------------------------------------------------------------------------------- 1 | import { IdGenerator } from '../index'; 2 | import { v4 as uuidv4 } from 'uuid'; 3 | import { Injectable } from '@nestjs/common'; 4 | 5 | @Injectable() 6 | export class UuidGenerator extends IdGenerator { 7 | generateId(): string { 8 | return uuidv4(); 9 | } 10 | } 11 | -------------------------------------------------------------------------------- /src/books/commands/index.ts: -------------------------------------------------------------------------------- 1 | import { CreateBookHandler } from './create-book/create-book.handler'; 2 | import { UpdateBookHandler } from './update-book/update-book.handler'; 3 | import { DeleteBookHandler } from './delete-book/delete-book.handler'; 4 | 5 | export const CommandHandlers = [ 6 | CreateBookHandler, 7 | UpdateBookHandler, 8 | DeleteBookHandler, 9 | ]; 10 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "module": "commonjs", 4 | "declaration": true, 5 | "removeComments": true, 6 | "emitDecoratorMetadata": true, 7 | "experimentalDecorators": true, 8 | "allowSyntheticDefaultImports": true, 9 | "target": "es2017", 10 | "sourceMap": true, 11 | "outDir": "./dist", 12 | "baseUrl": "./", 13 | "incremental": true 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # compiled output 2 | /dist 3 | /node_modules 4 | 5 | # Logs 6 | logs 7 | *.log 8 | npm-debug.log* 9 | yarn-debug.log* 10 | yarn-error.log* 11 | lerna-debug.log* 12 | 13 | # OS 14 | .DS_Store 15 | 16 | # Tests 17 | /coverage 18 | /.nyc_output 19 | 20 | # IDEs and editors 21 | /.idea 22 | .project 23 | .classpath 24 | .c9/ 25 | *.launch 26 | .settings/ 27 | *.sublime-workspace 28 | 29 | # IDE - VSCode 30 | .vscode/* 31 | !.vscode/settings.json 32 | !.vscode/tasks.json 33 | !.vscode/launch.json 34 | !.vscode/extensions.json -------------------------------------------------------------------------------- /src/books/commands/delete-book/delete-book.handler.ts: -------------------------------------------------------------------------------- 1 | import { DeleteBookCommand } from './delete-book.command'; 2 | import { CommandHandler, ICommandHandler } from '@nestjs/cqrs'; 3 | import { BookRepository } from 'src/books/repository/book-repository'; 4 | 5 | @CommandHandler(DeleteBookCommand) 6 | export class DeleteBookHandler implements ICommandHandler { 7 | constructor(private bookRepository: BookRepository) {} 8 | 9 | async execute(command: DeleteBookCommand): Promise { 10 | this.bookRepository.delete(command.id); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/books/queries/list-books/list-books.handler.ts: -------------------------------------------------------------------------------- 1 | import { Book } from 'src/books/entities/book.entity'; 2 | import { ListBooksQuery } from './list-books.query'; 3 | import { IQueryHandler, QueryHandler } from '@nestjs/cqrs'; 4 | import { BookRepository } from 'src/books/repository/book-repository'; 5 | 6 | @QueryHandler(ListBooksQuery) 7 | export class ListBooksHandler implements IQueryHandler { 8 | constructor(private bookRepository: BookRepository) {} 9 | 10 | async execute(): Promise { 11 | return this.bookRepository.findAll(); 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /src/books/commands/update-book/update-book.handler.ts: -------------------------------------------------------------------------------- 1 | import { CommandHandler, ICommandHandler } from '@nestjs/cqrs'; 2 | import { UpdateBookCommand } from './update-book.command'; 3 | import { BookRepository } from 'src/books/repository/book-repository'; 4 | 5 | @CommandHandler(UpdateBookCommand) 6 | export class UpdateBookHandler implements ICommandHandler { 7 | constructor(private bookRepository: BookRepository) {} 8 | 9 | async execute(command: UpdateBookCommand): Promise { 10 | this.bookRepository.update(command.id, command.payload); 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /src/books/repository/book-repository.ts: -------------------------------------------------------------------------------- 1 | import { Book } from '../entities/book.entity'; 2 | import { UpdateBookDto } from '../dto/update-book.dto'; 3 | import { CreateBookDto } from '../dto/create-book.dto'; 4 | 5 | export abstract class BookRepository { 6 | abstract async findOneById(id: string): Promise; 7 | abstract async findAll(): Promise; 8 | 9 | abstract async create(id: string, payload: CreateBookDto): Promise; 10 | abstract async delete(id: string): Promise; 11 | abstract async update(id: string, payload: UpdateBookDto): Promise; 12 | } 13 | -------------------------------------------------------------------------------- /src/books/queries/get-book/get-book.handler.ts: -------------------------------------------------------------------------------- 1 | import { Book } from 'src/books/entities/book.entity'; 2 | import { IQueryHandler, QueryHandler } from '@nestjs/cqrs'; 3 | import { GetBookQuery } from './get-book.query'; 4 | import { BookRepository } from 'src/books/repository/book-repository'; 5 | 6 | @QueryHandler(GetBookQuery) 7 | export class GetBookHandler implements IQueryHandler { 8 | constructor(private bookRepository: BookRepository) {} 9 | 10 | async execute(query: GetBookQuery): Promise { 11 | return this.bookRepository.findOneById(query.id); 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Clean REST API with NestJS 2 | 3 |

4 | Nest Logo 5 |

6 | 7 | ## Description 8 | 9 | Example of rest api created with NestJS 10 | 11 | ## Installation 12 | 13 | ```bash 14 | $ npm install 15 | ``` 16 | 17 | ## Running the app 18 | 19 | ```bash 20 | # development 21 | $ npm run start 22 | 23 | # watch mode 24 | $ npm run start:dev 25 | 26 | # production mode 27 | $ npm run start:prod 28 | ``` 29 | 30 | ## License 31 | 32 | [MIT licensed](LICENSE). 33 | -------------------------------------------------------------------------------- /src/books/commands/create-book/create-book.handler.ts: -------------------------------------------------------------------------------- 1 | import { CommandHandler, ICommandHandler } from '@nestjs/cqrs'; 2 | import { CreateBookCommand } from './create-book.command'; 3 | import { BookRepository } from 'src/books/repository/book-repository'; 4 | import { IdGenerator } from 'src/shared'; 5 | 6 | @CommandHandler(CreateBookCommand) 7 | export class CreateBookHandler implements ICommandHandler { 8 | constructor( 9 | private idGenerator: IdGenerator, 10 | private bookRepository: BookRepository, 11 | ) {} 12 | 13 | async execute(command: CreateBookCommand): Promise { 14 | const id = this.idGenerator.generateId(); 15 | this.bookRepository.create(id, command.payload); 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /src/books/repository/memory/fixtures/books.ts: -------------------------------------------------------------------------------- 1 | import { Book } from 'src/books/entities/book.entity'; 2 | 3 | export const books = [ 4 | new Book('1', 'Harry Potter and the Sorcerer’s Stone', 'J. K. Rowling'), 5 | new Book('2', `Harry Potter and the Chamber of Secrets`, 'J. K. Rowling'), 6 | new Book('3', `Harry Potter and the Prisoner of Azkaban`, 'J. K. Rowling'), 7 | new Book('4', `Harry Potter and the Goblet of Fire`, 'J. K. Rowling'), 8 | new Book('5', `Harry Potter and the Order of the Phoenix`, 'J. K. Rowling'), 9 | new Book('6', `Harry Potter and the Half-Blood Prince`, 'J. K. Rowling'), 10 | new Book('7', `Harry Potter and the Deathly Hallows`, 'J. K. Rowling'), 11 | new Book('8', `Harry Potter and the Cursed Child`, 'J. K. Rowling'), 12 | ]; 13 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | parser: '@typescript-eslint/parser', 3 | parserOptions: { 4 | project: 'tsconfig.json', 5 | sourceType: 'module', 6 | }, 7 | plugins: ['@typescript-eslint/eslint-plugin'], 8 | extends: [ 9 | 'plugin:@typescript-eslint/eslint-recommended', 10 | 'plugin:@typescript-eslint/recommended', 11 | 'prettier', 12 | 'prettier/@typescript-eslint', 13 | ], 14 | root: true, 15 | env: { 16 | node: true, 17 | jest: true, 18 | }, 19 | rules: { 20 | '@typescript-eslint/interface-name-prefix': 'off', 21 | '@typescript-eslint/explicit-function-return-type': 'off', 22 | '@typescript-eslint/explicit-module-boundary-types': 'off', 23 | '@typescript-eslint/no-explicit-any': 'off', 24 | }, 25 | }; 26 | -------------------------------------------------------------------------------- /src/books/books.module.ts: -------------------------------------------------------------------------------- 1 | import { Module } from '@nestjs/common'; 2 | import { BooksController } from './books.controller'; 3 | import { IdGenerator, UuidGenerator } from 'src/shared'; 4 | import { CommandHandlers } from './commands'; 5 | import { QueryHandlers } from './queries'; 6 | import { CqrsModule } from '@nestjs/cqrs'; 7 | import { BookRepositoryMemoryAdapter } from './repository/memory/book-repository-memory.adapter'; 8 | import { BookRepository } from './repository/book-repository'; 9 | 10 | @Module({ 11 | imports: [CqrsModule], 12 | controllers: [BooksController], 13 | providers: [ 14 | { 15 | provide: IdGenerator, 16 | useClass: UuidGenerator, 17 | }, 18 | { 19 | provide: BookRepository, 20 | useClass: BookRepositoryMemoryAdapter, 21 | }, 22 | ...CommandHandlers, 23 | ...QueryHandlers, 24 | ], 25 | }) 26 | export class BooksModule {} 27 | -------------------------------------------------------------------------------- /src/books/entities/book.entity.ts: -------------------------------------------------------------------------------- 1 | import { AggregateRoot } from '@nestjs/cqrs'; 2 | import { 3 | UnprocessableEntityException, 4 | InternalServerErrorException, 5 | } from '@nestjs/common'; 6 | export class Book extends AggregateRoot { 7 | constructor(public id: string, public title: string, public author: string) { 8 | super(); 9 | this.validate(); 10 | } 11 | 12 | validate(): void { 13 | if (!this.id) { 14 | throw new InternalServerErrorException(); 15 | } 16 | 17 | if (!this.title || !this.author) { 18 | throw new UnprocessableEntityException(); 19 | } 20 | 21 | if (this.title.length < 3) { 22 | throw new UnprocessableEntityException( 23 | 'Title must contain at least three letters.', 24 | ); 25 | } 26 | 27 | if (this.author.length < 2) { 28 | throw new UnprocessableEntityException( 29 | 'Author must contain at least two letters.', 30 | ); 31 | } 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/books/repository/memory/book-repository-memory.adapter.ts: -------------------------------------------------------------------------------- 1 | import { Book } from 'src/books/entities/book.entity'; 2 | import { CreateBookDto } from 'src/books/dto/create-book.dto'; 3 | import { UpdateBookDto } from 'src/books/dto/update-book.dto'; 4 | import { books } from './fixtures/books'; 5 | import { BookRepository } from '../book-repository'; 6 | 7 | export class BookRepositoryMemoryAdapter extends BookRepository { 8 | private books = books; 9 | 10 | async findOneById(id: string): Promise { 11 | return this.books.find(book => book.id === id); 12 | } 13 | 14 | async findAll(): Promise { 15 | return this.books; 16 | } 17 | 18 | async create(id: string, payload: CreateBookDto): Promise { 19 | const { title, author } = payload; 20 | const newBook = new Book(id, title, author); 21 | this.books.push(newBook); 22 | } 23 | 24 | async delete(id: string): Promise { 25 | this.books = this.books.filter(book => id !== book.id); 26 | } 27 | 28 | async update(id: string, payload: UpdateBookDto): Promise { 29 | const { title, author } = payload; 30 | const newBook = new Book(id, title, author); 31 | this.books = this.books.filter(book => id !== book.id); 32 | this.books.push(newBook); 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "clean-api-with-nestjs", 3 | "version": "0.1.0", 4 | "description": "", 5 | "author": "", 6 | "private": true, 7 | "license": "MIT License", 8 | "scripts": { 9 | "prebuild": "rimraf dist", 10 | "build": "nest build", 11 | "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"", 12 | "start": "nest start", 13 | "start:dev": "nest start --watch", 14 | "start:debug": "nest start --debug --watch", 15 | "start:prod": "node dist/main", 16 | "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix" 17 | }, 18 | "dependencies": { 19 | "@nestjs/common": "^7.0.0", 20 | "@nestjs/core": "^7.0.0", 21 | "@nestjs/cqrs": "^7.0.1", 22 | "@nestjs/platform-express": "^7.0.0", 23 | "reflect-metadata": "^0.1.13", 24 | "rimraf": "^3.0.2", 25 | "rxjs": "^6.5.4", 26 | "uuid": "^8.3.0" 27 | }, 28 | "devDependencies": { 29 | "@nestjs/cli": "^7.0.0", 30 | "@nestjs/schematics": "^7.0.0", 31 | "@nestjs/testing": "^7.0.0", 32 | "@types/express": "^4.17.3", 33 | "@types/node": "^13.9.1", 34 | "@types/supertest": "^2.0.8", 35 | "@typescript-eslint/eslint-plugin": "3.9.1", 36 | "@typescript-eslint/parser": "3.9.1", 37 | "eslint": "7.7.0", 38 | "eslint-config-prettier": "^6.10.0", 39 | "eslint-plugin-import": "^2.20.1", 40 | "prettier": "^1.19.1", 41 | "supertest": "^4.0.2", 42 | "ts-loader": "^6.2.1", 43 | "ts-node": "9.0.0", 44 | "tsconfig-paths": "^3.9.0", 45 | "typescript": "^3.7.4" 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /src/books/books.controller.ts: -------------------------------------------------------------------------------- 1 | import { 2 | Controller, 3 | Get, 4 | Post, 5 | Body, 6 | Put, 7 | Param, 8 | Delete, 9 | } from '@nestjs/common'; 10 | import { CreateBookDto } from './dto/create-book.dto'; 11 | import { UpdateBookDto } from './dto/update-book.dto'; 12 | import { CommandBus, QueryBus } from '@nestjs/cqrs'; 13 | import { CreateBookCommand } from './commands/create-book/create-book.command'; 14 | import { UpdateBookCommand } from './commands/update-book/update-book.command'; 15 | import { DeleteBookCommand } from './commands/delete-book/delete-book.command'; 16 | import { ListBooksQuery } from './queries/list-books/list-books.query'; 17 | import { GetBookQuery } from './queries/get-book/get-book.query'; 18 | 19 | @Controller('books') 20 | export class BooksController { 21 | constructor( 22 | private readonly commandBus: CommandBus, 23 | private readonly queryBus: QueryBus, 24 | ) {} 25 | 26 | @Post() 27 | create(@Body() createBookDto: CreateBookDto) { 28 | return this.commandBus.execute(new CreateBookCommand(createBookDto)); 29 | } 30 | 31 | @Get() 32 | findAll() { 33 | return this.queryBus.execute(new ListBooksQuery()); 34 | } 35 | 36 | @Get(':id') 37 | findOne(@Param('id') id: string) { 38 | return this.queryBus.execute(new GetBookQuery(id)); 39 | } 40 | 41 | @Put(':id') 42 | update(@Param('id') id: string, @Body() updateBookDto: UpdateBookDto) { 43 | return this.commandBus.execute(new UpdateBookCommand(id, updateBookDto)); 44 | } 45 | 46 | @Delete(':id') 47 | remove(@Param('id') id: string) { 48 | return this.commandBus.execute(new DeleteBookCommand(id)); 49 | } 50 | } 51 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------