npmpackage.info

Gathering detailed insights and metrics for @forlagshuset/nestjs-mongoose-paginate

@forlagshuset/nestjs-mongoose-paginate

A pagination, filtering and sorting lib for nestjs using mongoose orm

1.2.16

MIT

TypeScript

38,266 4.9

Installations

npm install @forlagshuset/nestjs-mongoose-paginate

Pull Requests

Open

1

Total

39

Closed

6

Merged

32

Issues

Open

2

Total

7

Closed

5

Releases

v1.2.16

Published on 08 Oct 2024

v1.2.15

Published on 08 Oct 2024

v1.2.14

Published on 08 Oct 2024

Optional filtering

v1.2.13

Published on 03 Jul 2024

v1.2.12

Published on 24 May 2024

Api documentation updates

v1.2.11

Published on 12 Feb 2024

View all 20 releases

Developer

fagbokforlaget

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

20.17.0

NPM Version

10.8.2 Statistics

16 Stars

134 Commits

10 Forks

7 Watching

21 Branches

10 Contributors

Updated on 08 Oct 2024

Languages

TypeScript (96%)

JavaScript (4%)

Total Downloads

Cumulative downloads

Total Downloads

38,266

Last day

64.1%

Compared to previous day

Last week

35.2%

396

Compared to previous week

Last month

-9.4%

1,557

Compared to previous month

Last year

46.7%

16,991

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

nestjs-mongoose-paginate

A pagination, filtering and sorting lib for nestjs v8(for v7 please use < v1.1) using mongoose orm

Usage

Exposing properties

Create a class to hold information about filterable and sortable properties You need to @Expose properties of this class. By default none of it is filterable nor sortable. You should set this parameters explicitly. In case you want to expose some of the properties with a different name, you need to specify a name option in this decorator.

1import {
2  CollectionProperties,
3  Expose
4} from '@forlagshuset/nestjs-mongoose-paginate';
5
6export class MyCollectionProperties extends CollectionProperties {
7  @Expose({ name: 'createdAt', sortable: true })
8  readonly created_at: 'desc' | 'asc';
9
10  @Expose({ sortable: true, default: true, filterable: true })
11  readonly userName: 'desc' | 'asc';
12
13  readonly unsortable: string;
14}

Validation Pipe

1import {
2  CollectionDto,
3  ValidationPipe,
4  CollectionResponse
5} from '@forlagshuset/nestjs-mongoose-paginate';
6
7@Controller()
8export class AppController {
9  @Get('list')
10  async filter(
11    @Query(new ValidationPipe(MyCollectionProperties))
12    collectionDto: CollectionDto,
13  ): Promise<CollectionResponse<MyDocument>> {
14    return await this.service.list(collectionDto);
15  }
16}

Document collector usage

1import { Model } from 'mongoose';
2import { InjectModel } from '@nestjs/mongoose';
3import {
4  CollectionDto,
5  DocumentCollector,
6  CollectionResponse
7} from '@forlagshuset/nestjs-mongoose-paginate';
8
9@Injectable()
10export class AppService {
11  constructor(
12    @InjectModel('MyModel') private readonly model: Model<MyDocument>,
13  )
14
15  async list(
16      collectionDto: CollectionDto,
17  ): Promise<CollectionResponse<MyDocument>> {
18    const collector = new DocumentCollector<MyDocument>(this.model);
19    return collector.find(collectionDto);
20  }
21}

Queries

You may now send a request, like in example below:

http://localhost:3000/list?filter={"userName": {"$regex": "^test"}}&sort=-createdAt&page=0&limit=100

You need to run the parameters through urlencode to be able to parse the query correctly. So the filter part looks more like

%7B%22userName%22%3A%20%7B%22%24regex%22%3A%20%22%5Etest%22%7D%7D

Sort

You can specify more than one field for sorting by providing a list of them separated by a semicolon: createdAt;userName. To use DESC sort order: -createdAt.

Filter

A subset of mongoose query language is supported. Currently only these operators are supported:

'$eq', '$gt', '$gte', '$in', '$lt', '$lte', '$ne', '$nin', '$and', '$not', '$nor', '$or', '$regex'

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

9

Maintained

Determines if the project is "actively maintained".

7

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 3

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/npm-publish.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/npm-publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-main.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/test-main.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-main.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/fagbokforlaget/nestjs-mongoose-paginate/test-main.yml/main?enable=pin
Info: 0 out of 8 GitHub-owned GitHubAction dependencies pinned
Info: 4 out of 4 npmCommand dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

4.9

/10

Last Scanned on 2024-11-25

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@forlagshuset/nestjs-mongoose-paginate

Installations

Pull Requests

1

39

6

32

Issues

2

7

5

Releases

Developer

fagbokforlaget

Developer Guide

CommonJS

Yes

20.17.0

10.8.2

Statistics

Languages

Total Downloads

38,266

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

nestjs-mongoose-paginate

Usage

Exposing properties

Validation Pipe

Document collector usage

Queries

Sort

Filter

10

10

10

9

7

4

3

0

0

0

0

0

4.9

/10