MCPcopy Index your code
hub / github.com/nestjsx/crud

github.com/nestjsx/crud @v5.0.1 sqlite

repository ↗ · DeepWiki ↗ · release v5.0.1 ↗
619 symbols 1,380 edges 163 files 15 documented · 2%
README

CRUD

for RESTful APIs built with NestJs

Build Coverage License npm version npm downloads Package Quality Renovate PRs welcome Awesome REST Awesome Nest Nest Powered

Built with :purple_heart: by @MichaelYali and Contributors

:star2: :eyes: :zap: :boom:

We believe that everyone who's working with NestJs and building some RESTful services and especially some CRUD functionality will find @nestjsx/crud microframework very useful.

Features

CRUD usage

  • :electric_plug: Super easy to install and start using the full-featured controllers and services :point_right:

  • :octopus: DB and service agnostic extendable CRUD controllers

  • :mag_right: Reach query parsing with filtering, pagination, sorting, relations, nested relations, cache, etc.

  • :telescope: Framework agnostic package with query builder for a frontend usage

  • :space_invader: Query, path params and DTOs validation included

  • :clapper: Overriding controller methods with ease

  • :wrench: Tiny config (including globally)

  • :gift: Additional helper decorators

  • :pencil2: Swagger documentation

Packages

  • @nestjsx/crud - core package which provides @Crud() decorator for endpoints generation, global configuration, validation, helper decorators (docs)
  • @nestjsx/crud-request - request builder/parser package which provides RequestQueryBuilder class for a frontend usage and RequestQueryParser that is being used internally for handling and validating query/path params on a backend side (docs)
  • @nestjsx/crud-typeorm - TypeORM package which provides base TypeOrmCrudService with methods for CRUD database operations (docs)

Documentation

Support

Any support is welcome. At least you can give us a star :star:

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

MIT

Extension points exported contracts — how you extend this code

ParsedRequestParams (Interface)
(no doc) [1 implementers]
packages/crud-request/src/interfaces/parsed-request.interface.ts
CrudController (Interface)
(no doc) [1 implementers]
packages/crud/src/interfaces/crud-controller.interface.ts
IAllowedRelation (Interface)
(no doc)
packages/crud-typeorm/src/typeorm-crud.service.ts
RequestQueryBuilderOptions (Interface)
(no doc)
packages/crud-request/src/interfaces/request-query-builder-options.interface.ts
DtoOptions (Interface)
(no doc)
packages/crud/src/interfaces/dto-options.interface.ts
ParamsOptions (Interface)
(no doc)
packages/crud-request/src/interfaces/params-options.interface.ts
CreateManyDto (Interface)
(no doc)
packages/crud/src/interfaces/create-many-dto.interface.ts
ParamOption (Interface)
(no doc)
packages/crud-request/src/interfaces/params-options.interface.ts

Core symbols most depended-on inside this repo

query
called by 138
packages/crud-request/src/request-query.builder.ts
get
called by 75
packages/crud/src/crud/reflection.helper.ts
Crud
called by 48
packages/crud/src/decorators/crud.decorator.ts
parseQuery
called by 47
packages/crud-request/src/request-query.parser.ts
search
called by 39
packages/crud-request/src/request-query.builder.ts
setFilter
called by 32
packages/crud-request/src/request-query.builder.ts
setJoin
called by 26
packages/crud-typeorm/src/typeorm-crud.service.ts
isObject
called by 24
packages/util/src/checks.util.ts

Shape

Method 282
Class 235
Function 63
Interface 35
Enum 4

Languages

TypeScript100%

Modules by API surface

packages/crud-typeorm/src/typeorm-crud.service.ts40 symbols
packages/crud/src/crud/crud-routes.factory.ts36 symbols
packages/crud-typeorm/test/b.query-params.spec.ts30 symbols
packages/crud-request/src/request-query.builder.ts27 symbols
packages/crud/src/crud/reflection.helper.ts25 symbols
packages/crud/test/crud-request.interceptor.spec.ts23 symbols
packages/crud-typeorm/test/c.basic-crud.spec.ts23 symbols
packages/util/src/checks.util.ts22 symbols
packages/crud-request/src/request-query.parser.ts21 symbols
packages/crud/test/crud.serialize.options.spec.ts20 symbols
packages/crud/src/crud/swagger.helper.ts19 symbols
packages/crud/test/__fixture__/services/test.service.ts11 symbols

Dependencies from manifests, versioned

@nestjs/common7.6.6 · 1×
@nestjs/core7.6.6 · 1×
@nestjs/platform-express7.6.6 · 1×
@nestjs/swagger4.7.12 · 1×
@nestjs/testing7.6.6 · 1×
@nestjs/typeorm7.1.5 · 1×
@nestjsx/crud-request5.0.1 · 1×
@nestjsx/util5.0.1 · 1×
@nuxtjs/opencollective0.2.2 · 1×
@types/jest24.0.18 · 1×
@types/node12.7.5 · 1×
@types/qs6.5.3 · 1×

Datastores touched

(mysql)Database · 1 repos

For agents

$ claude mcp add crud \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact