npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nest-jsonapi

v0.6.0

Published

a NestJS module that provides JSONAPI integration

Downloads

46

Readme

NPM Build Status Download count

Installation

npm install --save nest-jsonapi

Usage

Import the JsonapiModule into the root AppModule and use the forRoot() method to configure it:

import { JsonapiModule } from "nest-jsonapi";

@Module({
    imports: [
        JsonapiModule.forRoot({
            // options
        }),
    ],
})
export class AppModule {}

Inject JsonapiService:

import { JsonapiService, JSONAPI_MODULE_SERVICE } from "nest-jsonapi";

@Controller("photos")
export class PhotosController {
    constructor(@Inject(JSONAPI_MODULE_SERVICE) private readonly jsonapiService: JsonapiService) {}
}

Note that JsonapiModule is a global module, therefore it will be available in all modules.

Middleware

If you plan on using the JsonapiPayload decorator (more info below), you must use the JsonapiMiddleware in your application. This does 2 things:

  1. enable parsing jsonapi content as JSON
  2. creates a request-scoped holder for tracking metadata

e.g.

export class AppModule implements NestModule {
    public configure(consumer: MiddlewareConsumer): void {
        consumer.apply(JsonapiMiddleware).forRoutes(PhotosController);
    }
}

Interceptor

The JsonapiInterceptor is used to properly transform your controller result data to JSONAPI. You can decorate at a class or method level:

@UseInterceptors(JsonapiInterceptor)
@Controller("photos")
export default class PhotosController {}

Payload Metadata

In order for the JsonapiInterceptor to know how to transform your data, you need to decorate your methods.

@JsonapiPayload({ resource: RESOURCE_PHOTOS })
@Get()
public async findPhotos(@Query() query: FindOptions): Promise<Photo[]>

Exception Filter

In order to support error responses compliant with the JSONAPI specification, the JsonapiExceptionFilter exists.

const { httpAdapter } = app.get(HttpAdapterHost);
app.useGlobalFilters(new JsonapiExceptionFilter(httpAdapter));

Schema Registration

The JsonapiService requires schemas for the resources it is going to handle. You have control of how that is configured, by defining a schematic. We provide a thin wrapper around the transformalizer library.

Typically you will want to register your schemas on module initialization.

export class AppModule implements OnModuleInit {
    constructor(@Inject(JSONAPI_MODULE_SERVICE) private readonly jsonapiService: JsonapiService) {}

    public async onModuleInit(): Promise<void> {
        const photoBuilder = new SchemaBuilder<Photo>(RESOURCE_PHOTOS);
        photoBuilder.dataBuilder.untransformAttributes({ deny: ["createdAt", "updatedAt"] });
        this.jsonapiService.register(photoBuilder);
    }
}

Reference Example

nest-jsonapi-example is an example project that demonstrates the usage of this module. Since not all aspects of the module have been fully tested yet (coming soon!), I highly suggest checking this out!

API Docs

For detailed API information please visit the API documentation.

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.