{"_id":"nestjs-typeorm-paginate","_rev":"61-dee46617233fb7f78b069f081612150a","name":"nestjs-typeorm-paginate","dist-tags":{"latest":"4.1.0"},"versions":{"0.1.0":{"name":"nestjs-typeorm-paginate","version":"0.1.0","keywords":["nestjs","typeorm","pagination"],"author":{"url":"http://ashleighsimonelli.co.uk","name":"Ashleigh Simonelli","email":"ashleighsimonelli@gmail.com"},"license":"MIT","_id":"nestjs-typeorm-paginate@0.1.0","maintainers":[{"name":"bashleigh","email":"ashleighsimonelli@gmail.com"}],"dist":{"shasum":"ca9febc7b22e8bf6a679dc936c1ce9e070daa5ce","tarball":"https://registry.npmjs.org/nestjs-typeorm-paginate/-/nestjs-typeorm-paginate-0.1.0.tgz","fileCount":14,"integrity":"sha512-r0sReQAbC9dgxkSZJC48U1MPhYbzsHmlf9eTkZ11Iaz6znSXZNueUSrFIIFV7MENW8aqzyVNE0fLd3ZTnYIk8w==","signatures":[{"sig":"MEUCIAG2kIvq5WVYcp+D9lmva8e1HW9Tf+Zu0qj5J/E8TMOqAiEAywFZChNqJUY7U4/kn6dAjb5RLT6oG5LTJNBSKbPPecI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11025,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcVJXACRA9TVsSAnZWagAAnq0QAJR8tIDxrsyeZudEzGZu\nLCWmORCcTSeUertlqIcSFKr/jpZluBfzmvBC7ke2hPSNIr6ItRNDFXDAJPW8\noQU8xTNVu7xelD5CazgUWNer1wgeXRzneLddRR8PIIl+ilglAgCJUogHu5jx\nJupGTvYV1lBNnDaaBnAhD4fT2xQcVHbe5UL/0zRutdS17c+1HhyHW9N+eRQV\nwrfbQzbX+9EJWshzdyIrsTFmyFPBPZccSkfyP+BWfZzispbzKlGkPIUaLUz7\nmx9KIBj7XmnxFth66lS35Q/z0EI2L2OMsW8GIp7FFTy8VNu1NZDuhIgUy5P9\nBj/AUSJWXBzp3rowrB+GLctG2W/Jja5Ap8+ZQlIi2y0Un3vM6sHmqwTBLy2r\nOagw0n4eFl4t93br7a74lkdxw83GZz59OmlY0vJaCGQeBNGpKT+jtLdbt2z3\nZpCGj7cyyk5lArdOTtFH3dZrKqDbzJ/aZbSl9ddET3olirlrPFF8eM8m9HFC\nyBG5zy/jrOp64N2cHYhGTNuEmXhIi9TLuyfH+brV5mZYmQl9/z+7c7URkdJ6\n9C6DaByftaWqtN6hw4mnalqd71TBxoOuPuO9kR8P5OcVKlEBPtzN6WsbnW3e\nsSIo+y7PBpkU3HvAKd/0EWHpS6SimlZqNoPATXI+C9Q4/bEHX2fQQA12/Orr\nipyn\r\n=y772\r\n-----END PGP SIGNATURE-----\r\n"},"jest":{"rootDir":"src","testRegex":".spec.ts$","transform":{"^.+\\.(t|j)s$":"ts-jest"},"coverageDirectory":"../coverage","moduleFileExtensions":["js","json","ts"]},"scripts":{"test":"jest","build":"tsc -p .","format":"prettier --write \"**/*.ts\"","test:cov":"jest --coverage"},"_npmUser":{"name":"bashleigh","email":"ashleighsimonelli@gmail.com"},"description":"","directories":{},"licenseText":"MIT License\n\nCopyright (c) 2019 Ashleigh Simonelli\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","_hasShrinkwrap":false,"devDependencies":{"jest":"^24.0.0","ts-jest":"^23.10.5","typeorm":"^0.2.12","prettier":"^1.16.2","typescript":"^3.2.4","@types/jest":"^23.3.13","@nestjs/core":"^5.6.2","@nestjs/common":"^5.6.2","@nestjs/testing":"^5.6.2","@nestjs/typeorm":"^5.2.2"},"peerDependencies":{"typeorm":"^0.2.12"},"_npmOperationalInternal":{"tmp":"tmp/nestjs-typeorm-paginate_0.1.0_1549047231216_0.5176082922672756","host":"s3://npm-registry-packages"}},"0.1.1":{"name":"nestjs-typeorm-paginate","version":"0.1.1","keywords":["nestjs","typeorm","pagination","paginate"],"author":{"url":"http://ashleighsimonelli.co.uk","name":"Ashleigh Simonelli","email":"ashleighsimonelli@gmail.com"},"license":"MIT","_id":"nestjs-typeorm-paginate@0.1.1","maintainers":[{"name":"bashleigh","email":"ashleighsimonelli@gmail.com"}],"dist":{"shasum":"29d3feac233da44089334bc459fa010bab917803","tarball":"https://registry.npmjs.org/nestjs-typeorm-paginate/-/nestjs-typeorm-paginate-0.1.1.tgz","fileCount":16,"integrity":"sha512-/M/EK752zKhsXmlLobF0LDllD12/WlSY6HmJ1WQM6NjMa4A1wowsDTMn503Nv3phvJ7aXvO5yYfdK8sLdyNrqg==","signatures":[{"sig":"MEYCIQCtWlY8RRHG/iLal7squLCNXb6PjAtwGEX3XaEd4teltQIhAP3EQnqUEUxPPeyV3I60Yx7/DlLMZhqsb/9xgw3ujqqp","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":9325,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJchZzYCRA9TVsSAnZWagAASP8P/2234ZzXkO843TU8Goea\n5i5Eex5VaI9cg8BIRTMYkpy2s887/FX3d4FTuScuDq3/w09i1stuAQY3AHpE\npeZFwejN68wFbsQQIyTt4nXmTzNkZEiOUZQt3ZMc865SV9Z/+YnTtVDHaztk\n7FuHxYT66yeozOi837FQ0CkFuKgG5uBZZ6UG7+eXn7L61ceNRTz/clINmMgY\ntN+oB9VkkqviyLNzE3fQrz0A4QanCRK6+C8asacV26dIzOn1/37rI07oIJld\nVHIgsTslRnFJ39ri9v+ka6v+NWb1VRMnf+YPyEeTl4J/wSfIQ7XxKm1FdsP/\nI/mO+O4KxQZdjjoVWRlqWVynp2SNQIsAYvrKlQlhzyA7mZWrXQando69eBfV\n4CL9Jx0M610Y0LMbazLMUVnO29nQ+58wWDIYYMFg2eTNp1v6DEEC5GhTVNaH\nXz6Uf2hVgGUp3dKxk5Fb/kUbWI8510xtg9fzm8lC9ScGgG5V+C/XXb7lxpZj\naLZKk0a/dSIieVsg/kvETG+Wz0nvlVevyh+Ipdiecp8gvdL7j7EjzbrVLN31\nW8oQdTHhZDE2MwwKelUco9LVfQuXLdf9310/zuNZgpD7pRgLtHv3mKSRP7UQ\nmzxaGF0MY9apvbIaQ9YL5DKGeMvLczUkhKojZcyjIyOALGDwj1P6ezeMKPk/\naRKV\r\n=7bmm\r\n-----END PGP SIGNATURE-----\r\n"},"jest":{"rootDir":"src","testRegex":".spec.ts$","transform":{"^.+\\.(t|j)s$":"ts-jest"},"coverageDirectory":"../coverage","moduleFileExtensions":["js","json","ts"]},"main":"./dist/index.js","scripts":{"test":"jest","build":"tsc -p .","format":"prettier --write \"**/*.ts\"","test:cov":"jest --coverage"},"_npmUser":{"name":"bashleigh","email":"ashleighsimonelli@gmail.com"},"description":"

\n

\n \n \n Coverage Status\n \n \"Awesome\n \"Nest\n \n \n \"npm\n \n

\n\n

Nestjs Typeorm paginate

\n\nPagination helper method for TypeORM repositories or queryBuilders with strict typings\n\n## Install\n\n```bash\n$ yarn add nestjs-typeorm-paginate\n```\nor\n```bash\n$ npm i nestjs-typeorm-paginate\n```\n\n> If you're using typeorm^0.2.6 please use nestjs-typeorm-paginate^3.2.0\n> For typeorm^0.3.0 please use nestjs-typeorm-paginate^4.0.0\n\n## Usage\n\n##### Service\n\n###### Repository\n\n```ts\nimport { Injectable } from '@nestjs/common';\nimport { Repository } from 'typeorm';\nimport { InjectRepository } from '@nestjs/typeorm';\nimport { CatEntity } from './entities';\nimport {\n paginate,\n Pagination,\n IPaginationOptions,\n} from 'nestjs-typeorm-paginate';\n\n@Injectable()\nexport class CatService {\n constructor(\n @InjectRepository(CatEntity)\n private readonly repository: Repository,\n ) {}\n\n async paginate(options: IPaginationOptions): Promise> {\n return paginate(this.repository, options);\n }\n}\n```\n\n###### QueryBuilder\n\n```ts\nimport { Injectable } from '@nestjs/common';\nimport { Repository } from 'typeorm';\nimport { InjectRepository } from '@nestjs/typeorm';\nimport { CatEntity } from './entities';\nimport {\n paginate,\n Pagination,\n IPaginationOptions,\n} from 'nestjs-typeorm-paginate';\n\n@Injectable()\nexport class CatService {\n constructor(\n @InjectRepository(CatEntity)\n private readonly repository: Repository,\n ) {}\n\n async paginate(options: IPaginationOptions): Promise> {\n const queryBuilder = this.repository.createQueryBuilder('c');\n queryBuilder.orderBy('c.name', 'DESC'); // Or whatever you need to do\n\n return paginate(queryBuilder, options);\n }\n}\n```\n\n##### Controller\n\n```ts\nimport { Controller, DefaultValuePipe, Get, ParseIntPipe, Query } from '@nestjs/common';\nimport { CatService } from './cat.service';\nimport { CatEntity } from './cat.entity';\nimport { Pagination } from 'nestjs-typeorm-paginate';\n\n@Controller('cats')\nexport class CatsController {\n constructor(private readonly catService: CatService) {}\n @Get('')\n async index(\n @Query('page', new DefaultValuePipe(1), ParseIntPipe) page: number = 1,\n @Query('limit', new DefaultValuePipe(10), ParseIntPipe) limit: number = 10,\n ): Promise> {\n limit = limit > 100 ? 100 : limit;\n return this.catService.paginate({\n page,\n limit,\n route: 'http://cats.com/cats',\n });\n }\n}\n```\n\n> If you use `ParseIntPipe` on the query params (as in the example), don't forget to also add `DefaultValuePipe`. See [issue 517](https://github.com/nestjsx/nestjs-typeorm-paginate/issues/517) for more info.\n\n> the `route` property of the paginate options can also be the short version of an absolute path , In this case, it would be `/cats` instead of `http://cats.com/cats`\n\n### Example Response\n\n```json\n{\n \"items\": [\n {\n \"lives\": 9,\n \"type\": \"tabby\",\n \"name\": \"Bobby\"\n },\n {\n \"lives\": 2,\n \"type\": \"Ginger\",\n \"name\": \"Garfield\"\n },\n {\n \"lives\": 6,\n \"type\": \"Black\",\n \"name\": \"Witch's mate\"\n },\n {\n \"lives\": 7,\n \"type\": \"Purssian Grey\",\n \"name\": \"Alisdaya\"\n },\n {\n \"lives\": 1,\n \"type\": \"Alistair\",\n \"name\": \"ali\"\n },\n ...\n ],\n \"meta\": {\n \"itemCount\": 10,\n \"totalItems\": 20,\n \"itemsPerPage\": 10,\n \"totalPages\": 5,\n \"currentPage\": 2\n },\n \"links\" : {\n \"first\": \"http://cats.com/cats?limit=10\",\n \"previous\": \"http://cats.com/cats?page=1&limit=10\",\n \"next\": \"http://cats.com/cats?page=3&limit=10\",\n \"last\": \"http://cats.com/cats?page=5&limit=10\"\n }\n}\n```\n\n`items`: An array of SomeEntity\n\n`meta.itemCount`: The length of items array (i.e., the amount of items on this page)\n`meta.totalItems`: The total amount of SomeEntity matching the filter conditions\n`meta.itemsPerPage`: The requested items per page (i.e., the `limit` parameter)\n\n`meta.totalPages`: The total amount of pages (based on the `limit`)\n`meta.currentPage`: The current page this paginator \"points\" to\n\n`links.first`: A URL for the first page to call | `\"\"` (blank) if no `route` is defined\n`links.previous`: A URL for the previous page to call | `\"\"` (blank) if no previous to call\n`links.next`: A URL for the next page to call | `\"\"` (blank) if no page to call\n`links.last`: A URL for the last page to call | `\"\"` (blank) if no `route` is defined\n\n\n> Do note that `links.first` may not have the 'page' query param defined\n\n## Find Parameters\n\n```ts\n@Injectable()\nexport class CatService {\n constructor(\n @InjectRepository(CatEntity)\n private readonly repository: Repository,\n ) {}\n\n async paginate(options: IPaginationOptions): Promise> {\n return paginate(this.repository, options, {\n lives: 9,\n });\n }\n}\n```\n\n## Eager loading\n\nEager loading should work with typeorm's eager property out the box. Like so\n\n```typescript\nimport { Entity, OneToMany } from 'typeorm';\n\n@Entity()\nexport class CatEntity {\n @OneToMany(t => TigerKingEntity, tigerKing.cats, {\n eager: true,\n })\n tigerKings: TigerKingEntity[];\n}\n\n// service\nclass CatService {\n constructor(private readonly repository: Repository) {}\n\n async paginate(page: number, limit: number): Promise> {\n return paginate(this.repository, { page, limit });\n }\n}\n```\n\n#### QueryBuilder\n\nHowever, when using the query builder you'll have to hydrate the entities yourself. Here is a crude example that I've used in the past. It's not great but this is partially what typeORM will do.\n\n```typescript\nconst results = paginate(queryBuilder, { page, limit });\n\nreturn new Pagination(\n await Promise.all(\n results.items.map(async (item: SomeEntity) => {\n const hydrate = await this.someRepository.findByEntity(item);\n item.hydrated = hydrate;\n\n return item;\n }),\n ),\n results.meta,\n results.links,\n);\n```\n\n## Raw queries\n\n```typescript\nconst queryBuilder = this.repository\n .createQueryBuilder<{ type: string; totalLives: string }>('c')\n .select('c.type', 'type')\n .addSelect('SUM(c.lives)', 'totalLives')\n .groupBy('c.type')\n .orderBy('c.type', 'DESC'); // Or whatever you need to do\n\nreturn paginateRaw(queryBuilder, options);\n```\n\n### Raw and Entities\n\nA similar approach is used for TypeORM's `getRawAndEntities`\n\nLet's assume there's a joined table that matches each cat with its cat toys.\nAnd we want to bring how many toys each cat has.\n\n```typescript\n\nconst queryBuilder = this.repository\n .createQueryBuilder<{ type: string; totalLives: string }>('cat')\n .leftJoinAndSelect('cat.toys', 'toys')\n .addSelect('COUNT(toys)::INTEGER', 'toyCount')\n .groupBy('cat.name');\n```\n\nThis will allow us to get the paginated cats information with the additional raw query to build our actual response value.\nThe return pagination object will be the same, but you're now able to handle or map the results and the raw objects as needed.\n\n```typescript\nconst [pagination, rawResults] = await paginateRawAndEntities(query, options);\npagination.items.map((item, index) => {\n // we can do what we need with the items and raw results here\n // change your items using rawResults.find(raw => raw.id === item.id)\n});\nreturn pagination;\n```\n\n#### Note about joined tables and raw values\n\nSince the values of the raw results will include all the joined table items as queried, you must make sure to handle the items as needed for your use case. Refer to TypeORM's [getRawAndEntities](https://github.com/typeorm/typeorm/blob/920e7812cd9d405df921f9ae9ce52ba0a9743bea/src/query-builder/SelectQueryBuilder.ts#L1047) implementation as needed.\n\nThe rawResults array will look something like this:\n\n```typescript\n[\n { // Bobby appears 3 times due to the joined query\n \"cat_lives\": 9,\n \"cat_type\": \"tabby\",\n \"cat_name\": \"Bobby\",\n \"toyCount\": 3\n },\n {\n \"cat_lives\": 9,\n \"cat_type\": \"tabby\",\n \"cat_name\": \"Bobby\",\n \"toyCount\": 3\n },\n {\n \"cat_lives\": 9,\n \"cat_type\": \"tabby\",\n \"cat_name\": \"Bobby\",\n \"toyCount\": 3\n },\n {\n \"cat_lives\": 2,\n \"cat_type\": \"Ginger\",\n \"cat_name\": \"Garfield\",\n \"toyCount\": 1\n },\n ...\n]\n```\n\n## Custom meta data transformer\n\nIf you wanted to alter the meta data that is returned from the pagination object. Then use the `metaTransformer` in the options like so\n\n```ts\n\nclass CustomPaginationMeta {\n constructor(\n public readonly count: number,\n public readonly total: number,\n ) {}\n}\n\nreturn paginate(this.repository, { \n page,\n limit,\n metaTransformer: (meta: IPaginationMeta): CustomPaginationMeta => new CustomPaginationMeta(\n meta.itemCount,\n meta.totalItems,\n ),\n });\n```\n\nThis will result in the above returning `CustomPaginationMeta` in the `meta` property instead of the default `IPaginationMeta`.\n\n\n## Custom links query params labels\n\nIf you want to alter the `limit` and/or `page` labels in meta links, then use `routingLabels` in the options like so\n\n```ts\n\nreturn paginate(this.repository, { \n page,\n limit,\n routingLabels: {\n limitLabel: 'page-size', // default: limit\n pageLabel: 'current-page', //default: page\n }\n });\n```\n\nThis will result links like `http://example.com/something?current-page=1&page-size=3`.\n","readmeFilename":"README.md"}